SCR_CallsignBaseComponent Interface Reference

Component of assigning and storing squad names. More...

Inheritance diagram for SCR_CallsignBaseComponent:

Public Member Functions
bool	GetCallsignNames (out string company, out string platoon, out string squad, out string character, out string format)
	Get the callsign names assigned.
bool	GetCallsignIndexes (out int companyIndex, out int platoonIndex, out int squadIndex, out int characterNumber=-1, out ERoleCallsign characterRole=ERoleCallsign.NONE)
	Get the callsign indexes assigned.
ScriptInvokerBase< SCR_CallsignBaseComponent_OnCallsignChanged >	GetOnCallsignChanged ()
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)

Protected Member Functions
void	ClearCallsigns ()
bool	SetCallsignInfo ()
void	InitOnServer (IEntity owner)

Protected Attributes
Faction	m_Faction
SCR_FactionCallsignInfo	m_CallsignInfo
int	m_iCompanyCallsign = -1
int	m_iPlatoonCallsign = -1
int	m_iSquadCallsign = -1
bool	m_bIsServer
SCR_CallsignManagerComponent	m_CallsignManager
ref ScriptInvokerBase< SCR_CallsignBaseComponent_OnCallsignChanged >	Event_OnCallsignChanged = new ScriptInvokerBase<SCR_CallsignBaseComponent_OnCallsignChanged>()

Detailed Description

Component of assigning and storing squad names.

Member Function Documentation

ClearCallsigns()

void SCR_CallsignBaseComponent.ClearCallsigns ( )

protected

Implemented in SCR_CallsignCharacterComponent.

EOnInit()

override void SCR_CallsignBaseComponent.EOnInit

(

IEntity

owner

)

GetCallsignIndexes()

bool SCR_CallsignBaseComponent.GetCallsignIndexes	(	out int	companyIndex,
		out int	platoonIndex,
		out int	squadIndex,
		out int	characterNumber = -1,
		out ERoleCallsign	characterRole = ERoleCallsign::NONE
	)

Get the callsign indexes assigned.

Parameters

[out]	companyIndex	company index. Eg: Company Alpha is index 0 and Beta is index 1
[out]	platoonIndex	platoon index. Is an index similar to how Company works.
[out]	squadIndex	squad index. Is an index similar to how Company works.
[out]	characterNumber	character callsign number. This is not an index. Soldier 1 will have character 1. The second soldier in the group will have character 2. Will return -1 if component is on a group
[out]	characterRole	Character role number, roles can be checked with ERoleCallsign eg: characterRole == ERoleCallsign.SQUAD_LEADER will let you know if the character is a squad leader etc. Will return -1 if component is on a group

Returns

returns false if indexes are not assigned

Implemented in SCR_CallsignCharacterComponent, and SCR_CallsignGroupComponent.

GetCallsignNames()

bool SCR_CallsignBaseComponent.GetCallsignNames	(	out string	company,
		out string	platoon,
		out string	squad,
		out string	character,
		out string	format
	)

Get the callsign names assigned.

Parameters

[out]	company	Company name
[out]	platoon	Platoon name
[out]	squad	Squad name
[out]	character	Character name (Optional if callsign assigned to a character). Will return Role name if any role is assigned to the character
[out]	format	Format of callsign

Returns

returns true if names are succesfully found

Implemented in SCR_CallsignCharacterComponent, and SCR_CallsignGroupComponent.

GetOnCallsignChanged()

ScriptInvokerBase< SCR_CallsignBaseComponent_OnCallsignChanged > SCR_CallsignBaseComponent.GetOnCallsignChanged

(

)

Returns

InitOnServer()

void SCR_CallsignBaseComponent.InitOnServer ( IEntity  owner )

protected

Implemented in SCR_CallsignGroupComponent.

OnPostInit()

override void SCR_CallsignBaseComponent.OnPostInit

(

IEntity

owner

)

SetCallsignInfo()

bool SCR_CallsignBaseComponent.SetCallsignInfo ( )

protected

Member Data Documentation

Event_OnCallsignChanged

ref ScriptInvokerBase<SCR_CallsignBaseComponent_OnCallsignChanged> SCR_CallsignBaseComponent.Event_OnCallsignChanged = new ScriptInvokerBase<SCR_CallsignBaseComponent_OnCallsignChanged>()

protected

m_bIsServer

bool SCR_CallsignBaseComponent.m_bIsServer

protected

m_CallsignInfo

SCR_FactionCallsignInfo SCR_CallsignBaseComponent.m_CallsignInfo

protected

m_CallsignManager

SCR_CallsignManagerComponent SCR_CallsignBaseComponent.m_CallsignManager

protected

m_Faction

Faction SCR_CallsignBaseComponent.m_Faction

protected

m_iCompanyCallsign

int SCR_CallsignBaseComponent.m_iCompanyCallsign = -1

protected

m_iPlatoonCallsign

int SCR_CallsignBaseComponent.m_iPlatoonCallsign = -1

protected

m_iSquadCallsign

int SCR_CallsignBaseComponent.m_iSquadCallsign = -1

protected

---

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

• Game/Callsign/SCR_CallsignBaseComponent.c