CharacterAnimancerComponent Class

Summary

An Animancer.AnimancerComponent which also manages a UnityEngine.SpriteRenderer and hit boxes.
Assembly
PlatformerGameKit.dll
Namespace
PlatformerGameKit.Characters
Base Types
  • AnimancerComponent
graph BT Type-->Base0["AnimancerComponent"] Type["CharacterAnimancerComponent"] class Type type-node

Syntax

[AddComponentMenu(Character.MenuPrefix + "Character Animancer Component")]
public class CharacterAnimancerComponent : AnimancerComponent

Remarks

Documentation: Animancer Component

Attributes

Type Description
AddComponentMenu

Properties

Name Value Summary
Character Character
Facing Vector2
The direction the PlatformerGameKit.Characters.CharacterAnimancerComponent.Renderer is facing.
FacingLeft bool
Is the PlatformerGameKit.Characters.CharacterAnimancerComponent.Renderer facing to the left?
FacingX float
The horizontal direction the PlatformerGameKit.Characters.CharacterAnimancerComponent.Renderer is facing.
Renderer SpriteRenderer

Methods

Name Value Summary
AddHitBox(HitData) void
Activates a PlatformerGameKit.HitTrigger for the `data`.
ClearHitBoxes() void
Clears all currently active PlatformerGameKit.HitTriggers.
EndHitSequence() void
Clears all currently active PlatformerGameKit.HitTriggers and the list of objects hit by the current attack.
Get(AnimancerGraph) CharacterAnimancerComponent
Returns the PlatformerGameKit.Characters.CharacterAnimancerComponent associated with the `animancer`.
static
Get(AnimancerNode) CharacterAnimancerComponent
Returns the PlatformerGameKit.Characters.CharacterAnimancerComponent associated with the `node`.
static
GetCurrent() CharacterAnimancerComponent
Returns the PlatformerGameKit.Characters.CharacterAnimancerComponent associated with the Animancer.AnimancerEvent.Current state.
static
OnDisable() void
Calls PlatformerGameKit.Characters.CharacterAnimancerComponent.EndHitSequence.
OnValidate() void
[Editor-Only] Ensures that all fields have valid values and finds missing components nearby.
RemoveHitBox(HitData) void
Deactivates a PlatformerGameKit.HitTrigger for the `data`.
Update() void
Updates the PlatformerGameKit.Characters.CharacterAnimancerComponent.Facing if the current state PlatformerGameKit.Characters.States.CharacterState.CanTurn.