SCR_BaseEditorAttributeUIComponent Interface Reference

Inheritance diagram for SCR_BaseEditorAttributeUIComponent:

Public Member Functions
SCR_BaseEditorAttribute	GetAttribute ()
	Get attribute this component represents.
void	SetFromVar (SCR_BaseEditorAttributeVar var)
	Update GUI from attribute variable.
void	Init (Widget w, SCR_BaseEditorAttribute attribute)
	Initialize GUI from attribute.
override bool	OnChange (Widget w, bool finished)
bool	OnChangeInternal (Widget w, int x, int y, bool finished)
void	ShowButtonDescription (SCR_AttributeButtonUIComponent button, bool showButtonDescription, string buttonDescription=string.Empty)
ScriptInvoker	GetOnAttributeChanged ()
	Called on attribute changed via UI.
ScriptInvoker	GetOnAttributeUIFocusChanged ()
	Called on focus changes.
ScriptInvoker	GetOnEnabledByAttribute ()
	Called when another attribute enables/disables the attribute.
ScriptInvoker	GetOnMouseLeave ()
	Called when the mouse leaves the attribute.
bool	GetTickboxEnabled ()
	Get if tickbox is enabled or not.
void	ToggleEnableAttributeTickbox ()
	Toggle tickbox UI, flipping the tickbox from true to false and viceversa.
bool	GetIsFocused ()
	Get if attribute is focused /return if attribute is focused.
override bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override void	HandlerDeattached (Widget w)

Protected Member Functions
void	SetFromVarExternal (SCR_BaseEditorAttributeVar var, bool isReset)
void	SetFromVarOrDefault ()
void	ToggleButtonSelected (bool selected, int index, bool animated=true)
void	SetAsSubAttribute ()
void	AttributeValueChanged ()
void	ShowAttributeDescription ()
void	HideAttributeDescription ()
void	SetVariableToDefaultValue (SCR_BaseEditorAttributeVar var)
void	ToggleEnableAttribute (bool enabled)
void	ToggleEnable (bool enabled)
	Toggle UI enabled.
void	OnTickboxToggleChanged (bool toggle)
void	GamePadLockedSelectorFocusChanged (bool newFocus)
void	OnFocusAttributeWidget (Widget w)
	Callback for focus of widget used.
void	SetGamepadLockSelectorActive (bool isGamepad)

Protected Attributes
string	m_sUiComponentName
string	m_sTickBoxAttributeName
string	m_sAttributeHolder
string	m_sGamePadLockedSelectorName
string	m_sSubAttributeIndicatorName
float	m_fSubAttributeDisabledAlphaColor
ref SCR_EditorAttributeUIInfo	m_ButtonDescriptionUIInfo = new SCR_EditorAttributeUIInfo
SCR_AttributeButtonUIComponent	m_ActiveButtonDescription
SCR_ChangeableComponentBase	m_UIComponent
float	m_fBottomPadding = 1
bool	m_bIsSubAttribute
SCR_AttributeTickboxUIComponent	m_TickBoxAttribute
Widget	m_GamePadLockedSelector
SCR_AttributesManagerEditorComponent	m_AttributeManager
InputManager	m_InputManager
Widget	m_SubAttributeIndicator
Widget	m_wAttributeHolder
bool	m_bEnabledByAttribute
bool	m_bEnabledByTickbox
bool	m_bIsFocused
bool	m_bIsShowingDescription
bool	m_bShowButtonDescription
string	m_sButtonDescription
string	m_sButtonDescriptionParam1
ref ScriptInvoker	Event_OnAttributeChanged = new ScriptInvoker
ref ScriptInvoker	Event_OnEnabledByAttribute = new ScriptInvoker
ref ScriptInvoker	Event_OnAttributeUIFocusChanged = new ScriptInvoker
ref ScriptInvoker	Event_OnInputDeviceChanged = new ScriptInvoker
ref ScriptInvoker	Event_OnMouseLeave = new ScriptInvoker

Member Function Documentation

AttributeValueChanged()

void SCR_BaseEditorAttributeUIComponent.AttributeValueChanged ( )

protected

GamePadLockedSelectorFocusChanged()

void SCR_BaseEditorAttributeUIComponent.GamePadLockedSelectorFocusChanged ( bool newFocus )

protected

GetAttribute()

SCR_BaseEditorAttribute SCR_BaseEditorAttributeUIComponent.GetAttribute

(

)

Get attribute this component represents.

Returns

Editor attribute

GetIsFocused()

bool SCR_BaseEditorAttributeUIComponent.GetIsFocused

(

)

Get if attribute is focused /return if attribute is focused.

GetOnAttributeChanged()

ScriptInvoker SCR_BaseEditorAttributeUIComponent.GetOnAttributeChanged

(

)

Called on attribute changed via UI.

Returns

Event_OnAttributeChanged ScriptInvoker

GetOnAttributeUIFocusChanged()

ScriptInvoker SCR_BaseEditorAttributeUIComponent.GetOnAttributeUIFocusChanged

(

)

Called on focus changes.

For gamepad to know if the attribute is being focused on

Returns

Event_OnAttributeUIFocusChanged ScriptInvoker

GetOnEnabledByAttribute()

ScriptInvoker SCR_BaseEditorAttributeUIComponent.GetOnEnabledByAttribute

(

)

Called when another attribute enables/disables the attribute.

Returns

Event_OnEnabledByAttribute ScriptInvoker when on enabled by attribute happens

GetOnMouseLeave()

ScriptInvoker SCR_BaseEditorAttributeUIComponent.GetOnMouseLeave

(

)

Called when the mouse leaves the attribute.

Returns

Event_OnMouseLeave ScriptInvoker on mouse leave

GetTickboxEnabled()

bool SCR_BaseEditorAttributeUIComponent.GetTickboxEnabled

(

)

Get if tickbox is enabled or not.

Returns

Tickbox is enabled true or false

HandlerDeattached()

override void SCR_BaseEditorAttributeUIComponent.HandlerDeattached

(

Widget

w

)

Implemented in SCR_ButtonBoxAttributeUIComponent, SCR_CheckboxEditorAttributeUIComponent, SCR_DateAttributeUIComponent, SCR_DropdownEditorAttributeUIComponent, SCR_PositionEditorAttributeUIComponent, and SCR_SpinboxEditorAttributeUIComponent.

HideAttributeDescription()

void SCR_BaseEditorAttributeUIComponent.HideAttributeDescription ( )

protected

Init()

void SCR_BaseEditorAttributeUIComponent.Init	(	Widget	w,
		SCR_BaseEditorAttribute	attribute )

Initialize GUI from attribute.

To be overridden by inherited classes.

Parameters

w	Widget this component is attached to
attribute	Editor attribute this component represents

Implemented in SCR_ButtonBoxAttributeUIComponent, SCR_ButtonBoxMultiSelectAttributeUIComponent, SCR_CheckboxEditorAttributeUIComponent, SCR_DateAttributeUIComponent, SCR_DropdownEditorAttributeUIComponent, SCR_GameOverTypeAttributeUIComponent, SCR_PositionEditorAttributeUIComponent, SCR_SliderBloodAttributeComponent, SCR_SliderEditorAttributeUIComponent, and SCR_SpinboxEditorAttributeUIComponent.

OnChange()

override bool SCR_BaseEditorAttributeUIComponent.OnChange	(	Widget	w,
		bool	finished )

OnChangeInternal()

bool SCR_BaseEditorAttributeUIComponent.OnChangeInternal	(	Widget	w,
		int	x,
		int	y,
		bool	finished )

Implemented in SCR_ButtonBoxAttributeUIComponent, SCR_ButtonBoxMultiSelectAttributeUIComponent, SCR_CheckboxEditorAttributeUIComponent, SCR_DateAttributeUIComponent, SCR_DropdownEditorAttributeUIComponent, SCR_PositionEditorAttributeUIComponent, SCR_SliderBloodAttributeComponent, SCR_SliderEditorAttributeUIComponent, SCR_SpinboxEditorAttributeUIComponent, and SCR_TimePresetsAttributeUIComponent.

OnFocus()

override bool SCR_BaseEditorAttributeUIComponent.OnFocus	(	Widget	w,
		int	x,
		int	y )

OnFocusAttributeWidget()

void SCR_BaseEditorAttributeUIComponent.OnFocusAttributeWidget ( Widget w )

protected

Callback for focus of widget used.

OnFocusLost()

override bool SCR_BaseEditorAttributeUIComponent.OnFocusLost	(	Widget	w,
		int	x,
		int	y )

OnMouseEnter()

override bool SCR_BaseEditorAttributeUIComponent.OnMouseEnter	(	Widget	w,
		int	x,
		int	y )

Implemented in SCR_DateAttributeUIComponent.

OnMouseLeave()

override bool SCR_BaseEditorAttributeUIComponent.OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y )

OnTickboxToggleChanged()

void SCR_BaseEditorAttributeUIComponent.OnTickboxToggleChanged ( bool toggle )

protected

SetAsSubAttribute()

void SCR_BaseEditorAttributeUIComponent.SetAsSubAttribute ( )

protected

SetFromVar()

void SCR_BaseEditorAttributeUIComponent.SetFromVar

(

SCR_BaseEditorAttributeVar

var

)

Update GUI from attribute variable.

Called when attributes are initialized in a dialog or when they are reset based on user request.

Parameters

var	Attribute variable

Implemented in SCR_ButtonBoxAttributeUIComponent, SCR_ButtonBoxMultiSelectAttributeUIComponent, SCR_CheckboxEditorAttributeUIComponent, SCR_DateAttributeUIComponent, SCR_DropdownEditorAttributeUIComponent, SCR_PositionEditorAttributeUIComponent, SCR_SliderBloodAttributeComponent, SCR_SliderEditorAttributeUIComponent, SCR_SpinboxEditorAttributeUIComponent, and SCR_TimePresetsAttributeUIComponent.

SetFromVarExternal()

void SCR_BaseEditorAttributeUIComponent.SetFromVarExternal ( SCR_BaseEditorAttributeVar var, bool isReset )

protected

SetFromVarOrDefault()

void SCR_BaseEditorAttributeUIComponent.SetFromVarOrDefault ( )

protected

SetGamepadLockSelectorActive()

void SCR_BaseEditorAttributeUIComponent.SetGamepadLockSelectorActive ( bool isGamepad )

protected

SetVariableToDefaultValue()

void SCR_BaseEditorAttributeUIComponent.SetVariableToDefaultValue ( SCR_BaseEditorAttributeVar var )

protected

Implemented in SCR_ButtonBoxAttributeUIComponent, SCR_CheckboxEditorAttributeUIComponent, SCR_DropdownEditorAttributeUIComponent, SCR_PositionEditorAttributeUIComponent, SCR_SliderBloodAttributeComponent, SCR_SliderEditorAttributeUIComponent, and SCR_SpinboxEditorAttributeUIComponent.

ShowAttributeDescription()

void SCR_BaseEditorAttributeUIComponent.ShowAttributeDescription ( )

protected

ShowButtonDescription()

void SCR_BaseEditorAttributeUIComponent.ShowButtonDescription	(	SCR_AttributeButtonUIComponent	button,
		bool	showButtonDescription,
		string	buttonDescription = string::Empty )

ToggleButtonSelected()

void SCR_BaseEditorAttributeUIComponent.ToggleButtonSelected ( bool selected, int index, bool animated = true )

protected

Implemented in SCR_ButtonBoxAttributeUIComponent.

ToggleEnable()

void SCR_BaseEditorAttributeUIComponent.ToggleEnable ( bool enabled )

protected

Toggle UI enabled.

Disabled will delete the var if is conflicting var /param bool enable true or false

ToggleEnableAttribute()

void SCR_BaseEditorAttributeUIComponent.ToggleEnableAttribute ( bool enabled )

protected

Implemented in SCR_OverrideModesEditorAttributeUIComponent.

ToggleEnableAttributeTickbox()

void SCR_BaseEditorAttributeUIComponent.ToggleEnableAttributeTickbox

(

)

Toggle tickbox UI, flipping the tickbox from true to false and viceversa.

Member Data Documentation

Event_OnAttributeChanged

ref ScriptInvoker SCR_BaseEditorAttributeUIComponent.Event_OnAttributeChanged = new ScriptInvoker

protected

Event_OnAttributeUIFocusChanged

ref ScriptInvoker SCR_BaseEditorAttributeUIComponent.Event_OnAttributeUIFocusChanged = new ScriptInvoker

protected

Event_OnEnabledByAttribute

ref ScriptInvoker SCR_BaseEditorAttributeUIComponent.Event_OnEnabledByAttribute = new ScriptInvoker

protected

Event_OnInputDeviceChanged

ref ScriptInvoker SCR_BaseEditorAttributeUIComponent.Event_OnInputDeviceChanged = new ScriptInvoker

protected

Event_OnMouseLeave

ref ScriptInvoker SCR_BaseEditorAttributeUIComponent.Event_OnMouseLeave = new ScriptInvoker

protected

m_ActiveButtonDescription

SCR_AttributeButtonUIComponent SCR_BaseEditorAttributeUIComponent.m_ActiveButtonDescription

protected

m_AttributeManager

SCR_AttributesManagerEditorComponent SCR_BaseEditorAttributeUIComponent.m_AttributeManager

protected

m_bEnabledByAttribute

bool SCR_BaseEditorAttributeUIComponent.m_bEnabledByAttribute

protected

m_bEnabledByTickbox

bool SCR_BaseEditorAttributeUIComponent.m_bEnabledByTickbox

protected

m_bIsFocused

bool SCR_BaseEditorAttributeUIComponent.m_bIsFocused

protected

m_bIsShowingDescription

bool SCR_BaseEditorAttributeUIComponent.m_bIsShowingDescription

protected

m_bIsSubAttribute

bool SCR_BaseEditorAttributeUIComponent.m_bIsSubAttribute

protected

m_bShowButtonDescription

bool SCR_BaseEditorAttributeUIComponent.m_bShowButtonDescription

protected

m_ButtonDescriptionUIInfo

ref SCR_EditorAttributeUIInfo SCR_BaseEditorAttributeUIComponent.m_ButtonDescriptionUIInfo = new SCR_EditorAttributeUIInfo

protected

m_fBottomPadding

float SCR_BaseEditorAttributeUIComponent.m_fBottomPadding = 1

protected

m_fSubAttributeDisabledAlphaColor

float SCR_BaseEditorAttributeUIComponent.m_fSubAttributeDisabledAlphaColor

protected

m_GamePadLockedSelector

Widget SCR_BaseEditorAttributeUIComponent.m_GamePadLockedSelector

protected

m_InputManager

InputManager SCR_BaseEditorAttributeUIComponent.m_InputManager

protected

m_sAttributeHolder

string SCR_BaseEditorAttributeUIComponent.m_sAttributeHolder

protected

m_sButtonDescription

string SCR_BaseEditorAttributeUIComponent.m_sButtonDescription

protected

m_sButtonDescriptionParam1

string SCR_BaseEditorAttributeUIComponent.m_sButtonDescriptionParam1

protected

m_sGamePadLockedSelectorName

string SCR_BaseEditorAttributeUIComponent.m_sGamePadLockedSelectorName

protected

m_sSubAttributeIndicatorName

string SCR_BaseEditorAttributeUIComponent.m_sSubAttributeIndicatorName

protected

m_sTickBoxAttributeName

string SCR_BaseEditorAttributeUIComponent.m_sTickBoxAttributeName

protected

m_SubAttributeIndicator

Widget SCR_BaseEditorAttributeUIComponent.m_SubAttributeIndicator

protected

m_sUiComponentName

string SCR_BaseEditorAttributeUIComponent.m_sUiComponentName

protected

m_TickBoxAttribute

SCR_AttributeTickboxUIComponent SCR_BaseEditorAttributeUIComponent.m_TickBoxAttribute

protected

m_UIComponent

SCR_ChangeableComponentBase SCR_BaseEditorAttributeUIComponent.m_UIComponent

protected

m_wAttributeHolder

Widget SCR_BaseEditorAttributeUIComponent.m_wAttributeHolder

protected

---

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

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