MultiState Class

Summary

A PlatformerGameKit.Characters.States.CharacterState which redirects to other states.
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["MultiState"] class Type type-node

Syntax

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

Remarks

Documentation: Multi-State

Attributes

Type Description
AddComponentMenu
HelpURLAttribute
DefaultExecutionOrder

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
DefaultExecutionOrder -1000
Run before other states in case PlatformerGameKit.Characters.States.MultiState.FixedUpdate changes the state.
static
MenuPrefix Platformer Game Kit/Characters/States/
The menu prefix for UnityEngine.AddComponentMenu.
Inherited from CharacterState
static

Properties

Name Value Summary
AutoInternalTransitions bool
CanEnterState bool
CanExitState bool
CanTurn bool
Inherited from CharacterState
Character Character
The Examples.PlatformerCharacter that owns this state.
Inherited from CharacterState
MovementSpeedMultiplier float
Inherited from CharacterState
OwnerStateMachine StateMachine<CharacterState>
Inherited from CharacterState
States CharacterState[]

Methods

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