IdleState Class

Summary

A PlatformerGameKit.Characters.States.CharacterState that plays an idle animation.
Assembly
PlatformerGameKit.dll
Namespace
PlatformerGameKit.Characters.States
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["CharacterState"] click Base0 "/platformer/api/PlatformerGameKit.Characters.States/CharacterState" Base0-->Base1["StateBehaviour"] Type-.->Interface0["IOwnedState<CharacterState>"] Type["IdleState"] class Type type-node Derived0["MobileIdleState"]-->Type click Derived0 "/platformer/api/PlatformerGameKit.Characters.States/MobileIdleState"

Syntax

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

Remarks

Documentation: 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
Inherited from CharacterState
OwnerStateMachine StateMachine<CharacterState>
Inherited from CharacterState

Methods

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