MobileIdleState Class

Summary

An PlatformerGameKit.Characters.States.IdleState that can move.
Assembly
PlatformerGameKit.dll
Namespace
PlatformerGameKit.Characters.States
Interfaces
Base Types
graph BT Type-->Base0["IdleState"] click Base0 "/platformer/api/PlatformerGameKit.Characters.States/IdleState" Base0-->Base1["CharacterState"] click Base1 "/platformer/api/PlatformerGameKit.Characters.States/CharacterState" Base1-->Base2["StateBehaviour"] Type-.->Interface0["IOwnedState<CharacterState>"] Type["MobileIdleState"] class Type type-node

Syntax

[AddComponentMenu(MenuPrefix + "Mobile Idle State")]
[PlatformerHelpUrl(typeof(MobileIdleState))]
public class MobileIdleState : IdleState, IOwnedState<CharacterState>

Remarks

Documentation: Mobile Idle

Attributes

Type Description
AddComponentMenu
PlatformerHelpUrlAttribute [Assert-Conditional] A UnityEngine.HelpURLAttribute which points to Platformer Game Kit's documentation.

Fields

Name Constant Value Summary
MenuPrefix Platformer Game Kit/Characters/States/
The menu prefix for UnityEngine.AddComponentMenu.
Inherited from CharacterState
static

Properties

Name Value Summary
CanTurn bool
Inherited from CharacterState
Character Character
The Samples.PlatformerCharacter that owns this state.
Inherited from CharacterState
MovementSpeedMultiplier float
OwnerStateMachine StateMachine<CharacterState>
Inherited from CharacterState

Methods

Name Value Summary
OnEnterState() void
Inherited from IdleState
OnValidate() void
[Editor-Only] Ensures that all fields have valid values and finds missing components nearby.
Inherited from IdleState
SetCharacter(Character) void
Sets the PlatformerGameKit.Characters.States.CharacterState.Character.
Inherited from CharacterState