SCR_EntityTooltipDetail Interface Reference

Inheritance diagram for SCR_EntityTooltipDetail:

Public Member Functions
bool	NeedUpdate ()
bool	CreateDetail (SCR_EditableEntityComponent entity, Widget parent, TextWidget label, bool setFrameslot=true)
void	UpdateDetail (SCR_EditableEntityComponent entity)
bool	InitDetail (SCR_EditableEntityComponent entity, Widget widget)
bool	GetShowLabel ()

Protected Attributes
LocalizedString	m_sDisplayName
ResourceName	m_Layout
Widget	m_Widget
bool	m_bShowLabel

Member Function Documentation

CreateDetail()

bool SCR_EntityTooltipDetail.CreateDetail	(	SCR_EditableEntityComponent	entity,
		Widget	parent,
		TextWidget	label,
		bool	setFrameslot = true
	)

Parameters

[in]	entity
[in]	parent
[in]	label
[in]	setFrameslot

Returns

Implemented in SCR_EntityConditionTooltipDetail.

GetShowLabel()

bool SCR_EntityTooltipDetail.GetShowLabel

(

)

Returns

if label should be shown

InitDetail()

bool SCR_EntityTooltipDetail.InitDetail	(	SCR_EditableEntityComponent	entity,
		Widget	widget
	)

Parameters

[in]	entity
[in]	widget

Returns

true to show the detail

Implemented in SCR_AIStateTooltipDetail, SCR_ArsenalSaveTypeTooltipDetail, SCR_BaseResourceTooltipDetail, SCR_BloodTooltipDetail, SCR_BuilderNameTooltipDetail, SCR_CommentPlacablePrefabDetail, SCR_DamageDisabledTooltipDetail, SCR_DebugTooltipDetail, SCR_DescriptionTooltipDetail, SCR_DpsConditionBarBaseTooltipDetail, SCR_EntityConditionTooltipDetail, SCR_ExplosiveChargeDetail, SCR_FactionGroupsTooltipDetail, SCR_FactionHintTooltipDetail, SCR_FactionPlayersTooltipDetail, SCR_FactionTasksAndSpawnPointsTooltipDetail, SCR_FactionTooltipDetail, SCR_FrequencyTooltipDetail, SCR_FuelTooltipDetail, SCR_MapGridTooltipDetail, SCR_GroupOwnerTooltipDetail, SCR_GroupSizeTooltipDetail, SCR_HealthTooltipDetail, SCR_LabelDescriptionTooltipDetail, SCR_MultiOccupantVehcileTooltipDetail, SCR_PassagerTooltipDetail, SCR_SuppliesBaseTooltipDetail, SCR_SupplyCapacityTooltipDetail, SCR_SupplyRefundTooltipDetail, SCR_TaskCompleteDescriptionTooltipDetail, SCR_TextAndWarningTooltipDetail, SCR_WaypointIndexTooltipDetail, and SCR_WeaponsTooltipDetail.

NeedUpdate()

bool SCR_EntityTooltipDetail.NeedUpdate

(

)

Returns

Implemented in SCR_BaseResourceTooltipDetail, SCR_BloodTooltipDetail, SCR_DpsConditionBarBaseTooltipDetail, SCR_EntityConditionTooltipDetail, SCR_ExplosiveChargeDetail, SCR_FuelTooltipDetail, SCR_GroupSizeTooltipDetail, SCR_MultiOccupantVehcileTooltipDetail, SCR_PassagerTooltipDetail, and SCR_WeaponsTooltipDetail.

UpdateDetail()

void SCR_EntityTooltipDetail.UpdateDetail

(

SCR_EditableEntityComponent

entity

)

Parameters

[in]

entity

Implemented in SCR_AIStateTooltipDetail, SCR_BaseResourceTooltipDetail, SCR_BloodTooltipDetail, SCR_CommentPlacablePrefabDetail, SCR_DebugTooltipDetail, SCR_DescriptionTooltipDetail, SCR_DpsConditionBarBaseTooltipDetail, SCR_EntityConditionTooltipDetail, SCR_ExplosiveChargeDetail, SCR_FactionGroupsTooltipDetail, SCR_FactionPlayersTooltipDetail, SCR_FactionTasksAndSpawnPointsTooltipDetail, SCR_FactionTooltipDetail, SCR_FrequencyTooltipDetail, SCR_FuelTooltipDetail, SCR_MapGridTooltipDetail, SCR_GroupOwnerTooltipDetail, SCR_GroupSizeTooltipDetail, SCR_HealthTooltipDetail, SCR_MultiOccupantVehcileTooltipDetail, SCR_PassagerTooltipDetail, SCR_ResourceAvailableTooltipDetail, SCR_ResourceStorageTooltipDetail, SCR_SuppliesBaseTooltipDetail, SCR_TaskCompleteDescriptionTooltipDetail, SCR_WaypointIndexTooltipDetail, and SCR_WeaponsTooltipDetail.

Member Data Documentation

m_bShowLabel

bool SCR_EntityTooltipDetail.m_bShowLabel

protected

m_Layout

ResourceName SCR_EntityTooltipDetail.m_Layout

protected

m_sDisplayName

LocalizedString SCR_EntityTooltipDetail.m_sDisplayName

protected

m_Widget

Widget SCR_EntityTooltipDetail.m_Widget

protected

---

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

• Game/Editor/UI/Components/Tooltips/Tooltips/Details/SCR_EntityTooltipDetail.c