SCR_MapSelectionModule Interface Reference

Inheritance diagram for SCR_MapSelectionModule:

Public Member Functions
float	GetSelCircleSize ()
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	Update (float timeSlice)
	Update method for frame operations.
Public Member Functions inherited from SCR_MapModuleBase
bool	IsConfigDisabled ()
	Whether this module is disabled in config.
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events.
void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
void	Update (float timeSlice)
	Update method for frame operations.
void	SCR_MapModuleBase ()
	Dont use arguments in the contructor for this class or its children.

Public Attributes
ResourceName	m_sMultiselectTexture
float	m_fMultiselectSpeed

Static Public Attributes
const float	MAX_HOLD_TIME = 4
const float	MULTISEL_INIT_SIZE = 0.25

Protected Member Functions
void	RenderSelectionCircle (float timeSlice)
	Render multiselection circle.
void	AdjustCircleSize ()
	Adjust multiselection circle size based on hold time.
void	RenderSelectionRectangle ()
	Render multiselection rectangle.
Protected Member Functions inherited from SCR_MapModuleBase
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
ref array< ref CanvasWidgetCommand >	m_Commands = new array<ref CanvasWidgetCommand>
float	m_fHoldTimeSlice = 0
	controller multi selection
float	m_fSelCircleSize = 0
ref ImageDrawCommand	m_SelectionCircle
ref SharedItemRef	m_SelCircleSharedItem
CanvasWidget	m_DrawCanvas
SCR_MapCursorModule	m_CursorModule
SCR_MapCursorInfo	m_CursorInfo
Protected Attributes inherited from SCR_MapModuleBase
bool	m_bDisableModule
Widget	m_wRootWidget
SCR_MapEntity	m_MapEntity

Member Function Documentation

AdjustCircleSize()

void SCR_MapSelectionModule.AdjustCircleSize ( )

protected

Adjust multiselection circle size based on hold time.

GetSelCircleSize()

float SCR_MapSelectionModule.GetSelCircleSize

(

)

OnMapOpen()

override void SCR_MapSelectionModule.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Implements SCR_MapModuleBase.

RenderSelectionCircle()

void SCR_MapSelectionModule.RenderSelectionCircle ( float  timeSlice )

protected

Render multiselection circle.

RenderSelectionRectangle()

void SCR_MapSelectionModule.RenderSelectionRectangle ( )

protected

Render multiselection rectangle.

Update()

override void SCR_MapSelectionModule.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapModuleBase.

Member Data Documentation

m_Commands

ref array<ref CanvasWidgetCommand> SCR_MapSelectionModule.m_Commands = new array<ref CanvasWidgetCommand>

protected

m_CursorInfo

SCR_MapCursorInfo SCR_MapSelectionModule.m_CursorInfo

protected

m_CursorModule

SCR_MapCursorModule SCR_MapSelectionModule.m_CursorModule

protected

m_DrawCanvas

CanvasWidget SCR_MapSelectionModule.m_DrawCanvas

protected

m_fHoldTimeSlice

float SCR_MapSelectionModule.m_fHoldTimeSlice = 0

protected

controller multi selection

m_fMultiselectSpeed

float SCR_MapSelectionModule.m_fMultiselectSpeed

m_fSelCircleSize

float SCR_MapSelectionModule.m_fSelCircleSize = 0

protected

m_SelCircleSharedItem

ref SharedItemRef SCR_MapSelectionModule.m_SelCircleSharedItem

protected

m_SelectionCircle

ref ImageDrawCommand SCR_MapSelectionModule.m_SelectionCircle

protected

m_sMultiselectTexture

ResourceName SCR_MapSelectionModule.m_sMultiselectTexture

MAX_HOLD_TIME

const float SCR_MapSelectionModule.MAX_HOLD_TIME = 4

static

MULTISEL_INIT_SIZE

const float SCR_MapSelectionModule.MULTISEL_INIT_SIZE = 0.25

static

---

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

• Game/Map/Modules/SCR_MapSelectionModule.c