Add this component to a Character and it'll be able to go up and down ladders. Animator parameters : LadderClimbing (bool), LadderClimbingSpeed (float)
More...
|
float | LadderClimbingSpeed = 2f |
| the speed of the character when climbing a ladder More...
|
|
bool | ForceRightFacing = false |
| force face right when on a ladder (useful for 3D characters) More...
|
|
bool | ForceAnchorToGroundOnExit = false |
| forces the character to teleport to the ladder platform when reaching the ladder's top More...
|
|
float | MinimumTimeAfterLadderJump = 0.5f |
| the time (in seconds) between jumping from a ladder and being able to climb another one (or the same one) More...
|
|
bool | NoInputClimb = false |
| if this is true, the Player won't have to press up to climb a ladder, simply colliding with one will cause the climb More...
|
|
bool | NoInputClimbAirOnly = false |
| if this is true, the character will have to be in the air for NoInputClimb to activate More...
|
|
MMFeedbacks | AbilityStartFeedbacks |
| the feedbacks to play when the ability starts More...
|
|
MMFeedbacks | AbilityStopFeedbacks |
| the feedbacks to play when the ability stops More...
|
|
bool | AbilityPermitted = true |
| if true, this ability can perform as usual, if not, it'll be ignored. You can use this to unlock abilities over time for example More...
|
|
CharacterStates.MovementStates[] | BlockingMovementStates |
| an array containing all the blocking movement states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while Idle or Swimming, for example. More...
|
|
CharacterStates.CharacterConditions[] | BlockingConditionStates |
| an array containing all the blocking condition states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while dead, for example. More...
|
|
Weapon.WeaponStates[] | BlockingWeaponStates |
| an array containing all the blocking weapon states. If one of the character's weapons is in one of these states and yet the character tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while attacking, for example. More...
|
|
Add this component to a Character and it'll be able to go up and down ladders. Animator parameters : LadderClimbing (bool), LadderClimbingSpeed (float)
◆ AboveLadderPlatform()
virtual bool MoreMountains.CorgiEngine.CharacterLadder.AboveLadderPlatform |
( |
| ) |
|
|
virtual |
Determines if the player is above the ladder's platform (usually positioned near the top)
- Returns
true
, if the player is above the ladder's platform, false
otherwise.
◆ AddCollidingLadder()
virtual void MoreMountains.CorgiEngine.CharacterLadder.AddCollidingLadder |
( |
Collider2D |
newCollider | ) |
|
|
virtual |
Adds a new ladder to the list of colliding ladders
- Parameters
-
◆ Climbing()
virtual void MoreMountains.CorgiEngine.CharacterLadder.Climbing |
( |
| ) |
|
|
protectedvirtual |
Handles movement on the ladder
◆ ComputeClosestLadder()
virtual void MoreMountains.CorgiEngine.CharacterLadder.ComputeClosestLadder |
( |
| ) |
|
|
protectedvirtual |
Determines the current, highest and lowest ladders if there are any
◆ GetOffTheLadder()
virtual void MoreMountains.CorgiEngine.CharacterLadder.GetOffTheLadder |
( |
| ) |
|
|
virtual |
Resets various states so that the Character isn't climbing anymore
◆ HandleFeedbacks()
virtual void MoreMountains.CorgiEngine.CharacterLadder.HandleFeedbacks |
( |
| ) |
|
|
protectedvirtual |
◆ HandleLadderClimbing()
virtual void MoreMountains.CorgiEngine.CharacterLadder.HandleLadderClimbing |
( |
| ) |
|
|
protectedvirtual |
Called at ProcessAbility(), checks if we're colliding with a ladder and if we need to do something about it
◆ Initialization()
override void MoreMountains.CorgiEngine.CharacterLadder.Initialization |
( |
| ) |
|
|
protectedvirtual |
◆ InitializeAnimatorParameters()
override void MoreMountains.CorgiEngine.CharacterLadder.InitializeAnimatorParameters |
( |
| ) |
|
|
protectedvirtual |
◆ JumpFromLadder()
virtual void MoreMountains.CorgiEngine.CharacterLadder.JumpFromLadder |
( |
| ) |
|
|
virtual |
Called externally when jumping while on a ladder
◆ OnDeath()
override void MoreMountains.CorgiEngine.CharacterLadder.OnDeath |
( |
| ) |
|
|
protectedvirtual |
◆ ProcessAbility()
override void MoreMountains.CorgiEngine.CharacterLadder.ProcessAbility |
( |
| ) |
|
|
virtual |
◆ RemoveCollidingLadder()
virtual void MoreMountains.CorgiEngine.CharacterLadder.RemoveCollidingLadder |
( |
Collider2D |
newCollider | ) |
|
|
virtual |
Removes a ladder from the list of colliding ladders
◆ ResetAbility()
override void MoreMountains.CorgiEngine.CharacterLadder.ResetAbility |
( |
| ) |
|
|
virtual |
◆ SetClimbingState()
virtual void MoreMountains.CorgiEngine.CharacterLadder.SetClimbingState |
( |
| ) |
|
|
protectedvirtual |
Sets the various flags and states
◆ SetInput()
virtual void MoreMountains.CorgiEngine.CharacterLadder.SetInput |
( |
Vector2 |
ladderInput, |
|
|
float |
threshold |
|
) |
| |
|
virtual |
◆ StartClimbing()
virtual void MoreMountains.CorgiEngine.CharacterLadder.StartClimbing |
( |
| ) |
|
|
protectedvirtual |
Puts the character on the ladder
◆ StartClimbingDown()
virtual void MoreMountains.CorgiEngine.CharacterLadder.StartClimbingDown |
( |
| ) |
|
|
protectedvirtual |
Puts the character on the ladder if it's standing on top of it
◆ UpdateAnimator()
override void MoreMountains.CorgiEngine.CharacterLadder.UpdateAnimator |
( |
| ) |
|
|
virtual |
◆ _boxCollider
BoxCollider2D MoreMountains.CorgiEngine.CharacterLadder._boxCollider |
|
protected |
◆ _characterHandleWeapon
◆ _colliders
List<Collider2D> MoreMountains.CorgiEngine.CharacterLadder._colliders |
|
protected |
◆ _ladderClimbingSpeedXAnimationParameter
int MoreMountains.CorgiEngine.CharacterLadder._ladderClimbingSpeedXAnimationParameter |
|
protected |
◆ _ladderClimbingSpeedXAnimationParameterName
const string MoreMountains.CorgiEngine.CharacterLadder._ladderClimbingSpeedXAnimationParameterName = "LadderClimbingSpeedX" |
|
staticprotected |
◆ _ladderClimbingSpeedYAnimationParameter
int MoreMountains.CorgiEngine.CharacterLadder._ladderClimbingSpeedYAnimationParameter |
|
protected |
◆ _ladderClimbingSpeedYpAnimationParameterName
const string MoreMountains.CorgiEngine.CharacterLadder._ladderClimbingSpeedYpAnimationParameterName = "LadderClimbingSpeedY" |
|
staticprotected |
◆ _ladderClimbingUpAnimationParameter
int MoreMountains.CorgiEngine.CharacterLadder._ladderClimbingUpAnimationParameter |
|
protected |
◆ _ladderClimbingUpAnimationParameterName
const string MoreMountains.CorgiEngine.CharacterLadder._ladderClimbingUpAnimationParameterName = "LadderClimbing" |
|
staticprotected |
◆ _ladderInput
Vector2 MoreMountains.CorgiEngine.CharacterLadder._ladderInput |
|
protected |
◆ _lastJumpFromLadderAt
float MoreMountains.CorgiEngine.CharacterLadder._lastJumpFromLadderAt = -float.MaxValue |
|
protected |
◆ _threshold
float MoreMountains.CorgiEngine.CharacterLadder._threshold |
|
protected |
◆ ForceAnchorToGroundOnExit
bool MoreMountains.CorgiEngine.CharacterLadder.ForceAnchorToGroundOnExit = false |
forces the character to teleport to the ladder platform when reaching the ladder's top
◆ ForceRightFacing
bool MoreMountains.CorgiEngine.CharacterLadder.ForceRightFacing = false |
force face right when on a ladder (useful for 3D characters)
◆ LadderClimbingSpeed
float MoreMountains.CorgiEngine.CharacterLadder.LadderClimbingSpeed = 2f |
the speed of the character when climbing a ladder
◆ MinimumTimeAfterLadderJump
float MoreMountains.CorgiEngine.CharacterLadder.MinimumTimeAfterLadderJump = 0.5f |
the time (in seconds) between jumping from a ladder and being able to climb another one (or the same one)
◆ NoInputClimb
bool MoreMountains.CorgiEngine.CharacterLadder.NoInputClimb = false |
if this is true, the Player won't have to press up to climb a ladder, simply colliding with one will cause the climb
◆ NoInputClimbAirOnly
bool MoreMountains.CorgiEngine.CharacterLadder.NoInputClimbAirOnly = false |
if this is true, the character will have to be in the air for NoInputClimb to activate
◆ CurrentLadder
Ladder MoreMountains.CorgiEngine.CharacterLadder.CurrentLadder |
|
getset |
the ladder the character is currently on
◆ CurrentLadderClimbingSpeed
Vector2 MoreMountains.CorgiEngine.CharacterLadder.CurrentLadderClimbingSpeed |
|
getset |
the current ladder climbing speed of the character
◆ HighestLadder
Ladder MoreMountains.CorgiEngine.CharacterLadder.HighestLadder |
|
getset |
the highest ladder the character is currently colliding with
◆ LadderColliding
bool MoreMountains.CorgiEngine.CharacterLadder.LadderColliding |
|
get |
true if the character is colliding with a ladder
◆ LowestLadder
Ladder MoreMountains.CorgiEngine.CharacterLadder.LowestLadder |
|
getset |
the lowest ladder the character is currently colliding with
The documentation for this class was generated from the following file: