void ApplyFriction( float frictionAmount, float stopSpeed )

robot_2Generated
code_blocksInput

Description

The ApplyFriction method is used to apply a specified amount of friction to the current velocity of a character. This method is part of the CharacterController class, which allows for collision-constrained movement without the need for a rigidbody. The friction is applied directly to the velocity, and there is no need to manually scale it by the time delta, as this is handled internally by the method.

Usage

To use the ApplyFriction method, you need to provide two parameters:

  • frictionAmount (Single): The amount of friction to apply to the character's velocity. This value should be a positive number representing the friction coefficient.
  • stopSpeed (Single): The speed at which the character should stop moving. If the character's velocity falls below this speed, it will be set to zero.

This method is typically called within the update loop of a game to continuously apply friction to a character's movement, simulating realistic deceleration.

Example

// Example of using ApplyFriction in a game update loop
public class MyCharacter : CharacterController
{
    public void Update()
    {
        // Define friction amount and stop speed
        float frictionAmount = 0.5f;
        float stopSpeed = 0.1f;

        // Apply friction to the character's velocity
        ApplyFriction(frictionAmount, stopSpeed);

        // Additional movement logic here
    }
}