PlayerBrain Class

Summary

A PlatformerGameKit.Characters.Brains.CharacterBrain which manages the states of a player to be controlled by a PlatformerGameKit.Characters.Brains.PlayerInputManager or PlayerInputSystem.
Assembly
PlatformerGameKit.dll
Namespace
PlatformerGameKit.Characters.Brains
Base Types
graph BT Type-->Base0["CharacterBrain"] click Base0 "/platformer/api/PlatformerGameKit.Characters.Brains/CharacterBrain" Base0-->Base1["MonoBehaviour"] Type["PlayerBrain"] class Type type-node

Syntax

[AddComponentMenu(MenuPrefix + "Player Brain")]
[HelpURL(APIDocumentation + nameof(PlayerBrain))]
public class PlayerBrain : CharacterBrain

Remarks

Documentation: Player Brain

Attributes

Type Description
AddComponentMenu
HelpURLAttribute

Fields

Name Constant Value Summary
APIDocumentation https://kybernetik.com.au/platformer/api/PlatformerGameKit.Characters.Brains/
The URL of the website where the PlatformerGameKit.Characters.Brains API documentation is hosted.
Inherited from CharacterBrain
static
DefaultExecutionOrder -10000
Run inputs before everything else.
Inherited from CharacterBrain
static
MenuPrefix Platformer Game Kit/Characters/Brains/
The menu prefix for UnityEngine.AddComponentMenu.
Inherited from CharacterBrain
static

Properties

Name Value Summary
Character Character
The PlatformerGameKit.Characters.Character this brain is controlling.
Inherited from CharacterBrain

Methods

Name Value Summary
Awake() void
Buffer(CharacterState) void
OnValidate() void
[Editor-Only] Ensures that all fields have valid values and finds missing components nearby.
Inherited from CharacterBrain
TryIdle() void
TryJump() void
TryPrimaryAttack() void
TrySecondaryAttack() void
Update() void