SCR_AttributeTickboxUIComponent Interface Reference

Using a controller will show/hide the Select button hint if the attribute with this script is focused on. More...

Inheritance diagram for SCR_AttributeTickboxUIComponent:

Public Member Functions
void	ToggleTickbox (bool toggled)
	Set if tickbox is toggled or not.
void	ToggleEnableByAttribute (bool enabled)
	If subAttribute toggles the tickbox if the 'parent' attribute disabled the attribute.
bool	GetToggled ()
	Get if tickbox is toggled or not.
bool	IsVisibleAndEnabled ()
	Get if tickbox is visible and enabled.
ScriptInvokerBool	GetOnToggleChanged ()
bool	GetEnabled ()
	Get if tickbox is enabled or not.
void	InitTickbox (bool toggleState, SCR_BaseEditorAttributeUIComponent attributeUI, TypeName linkedOverrideAttributeType=TypeName.Empty)
	On init as overriding attributes (multiple entities with the same attribute) and one or more of the values are conflicting with each other This will enable the tickbox and allow the value to be overridden for all.
void	InitDisabled ()
	On init as overriding attributes (multiple entities with the same attribute) but non of them are conflicting dus show the tickbox but disable it.
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	OnButtonToggle ()
void	SetVisible (bool frameVisible, bool buttonVisible)
	Set tickbox's visibility.
void	SetEnabled (bool enabled)
void	OnAttributeEnabledByAttribute (bool enabled)

Protected Attributes
string	m_sTickBoxImageName
string	m_sTickBoxButtonName
ResourceName	m_sTickBoxImageToggled
ResourceName	m_sTickBoxImageUntoggled
SCR_BaseEditorAttributeUIComponent	m_AttributeUI
TypeName	m_LinkedOverrideAttributeType = TypeName.Empty
Widget	m_Root
ImageWidget	m_TickBoxImage
Widget	m_TickBoxButton
float	m_fDisabledAlphaColor = 0.25
bool	m_bToggled
bool	m_bEnabled = true
ref ScriptInvokerBool	m_OnToggleChanged

Detailed Description

Using a controller will show/hide the Select button hint if the attribute with this script is focused on.

Member Function Documentation

GetEnabled()

bool SCR_AttributeTickboxUIComponent.GetEnabled

(

)

Get if tickbox is enabled or not.

Returns

Tickbox is enabled true or false

GetOnToggleChanged()

ScriptInvokerBool SCR_AttributeTickboxUIComponent.GetOnToggleChanged

(

)

GetToggled()

bool SCR_AttributeTickboxUIComponent.GetToggled

(

)

Get if tickbox is toggled or not.

Returns

m_bToggled, If toggled editing the attribute is enabled (unless the attribute itself is disabled)

HandlerAttached()

override void SCR_AttributeTickboxUIComponent.HandlerAttached

(

Widget

w

)

HandlerDeattached()

override void SCR_AttributeTickboxUIComponent.HandlerDeattached

(

Widget

w

)

InitDisabled()

void SCR_AttributeTickboxUIComponent.InitDisabled

(

)

On init as overriding attributes (multiple entities with the same attribute) but non of them are conflicting dus show the tickbox but disable it.

InitTickbox()

void SCR_AttributeTickboxUIComponent.InitTickbox	(	bool	toggleState,
		SCR_BaseEditorAttributeUIComponent	attributeUI,
		TypeName	linkedOverrideAttributeType = TypeName::Empty )

On init as overriding attributes (multiple entities with the same attribute) and one or more of the values are conflicting with each other This will enable the tickbox and allow the value to be overridden for all.

Parameters

toggleState
attributeUI
linkedOverrideAttributeType

IsVisibleAndEnabled()

bool SCR_AttributeTickboxUIComponent.IsVisibleAndEnabled

(

)

Get if tickbox is visible and enabled.

Returns

false if the tickbox is either disabled or invisible, true otherwise

OnAttributeEnabledByAttribute()

void SCR_AttributeTickboxUIComponent.OnAttributeEnabledByAttribute ( bool enabled )

protected

OnButtonToggle()

void SCR_AttributeTickboxUIComponent.OnButtonToggle ( )

protected

SetEnabled()

void SCR_AttributeTickboxUIComponent.SetEnabled ( bool enabled )

protected

SetVisible()

void SCR_AttributeTickboxUIComponent.SetVisible ( bool frameVisible, bool buttonVisible )

protected

Set tickbox's visibility.

Parameters

frameVisible
buttonVisible

ToggleEnableByAttribute()

void SCR_AttributeTickboxUIComponent.ToggleEnableByAttribute

(

bool

enabled

)

If subAttribute toggles the tickbox if the 'parent' attribute disabled the attribute.

Parameters

enabled,If

true sets itself as enabled. Else disables it

ToggleTickbox()

void SCR_AttributeTickboxUIComponent.ToggleTickbox

(

bool

toggled

)

Set if tickbox is toggled or not.

Parameters

toggled

If toggled editing the attribute is enabled (unless the attribute itself is disabled)

Member Data Documentation

m_AttributeUI

SCR_BaseEditorAttributeUIComponent SCR_AttributeTickboxUIComponent.m_AttributeUI

protected

m_bEnabled

bool SCR_AttributeTickboxUIComponent.m_bEnabled = true

protected

m_bToggled

bool SCR_AttributeTickboxUIComponent.m_bToggled

protected

m_fDisabledAlphaColor

float SCR_AttributeTickboxUIComponent.m_fDisabledAlphaColor = 0.25

protected

m_LinkedOverrideAttributeType

TypeName SCR_AttributeTickboxUIComponent.m_LinkedOverrideAttributeType = TypeName.Empty

protected

m_OnToggleChanged

ref ScriptInvokerBool SCR_AttributeTickboxUIComponent.m_OnToggleChanged

protected

m_Root

Widget SCR_AttributeTickboxUIComponent.m_Root

protected

m_sTickBoxButtonName

string SCR_AttributeTickboxUIComponent.m_sTickBoxButtonName

protected

m_sTickBoxImageName

string SCR_AttributeTickboxUIComponent.m_sTickBoxImageName

protected

m_sTickBoxImageToggled

ResourceName SCR_AttributeTickboxUIComponent.m_sTickBoxImageToggled

protected

m_sTickBoxImageUntoggled

ResourceName SCR_AttributeTickboxUIComponent.m_sTickBoxImageUntoggled

protected

m_TickBoxButton

Widget SCR_AttributeTickboxUIComponent.m_TickBoxButton

protected

m_TickBoxImage

ImageWidget SCR_AttributeTickboxUIComponent.m_TickBoxImage

protected

---

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

• Game/Editor/UI/Components/Attributes/SCR_AttributeTickboxUIComponent.c