Summary
A
PlatformerGameKit.Characters.States.CharacterState that plays an idle animation.- Assembly
- PlatformerGameKit
.dll - Namespace
- PlatformerGameKit
.Characters .States - Interfaces
-
- IOwnedState
<CharacterState>
- IOwnedState
- Base Types
-
- StateBehaviour
- CharacterState
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")]
[PlatformerHelpUrl(typeof(LocomotionState))]
public class LocomotionState : CharacterState, IOwnedState<CharacterState>Remarks
Documentation:
Locomotion
Attributes
| Type | Description |
|---|---|
| AddComponentMenu | |
| Platformer |
[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
|
| CurrentAnimation | ClipTransition | |
| Fall | ClipTransition | |
| Idle | ClipTransition | |
| Movement |
float | |
| OwnerStateMachine | StateMachine |
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 |
void |
Sets the
PlatformerGameKit.Characters.States.CharacterState.Character.Inherited from CharacterState
|
| Update |
void |