CharacterControllerclass
Allows collision constrained movement without the need for a rigidbody. This is not affected by forces and will only move when you call the Move() method.
Constructors1
Showing 1 constructors
public CharacterController()
No results match this filter.
Methods7
Showing 7 methods
public void Accelerate(Vector3 vector)
Add acceleration to the current velocity. No need to scale by time delta - it will be done inside.
| Parameter | Type | Description |
|---|---|---|
| vector | Vector3 | — |
void—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.
| Parameter | Type | Description |
|---|---|---|
| frictionAmount | float | — |
| stopSpeed = 140 | float | — |
void—protected virtual void DrawGizmos()
void—public void Move()
Move a character, with this velocity
void—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.
| Parameter | Type | Description |
|---|---|---|
| targetPosition | Vector3 | — |
| useStep | bool | — |
void—public void Punch(Vector3 amount)
Disconnect from ground and punch our velocity. This is useful if you want the player to jump or something.
| Parameter | Type | Description |
|---|---|---|
| amount | Vector3 | — |
void—public Sandbox.SceneTraceResult TraceDirection(Vector3 direction)
Trace the controller's current position to the specified delta
| Parameter | Type | Description |
|---|---|---|
| direction | Vector3 | — |
No results match this filter.
Properties13
Showing 13 properties
public float Sandbox.CharacterController.Acceleration { get; set; }
float—public float Sandbox.CharacterController.Bounciness { get; set; }
When jumping into walls, should we bounce off or just stop dead?
float—public BBox Sandbox.CharacterController.BoundingBox { get; set; }
public float Sandbox.CharacterController.GroundAngle { get; set; }
float—public Sandbox.Collider Sandbox.CharacterController.GroundCollider { get; set; }
public Sandbox.GameObject Sandbox.CharacterController.GroundObject { get; set; }
public float Sandbox.CharacterController.Height { get; set; }
float—public Sandbox.TagSet Sandbox.CharacterController.IgnoreLayers { get; set; }
public bool Sandbox.CharacterController.IsOnGround { get; set; }
bool—public float Sandbox.CharacterController.Radius { get; set; }
float—public float Sandbox.CharacterController.StepHeight { get; set; }
float—public bool Sandbox.CharacterController.UseCollisionRules { get; set; }
If enabled, determine what to collide with using current project's collision rules for the `Sandbox.GameObject.Tags` of the containing `Sandbox.GameObject`.
bool—public Vector3 Sandbox.CharacterController.Velocity { get; set; }
No results match this filter.