Loading...
Searching...
No Matches
AdventureCore.CharacterActionAreaSurrogate Class Reference

Detailed Description

placeholder that redirects to an actual component when a character with a specified id is available
can be used to bind things like UI to components of characters that will spawn during gameplay

https://adventure.softleitner.com/manual/character

Inheritance diagram for AdventureCore.CharacterActionAreaSurrogate:
AdventureCore.CharacterActionArea AdventureCore.ICharacterAssociator

Public Member Functions

override void OnStartAction (InputValue value)
 
override void OnStartAction (InputAction.CallbackContext context)
 
override void StartAction ()
 
override void BindInput (InputAction inputAction)
 
override void UnbindInput (InputAction inputAction)
 

Public Attributes

string CharacterId
 
- Public Attributes inherited from AdventureCore.CharacterActionArea
string Tag
 
CharacterActorBase CharacterActor
 
bool SortByDistance
 
bool ShowActive
 
UnityEvent Changed
 

Protected Member Functions

override void Start ()
 
override void Update ()
 
- Protected Member Functions inherited from AdventureCore.CharacterActionArea
virtual void onChanged ()
 

Properties

override CharacterActionBase Action [get]
 
override CharacterActionBindings Bindings [get]
 
override IReadOnlyCollection< CharacterActionBaseActions [get]
 
override bool HasAction [get]
 
override bool CanStart [get]
 
override string Text [get]
 
override CharacterBase AssociatedCharacter [get]
 character that owns or is otherwise associted with the object
 
- Properties inherited from AdventureCore.CharacterActionArea
virtual CharacterActionBase Action [get]
 
virtual CharacterActionBindings Bindings [get]
 
virtual IReadOnlyCollection< CharacterActionBaseActions [get]
 
virtual bool HasAction [get]
 
virtual bool CanStart [get]
 
virtual string Text [get]
 
virtual CharacterBase AssociatedCharacter [get]
 character that owns or is otherwise associted with the object
 
- Properties inherited from AdventureCore.ICharacterAssociator

Member Function Documentation

◆ BindInput()

override void AdventureCore.CharacterActionAreaSurrogate.BindInput ( InputAction inputAction)
virtual

Reimplemented from AdventureCore.CharacterActionArea.

◆ OnStartAction() [1/2]

override void AdventureCore.CharacterActionAreaSurrogate.OnStartAction ( InputAction.CallbackContext context)
virtual

Reimplemented from AdventureCore.CharacterActionArea.

◆ OnStartAction() [2/2]

override void AdventureCore.CharacterActionAreaSurrogate.OnStartAction ( InputValue value)
virtual

Reimplemented from AdventureCore.CharacterActionArea.

◆ Start()

override void AdventureCore.CharacterActionAreaSurrogate.Start ( )
inlineprotectedvirtual

Reimplemented from AdventureCore.CharacterActionArea.

◆ StartAction()

override void AdventureCore.CharacterActionAreaSurrogate.StartAction ( )
virtual

Reimplemented from AdventureCore.CharacterActionArea.

◆ UnbindInput()

override void AdventureCore.CharacterActionAreaSurrogate.UnbindInput ( InputAction inputAction)
virtual

Reimplemented from AdventureCore.CharacterActionArea.

◆ Update()

override void AdventureCore.CharacterActionAreaSurrogate.Update ( )
inlineprotectedvirtual

Reimplemented from AdventureCore.CharacterActionArea.

Property Documentation

◆ AssociatedCharacter

override CharacterBase AdventureCore.CharacterActionAreaSurrogate.AssociatedCharacter
get

character that owns or is otherwise associted with the object

Implements AdventureCore.ICharacterAssociator.