Player
Inherits: Instance
A player is a user client connected to the game server.
Properties
The CharacterController that this player is using, if any.
True if this player is a TruWorlds Crew Member; false otherwise.
The current membership tier of the player.
If set, this Player will always spawn their CharacterController at the specified PlayerStart instance, overriding the default spawn selection behavior.
The ID of the player's TruWorlds account.
Functions
Kicks this player from the server with an optional reason. Must be called server-side.
Spawns a fresh CharacterController for this player immediately, canceling any pending respawn. Must be called server-side.
Signals
A signal emitted when a new CharacterController is created for this player.
A signal emitted when this player sends a chat message.
Properties
Whether this Instance or any of its descendants should be included when saving or copying via Clone()
The unique identifier for this Instance.
If true, this instance and all of its descendants cannot be selected in the editor.
The name of this Instance.
The parent of this Instance in the hierarchy.
The sort index of this Instance among its siblings. If this Instance has no parent, this value is ignored.
Functions
Attaches a script to this instance by its file path. The path should be relative to the root assets directory, e.g. "Scripts/MyScript".
Creates a deep clone of this Instance and all its descendants.
Removes this Instance, and all its descendants, from the DataModel, and locks its parent property.
Schedules this Instance to be destroyed after the specified delay in seconds. This function will error if called multiple times.
Removes a script from this instance by its file path. The path should be relative to the root assets directory, e.g. "Scripts/MyScript".
Returns an array of the children of this Instance.
Gets the global bounding box that encapsulates all DynamicInstance children of this Instance.
Returns the path of the script component at , or an empty string if the script file no longer exists.
Determines if this Instance is a descendant of the specified ancestor Instance.