Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.UIActivationGroupInteraction Class Reference

Optional component which can be added to control ActivationGroups with action buttons. Typically used for adding next/prev behaviour to an ActionvationGroup used by UIActionBarButtons. More...

Inheritance diagram for PlatformerPro.UIActivationGroupInteraction:

Public Attributes

int actionButtonNext =-1
 Action button to use for moving to the next item in the list or -1 for no next button. More...
 
int actionButtonPrev = -1
 The action button to use for mocing to the previous item in the list or -1 for no prev button. More...
 
Character character
 Input to use, if null component will try to find one in the scene. More...
 
PlatformerProGameManager characterLoader
 The character loader. More...
 
ActivationGroup group
 Activation group to interact with. More...
 
string groupName
 The name of the activation group. More...
 

Protected Member Functions

virtual void CheckButtons ()
 Checks for presses of next or previous button. More...
 
virtual void DoDestroy ()
 Do the destroy actions (remove event listeners). More...
 
virtual void GetCharacter ()
 Gets a character ref or defers to loader event. More...
 
virtual void HandleCharacterLoaded (object sender, CharacterEventArgs e)
 Handles the character being loaded. More...
 

Detailed Description

Optional component which can be added to control ActivationGroups with action buttons. Typically used for adding next/prev behaviour to an ActionvationGroup used by UIActionBarButtons.

Member Function Documentation

◆ CheckButtons()

virtual void PlatformerPro.UIActivationGroupInteraction.CheckButtons ( )
protectedvirtual

Checks for presses of next or previous button.

◆ DoDestroy()

virtual void PlatformerPro.UIActivationGroupInteraction.DoDestroy ( )
protectedvirtual

Do the destroy actions (remove event listeners).

◆ GetCharacter()

virtual void PlatformerPro.UIActivationGroupInteraction.GetCharacter ( )
protectedvirtual

Gets a character ref or defers to loader event.

◆ HandleCharacterLoaded()

virtual void PlatformerPro.UIActivationGroupInteraction.HandleCharacterLoaded ( object  sender,
CharacterEventArgs  e 
)
protectedvirtual

Handles the character being loaded.

Parameters
senderSender.
eE.

Member Data Documentation

◆ actionButtonNext

int PlatformerPro.UIActivationGroupInteraction.actionButtonNext =-1

Action button to use for moving to the next item in the list or -1 for no next button.

◆ actionButtonPrev

int PlatformerPro.UIActivationGroupInteraction.actionButtonPrev = -1

The action button to use for mocing to the previous item in the list or -1 for no prev button.

◆ character

Character PlatformerPro.UIActivationGroupInteraction.character

Input to use, if null component will try to find one in the scene.

◆ characterLoader

PlatformerProGameManager PlatformerPro.UIActivationGroupInteraction.characterLoader

The character loader.

◆ group

ActivationGroup PlatformerPro.UIActivationGroupInteraction.group

Activation group to interact with.

◆ groupName

string PlatformerPro.UIActivationGroupInteraction.groupName

The name of the activation group.


The documentation for this class was generated from the following file: