PlatformerPro.UIActionBarButton_Activation Class Reference

A button on an action bar that activates/deactivates. More...

Inheritance diagram for PlatformerPro.UIActionBarButton_Activation:

Protected Member Functions
override void	DoDestroy ()
	Do the destroy actions (remove event listeners). More...
override void	GetCharacter ()
	Gets a character ref or defers to loader event. Here we wait an extra frame to give group time to load. More...
IEnumerator	GetCharacterAfterWait ()
	Waits a frame then gets character reference. More...
override void	HandleCharacterLoaded (object sender, CharacterEventArgs e)
	Handles the character being loaded. More...
override void	DoPointerClick ()
	Handles the click event. More...
Protected Member Functions inherited from PlatformerPro.UIActionBarButton
virtual void	OnActivated ()
	Raises the activated event. More...
virtual void	Init ()
	Init this instance. More...
virtual void	GetItemManager ()
	Get item manager reference and register listerns. More...
virtual void	UpdateItemCount ()
virtual void	HandleItemChanged (object sender, ItemEventArgs e)

Protected Attributes
ActivationGroup	group
	The activation group. More...
string	groupName
	The name of the activation group. More...
string	activationItemId
	The activation item id. More...
Protected Attributes inherited from PlatformerPro.UIActionBarButton
GameObject	disabledContent
	Content to show when this object is disabled. More...
GameObject	enabledContent
	Content to show when this object is enabled. More...
GameObject	activeContent
	Content to show when this object is active. More...
Text	itemCountText
	text for item count if this button is connected to an item. More...
Character	character
	Character reference, looked up using CharacterLoader (falling back to Find) if null. More...
PlatformerProGameManager	characterLoader
	The character loader. More...
bool	allowDeactivate
int	actionButton
bool	displayOnly
bool	canClickWhenPaused
ItemManager	itemManager
	Cached item manager reference More...
string	itemId
	Cached item ID More...
bool	isActive
	Track if we are active or not. More...

Properties
override Character	Character [get]
	Gets the character reference. More...
Properties inherited from PlatformerPro.UIActionBarButton
virtual Character	Character [get]
	Gets the character reference. More...

Additional Inherited Members
Public Member Functions inherited from PlatformerPro.UIActionBarButton
virtual void	Disable ()
	Call to disable intance. More...
virtual void	Enable ()
	call to enable instance. More...
virtual void	Activate ()
	Call to activate instance. More...
virtual void	Deactivate ()
	Call to activate instance. More...
virtual void	OnPointerClick (PointerEventData eventData)
virtual void	OnPointerDown (PointerEventData eventData)
Events inherited from PlatformerPro.UIActionBarButton
System.EventHandler< System.EventArgs >	Activated
	Occurs when button pressed/clicked and state is ready for activation. More...

Detailed Description

A button on an action bar that activates/deactivates.

Member Function Documentation

DoDestroy()

override void PlatformerPro.UIActionBarButton_Activation.DoDestroy ( )

protectedvirtual

Do the destroy actions (remove event listeners).

Reimplemented from PlatformerPro.UIActionBarButton.

DoPointerClick()

override void PlatformerPro.UIActionBarButton_Activation.DoPointerClick ( )

protectedvirtual

Handles the click event.

Reimplemented from PlatformerPro.UIActionBarButton.

GetCharacter()

override void PlatformerPro.UIActionBarButton_Activation.GetCharacter ( )

protectedvirtual

Gets a character ref or defers to loader event. Here we wait an extra frame to give group time to load.

Reimplemented from PlatformerPro.UIActionBarButton.

GetCharacterAfterWait()

IEnumerator PlatformerPro.UIActionBarButton_Activation.GetCharacterAfterWait ( )

protected

Waits a frame then gets character reference.

Returns

The character after wait.

HandleCharacterLoaded()

override void PlatformerPro.UIActionBarButton_Activation.HandleCharacterLoaded ( object  sender, CharacterEventArgs  e  )

protectedvirtual

Handles the character being loaded.

Parameters

sender	Sender.
e	E.

Reimplemented from PlatformerPro.UIActionBarButton.

Member Data Documentation

activationItemId

string PlatformerPro.UIActionBarButton_Activation.activationItemId

protected

The activation item id.

group

ActivationGroup PlatformerPro.UIActionBarButton_Activation.group

protected

The activation group.

groupName

string PlatformerPro.UIActionBarButton_Activation.groupName

protected

The name of the activation group.

Property Documentation

Character

override Character PlatformerPro.UIActionBarButton_Activation.Character

get

Gets the character reference.

The character.

---

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

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/UI/InGameUI/Legacy/UIActionBarButton_Activation.cs