Instances
Instance discovery, references, and interactions.
Functions
clonerefMake a separate Luau wrapper for an existing Instance without cloning the engine object. It helps distinguish userdata identity from Instance identity when testing cache behavior.
compareinstancesCompare the underlying Roblox Instance identities of two references. Use it when one reference may have come from cloneref or another wrapper-producing API.
fireclickdetectorSubmit a ClickDetector interaction for the local player. Choose the default left click or one of the supported right-click and hover events.
fireproximitypromptTrigger a ProximityPrompt immediately through the host interaction path. Use it with a prompt that exists in the active scene.
firetouchinterestSubmit a touch-begin or touch-end event for two BaseParts. Use it when checking a touch interaction on parts in the active world.
gethuiGet Kawaii’s protected GUI container for script interfaces. Parent a ScreenGui there when the interface should live outside the ordinary PlayerGui tree.
getinstancesTake a snapshot of Instance wrappers known to the current runtime cache. It can include objects outside the DataModel, which a walk from game would miss.
getinstancesbyclassFind known Instances whose concrete ClassName exactly equals a supplied name. This is handy when you need one class without building a hierarchy filter yourself.
getmenvRead the environment of a loaded ModuleScript. Use it when inspecting a module’s execution context; it is separate from getsenv for ordinary scripts.
getnilinstancesFind known Instances with no Parent. This is useful for checking objects your script has created but not yet placed in the DataModel.
getobjectsLoad Instances from an asset URL through the DataModel’s GetObjects method. Use it when your script needs the objects inside an asset rather than only its ID.
getproximitypromptdurationRead how long the player must hold a ProximityPrompt before it triggers. Use it before a temporary change so the original duration can be restored.
getreferencedbyFind known Instances that have a readable property referring directly to a target Instance. Use it to locate an obvious owner or link when a reference is stored in properties.
getrendersteppedlistInspect named render-step bindings tracked for this Luau state. It helps diagnose duplicate render callbacks or unexpected priorities.
getsenvGet the environment table associated with an executing script. Use it to inspect values a script sees without assuming they are in your own environment.
isnetworkownerCheck whether an unanchored BasePart currently appears owned by the local client. It helps decide whether a client-side physics observation is likely to reflect local simulation.
setproximitypromptdurationChange a ProximityPrompt’s hold duration. It is useful for a temporary interaction flow that should be quicker or require a deliberate hold.