Tool.getMovementSpeedFraction
Returns the fraction of the player's movement speed in proportion to its maximum. This is affected by sprinting, crouching, blocking, aiming, etc.
Kind: Function
Environments: Game
Game
tool:getMovementSpeedFraction( )
Availability: Client only
| Value | Description |
|---|---|
| sprinting | 1.0 |
| walking | 0.5 |
| crouching | 0.375 |
| aiming | 0.3125 |
Parameters:
| Name | Type | Description |
|---|---|---|
tool |
Tool | The tool. |
Returns:
| Type | Description |
|---|---|
| number | The player's movement speed fraction. |