AttackState Class

Summary

A PlatformerGameKit.Characters.States.CharacterState that plays an attack animation then returns to idle.
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["AttackState"] class Type type-node Derived0["AdvancedAttackState"]-->Type click Derived0 "/platformer/api/PlatformerGameKit.Characters.States/AdvancedAttackState" Derived1["SideAttackState"]-->Type click Derived1 "/platformer/api/PlatformerGameKit.Characters.States/SideAttackState" Derived2["BasicActionState"]-->Type click Derived2 "/platformer/api/PlatformerGameKit.Characters.States/BasicActionState"

Syntax

[HelpURL(APIDocumentation + nameof(AttackState))]
public abstract class AttackState : CharacterState, IOwnedState<CharacterState>

Remarks

Documentation: Attack

Attributes

Type Description
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
Character Character
The Examples.PlatformerCharacter that owns this state.
Inherited from CharacterState
MovementSpeedMultiplier float
Inherited from CharacterState
OwnerStateMachine StateMachine<CharacterState>
Inherited from CharacterState

Methods

Name Value Summary
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