Character

Availability

Server + Client

Serializable

Yes

Associated namespace

sm.character

A userdata object representing a character in the game.

Values:

• clientPublicData [ table ]
  

  • Get: (Client-Only) Returns client public data from a character.
  • Set: (Client-Only) Sets client public data on a character.

• color [ Color ]
  

  • Get: Returns the base color of a character.
  • Set: (Server-Only) Sets the character color.

• direction [ Vec3 ]
  

  • Get: Returns the direction of where a character is viewing or aiming.

• id [ integer ]
  

  • Get: Returns the id of a character.

• mass [ number ]
  

  • Get: Returns the mass of a character.

• movementSpeedFraction [ number ]
  

  • Get: Gets the current fraction multiplier applied on the character's movement speed.
  • Set: Sets a fraction multiplier to the character's movement speed.

• publicData [ table ]
  

  • Get: (Server-Only) Returns (server) public data from a character.
  • Set: (Server-Only) Sets (server) public data on a character.

• smoothDirection [ Vec3 ]
  

  • Get: Returns the smooth direction of where a character is viewing or aiming.

• velocity [ Vec3 ]
  

  • Get: Returns the velocity of a character.

• world [ World ]
  

  • Get: Returns the world a character exists in.

• worldPosition [ Vec3 ]
  

  • Get: Returns the world position of a character.
  • Set: (Server-Only) Sets the world position of a character.

Operations:

Server + Client

applyTumblingImpulse

character:applyTumblingImpulse( impulse, offset )

Applies impulse to the characters tumbling shape.

Parameters:

bindAnimationCallback

character:bindAnimationCallback( animationName, triggerTime, callback )

Binds a character's animation to a callback function.

Parameters:

getActiveAnimations

character:getActiveAnimations(  )

Returns the set of active animations.

Parameters:

Returns:

getCanSwim

character:getCanSwim(  )

Returns whether the character will float or sink in liquid.

Parameters:

Returns:

getCharacterType

character:getCharacterType(  )

Returns the uuid of the character.

Parameters:

Returns:

getColor

character:getColor(  )

Returns the base color of a character.

Parameters:

Returns:

getCurrentMovementNoiseRadius

character:getCurrentMovementNoiseRadius(  )

Returns the radius around the character where it can be heard.

Parameters:

Returns:

getCurrentMovementSpeed

character:getCurrentMovementSpeed(  )

Returns the current movement speed of the character depending on state and multiplier.

Parameters:

Returns:

getDirection

character:getDirection(  )

Returns the direction of where a character is viewing or aiming.

Parameters:

Returns:

getHeight

character:getHeight(  )

Returns the height of a character

Parameters:

Returns:

getId

character:getId(  )

Returns the id of a character.

Parameters:

Returns:

getJumpSpeedFraction

character:getJumpSpeedFraction(  )

Gets the current fraction multiplier applied on the character's jump speed.

Parameters:

Returns:

getLockingHarvestable

character:getLockingHarvestable(  )

Get the Harvestable that the Character is locked to.

Parameters:

Returns:

getLockingInteractable

character:getLockingInteractable(  )

Get the Interactable that the Character is locked to.

Parameters:

Returns:

getMass

character:getMass(  )

Returns the mass of a character.

Parameters:

Returns:

getMoveSpeed

character:getMoveSpeed(  )

Returns the move speed of a character

Parameters:

Returns:

getMovementSpeedFraction

character:getMovementSpeedFraction(  )

Gets the current fraction multiplier applied on the character's movement speed.

Parameters:

Returns:

getPlayer

character:getPlayer(  )

Returns the player controlling the character.

Parameters:

Returns:

getRadius

character:getRadius(  )

Returns the radius of a character

Parameters:

Returns:

getSmoothViewDirection

character:getSmoothViewDirection(  )

Returns the smooth direction of where a character is viewing or aiming.

Parameters:

Returns:

getSprintSpeed

character:getSprintSpeed(  )

Returns the sprint speed of a character

Parameters:

Returns:

getSurfaceNormal

character:getSurfaceNormal(  )

Returns the normal of the character's contact with a surface. Defaults to a zero vector when no contact is found.

Parameters:

Returns:

getTpBonePos

character:getTpBonePos( jointName )

Returns the world position for a bone in the third person view animation skeleton.

Parameters:

Returns:

getTpBoneRot

character:getTpBoneRot( jointName )

Returns the world rotation for a bone in the third person view animation skeleton.

Parameters:

Returns:

getTumblingAngularVelocity

character:getTumblingAngularVelocity(  )

Returns the angular velocity of the characters tumbling shape.

Parameters:

Returns:

getTumblingExtent

character:getTumblingExtent(  )

Returns the extent of the characters tumbling shape.

Parameters:

Returns:

getTumblingLinearVelocity

character:getTumblingLinearVelocity(  )

Returns the linear velocity of the characters tumbling shape.

Parameters:

Returns:

getTumblingWorldPosition

character:getTumblingWorldPosition(  )

Returns the world position of the characters tumbling shape.

Parameters:

Returns:

getTumblingWorldRotation

character:getTumblingWorldRotation(  )

Returns the world rotation of the characters tumbling shape.

Parameters:

Returns:

getUnit

character:getUnit(  )

Returns the unit controlling the character.

Parameters:

Returns:

getVelocity

character:getVelocity(  )

Returns the velocity of a character.

Parameters:

Returns:

getWorld

character:getWorld(  )

Returns the world a character exists in.

Parameters:

Returns:

getWorldPosition

character:getWorldPosition(  )

Returns the world position of a character.

Parameters:

Returns:

isAiming

character:isAiming(  )

Returns whether a character is currently aiming with a weapon.

Parameters:

Returns:

isClimbing

character:isClimbing(  )

Get the character climbing state.

Parameters:

Returns:

isCrouching

character:isCrouching(  )

Returns whether a character is currently crouching.

Parameters:

Returns:

isDefaultColor

character:isDefaultColor(  )

Returns true if the current character color is its default color.

Parameters:

Returns:

isDiving

character:isDiving(  )

Get the character diving state.

Parameters:

Returns:

isDowned

character:isDowned(  )

Get the character downed state.

Parameters:

Returns:

isFlying

character:isFlying(  )

Get the character flying state.

Parameters:

Returns:

isHovering

character:isHovering(  )

Get the character hovering state.

Parameters:

Returns:

isLadderClimbing

character:isLadderClimbing(  )

Get whether the character is climbing a ladder.

Parameters:

Returns:

isMoving

character:isMoving(  )

Returns whether a character is currently moving.

Parameters:

Returns:

isOnGround

character:isOnGround(  )

Returns whether the character is currently standing on the ground.

Parameters:

Returns:

isPlayer

character:isPlayer(  )

Returns whether a character is owned by a player.

Parameters:

Returns:

isSeated

character:isSeated(  )

Returns whether the character is currently seated.

Parameters:

Returns:

isSprinting

character:isSprinting(  )

Returns whether a character is currently sprinting.

Parameters:

Returns:

isSwimming

character:isSwimming(  )

Get the character swimming state.

Parameters:

Returns:

isTumbling

character:isTumbling(  )

Get the character tumbling state.

Parameters:

Returns:

removeAnimationCallbacks

character:removeAnimationCallbacks(  )

Removes all of a character's animation callbacks.

Parameters:

setJumpSpeedFraction

character:setJumpSpeedFraction( fraction )

Sets a fraction multiplier to the character's jump speed.

Parameters:

setLockingHarvestable

character:setLockingHarvestable( harvestable )

Set the Harvestable that the Character is locked to. Set Harvestable to nil to unlock.

Parameters:

Returns:

setLockingInteractable

character:setLockingInteractable( interactable )

Set the Interactable that the Character is locked to. Set Interactable to nil to unlock.

Parameters:

Returns:

setMovementEffects

character:setMovementEffects( filepath )

Sets the movement effect set filepath.

Parameters:

setMovementSpeedFraction

character:setMovementSpeedFraction( fraction )

Sets a fraction multiplier to the character's movement speed.

Parameters:

Server-only

getImmovable

character:getImmovable(  )

Returns whether a non-player character is immovable,

Parameters:

Returns:

getPublicData

character:getPublicData(  )

Returns (server) public data from a character.

Parameters:

Returns:

setClimbing

character:setClimbing( state )

Sets whether the character is climbing.

Parameters:

setColor

character:setColor( color )

Sets the character color.

Parameters:

setDiving

character:setDiving( state )

Sets whether the character is diving.

Parameters:

setDowned

character:setDowned( state )

Sets whether the character is downed.

Parameters:

setFlying

character:setFlying( state )

Sets whether the character is flying.

Will not activate flight for player characters.

Parameters:

setHovering

character:setHovering( state )

Sets whether the character is hovering.

Will not activate hover for player characters.

Parameters:

setImmovable

character:setImmovable( enable )

Sets the immovable state on a non-player character. This prevents the character from updating its physics.

Parameters:

setPublicData

character:setPublicData( data )

Sets (server) public data on a character.

Parameters:

setSwimming

character:setSwimming( state )

Sets whether the character is swimming.

Note: By default the swimming state is controlled by the client as part of the player movement. This value is treated like an override that is synchronized from the server. Buoyancy calculations in the character controller require that the character touches a liquid volume.

Parameters:

setTumbling

character:setTumbling( state )

Sets whether the character is tumbling.

Parameters:

setWorldPosition

character:setWorldPosition( position )

Sets the world position of a character.

Parameters:

Client-only

addRenderable

character:addRenderable( renderable )

Adds a renderable (file containing model data) to be used for the character in third person view.

Parameters:

getAnimationInfo

character:getAnimationInfo( name )

Parameters:

Returns:

getClientPublicData

character:getClientPublicData(  )

Returns client public data from a character.

Parameters:

Returns:

getGlowMultiplier

character:getGlowMultiplier(  )

Gets the glow multiplier.

Parameters:

Returns:

hasActiveOverrideAnimation

character:hasActiveOverrideAnimation(  )

Returns whether or not the character has an active animation override on its third person animations.

A third person animation override could be the crowbar animation when picking something up or the hammer when placing something.

Parameters:

Returns:

hasGraphics

character:hasGraphics(  )

Checks if a character has graphics.

Parameters:

Returns:

isVisible

character:isVisible(  )

Returns whether a character is visible.

Parameters:

Returns:

overrideRenderableList

character:overrideRenderableList( renderables )

Overrides a non player character's third person renderable list with a new list of renderables. Will trigger a rebuild of the character's graphics.

Parameters:

removeRenderable

character:removeRenderable( renderable )

Removes a renderable (file containing model data) that was used for the character in third person view.

Parameters:

setAllowTumbleAnimations

character:setAllowTumbleAnimations( allow )

Enables or disables event animations.

When set to false no animations can play while tumble is active, and when set to true the animations will play while tumbling.

Parameters:

setClientPublicData

character:setClientPublicData( data )

Sets client public data on a character.

Parameters:

setGlowMultiplier

character:setGlowMultiplier( value )

Sets a value to multiply the glow from asg texture with.

Parameters:

setMovementWeights

character:setMovementWeights( lower, upper )

Sets the weights for movement animations on a character's upper and lower body.

For a value of 0 no movement animations will play, and for a value of 1 the movement animations will fully play unless otherwise overridden.

Parameters:

setNameTag

character:setNameTag(
    name,
    color,
    requiresLoS,
    renderDistance,
    fadeDistance
)

Sets the name tag display value for the character

Parameters:

setUpDirection

character:setUpDirection( up )

Sets the upward direction of the character's graphics.

Parameters:

setVisible

character:setVisible( visible )

Sets the visibility.

Parameters:

updateAnimation

character:updateAnimation( name, time, weight, additive )

Updates a character animation.

Parameters: