SCR_CursorCustom Interface Reference

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

Public Member Functions
void	SetCursorVisual (SCR_CursorVisualState stateCfg)
	Set visual.
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 ()

Static Public Attributes
const int	REAL_CURSOR_HIDE = 12
const string	layoutPath = "{80F7ED5410342195}UI/layouts/Map/CursorCustom.layout"

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.

Constructor & Destructor Documentation

SCR_CursorCustom()

void SCR_CursorCustom.SCR_CursorCustom

(

)

~SCR_CursorCustom()

void SCR_CursorCustom.~SCR_CursorCustom

(

)

Member Function Documentation

SetCursorVisual()

void SCR_CursorCustom.SetCursorVisual

(

SCR_CursorVisualState

stateCfg

)

Set visual.

Parameters

stateCfg

is cursor state config, null to disable

SetOpacity()

void SCR_CursorCustom.SetOpacity

(

float

opacity

)

Set opacity.

Update()

void SCR_CursorCustom.Update	(	float	x,
		float	y
	)

Update position, has to be called manually.

Member Data Documentation

layoutPath

const string SCR_CursorCustom.layoutPath = "{80F7ED5410342195}UI/layouts/Map/CursorCustom.layout"

static

m_bIsVisible

bool SCR_CursorCustom.m_bIsVisible

protected

m_wCursor

Widget SCR_CursorCustom.m_wCursor

protected

m_wCursorImage

ImageWidget SCR_CursorCustom.m_wCursorImage

protected

m_wRoot

Widget SCR_CursorCustom.m_wRoot

protected

REAL_CURSOR_HIDE

const int SCR_CursorCustom.REAL_CURSOR_HIDE = 12

static

---

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

• Game/UI/SCR_CursorCustom.c