SCR_PlayerSupplyAllocationUI Interface Reference

Inheritance diagram for SCR_PlayerSupplyAllocationUI:

Public Member Functions
override void	HandlerAttached (Widget w)
	Calls superclass method, subscribes to events and sets player current and limit allocation.
override void	HandlerDeattached (Widget w)
	Calls superclass method and unsubscribes from events.

Protected Member Functions
void	SetPlayerCurrentAndLimitAllocation (Widget w)
void	UpdateSupplyAmountText ()
	Sets the Supplies text to current amount of available and allocated supplies.
void	OnAvailableAllocatedSuppliesChanged (int amount)
	Available Allocated Supplies amount changed, set the new value and update Supplies text.
void	OnMilitarySupplyAllocationChanged (int amount)
	Military Supply Allocation amount changed, set the new value and update Supplies text.

Protected Attributes
ResourceName	m_sSuppliesText
int	m_iAvailableSuppliesAmount
int	m_iMaxAvailableSuppliesAmount
bool	m_bVisibleTopLimit
RichTextWidget	m_wSuppliesText
string	m_sSuppliesAmount
string	m_sAvailableText
string	m_sAvailableTextLong
PlayerController	m_PlayerController = GetGame().GetPlayerController()
SCR_PlayerSupplyAllocationComponent	m_PlayerSupplyAllocationComponent

Member Function Documentation

HandlerAttached()

override void SCR_PlayerSupplyAllocationUI.HandlerAttached

(

Widget

w

)

Calls superclass method, subscribes to events and sets player current and limit allocation.

Parameters

[in]

w

Widget attached to the method, representing the root of the layout.

HandlerDeattached()

override void SCR_PlayerSupplyAllocationUI.HandlerDeattached

(

Widget

w

)

Calls superclass method and unsubscribes from events.

Parameters

[in]

w

Widget attached to the method, representing the root of the layout.

OnAvailableAllocatedSuppliesChanged()

void SCR_PlayerSupplyAllocationUI.OnAvailableAllocatedSuppliesChanged ( int amount )

protected

Available Allocated Supplies amount changed, set the new value and update Supplies text.

Parameters

[in]

amount

OnMilitarySupplyAllocationChanged()

void SCR_PlayerSupplyAllocationUI.OnMilitarySupplyAllocationChanged ( int amount )

protected

Military Supply Allocation amount changed, set the new value and update Supplies text.

Parameters

[in]

amount

SetPlayerCurrentAndLimitAllocation()

void SCR_PlayerSupplyAllocationUI.SetPlayerCurrentAndLimitAllocation ( Widget w )

protected

UpdateSupplyAmountText()

void SCR_PlayerSupplyAllocationUI.UpdateSupplyAmountText ( )

protected

Sets the Supplies text to current amount of available and allocated supplies.

Member Data Documentation

m_bVisibleTopLimit

bool SCR_PlayerSupplyAllocationUI.m_bVisibleTopLimit

protected

m_iAvailableSuppliesAmount

int SCR_PlayerSupplyAllocationUI.m_iAvailableSuppliesAmount

protected

m_iMaxAvailableSuppliesAmount

int SCR_PlayerSupplyAllocationUI.m_iMaxAvailableSuppliesAmount

protected

m_PlayerController

PlayerController SCR_PlayerSupplyAllocationUI.m_PlayerController = GetGame().GetPlayerController()

protected

m_PlayerSupplyAllocationComponent

SCR_PlayerSupplyAllocationComponent SCR_PlayerSupplyAllocationUI.m_PlayerSupplyAllocationComponent

protected

m_sAvailableText

string SCR_PlayerSupplyAllocationUI.m_sAvailableText

protected

m_sAvailableTextLong

string SCR_PlayerSupplyAllocationUI.m_sAvailableTextLong

protected

m_sSuppliesAmount

string SCR_PlayerSupplyAllocationUI.m_sSuppliesAmount

protected

m_sSuppliesText

ResourceName SCR_PlayerSupplyAllocationUI.m_sSuppliesText

protected

m_wSuppliesText

RichTextWidget SCR_PlayerSupplyAllocationUI.m_wSuppliesText

protected

---

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

• Game/UI/Menu/DeployMenu/SCR_PlayerSupplyAllocationUI.c