Optional
Readonly
avatarGet the player's avatar information.
Whenther the player can fly.
Whenther the player can hard land.
Whether the player can jump.
Whether the player can move.
Whether the player can run.
Readonly
collisionPlayer's collision, default collision type is capsule.
Jump height multiplier.
Optional
Readonly
nameGet the player's name tag.
Optional
Readonly
networkGet the player's server connection information.
Optional
Readonly
profileGet the player's profile information.
Player's respawn point, default is null.
When executing respawn(), first using respawnPosition as the respawn location.
If respawnPosition is null, the respawn location will be determined by the original VIVERSE CREATE mechanism (checkpoint, spawn-point tag).
Readonly
spawnGet the player's respawn count.
Send a specific event.
Event name
Optional
Rest
...args: any[]Event parameters
Unsubscribe from a specific event.
Event name
Callback function
Subscribe to a specific event.
Event name
Callback function
Play a custom animation.
The stateName of animation.
Optional
options: { Optional parameters.
Optional
asset?: AssetSend the vrma file.
Lock the animation. Default is false.
Loop the animation. Default is false.
Send the character back to the respawn point (respawnPosition), with the respawned event triggered.
If respawnPosition is null, the respawn location will be determined by the original VIVERSE CREATE mechanism (checkpoint, spawn-point tag).
Optional
timeout: numberDelay the respawn time (in milliseconds).
Make the character face the target’s position on the horizontal plane.
X-coordinate of the target’s position on the horizontal plane, or the target's horizontal position.
Optional
y: numberY-coordinate of the target’s position on the horizontal plane.
Define LocalPlayer interface.