SCR_CursorCustom Class Reference

Scripted map cursor visualization for cases where the gamecode provided one is not sufficient. More...

Protected Member Functions
void	SetCursorVisual (SCR_CursorVisualState stateCfg)
void	SetOpacity (float opacity)
	Set opacity.
void	Update (float x, float y)
	Update position, has to be called manually.
void	SCR_CursorCustom ()
void	~SCR_CursorCustom ()

Protected Attributes
bool	m_bIsVisible
Widget	m_wRoot
Widget	m_wCursor
ImageWidget	m_wCursorImage

Detailed Description

Scripted map cursor visualization for cases where the gamecode provided one is not sufficient.

Definition at line 3 of file SCR_CursorCustom.c.

Constructor & Destructor Documentation

SCR_CursorCustom()

void SCR_CursorCustom::SCR_CursorCustom ( )

inlineprotected

Definition at line 57 of file SCR_CursorCustom.c.

~SCR_CursorCustom()

void SCR_CursorCustom::~SCR_CursorCustom ( )

inlineprotected

Definition at line 65 of file SCR_CursorCustom.c.

Member Function Documentation

SetCursorVisual()

void SCR_CursorCustom::SetCursorVisual ( SCR_CursorVisualState stateCfg )

inlineprotected

Set visual

Parameters

stateCfg

is cursor state config, null to disable

Definition at line 16 of file SCR_CursorCustom.c.

SetOpacity()

void SCR_CursorCustom::SetOpacity ( float opacity )

inlineprotected

Set opacity.

Definition at line 44 of file SCR_CursorCustom.c.

Update()

void SCR_CursorCustom::Update ( float x, float y )

inlineprotected

Update position, has to be called manually.

Definition at line 51 of file SCR_CursorCustom.c.

Member Data Documentation

m_bIsVisible

bool SCR_CursorCustom::m_bIsVisible

protected

Definition at line 8 of file SCR_CursorCustom.c.

m_wCursor

Widget SCR_CursorCustom::m_wCursor

protected

Definition at line 10 of file SCR_CursorCustom.c.

m_wCursorImage

ImageWidget SCR_CursorCustom::m_wCursorImage

protected

Definition at line 11 of file SCR_CursorCustom.c.

m_wRoot

Widget SCR_CursorCustom::m_wRoot

protected

Definition at line 9 of file SCR_CursorCustom.c.

---

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

• scripts/Game/UI/SCR_CursorCustom.c