API ReferenceSandbox.Movement

MoveModeLadderclass

The character is climbing up a ladder

object→MoveMode→MoveModeLadder
Namespace
Sandbox.Movement
Assembly
Sandbox.Engine
Declaration
public class Sandbox.Movement.MoveModeLadder : Sandbox.Movement.MoveMode

Constructors1

Showing 1 constructors

Methods10

Showing 10 methods

protected virtual void OnFixedUpdate()PROTECTEDVIRTUALFIXED TICK

Returns:void—

public virtual void OnJump()PUBLICVIRTUAL

Returns:void—

public virtual void OnModeBegin()PUBLICVIRTUAL

Returns:void—

public virtual void OnModeEnd(Sandbox.Movement.MoveMode next)PUBLICVIRTUAL

ParameterTypeDescription
nextMoveMode—
Returns:void—

protected virtual void OnUpdateAnimatorVelocity(Sandbox.SkinnedModelRenderer renderer)PROTECTEDVIRTUALPER-FRAME

Drive the existing movement blend from actual ladder-space velocity, so blocked movement holds the idle pose even while the rendered body is still turning.

ParameterTypeDescription
rendererSkinnedModelRenderer—
Returns:void—

public virtual void PostPhysicsStep()PUBLICVIRTUAL

Returns:void—

public virtual Vector3 UpdateMove(Rotation eyes, Vector3 input)PUBLICVIRTUALPER-FRAME

Climb vertically from the supplied movement input, reversing when looking down.

ParameterTypeDescription
eyesRotation—
inputVector3—
Returns:Vector3—

public virtual void UpdateRigidBody(Sandbox.Rigidbody body)PUBLICVIRTUALPER-FRAME

ParameterTypeDescription
bodyRigidbody—
Returns:void—

Properties5

Showing 5 properties

public Sandbox.TagSet Sandbox.Movement.MoveModeLadder.ClimbableTags { get; set; }PUBLICGETSET

A list of tags we can climb up - when they're on triggers

Returns:TagSet—

public Sandbox.GameObject Sandbox.Movement.MoveModeLadder.ClimbingObject { get; set; }PUBLICGETSET

The GameObject we're climbing. This will usually be a ladder trigger.

Returns:GameObject—

public Rotation Sandbox.Movement.MoveModeLadder.ClimbingRotation { get; set; }PUBLICGETSET

When climbing, this is the rotation of the wall/ladder you're climbing, where Forward is the direction to look at the ladder, and Up is the direction to climb.

Returns:Rotation—

public int Sandbox.Movement.MoveModeLadder.Priority { get; set; }PUBLICGETSET

Movement selection priority. Defaults above swimming so ladders can be climbed out of water.

Returns:int—

public float Sandbox.Movement.MoveModeLadder.Speed { get; set; }PUBLICGETSET

Multiplier for the ladder movement speed.

Returns:float—

On this page