LocomotionState Class

Summary

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

Syntax

[AddComponentMenu(MenuPrefix + "Locomotion State")]
[HelpURL(APIDocumentation + nameof(LocomotionState))]
public class LocomotionState : CharacterState, IOwnedState<CharacterState>

Remarks

Documentation: Locomotion

Attributes

Type Description
AddComponentMenu
HelpURLAttribute

Fields

Name Constant Value Summary
APIDocumentation https://kybernetik.com.au/platformer/api/PlatformerGameKit.Characters.States/
The URL of the website where the PlatformerGameKit.Characters.States API documentation is hosted.
Inherited from CharacterState
static
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 Examples.PlatformerCharacter that owns this state.
Inherited from CharacterState
CurrentAnimation ClipTransition
Fall ClipTransition
Idle ClipTransition
MovementSpeedMultiplier float
OwnerStateMachine StateMachine<CharacterState>
Inherited from CharacterState
Run ClipTransition
Walk ClipTransition

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
Update() void