Map cursor behavior and mode setup. More...

Inheritance diagram for SCR_MapCursorModule:

Public Member Functions
SCR_MapCursorInfo	GetCursorInfo ()
	Get cursor data class.

EMapCursorState	GetCursorState ()
	Get cursor state.

void	SetWheelZoomMultiplier (float value)
	Sets zoom strength multiplier for mouse wheel zoom.

void	ForceCenterCursor ()
	Force cursor to screen center Only use when necessarry as some methods rely on current cursor position.

bool	HandleDraw (bool active)
	Handle draw state.

bool	HandleSubMenu (bool active)
	Handle sub menu state.

bool	HandleDialog (bool active)
	Handle dialog state.

void	ToggleFastTravelDestinationSelection (bool enable)

bool	HandleContextualMenu (bool doClose=false)
	Handle contextual menu.

override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.

override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

override void	Update (float timeSlice)
	Update method for frame operations.

void	SCR_MapCursorModule ()

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.

Static Public Member Functions
static array< Widget >	GetMapWidgetsUnderCursor ()
	Get widgets under cursor.

Public Attributes
EMapCursorSelectType	m_eMultiSelType

Static Public Attributes
static const EMapCursorState	CUSTOM_CURSOR_LOCKED = EMapCursorState.CS_DISABLE

static const EMapCursorState	STATE_PAN_RESTRICTED = EMapCursorState.CS_DRAG \| EMapCursorState.CS_MODIFIER \| EMapCursorState.CS_CONTEXTUAL_MENU \| EMapCursorState.CS_DIALOG

static const EMapCursorState	STATE_ZOOM_RESTRICTED = EMapCursorState.CS_DRAG \| EMapCursorState.CS_MODIFIER \| EMapCursorState.CS_CONTEXTUAL_MENU

static const EMapCursorState	STATE_HOVER_RESTRICTED

static const EMapCursorState	STATE_SELECT_RESTRICTED = EMapCursorState.CS_MULTI_SELECTION \| EMapCursorState.CS_CONTEXTUAL_MENU \| EMapCursorState.CS_DRAG \| EMapCursorState.CS_DRAW

static const EMapCursorState	STATE_MULTISELECT_RESTRICTED = EMapCursorState.CS_DRAG \| EMapCursorState.CS_DRAW \| EMapCursorState.CS_CONTEXTUAL_MENU \| EMapCursorState.CS_MODIFIER

static const EMapCursorState	STATE_DRAG_RESTRICTED = EMapCursorState.CS_CONTEXTUAL_MENU \| EMapCursorState.CS_MULTI_SELECTION \| EMapCursorState.CS_ROTATE

static const EMapCursorState	STATE_ROTATE_RESTRICTED = EMapCursorState.CS_PAN \| EMapCursorState.CS_ZOOM \| EMapCursorState.CS_CONTEXTUAL_MENU

static const EMapCursorState	STATE_DRAW_RESTRICTED = EMapCursorState.CS_PAN \| EMapCursorState.CS_ZOOM \| EMapCursorState.CS_CONTEXTUAL_MENU \| EMapCursorState.CS_DIALOG

static const EMapCursorState	STATE_SUBMENU_RESTRICTED = EMapCursorState.CS_CONTEXTUAL_MENU \| EMapCursorState.CS_DIALOG

static const EMapCursorState	STATE_CTXMENU_RESTRICTED = EMapCursorState.CS_DRAG \| EMapCursorState.CS_DRAW \| EMapCursorState.CS_ROTATE

static const EMapCursorState	STATE_RESET_RESTRICTED = EMapCursorState.CS_DRAG \| EMapCursorState.CS_DRAW \| EMapCursorState.CS_ROTATE

static const EMapCursorState	STATE_POPUP_RESTRICTED = EMapCursorState.CS_PAN \| EMapCursorState.CS_DRAW \| EMapCursorState.CS_ROTATE

Protected Member Functions
void	SetCursorState (EMapCursorState state)
	Set cursor state.

void	UnsetCursorState (EMapCursorState state)
	Unset cursor state.

void	SetCursorType (EMapCursorState type)
	Sets cursor type - visual style.

void	SetCrosshairGridVisible (bool state)
	Set visibility of a custom crosshair grid lines.

void	OnInputDeviceIsGamepad (bool isGamepad)
	Sets active device - KB+M or controller.

void	HandleMove ()
	Handle move state.

void	HandlePan (float timeSlice)
	Handle pan.

void	HandleZoom ()
	Handle zoom.

void	HandleHover (float timeSlice)
	Handle hover state displaying details over target.

void	HandleSelect ()
	Handle select state.

void	HandleMultiSelect (bool activate)
	Handle multi select - rectangular selection.

void	HandleDrag (bool startDrag)
	Handle drag state.

void	HandleRotateTool (bool startRotate)
	Handle rotate map tool.

void	GetCursorSelection (out array< MapItem > mapItems)
	Acquires array of map items for multi selection based on selection mode.

void	GetCursorPosition (out int x, out int y)
	Actual cursor position screen (DPI Unscaled)

void	TestEdgePan (inout float x, inout float y, int screenX, int screenY)
	Window edge pan.

void	OnInputPanDrag (float value, EActionTrigger reason)
	Digital pan input for activating drag mode.

void	OnInputPanH (float value, EActionTrigger reason)
	Digital pan KBM.

void	OnInputPanV (float value, EActionTrigger reason)
	Digital pan vertical.

void	OnInputPanHGamepad (float value, EActionTrigger reason)
	Analog pan horizontal.

void	OnInputPanVGamepad (float value, EActionTrigger reason)
	Analog pan vertical.

void	CalculatePan (float direction, EMapPanMode panMode, float multiPlier)
	Process pan.

void	OnInputGamepadCursorH (float value, EActionTrigger reason)
	Cursor motion horizontal.

void	OnInputGamepadCursorV (float value, EActionTrigger reason)
	Cursor motion vertical.

void	OnInputZoom (float value, EActionTrigger reason)
	Digital zoom.

void	OnInputZoomWheelUp (float value, EActionTrigger reason)
	Digital zoom mouse wheel.

void	OnInputZoomWheelDown (float value, EActionTrigger reason)
	Digital zoom mouse wheel.

void	OnInputDrag (float value, EActionTrigger reason)
	Digital drag.

void	OnInputDragToggle (float value, EActionTrigger reason)
	Digital drag toggle.

void	OnInputModifier (float value, EActionTrigger reason)
	Digital modifier key.

void	OnInputModifClick (float value, EActionTrigger reason)
	Digital click.

void	OnInputMultiSel (float value, EActionTrigger reason)
	Digital multiselect mouse.

void	OnInputMultiSelGamepad (float value, EActionTrigger reason)
	Digital multiselect gamepad.

void	OnPauseMenuOpened ()
	PauseMenuUI event.

void	OnPauseMenuClosed ()
	PauseMenuUI event.

SCR_CursorVisualState	GetCursorStateCfg ()
	Get cursor visual state config.

void	UpdateCrosshairUI ()
	Update crosshair UI.

void	InitWidgets (Widget root)
	Initialize widgets.

void	InitInputs ()
	Initialize inputs.

void	CleanupInputs ()
	Cleanup inputs.

void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.

void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Static Protected Member Functions
static void	TraceMapWidgets ()
	Trace widgets under cursor.

Protected Attributes
float	m_fPanKBMMultiplier

float	m_fPanStickMultiplier

bool	m_bEnableCursorEdgePan

bool	m_bIsCursorCenteredOnOpen

float	m_fZoomAnimTime

float	m_fZoomStrength

int	m_iRotateSpeedMouse

bool	m_bEnableMapCrosshairVisuals

bool	m_bEnableCrosshairCoords

ref Color	m_GuidelineColor

ref array< ref SCR_CursorVisualState >	m_aCursorStatesConfig

ref map< EMapCursorState, SCR_CursorVisualState >	m_aCursorStatesMap = new map<EMapCursorState, SCR_CursorVisualState>

float	m_fPanCountdown

float	m_fModifActionDelay

float	m_fZoomHoldTime

float	m_fHoverTime

float	m_fFreeCursorTime

float	m_fSelectHoldTime

EMapCursorState	m_CursorState = EMapCursorState.CS_DEFAULT

bool	m_bIsInit

bool	m_bIsDisabled

bool	m_bIsDraggingAvailable

bool	m_bIsSelectionAvailable

bool	m_bIsModifierActive

int	m_iRotationDirVal

float	m_fZoomMultiplierWheel = 1

InputManager	m_InputManager

ref SCR_MapCursorInfo	m_CursorInfo

ref SCR_CursorCustom	m_CustomCursor

CanvasWidget	m_MapWidget

SCR_MapSelectionModule	m_SelectionModule

Widget	m_wCrossGrid

ImageWidget	m_wCrossLTop

ImageWidget	m_wCrossRTop

ImageWidget	m_wCrossLBot

ImageWidget	m_wGLLeft

ImageWidget	m_wGLTop

Widget	m_wCrossMCenter

ImageWidget	m_wGLRight

ImageWidget	m_wGLBot

ImageWidget	m_wGLFadeTop

ImageWidget	m_wGLFadeLeft

ImageWidget	m_wGLFadeRight

ImageWidget	m_wGLFadeBot

TextWidget	m_wCoordText

Protected Attributes inherited from SCR_MapModuleBase
bool	m_bDisableModule

Widget	m_wRootWidget

SCR_MapEntity	m_MapEntity

Static Protected Attributes
static bool	m_bRecentlyTraced

static ref array< Widget >	s_aTracedWidgets = {}

const int	CURSOR_CAPTURE_OFFSET = 10

const int	GUILDING_LINE_WIDTH = 16

const float	PAN_DEFAULT_COUNTDOWN = 0.1

const float	SINGLE_SELECTION_RANGE = 50.0

const float	CIRCLE_SELECTION_RANGE = 500.0

const float	FREE_CURSOR_RESET = 3.0

Detailed Description

Map cursor behavior and mode setup.

Constructor & Destructor Documentation

◆ SCR_MapCursorModule()

void SCR_MapCursorModule.SCR_MapCursorModule ( )

Member Function Documentation

◆ CalculatePan()

void SCR_MapCursorModule.CalculatePan	(	float	direction,
		EMapPanMode	panMode,
		float	multiPlier
	)

protected

Process pan.

Parameters

direction	determines direction of digital inputs for the horizontal/vertical axis
panMode	is mode of panning
multiPlier	is configurable speed adjustment

◆ CleanupInputs()

void SCR_MapCursorModule.CleanupInputs ( )

protected

Cleanup inputs.

◆ ForceCenterCursor()

void SCR_MapCursorModule.ForceCenterCursor ( )

Force cursor to screen center Only use when necessarry as some methods rely on current cursor position.

◆ GetCursorInfo()

SCR_MapCursorInfo SCR_MapCursorModule.GetCursorInfo ( )

Get cursor data class.

◆ GetCursorPosition()

void SCR_MapCursorModule.GetCursorPosition	(	out int	x,
		out int	y
	)

protected

Actual cursor position screen (DPI Unscaled)

Parameters

[out]	unscaled	cursor x
[out]	unscaled	cursor y

◆ GetCursorSelection()

void SCR_MapCursorModule.GetCursorSelection ( out array< MapItem > mapItems )

protected

Acquires array of map items for multi selection based on selection mode.

Parameters

mapItems are map items within selection

screen to world conversion

get entities inside the selection rectangle

◆ GetCursorState()

EMapCursorState SCR_MapCursorModule.GetCursorState ( )

Get cursor state.

◆ GetCursorStateCfg()

SCR_CursorVisualState SCR_MapCursorModule.GetCursorStateCfg ( )

protected

Get cursor visual state config.

Returns: highest configured cursor state config relative to current cursor state

◆ GetMapWidgetsUnderCursor()

static array< Widget > SCR_MapCursorModule.GetMapWidgetsUnderCursor ( )

static

Get widgets under cursor.

◆ HandleContextualMenu()

bool SCR_MapCursorModule.HandleContextualMenu ( bool doClose = false )

Handle contextual menu.

Parameters

doClose determines whether the context menu should close

Returns: state of the menu where false = close / true = open

context menu disabled

◆ HandleDialog()

bool SCR_MapCursorModule.HandleDialog ( bool active )

Handle dialog state.

◆ HandleDrag()

void SCR_MapCursorModule.HandleDrag ( bool startDrag )

protected

Handle drag state.

Parameters

startDrag determines whether dragging should begin or stop

◆ HandleDraw()

bool SCR_MapCursorModule.HandleDraw ( bool active )

Handle draw state.

◆ HandleHover()

void SCR_MapCursorModule.HandleHover ( float timeSlice )

protected

Handle hover state displaying details over target.

◆ HandleMove()

void SCR_MapCursorModule.HandleMove ( )

protected

Handle move state.

◆ HandleMultiSelect()

void SCR_MapCursorModule.HandleMultiSelect ( bool activate )

protected

Handle multi select - rectangular selection.

◆ HandlePan()

void SCR_MapCursorModule.HandlePan ( float timeSlice )

protected

Handle pan.

◆ HandleRotateTool()

void SCR_MapCursorModule.HandleRotateTool ( bool startRotate )

protected

Handle rotate map tool.

◆ HandleSelect()

void SCR_MapCursorModule.HandleSelect ( )

protected

Handle select state.

select disabled

◆ HandleSubMenu()

bool SCR_MapCursorModule.HandleSubMenu ( bool active )

Handle sub menu state.

◆ HandleZoom()

void SCR_MapCursorModule.HandleZoom ( )

protected

Handle zoom.

zoom disabled

◆ InitInputs()

void SCR_MapCursorModule.InitInputs ( )

protected

Initialize inputs.

◆ InitWidgets()

void SCR_MapCursorModule.InitWidgets ( Widget root )

protected

Initialize widgets.

◆ OnInputDeviceIsGamepad()

void SCR_MapCursorModule.OnInputDeviceIsGamepad ( bool isGamepad )

protected

Sets active device - KB+M or controller.

◆ OnInputDrag()

void SCR_MapCursorModule.OnInputDrag	(	float	value,
		EActionTrigger	reason
	)

protected

Digital drag.

◆ OnInputDragToggle()

void SCR_MapCursorModule.OnInputDragToggle	(	float	value,
		EActionTrigger	reason
	)

protected

Digital drag toggle.

◆ OnInputGamepadCursorH()

void SCR_MapCursorModule.OnInputGamepadCursorH	(	float	value,
		EActionTrigger	reason
	)

protected

Cursor motion horizontal.

◆ OnInputGamepadCursorV()

void SCR_MapCursorModule.OnInputGamepadCursorV	(	float	value,
		EActionTrigger	reason
	)

protected

Cursor motion vertical.

◆ OnInputModifClick()

void SCR_MapCursorModule.OnInputModifClick	(	float	value,
		EActionTrigger	reason
	)

protected

Digital click.

◆ OnInputModifier()

void SCR_MapCursorModule.OnInputModifier	(	float	value,
		EActionTrigger	reason
	)

protected

Digital modifier key.

◆ OnInputMultiSel()

void SCR_MapCursorModule.OnInputMultiSel	(	float	value,
		EActionTrigger	reason
	)

protected

Digital multiselect mouse.

◆ OnInputMultiSelGamepad()

void SCR_MapCursorModule.OnInputMultiSelGamepad	(	float	value,
		EActionTrigger	reason
	)

protected

Digital multiselect gamepad.

◆ OnInputPanDrag()

void SCR_MapCursorModule.OnInputPanDrag	(	float	value,
		EActionTrigger	reason
	)

protected

Digital pan input for activating drag mode.

◆ OnInputPanH()

void SCR_MapCursorModule.OnInputPanH	(	float	value,
		EActionTrigger	reason
	)

protected

Digital pan KBM.

◆ OnInputPanHGamepad()

void SCR_MapCursorModule.OnInputPanHGamepad	(	float	value,
		EActionTrigger	reason
	)

protected

Analog pan horizontal.

◆ OnInputPanV()

void SCR_MapCursorModule.OnInputPanV	(	float	value,
		EActionTrigger	reason
	)

protected

Digital pan vertical.

◆ OnInputPanVGamepad()

void SCR_MapCursorModule.OnInputPanVGamepad	(	float	value,
		EActionTrigger	reason
	)

protected

Analog pan vertical.

◆ OnInputZoom()

void SCR_MapCursorModule.OnInputZoom	(	float	value,
		EActionTrigger	reason
	)

protected

Digital zoom.

zoom disabled

◆ OnInputZoomWheelDown()

void SCR_MapCursorModule.OnInputZoomWheelDown	(	float	value,
		EActionTrigger	reason
	)

protected

Digital zoom mouse wheel.

zoom disabled

◆ OnInputZoomWheelUp()

void SCR_MapCursorModule.OnInputZoomWheelUp	(	float	value,
		EActionTrigger	reason
	)

protected

Digital zoom mouse wheel.

zoom disabled

◆ OnMapClose()

override void SCR_MapCursorModule.OnMapClose ( MapConfiguration config )

SCR_MapEntity event.

Implements SCR_MapModuleBase.

◆ OnMapOpen()

override void SCR_MapCursorModule.OnMapOpen ( MapConfiguration config )

SCR_MapEntity event.

Implements SCR_MapModuleBase.

◆ OnPauseMenuClosed()

void SCR_MapCursorModule.OnPauseMenuClosed ( )

protected

PauseMenuUI event.

◆ OnPauseMenuOpened()

void SCR_MapCursorModule.OnPauseMenuOpened ( )

protected

PauseMenuUI event.

◆ SetCrosshairGridVisible()

void SCR_MapCursorModule.SetCrosshairGridVisible ( bool state )

protected

Set visibility of a custom crosshair grid lines.

◆ SetCursorState()

void SCR_MapCursorModule.SetCursorState ( EMapCursorState state )

protected

Set cursor state.

Parameters

state is the added state

◆ SetCursorType()

void SCR_MapCursorModule.SetCursorType ( EMapCursorState type )

protected

Sets cursor type - visual style.

◆ SetWheelZoomMultiplier()

void SCR_MapCursorModule.SetWheelZoomMultiplier ( float value )

Sets zoom strength multiplier for mouse wheel zoom.

◆ TestEdgePan()

void SCR_MapCursorModule.TestEdgePan	(	inout float	x,
		inout float	y,
		int	screenX,
		int	screenY
	)

protected

Window edge pan.

Parameters

x	is scaled cursor pos x
y	is scaled cursor pos y
screenX	is screen size x
screenY	is screen size y

◆ ToggleFastTravelDestinationSelection()

void SCR_MapCursorModule.ToggleFastTravelDestinationSelection ( bool enable )

◆ TraceMapWidgets()

static void SCR_MapCursorModule.TraceMapWidgets ( )

staticprotected

Trace widgets under cursor.

◆ UnsetCursorState()

void SCR_MapCursorModule.UnsetCursorState ( EMapCursorState state )

protected

Unset cursor state.

Parameters

state is the removed state

◆ Update()

override void SCR_MapCursorModule.Update ( float timeSlice )

Update method for frame operations.

Implements SCR_MapModuleBase.

◆ UpdateCrosshairUI()

void SCR_MapCursorModule.UpdateCrosshairUI ( )

protected

Update crosshair UI.

Member Data Documentation

◆ CIRCLE_SELECTION_RANGE

const float SCR_MapCursorModule.CIRCLE_SELECTION_RANGE = 500.0

staticprotected

◆ CURSOR_CAPTURE_OFFSET

const int SCR_MapCursorModule.CURSOR_CAPTURE_OFFSET = 10

staticprotected

◆ CUSTOM_CURSOR_LOCKED

const EMapCursorState SCR_MapCursorModule.CUSTOM_CURSOR_LOCKED = EMapCursorState.CS_DISABLE

static

◆ FREE_CURSOR_RESET

const float SCR_MapCursorModule.FREE_CURSOR_RESET = 3.0

staticprotected

◆ GUILDING_LINE_WIDTH

const int SCR_MapCursorModule.GUILDING_LINE_WIDTH = 16

staticprotected

◆ m_aCursorStatesConfig

ref array<ref SCR_CursorVisualState> SCR_MapCursorModule.m_aCursorStatesConfig

protected

◆ m_aCursorStatesMap

ref map<EMapCursorState, SCR_CursorVisualState> SCR_MapCursorModule.m_aCursorStatesMap = new map<EMapCursorState, SCR_CursorVisualState>

protected

◆ m_bEnableCrosshairCoords

bool SCR_MapCursorModule.m_bEnableCrosshairCoords

protected

◆ m_bEnableCursorEdgePan

bool SCR_MapCursorModule.m_bEnableCursorEdgePan

protected

◆ m_bEnableMapCrosshairVisuals

bool SCR_MapCursorModule.m_bEnableMapCrosshairVisuals

protected

◆ m_bIsCursorCenteredOnOpen

bool SCR_MapCursorModule.m_bIsCursorCenteredOnOpen

protected

◆ m_bIsDisabled

bool SCR_MapCursorModule.m_bIsDisabled

protected

◆ m_bIsDraggingAvailable

bool SCR_MapCursorModule.m_bIsDraggingAvailable

protected

◆ m_bIsInit

bool SCR_MapCursorModule.m_bIsInit

protected

◆ m_bIsModifierActive

bool SCR_MapCursorModule.m_bIsModifierActive

protected

◆ m_bIsSelectionAvailable

bool SCR_MapCursorModule.m_bIsSelectionAvailable

protected

◆ m_bRecentlyTraced

bool SCR_MapCursorModule.m_bRecentlyTraced

staticprotected

◆ m_CursorInfo

ref SCR_MapCursorInfo SCR_MapCursorModule.m_CursorInfo

protected

◆ m_CursorState

EMapCursorState SCR_MapCursorModule.m_CursorState = EMapCursorState.CS_DEFAULT

protected

◆ m_CustomCursor

ref SCR_CursorCustom SCR_MapCursorModule.m_CustomCursor

protected

◆ m_eMultiSelType

EMapCursorSelectType SCR_MapCursorModule.m_eMultiSelType

◆ m_fFreeCursorTime

float SCR_MapCursorModule.m_fFreeCursorTime

protected

◆ m_fHoverTime

float SCR_MapCursorModule.m_fHoverTime

protected

◆ m_fModifActionDelay

float SCR_MapCursorModule.m_fModifActionDelay

protected

◆ m_fPanCountdown

float SCR_MapCursorModule.m_fPanCountdown

protected

◆ m_fPanKBMMultiplier

float SCR_MapCursorModule.m_fPanKBMMultiplier

protected

◆ m_fPanStickMultiplier

float SCR_MapCursorModule.m_fPanStickMultiplier

protected

◆ m_fSelectHoldTime

float SCR_MapCursorModule.m_fSelectHoldTime

protected

◆ m_fZoomAnimTime

float SCR_MapCursorModule.m_fZoomAnimTime

protected

◆ m_fZoomHoldTime

float SCR_MapCursorModule.m_fZoomHoldTime

protected

◆ m_fZoomMultiplierWheel

float SCR_MapCursorModule.m_fZoomMultiplierWheel = 1

protected

◆ m_fZoomStrength

float SCR_MapCursorModule.m_fZoomStrength

protected

◆ m_GuidelineColor

ref Color SCR_MapCursorModule.m_GuidelineColor

protected

◆ m_InputManager

InputManager SCR_MapCursorModule.m_InputManager

protected

◆ m_iRotateSpeedMouse

int SCR_MapCursorModule.m_iRotateSpeedMouse

protected

◆ m_iRotationDirVal

int SCR_MapCursorModule.m_iRotationDirVal

protected

◆ m_MapWidget

CanvasWidget SCR_MapCursorModule.m_MapWidget

protected

◆ m_SelectionModule

SCR_MapSelectionModule SCR_MapCursorModule.m_SelectionModule

protected

◆ m_wCoordText

TextWidget SCR_MapCursorModule.m_wCoordText

protected

◆ m_wCrossGrid

Widget SCR_MapCursorModule.m_wCrossGrid

protected

◆ m_wCrossLBot

ImageWidget SCR_MapCursorModule.m_wCrossLBot

protected

◆ m_wCrossLTop

ImageWidget SCR_MapCursorModule.m_wCrossLTop

protected

◆ m_wCrossMCenter

Widget SCR_MapCursorModule.m_wCrossMCenter

protected

◆ m_wCrossRTop

ImageWidget SCR_MapCursorModule.m_wCrossRTop

protected

◆ m_wGLBot

ImageWidget SCR_MapCursorModule.m_wGLBot

protected

◆ m_wGLFadeBot

ImageWidget SCR_MapCursorModule.m_wGLFadeBot

protected

◆ m_wGLFadeLeft

ImageWidget SCR_MapCursorModule.m_wGLFadeLeft

protected

◆ m_wGLFadeRight

ImageWidget SCR_MapCursorModule.m_wGLFadeRight

protected

◆ m_wGLFadeTop

ImageWidget SCR_MapCursorModule.m_wGLFadeTop

protected

◆ m_wGLLeft

ImageWidget SCR_MapCursorModule.m_wGLLeft

protected

◆ m_wGLRight

ImageWidget SCR_MapCursorModule.m_wGLRight

protected

◆ m_wGLTop

ImageWidget SCR_MapCursorModule.m_wGLTop

protected

◆ PAN_DEFAULT_COUNTDOWN

const float SCR_MapCursorModule.PAN_DEFAULT_COUNTDOWN = 0.1

staticprotected

◆ s_aTracedWidgets

ref array<Widget> SCR_MapCursorModule.s_aTracedWidgets = {}

staticprotected

◆ SINGLE_SELECTION_RANGE

const float SCR_MapCursorModule.SINGLE_SELECTION_RANGE = 50.0

staticprotected

◆ STATE_CTXMENU_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_CTXMENU_RESTRICTED = EMapCursorState.CS_DRAG | EMapCursorState.CS_DRAW | EMapCursorState.CS_ROTATE

static

◆ STATE_DRAG_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_DRAG_RESTRICTED = EMapCursorState.CS_CONTEXTUAL_MENU | EMapCursorState.CS_MULTI_SELECTION | EMapCursorState.CS_ROTATE

static

◆ STATE_DRAW_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_DRAW_RESTRICTED = EMapCursorState.CS_PAN | EMapCursorState.CS_ZOOM | EMapCursorState.CS_CONTEXTUAL_MENU | EMapCursorState.CS_DIALOG

static

◆ STATE_HOVER_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_HOVER_RESTRICTED

static

Initial value:

= EMapCursorState.CS_PAN | EMapCursorState.CS_ZOOM | EMapCursorState.CS_MULTI_SELECTION

| EMapCursorState.CS_DRAG | EMapCursorState.CS_DRAW | EMapCursorState.CS_CONTEXTUAL_MENU

◆ STATE_MULTISELECT_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_MULTISELECT_RESTRICTED = EMapCursorState.CS_DRAG | EMapCursorState.CS_DRAW | EMapCursorState.CS_CONTEXTUAL_MENU | EMapCursorState.CS_MODIFIER

static

◆ STATE_PAN_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_PAN_RESTRICTED = EMapCursorState.CS_DRAG | EMapCursorState.CS_MODIFIER | EMapCursorState.CS_CONTEXTUAL_MENU | EMapCursorState.CS_DIALOG

static

◆ STATE_POPUP_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_POPUP_RESTRICTED = EMapCursorState.CS_PAN | EMapCursorState.CS_DRAW | EMapCursorState.CS_ROTATE

static

◆ STATE_RESET_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_RESET_RESTRICTED = EMapCursorState.CS_DRAG | EMapCursorState.CS_DRAW | EMapCursorState.CS_ROTATE

static

◆ STATE_ROTATE_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_ROTATE_RESTRICTED = EMapCursorState.CS_PAN | EMapCursorState.CS_ZOOM | EMapCursorState.CS_CONTEXTUAL_MENU

static

◆ STATE_SELECT_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_SELECT_RESTRICTED = EMapCursorState.CS_MULTI_SELECTION | EMapCursorState.CS_CONTEXTUAL_MENU | EMapCursorState.CS_DRAG | EMapCursorState.CS_DRAW

static

◆ STATE_SUBMENU_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_SUBMENU_RESTRICTED = EMapCursorState.CS_CONTEXTUAL_MENU | EMapCursorState.CS_DIALOG

static

◆ STATE_ZOOM_RESTRICTED

const EMapCursorState SCR_MapCursorModule.STATE_ZOOM_RESTRICTED = EMapCursorState.CS_DRAG | EMapCursorState.CS_MODIFIER | EMapCursorState.CS_CONTEXTUAL_MENU

static

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

Game/Map/Modules/SCR_MapCursorModule.c

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_MapCursorModule()

Member Function Documentation

◆ CalculatePan()

◆ CleanupInputs()

◆ ForceCenterCursor()

◆ GetCursorInfo()

◆ GetCursorPosition()

◆ GetCursorSelection()

◆ GetCursorState()

◆ GetCursorStateCfg()

◆ GetMapWidgetsUnderCursor()

◆ HandleContextualMenu()

◆ HandleDialog()

◆ HandleDrag()

◆ HandleDraw()

◆ HandleHover()

◆ HandleMove()

◆ HandleMultiSelect()

◆ HandlePan()

◆ HandleRotateTool()

◆ HandleSelect()

◆ HandleSubMenu()

◆ HandleZoom()

◆ InitInputs()

◆ InitWidgets()

◆ OnInputDeviceIsGamepad()

◆ OnInputDrag()

◆ OnInputDragToggle()

◆ OnInputGamepadCursorH()

◆ OnInputGamepadCursorV()

◆ OnInputModifClick()

◆ OnInputModifier()

◆ OnInputMultiSel()

◆ OnInputMultiSelGamepad()

◆ OnInputPanDrag()

◆ OnInputPanH()

◆ OnInputPanHGamepad()

◆ OnInputPanV()

◆ OnInputPanVGamepad()

◆ OnInputZoom()

◆ OnInputZoomWheelDown()

◆ OnInputZoomWheelUp()

◆ OnMapClose()

◆ OnMapOpen()

◆ OnPauseMenuClosed()

◆ OnPauseMenuOpened()

◆ SetCrosshairGridVisible()

◆ SetCursorState()

◆ SetCursorType()

◆ SetWheelZoomMultiplier()

◆ TestEdgePan()

◆ ToggleFastTravelDestinationSelection()

◆ TraceMapWidgets()

◆ UnsetCursorState()

◆ Update()

◆ UpdateCrosshairUI()

Member Data Documentation

◆ CIRCLE_SELECTION_RANGE

◆ CURSOR_CAPTURE_OFFSET

◆ CUSTOM_CURSOR_LOCKED

◆ FREE_CURSOR_RESET

◆ GUILDING_LINE_WIDTH

◆ m_aCursorStatesConfig

◆ m_aCursorStatesMap

◆ m_bEnableCrosshairCoords

◆ m_bEnableCursorEdgePan

◆ m_bEnableMapCrosshairVisuals

◆ m_bIsCursorCenteredOnOpen

◆ m_bIsDisabled

◆ m_bIsDraggingAvailable