SCR_MapCommandCursor Class Reference

Inheritance diagram for SCR_MapCommandCursor:

Protected Member Functions
ScriptInvokerVector	GetOnCommandExecuted ()
ScriptInvokerVector	GetOnCommandNotExecuted ()
void	ShowCursor (vector startCursorPosition)
bool	CanExecuteCommand (vector position)
void	OnCommandExecuted (vector position)
void	OnCommandNotExecuted (vector position)
void	OnSelection (vector coords)
void	UpdateCursor ()
void	OnMapClose (MapConfiguration config)
void	DisableSelection (bool toggleOffCursors=true)
void	TogglePositiveCursor (bool enable)
void	ToggleNegativeCursor (bool enable)
void	SCR_MapCommandCursor ()
void	~SCR_MapCommandCursor ()

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

Detailed Description

Definition at line 1 of file SCR_MapCommandCursor.c.

Constructor & Destructor Documentation

SCR_MapCommandCursor()

void SCR_MapCommandCursor::SCR_MapCommandCursor ( )

inlineprotected

Definition at line 166 of file SCR_MapCommandCursor.c.

~SCR_MapCommandCursor()

void SCR_MapCommandCursor::~SCR_MapCommandCursor ( )

inlineprotected

Definition at line 176 of file SCR_MapCommandCursor.c.

Member Function Documentation

CanExecuteCommand()

bool SCR_MapCommandCursor::CanExecuteCommand ( vector position )

inlineprotected

Definition at line 45 of file SCR_MapCommandCursor.c.

DisableSelection()

void SCR_MapCommandCursor::DisableSelection ( bool toggleOffCursors = true )

inlineprotected

Definition at line 133 of file SCR_MapCommandCursor.c.

GetOnCommandExecuted()

ScriptInvokerVector SCR_MapCommandCursor::GetOnCommandExecuted ( )

inlineprotected

Returns

Definition at line 12 of file SCR_MapCommandCursor.c.

GetOnCommandNotExecuted()

ScriptInvokerVector SCR_MapCommandCursor::GetOnCommandNotExecuted ( )

inlineprotected

Returns

Definition at line 22 of file SCR_MapCommandCursor.c.

OnCommandExecuted()

void SCR_MapCommandCursor::OnCommandExecuted ( vector position )

inlineprotected

Definition at line 51 of file SCR_MapCommandCursor.c.

OnCommandNotExecuted()

void SCR_MapCommandCursor::OnCommandNotExecuted ( vector position )

inlineprotected

Definition at line 58 of file SCR_MapCommandCursor.c.

OnMapClose()

void SCR_MapCommandCursor::OnMapClose ( MapConfiguration config )

inlineprotected

Definition at line 127 of file SCR_MapCommandCursor.c.

OnSelection()

void SCR_MapCommandCursor::OnSelection ( vector coords )

inlineprotected

Definition at line 65 of file SCR_MapCommandCursor.c.

ShowCursor()

void SCR_MapCommandCursor::ShowCursor ( vector startCursorPosition )

inlineprotected

Definition at line 31 of file SCR_MapCommandCursor.c.

ToggleNegativeCursor()

void SCR_MapCommandCursor::ToggleNegativeCursor ( bool enable )

inlineprotected

Definition at line 157 of file SCR_MapCommandCursor.c.

TogglePositiveCursor()

void SCR_MapCommandCursor::TogglePositiveCursor ( bool enable )

inlineprotected

Definition at line 148 of file SCR_MapCommandCursor.c.

UpdateCursor()

void SCR_MapCommandCursor::UpdateCursor ( )

inlineprotected

Definition at line 90 of file SCR_MapCommandCursor.c.

Member Data Documentation

m_bIsDestinationEnabled

bool SCR_MapCommandCursor::m_bIsDestinationEnabled

protected

Definition at line 3 of file SCR_MapCommandCursor.c.

m_MapCursorModule

SCR_MapCursorModule SCR_MapCommandCursor::m_MapCursorModule

protected

Definition at line 5 of file SCR_MapCommandCursor.c.

m_OnCommandExecuted

ref ScriptInvokerVector SCR_MapCommandCursor::m_OnCommandExecuted

protected

Definition at line 7 of file SCR_MapCommandCursor.c.

m_OnCommandNotExecuted

ref ScriptInvokerVector SCR_MapCommandCursor::m_OnCommandNotExecuted

protected

Definition at line 8 of file SCR_MapCommandCursor.c.

m_vStartPosition

vector SCR_MapCommandCursor::m_vStartPosition

protected

Definition at line 4 of file SCR_MapCommandCursor.c.

---

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

• scripts/Game/FactionCommander/MapCommandCursors/SCR_MapCommandCursor.c