SCR_EstablishBaseMapCommandCursor Interface Reference

Inheritance diagram for SCR_EstablishBaseMapCommandCursor:

Public Member Functions
int	GetPlayerId ()
void	SetData (notnull Faction commanderFaction, int playerId, IEntity hoveredEntity)
void	SCR_EstablishBaseMapCommandCursor ()
Public Member Functions inherited from SCR_MapCommandCursor
ScriptInvokerVector	GetOnCommandExecuted ()
ScriptInvokerVector	GetOnCommandNotExecuted ()
void	ShowCursor (vector startCursorPosition)
void	DisableSelection (bool toggleOffCursors=true)
void	SCR_MapCommandCursor ()
void	~SCR_MapCommandCursor ()

Protected Member Functions
override bool	CanExecuteCommand (vector position)
override void	OnCommandNotExecuted (vector position)
Protected Member Functions inherited from SCR_MapCommandCursor
void	OnCommandExecuted (vector position)
void	OnSelection (vector coords)
void	UpdateCursor ()
void	OnMapClose (MapConfiguration config)
void	TogglePositiveCursor (bool enable)
void	ToggleNegativeCursor (bool enable)

Protected Attributes
Faction	m_CommanderFaction
int	m_iPlayerId
IEntity	m_HoveredEntity
ENotification	m_eBlockingNotification
BaseWorld	m_World
float	m_fOceanBaseHeight
bool	m_bIsOcean
float	m_fSignalRangeOffset
Protected Attributes inherited from SCR_MapCommandCursor
bool	m_bIsDestinationEnabled
vector	m_vStartPosition
SCR_MapCursorModule	m_MapCursorModule
ref ScriptInvokerVector	m_OnCommandExecuted
ref ScriptInvokerVector	m_OnCommandNotExecuted

Static Protected Attributes
const int	CONSTRUCTION_TRUCK_BUILDING_RADIUS = 35

Constructor & Destructor Documentation

SCR_EstablishBaseMapCommandCursor()

void SCR_EstablishBaseMapCommandCursor.SCR_EstablishBaseMapCommandCursor

(

)

Member Function Documentation

CanExecuteCommand()

override bool SCR_EstablishBaseMapCommandCursor.CanExecuteCommand ( vector position )

protected

Implements SCR_MapCommandCursor.

GetPlayerId()

int SCR_EstablishBaseMapCommandCursor.GetPlayerId

(

)

OnCommandNotExecuted()

override void SCR_EstablishBaseMapCommandCursor.OnCommandNotExecuted ( vector position )

protected

Implements SCR_MapCommandCursor.

SetData()

void SCR_EstablishBaseMapCommandCursor.SetData	(	notnull Faction	commanderFaction,
		int	playerId,
		IEntity	hoveredEntity )

Member Data Documentation

CONSTRUCTION_TRUCK_BUILDING_RADIUS

const int SCR_EstablishBaseMapCommandCursor.CONSTRUCTION_TRUCK_BUILDING_RADIUS = 35

staticprotected

m_bIsOcean

bool SCR_EstablishBaseMapCommandCursor.m_bIsOcean

protected

m_CommanderFaction

Faction SCR_EstablishBaseMapCommandCursor.m_CommanderFaction

protected

m_eBlockingNotification

ENotification SCR_EstablishBaseMapCommandCursor.m_eBlockingNotification

protected

m_fOceanBaseHeight

float SCR_EstablishBaseMapCommandCursor.m_fOceanBaseHeight

protected

m_fSignalRangeOffset

float SCR_EstablishBaseMapCommandCursor.m_fSignalRangeOffset

protected

m_HoveredEntity

IEntity SCR_EstablishBaseMapCommandCursor.m_HoveredEntity

protected

m_iPlayerId

int SCR_EstablishBaseMapCommandCursor.m_iPlayerId

protected

m_World

BaseWorld SCR_EstablishBaseMapCommandCursor.m_World

protected

---

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

• Game/FactionCommander/MapCommandCursors/SCR_EstablishBaseMapCommandCursor.c