Methods
Player:alignFollowers(facing: string?, x: number?, y: number?, dist: number?)
Aligns the player's followers' directions and positions.
Arguments:
| facing: string? | The direction every character should face (Defaults to player's direction) |
| x: number? | The x-coordinate of the 'front' of the line. (Defaults to player's x-position) |
| y: number? | The y-coordinate of the 'front' of the line. (Defaults to player's y-position) |
| dist: number? | The distance between each follower. |
Player:climbFall(time: integer, settings: ClimbFallSettings?)
Make the player fall while in the climb state. Does nothing if the player is not climbing.
Arguments:
| time: integer | The amount of time (in frames) that it takes the player to attempt to re-grab the wall. Defaults to 20. Common values are 10, 15, 20, 24, 30, 34, and 80. |
| settings: ClimbFallSettings? | The settings for the climb fall. Optional. |
Player:getSoulOffset()
Returns:
| 1: number | |
| 2: number | |
| 3: integer|nil | |
| 4: integer|nil | |
| 5: integer|nil | |
| 6: integer|nil | |
| 7: integer|nil | |
| 8: integer|nil | |
| 9: integer|nil | |
| 10: integer|nil |
Player:interpolateFollowers()
Adds all followers' current positions to their movement history.
Player:onAdd(parent: World)
Arguments:
| parent: World | The |
Player:onRemove(parent: World)
Arguments:
| parent: World | The |
Player:queueClimbDismount(settings: ClimbDismountSettings)
Requests that the player exits the climb state, jumping to a defined location.
Arguments:
| settings: ClimbDismountSettings | The settings for the climb dismount. |
Player:shouldDecreaseInvuln()
Whether the player should decrease the invulnerability timer.
This returns true if the state's shouldDecreaseInvuln callback returns true, or if World:shouldBulletsHurt() returns true.
Returns:
| decrease_invuln: boolean? |
|