class CharacterController

in global :: Sandbox

Allows collision contrained movement without the need for a rigidbody. This is not affected by forces and will only move when you call the Move() method.


public float Bounciness { get; set; }

When jumping into walls, should we bounce off or just stop dead?

public bool UseCollisionRules { get; set; }

If enabled, determine what to collide with using current project's collision rules for the of the containing .

public void Accelerate( Vector3 vector )

Add acceleration to the current velocity. No need to scale by time delta - it will be done inside.

public void ApplyFriction( float frictionAmount, float stopSpeed = 140 )

Apply an amount of friction to the current velocity. No need to scale by time delta - it will be done inside.

public SceneTraceResult TraceDirection( Vector3 direction )

Trace the controller's current position to the specified delta

public void Punch( ref Vector3 amount )

Disconnect from ground and punch our velocity. This is useful if you want the player to jump or something.

public void MoveTo( Vector3 targetPosition, bool useStep )

Move from our current position to this target position, but using tracing an sliding. This is good for different control modes like ladders and stuff.

public Vector3 LocalPosition { get; set; }

😔 No documentation found.

public Transform LocalTransform { get; set; }

😔 No documentation found.

public Guid Id { get; }

😔 No documentation found.

public T GetComponentInParent( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public Vector3 LocalScale { get; set; }

😔 No documentation found.

public T GetComponentInChildren( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public IEnumerable<T> GetComponentsInChildren( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public IEnumerable<T> GetComponents( bool includeDisabled = False )

😔 No documentation found.

public T GetComponent( bool includeDisabled = False )

😔 No documentation found.

public T GetOrAddComponent( bool startEnabled = True )

😔 No documentation found.

public T AddComponent( bool startEnabled = True )

😔 No documentation found.

public ComponentFlags Flags { get; set; }

😔 No documentation found.

public Rotation LocalRotation { get; set; }

😔 No documentation found.

public IEnumerable<T> GetComponentsInParent( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public void Invoke( float secondsDelay, Action action, CancellationToken ct = null )

😔 No documentation found.

public bool IsProxy { get; }

😔 No documentation found.

public DebugOverlaySystem DebugOverlay { get; }

😔 No documentation found.

public JsonNode Serialize( GameObject.SerializeOptions options = null )

😔 No documentation found.

public void Deserialize( JsonObject node )

😔 No documentation found.

public void DeserializeImmediately( JsonObject node )

😔 No documentation found.

public int ComponentVersion { get; }

😔 No documentation found.

public Transform WorldTransform { get; set; }

😔 No documentation found.

public Vector3 WorldPosition { get; set; }

😔 No documentation found.

public Rotation WorldRotation { get; set; }

😔 No documentation found.

public Vector3 WorldScale { get; set; }

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public GameObject.NetworkAccessor Network { get; }

😔 No documentation found.

public CharacterController( )

😔 No documentation found.

public void DestroyGameObject( )

😔 No documentation found.

public float Radius { get; set; }

😔 No documentation found.

public float Height { get; set; }

😔 No documentation found.

public float StepHeight { get; set; }

😔 No documentation found.

public float GroundAngle { get; set; }

😔 No documentation found.

public float Acceleration { get; set; }

😔 No documentation found.

public TagSet IgnoreLayers { get; set; }

😔 No documentation found.

public BBox BoundingBox { get; }

😔 No documentation found.

public Vector3 Velocity { get; set; }

😔 No documentation found.

public bool IsOnGround { get; set; }

😔 No documentation found.

public GameObject GroundObject { get; set; }

😔 No documentation found.

public Collider GroundCollider { get; set; }

😔 No documentation found.

public void Move( )

😔 No documentation found.

public Scene Scene { get; }

😔 No documentation found.

public GameTransform Transform { get; }

😔 No documentation found.

public GameObject GameObject { get; }

😔 No documentation found.

public ComponentList Components { get; }

😔 No documentation found.

public bool Enabled { get; set; }

😔 No documentation found.

public bool Active { get; }

😔 No documentation found.

public bool IsValid { get; }

😔 No documentation found.

public Action OnComponentEnabled { get; set; }

😔 No documentation found.

public Action OnComponentStart { get; set; }

😔 No documentation found.

public Action OnComponentUpdate { get; set; }

😔 No documentation found.

public Action OnComponentFixedUpdate { get; set; }

😔 No documentation found.

public Action OnComponentDisabled { get; set; }

😔 No documentation found.

public Action OnComponentDestroy { get; set; }

😔 No documentation found.

public void Destroy( )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public void Reset( )

😔 No documentation found.

public ITagSet Tags { get; }

😔 No documentation found.

public void EditLog( string name, object source )

😔 No documentation found.