SCR_FieldManualPiece_Image Interface Reference

Inheritance diagram for SCR_FieldManualPiece_Image:

Public Member Functions
override void	CreateWidget (notnull Widget parent)
ResourceName	GetImagePath ()
string	GetSetName ()
Color	GetImageColor ()
ResourceName	GetCaption ()
override bool	CanCreateWidget ()
	Check if the widget can be created (input method filter or anything else)
Public Member Functions inherited from SCR_FieldManualPiece
bool	CanRefresh ()
	Used to check if the entry requires a refresh (on e.g KBM/pad input change)

Public Attributes
ref Color	m_ImageColor

Protected Attributes
ResourceName	m_ImagePath
string	m_sImageSetName
string	m_sCaption
ResourceName	m_Layout
PlatformKind	m_eExcludedPlatform
Protected Attributes inherited from SCR_FieldManualPiece
SCR_EInputTypeCondition	m_eInputDisplayCondition

Static Protected Attributes
static const int	IMAGE_INDEX = 0

Member Function Documentation

CanCreateWidget()

override bool SCR_FieldManualPiece_Image.CanCreateWidget

(

)

Check if the widget can be created (input method filter or anything else)

Returns

true if the widget corresponds to the input method, false if not

Implements SCR_FieldManualPiece.

CreateWidget()

override void SCR_FieldManualPiece_Image.CreateWidget

(

notnull Widget

parent

)

Parameters

[in]

parent

Implements SCR_FieldManualPiece.

GetCaption()

ResourceName SCR_FieldManualPiece_Image.GetCaption

(

)

Returns

GetImageColor()

Color SCR_FieldManualPiece_Image.GetImageColor

(

)

Returns

GetImagePath()

ResourceName SCR_FieldManualPiece_Image.GetImagePath

(

)

Returns

GetSetName()

string SCR_FieldManualPiece_Image.GetSetName

(

)

Returns

Member Data Documentation

IMAGE_INDEX

const int SCR_FieldManualPiece_Image.IMAGE_INDEX = 0

staticprotected

m_eExcludedPlatform

PlatformKind SCR_FieldManualPiece_Image.m_eExcludedPlatform

protected

m_ImageColor

ref Color SCR_FieldManualPiece_Image.m_ImageColor

m_ImagePath

ResourceName SCR_FieldManualPiece_Image.m_ImagePath

protected

m_Layout

ResourceName SCR_FieldManualPiece_Image.m_Layout

protected

m_sCaption

string SCR_FieldManualPiece_Image.m_sCaption

protected

m_sImageSetName

string SCR_FieldManualPiece_Image.m_sImageSetName

protected

---

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

• Game/FieldManual/Models/Pieces/SCR_FieldManualPiece_Image.c