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

MonoBehaviour
CharacterBrain

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")]
[PlatformerHelpUrl(typeof(PlayerBrain))]
public class PlayerBrain : CharacterBrain

Remarks

Documentation: Player Brain

Attributes

Type	Description
AddComponentMenu
PlatformerHelpUrlAttribute	[Assert-Conditional] A `UnityEngine.HelpURLAttribute` which points to Platformer Game Kit's documentation.

Fields

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