SCR_MilitarySymbol Interface Reference

Public Member Functions
EMilitarySymbolIdentity	GetIdentity ()
	Get symbol identity.
void	SetIdentity (EMilitarySymbolIdentity identity)
	Set symbol identity.
EMilitarySymbolDimension	GetDimension ()
	Get symbol dimension.
void	SetDimension (EMilitarySymbolDimension dimension)
	Set symbol dimension.
EMilitarySymbolIcon	GetIcons ()
	Get symbol icons.
void	SetIcons (EMilitarySymbolIcon icons)
	Set symbol icons.
bool	HasIcon (EMilitarySymbolIcon icon)
	Check if the symbol has given icon.
EMilitarySymbolAmplifier	GetAmplifier ()
	Get symbol amplifier.
void	SetAmplifier (EMilitarySymbolAmplifier amplifier)
	Set symbol amplifier.
void	Set (EMilitarySymbolIdentity identity, EMilitarySymbolDimension dimension, EMilitarySymbolIcon icons, EMilitarySymbolAmplifier amplifier)
	Set all symbol values.
void	CopyFrom (SCR_MilitarySymbol from)
	Copy values from another symbol.
bool	IsEqual (SCR_MilitarySymbol symbol)
	Check if this symbol is equal to another one.
void	Log (LogLevel logLevel=LogLevel.DEBUG)
	Log the symbol values to console.
void	OnRplSave (ScriptBitWriter writer)
void	OnRplLoad (ScriptBitReader reader)

Static Public Member Functions
static void	Encode (SSnapSerializerBase snapshot, ScriptCtx hint, ScriptBitSerializer packet)
static bool	Decode (ScriptBitSerializer packet, ScriptCtx hint, SSnapSerializerBase snapshot)
static bool	SnapCompare (SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx hint)
static bool	PropCompare (SCR_MilitarySymbol prop, SSnapSerializerBase snapshot, ScriptCtx hint)
static bool	Extract (SCR_MilitarySymbol prop, ScriptCtx hint, SSnapSerializerBase snapshot)
static bool	Inject (SSnapSerializerBase snapshot, ScriptCtx hint, SCR_MilitarySymbol prop)

Protected Attributes
EMilitarySymbolIdentity	m_Identity
EMilitarySymbolDimension	m_Dimension
EMilitarySymbolIcon	m_Icons
EMilitarySymbolAmplifier	m_Amplifier

Member Function Documentation

CopyFrom()

void SCR_MilitarySymbol.CopyFrom

(

SCR_MilitarySymbol

from

)

Copy values from another symbol.

Parameters

from	Source symbol

Decode()

static bool SCR_MilitarySymbol.Decode ( ScriptBitSerializer packet, ScriptCtx hint, SSnapSerializerBase snapshot )

static

Encode()

static void SCR_MilitarySymbol.Encode ( SSnapSerializerBase snapshot, ScriptCtx hint, ScriptBitSerializer packet )

static

Extract()

static bool SCR_MilitarySymbol.Extract ( SCR_MilitarySymbol prop, ScriptCtx hint, SSnapSerializerBase snapshot )

static

GetAmplifier()

EMilitarySymbolAmplifier SCR_MilitarySymbol.GetAmplifier

(

)

Get symbol amplifier.

Returns

Amplifier

GetDimension()

EMilitarySymbolDimension SCR_MilitarySymbol.GetDimension

(

)

Get symbol dimension.

Returns

Dimension

GetIcons()

EMilitarySymbolIcon SCR_MilitarySymbol.GetIcons

(

)

Get symbol icons.

Returns

Icon flags

GetIdentity()

EMilitarySymbolIdentity SCR_MilitarySymbol.GetIdentity

(

)

Get symbol identity.

Returns

Identity

HasIcon()

bool SCR_MilitarySymbol.HasIcon

(

EMilitarySymbolIcon

icon

)

Check if the symbol has given icon.

Returns

True when it has the icon

Inject()

static bool SCR_MilitarySymbol.Inject ( SSnapSerializerBase snapshot, ScriptCtx hint, SCR_MilitarySymbol prop )

static

IsEqual()

bool SCR_MilitarySymbol.IsEqual

(

SCR_MilitarySymbol

symbol

)

Check if this symbol is equal to another one.

Parameters

symbol

Compared symbol

Returns

True when values are the same

Log()

void SCR_MilitarySymbol.Log

(

LogLevel

logLevel = LogLevel::DEBUG

)

Log the symbol values to console.

Parameters

logLevel

Log level

OnRplLoad()

void SCR_MilitarySymbol.OnRplLoad

(

ScriptBitReader

reader

)

OnRplSave()

void SCR_MilitarySymbol.OnRplSave

(

ScriptBitWriter

writer

)

PropCompare()

static bool SCR_MilitarySymbol.PropCompare ( SCR_MilitarySymbol prop, SSnapSerializerBase snapshot, ScriptCtx hint )

static

Set()

void SCR_MilitarySymbol.Set	(	EMilitarySymbolIdentity	identity,
		EMilitarySymbolDimension	dimension,
		EMilitarySymbolIcon	icons,
		EMilitarySymbolAmplifier	amplifier )

Set all symbol values.

Parameters

identity	Identity
dimension	Dimension
icons	Icons
amplifier	Amplifier

SetAmplifier()

void SCR_MilitarySymbol.SetAmplifier

(

EMilitarySymbolAmplifier

amplifier

)

Set symbol amplifier.

Parameters

amplifier

Amplifier

SetDimension()

void SCR_MilitarySymbol.SetDimension

(

EMilitarySymbolDimension

dimension

)

Set symbol dimension.

Parameters

dimension

Dimension

SetIcons()

void SCR_MilitarySymbol.SetIcons

(

EMilitarySymbolIcon

icons

)

Set symbol icons.

Parameters

icons

Icons

SetIdentity()

void SCR_MilitarySymbol.SetIdentity

(

EMilitarySymbolIdentity

identity

)

Set symbol identity.

Parameters

identity

Identity

SnapCompare()

static bool SCR_MilitarySymbol.SnapCompare ( SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx hint )

static

Member Data Documentation

m_Amplifier

EMilitarySymbolAmplifier SCR_MilitarySymbol.m_Amplifier

protected

m_Dimension

EMilitarySymbolDimension SCR_MilitarySymbol.m_Dimension

protected

m_Icons

EMilitarySymbolIcon SCR_MilitarySymbol.m_Icons

protected

m_Identity

EMilitarySymbolIdentity SCR_MilitarySymbol.m_Identity

protected

---

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

• Game/GroupIdentity/SCR_MilitarySymbol.c