local npc = world.FindFirstChild("Shopkeeper")
if npc:
npc.Speak("Welcome to my shop!", 4)
DynamicInstance
Inherits: VisualInstance
DynamicInstance is an Instance that has a position and rotation in the world, represented by a CMatrix.
Properties
CMatrix CMatrix
The coordinate matrix (CMatrix) representing the DynamicInstance's position and rotation transform in the world, in local space.
Position Vector3
The position of the DynamicInstance. This is a shortcut for setting CMatrix.Position.
Quaternion Quaternion
The rotation of the DynamicInstance as a quaternion. This is a shortcut for setting Types.CMatrix.Quaternion.
Rotation Vector3
The rotation of the DynamicInstance in Euler angles (degrees). This is a shortcut for setting Quaternion using Euler angles.
Functions
Speak(text: string)
Creates a child speech bubble attached to this DynamicInstance with the given text.
- text
- The text to display in the speech bubble.
- duration
- The duration (in seconds) for which the speech bubble should be displayed before automatically being removed. Default is 5 seconds.
Properties
Transparency float
The transparency of the VisualInstance.
Visible bool
Whether the VisualInstance is visible in the game world.
Properties
Archivable bool
Whether this Instance or any of its descendants should be included when saving or copying via Clone()
Id Guid
The unique identifier for this Instance.
Locked bool
If true, this instance and all of its descendants cannot be selected in the editor.
Name string
The name of this Instance.
Parent Instance?
The parent of this Instance in the hierarchy.
ScriptData InstanceScriptData
SortIndex ushort
The sort index of this Instance among its siblings. If this Instance has no parent, this value is ignored.
Functions
AttachScript(path: string)
Attaches a script to this instance by its file path. The path should be relative to the root assets directory, e.g. "Scripts/MyScript".
Clone() Instance
Creates a deep clone of this Instance and all its descendants.
Destroy()
Removes this Instance, and all its descendants, from the DataModel, and locks its parent property.
DestroyAfter(delaySeconds: float)
Schedules this Instance to be destroyed after the specified delay in seconds. This function will error if called multiple times.
DetachScript(path: string)
Removes a script from this instance by its file path. The path should be relative to the root assets directory, e.g. "Scripts/MyScript".
FindFirstChild(name: string) Instance?
GetChildren() Instance[]
Returns an array of the children of this Instance.
GetContentsGlobalBoundsBox() BoundsBox?
Gets the global bounding box that encapsulates all DynamicInstance children of this Instance.
GetDescendants() Instance[]
GetScriptCount() int
GetScriptPath(index: int) string
Returns the path of the script component at , or an empty string if the script file no longer exists.
IsDescendantOf(ancestor: Instance) bool
Determines if this Instance is a descendant of the specified ancestor Instance.
Properties
ClassName string read-only
Functions
IsA(className: string) bool