Public Member Functions
override void	Initialize ()
	Used for initialization.

override void	AfterUpdate ()
	Called right after updating the player.

void	EmitLadderSound ()
	Emits a ladder step sound.

Public Member Functions inherited from MFPP.PlayerModule
virtual void	BeforeUpdate ()
	Called right before updating the player.

Public Attributes
LayerMask	LadderLayerMask
	The layer mask of the ladder(s).

float	ClimbSpeed = 3f
	The climb speed of the Player on ladders.

float	ClimbStepTimer = 1f
	The step interval of the Player on ladders.

float	GrabForceMultiplier = 5f
	The grab force multiplier when grabbing a ladder.

float	GrabDuration = 0.5f
	The grab duration in seconds (until we grab a ladder).

Properties
bool	OnLadder `[get, protected set]`
	True if the player is using a ladder.

bool	OnTopOfLadder `[get, protected set]`
	True if the player is on top of a ladder.

Collider	CurrentLadderCollider `[get, protected set]`
	Returns the current ladder we are colliding and using.

float	StepTimer `[get, set]`
	The footstep timer interval left before emitting a ladder step.

Properties inherited from MFPP.PlayerModule
bool	Enabled `[get, set]`
	Is this PlayerModule enabled?

int	ExecutionOrder `[get, set]`
	The execution order of this PlayerModule, lower means earlier execution.

Player	Player `[get]`
	The attached global::Player to this PlayerModule.

Camera	Camera `[get]`
	The attached camera to this Player. Shortcut equivalent of "Player.Main.Camera".

Additional Inherited Members
Protected Member Functions inherited from MFPP.PlayerModule
float	GetAxis (string axisName)
	Similar to Input.GetAxis(string) but also taking into account MFPP.Player.ControlSettings.ControlsEnabled.

float	GetAxisRaw (string axisName)
	Similar to Input.GetAxisRaw(string) but also taking into account MFPP.Player.ControlSettings.ControlsEnabled.

float	GetCurrentAxis (string axisName)
	Returns the current axis value, based on whetever we use MFPP.Player.ControlSettings.RawInput and also taking into account MFPP.Player.ControlSettings.ControlsEnabled.

bool	GetButton (string buttonName)
	Similar to Input.GetButton(string) but also taking into account MFPP.Player.ControlSettings.ControlsEnabled.

bool	GetButtonDown (string buttonName)
	Similar to Input.GetButtonDown(string) but also taking into account MFPP.Player.ControlSettings.ControlsEnabled.

Member Function Documentation

◆ AfterUpdate()

override void MFPP.Modules.LadderModule.AfterUpdate ( )

virtual

Called right after updating the player.

Reimplemented from MFPP.PlayerModule.

override void MFPP.Modules.LadderModule.Initialize ( )

virtual

Used for initialization.

Reimplemented from MFPP.PlayerModule.

The documentation for this class was generated from the following file: