SCR_MapCommandCursor Interface Reference

Inheritance diagram for SCR_MapCommandCursor:

Public Member Functions
ScriptInvokerVector	GetOnCommandExecuted ()
ScriptInvokerVector	GetOnCommandNotExecuted ()
void	ShowCursor (vector startCursorPosition)
void	DisableSelection (bool toggleOffCursors=true)
void	SCR_MapCommandCursor ()
void	~SCR_MapCommandCursor ()

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

Protected Attributes
bool	m_bIsDestinationEnabled
vector	m_vStartPosition
SCR_MapCursorModule	m_MapCursorModule
ref ScriptInvokerVector	m_OnCommandExecuted
ref ScriptInvokerVector	m_OnCommandNotExecuted

Constructor & Destructor Documentation

SCR_MapCommandCursor()

void SCR_MapCommandCursor.SCR_MapCommandCursor

(

)

~SCR_MapCommandCursor()

void SCR_MapCommandCursor.~SCR_MapCommandCursor

(

)

Member Function Documentation

CanExecuteCommand()

bool SCR_MapCommandCursor.CanExecuteCommand ( vector position )

protected

Implemented in SCR_EstablishBaseMapCommandCursor.

DisableSelection()

void SCR_MapCommandCursor.DisableSelection

(

bool

toggleOffCursors = true

)

GetOnCommandExecuted()

ScriptInvokerVector SCR_MapCommandCursor.GetOnCommandExecuted

(

)

Returns

GetOnCommandNotExecuted()

ScriptInvokerVector SCR_MapCommandCursor.GetOnCommandNotExecuted

(

)

Returns

OnCommandExecuted()

void SCR_MapCommandCursor.OnCommandExecuted ( vector position )

protected

OnCommandNotExecuted()

void SCR_MapCommandCursor.OnCommandNotExecuted ( vector position )

protected

Implemented in SCR_EstablishBaseMapCommandCursor.

OnMapClose()

void SCR_MapCommandCursor.OnMapClose ( MapConfiguration config )

protected

OnSelection()

void SCR_MapCommandCursor.OnSelection ( vector coords )

protected

ShowCursor()

void SCR_MapCommandCursor.ShowCursor

(

vector

startCursorPosition

)

ToggleNegativeCursor()

void SCR_MapCommandCursor.ToggleNegativeCursor ( bool enable )

protected

TogglePositiveCursor()

void SCR_MapCommandCursor.TogglePositiveCursor ( bool enable )

protected

UpdateCursor()

void SCR_MapCommandCursor.UpdateCursor ( )

protected

Member Data Documentation

m_bIsDestinationEnabled

bool SCR_MapCommandCursor.m_bIsDestinationEnabled

protected

m_MapCursorModule

SCR_MapCursorModule SCR_MapCommandCursor.m_MapCursorModule

protected

m_OnCommandExecuted

ref ScriptInvokerVector SCR_MapCommandCursor.m_OnCommandExecuted

protected

m_OnCommandNotExecuted

ref ScriptInvokerVector SCR_MapCommandCursor.m_OnCommandNotExecuted

protected

m_vStartPosition

vector SCR_MapCommandCursor.m_vStartPosition

protected

---

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

• Game/FactionCommander/MapCommandCursors/SCR_MapCommandCursor.c