Summary
A
PlatformerGameKit.Characters.States.CharacterState
that plays a UnityEngine.Playables.PlayableAsset
(such as a
UnityEngine.Timeline.TimelineAsset
)
then returns to idle.
- 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["IntroductionState"]
class Type type-node
Syntax
[AddComponentMenu(MenuPrefix + "Introduction State")]
[HelpURL(APIDocumentation + nameof(IntroductionState))]
public sealed class IntroductionState : CharacterState, IOwnedState<CharacterState>
Remarks
Documentation: Introduction
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 |
---|---|---|
CanExitState | bool | |
CanTurn | bool |
Inherited from CharacterState
|
Character | Character |
The
Examples.PlatformerCharacter that owns this state.Inherited from CharacterState
|
Movement |
float |
Inherited from CharacterState
|
OwnerStateMachine | StateMachine |
Inherited from CharacterState
|
Methods
Name | Value | Summary |
---|---|---|
OnEnterState |
void | |
OnExitState |
void | |
OnValidate |
void |
[Editor-Only] Ensures that all fields have valid values and finds missing components nearby.
Inherited from CharacterState
|
SetCharacter |
void |
Sets the
PlatformerGameKit.Characters.States.CharacterState.Character .Inherited from CharacterState
|