Character

Inherits from:

Event that fires when the characters anchor changes

Event fired when an animation event occurs

local player = client.localPlayer
player.character.AnimationEvent:Connect(function(event)
  print("Animation event: " .. event)
end)

Event that fires when the character plays an emote

Event that fires when the character stops an emote in progress or a looping emote

Event fired when the character has finished moving

local player = client.localPlayer
player.character.MoveFinished:Connect(function()
  print("Character has finished moving.")
end)

Event fired when the character has started moving

Event that fires when the outfit of a character changes

Event fired when the characters state changes

local player = client.localPlayer
player.character.StateChanged:Connect(function(state)
  print("Character state changed to " .. state)
end)

Return the character's current anchor

Returns the transform for chat bubbles.

Returns the collection of default outfits for the character

Return the destination point of the current move

local player = client.localPlayer
print(tostring(player.character.destination))

Return the distance to the destination if character is moving or 0

local player = client.localPlayer
print(tostring(player.character.distanceToDestination))

Returns true if the character has one or more outfits

Returns true if the character is currently anchored

Returns true if the character is in a moving state (Walking, Running, or Jumping). A character attached to an anchor is considered to be in an idle state, even if the anchor is set to play a walk or run animation.

local player = client.localPlayer
print(tostring(player.character.isMoving))

Get/Set the distance at which the character will choose to jog instead of walk

Get/Set the characters jog speed

Get/Set the characters run speed

Return the outfits assigned to this character

Returns the player that is controlling this character if the character is the player character, otherwise null

The rendering layer of the character for drawing order.

The position of the character in the game world for rendering purposes.

local player = client.localPlayer
player.character.renderPosition = Vector3.New(0, 0, 0)

The rotation of the character in the game world for rendering purposes.

local player = client.localPlayer
player.character.renderRotation = Quaternion.New(0, 0, 0, 1)

The scale of the character in the game world for rendering purposes.

local player = client.localPlayer
player.character.renderScale = Vector3.New(1, 1, 1)

Get/Set the distance at which the character will choose to run instead of walk

Get/Set the characters run speed

The movement speed of the character. You must wait for the player to connect before setting this property.

local player = client.localPlayer
player.character.speed = 10

The current state of the character.

When set to true, the character uses pathfinding to navigate to its destination.

local player = client.localPlayer
player.character.usePathfinding = true

Get/Set the characters walk speed