Player

Represents a player. An instance of Player can be retrived via World.getPlayer

Properties

.id: String

The players unique ID. This is always the same for the same player, even when they leave and come back.

.name: String

The players name.

.local: Boolean

Whether the player is local to this client.

.admin: Boolean

Whether the player is an admin in this world.

.position: Vector3

The players position in the world.

.quaternion: Quaternion

The players rotation in the world.

.rotation: Euler

The players rotation in the world.

Methods

.teleport(position, rotationY)

Teleports the player instantly to the new position. The rotationY value is in radians, and if omitted the player will continue facing their current direction.

.getBoneTransform(boneName): Matrix4

Returns a matrix of the bone transform in world space.

See Avatar for full details.

.damage(amount)

Removes health from the player. Health cannot go below zero.

.heal(amount)

Adds health to the player. Health cannot go above 100.

.applyEffect({ anchor, emote, snare, freeze, turn, duration, cancellable, onEnd })

Applies an effect to the player. If the player already has an effect, it is replaced. If this function is called with null it removes any active effect.

All options are optional.

anchor: an Anchor to attach the player to

emote: a url to an emote to play while this effect is active

snare: a multiplier from 0 to 1 that reduces movement speed, where zero means no snaring and one means entirely snared. when snared, players can still turn and attempt to move.

freeze: when true, the player is frozen in place and all movement keys are ignored.

turn: when true, the player will continually face the direction the camera is looking in.

duration: how long this effect should last in seconds.

cancellable: whether any movement keys will cancel the effect. if enabled, freeze is ignored.

onEnd: a function that should be called either at the end of the duration or when the player moves if cancellable.