Avatar
Inherits: PhysicsInstance
Avatar is a PhysicsInstance that represents a player's character in the game world.
Avatars are the standard TruWorlds character models. They have a cylindrical collision shape, and are often controlled by a CharacterController to assign them to a player's character in the world. Avatars can be customized with different skin tones, clothing, and accessories. An AvatarAnimator can be used to control the animation state of the Avatar.
Properties
The color of the Avatar's body.
The color of the Avatar's head.
The color of the Avatar's left arm.
The color of the Avatar's left foot.
The color of the Avatar's left leg.
The color of the Avatar's right arm.
The color of the Avatar's right foot.
The color of the Avatar's right leg.
Properties
Indicates whether the PhysicsBody is anchored in place.
The angular velocity of the PhysicsBody.
Indicates whether the PhysicsBody can collide with other objects.
Indicates whether the PhysicsBody participates in dynamic simulation.
The linear velocity of the PhysicsBody.
The client ID that has local physics authority over this body. 0 means the server simulates it.
Functions
Returns an array of all PhysicsInstances currently touching this PhysicsInstance.
Removes any welds between this PhysicsBody and the other PhysicsBody.
Properties
The coordinate matrix (CMatrix) representing the DynamicInstance's position and rotation transform in the world, in local space.
The position of the DynamicInstance. This is a shortcut for setting CMatrix.Position.
The rotation of the DynamicInstance. This is a shortcut for setting CMatrix.Rotation.
The rotation of the DynamicInstance in Euler angles (degrees). This is a shortcut for setting Rotation using Euler angles.
Properties
The transparency of the VisualInstance.
Whether the VisualInstance is visible in the game world.
Properties
Whether this Instance or any of its descendants should be included when saving or copying via Clone()
The unique identifier for this Instance.
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
Re-attaches an existing component ref (used by detach-undo to preserve identity).
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.
Detaches a specific component by reference. Use this to remove a broken component, which has no live file to identify it by.
Returns an array of the 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.