SCR_MapCompassUI Interface Reference

Compass in map UI. More...

Inheritance diagram for SCR_MapCompassUI:

Public Member Functions
override void	SetWidgetNames ()
	Set widget names.
override void	InitPositionVectors ()
	Initialise RT camera and prefab positon.
override void	SetVisible (bool visible)
	Set visibility.
override void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
override void	Update (float timeSlice)
	Update method for frame operations.
void	SCR_MapCompassUI ()
Public Member Functions inherited from SCR_MapRTWBaseUI
IEntity	FindRelatedGadget ()
	Find related gadget in inventory.
void	SetFrameVisible ()
	TODO Frame is now set through script here instead of directly in callqueue to avoid leak.
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
override void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.
void	SCR_MapRTWBaseUI ()
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
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.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Protected Member Functions
void	UpdateCompassEntity ()
	Update for the compass entity within preview world.
void	OnInputQuickBind (float value, EActionTrigger reason)
override string	GetPrefabResource ()
	Get prefab resource for display.
Protected Member Functions inherited from SCR_MapRTWBaseUI
void	SetWidgetNames ()
	Set widget names.
void	InitPositionVectors ()
	Initialise RT camera and prefab positon.
string	GetPrefabResource ()
	Get prefab resource for display.
void	ToggleVisible ()
	Visibility toggle.
void	SetVisible (bool visible)
	Set visibility.
bool	SetupRTWorld ()
	Setup preview world.
bool	SpawnPrefab ()
	Spawn prefab in the preview world.
void	SetSize (bool nextSize=false)
	Set size of RTW widget, cyclying through an array of prepared sizes.
void	OnDragWidget (Widget widget)
	Drag event.
void	OnActivateTool (Widget widget)
	SCR_MapToolInteractionUI event.
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
SCR_CompassComponent	m_CompassComp
string	m_sPrefabResource
Protected Attributes inherited from SCR_MapRTWBaseUI
ref array< ref ToolSize >	m_aSizesArray
string	WIDGET_NAME
string	RT_WIDGET_NAME
string	WORLD_RESOURCE = "{88ABCDC0EEC969DF}Prefabs/World/PreviewWorld/MapCompassWorld.et"
string	WORLD_NAME
vector	m_vPrefabPos
vector	m_vCameraPos
vector	m_vCameraAngle
bool	m_bIsVisible
bool	m_bWantedVisible
bool	m_bIsDragged = false
int	m_iCurrentSizeIndex
int	m_iSizesCount
float	m_fPosX
float	m_fPosY
EGadgetType	m_eGadgetType
GenericEntity	m_RTEntity
ref SharedItemRef	m_RTWorld
SCR_MapToolEntry	m_ToolMenuEntry
Widget	m_wFrame
RenderTargetWidget	m_wRenderTarget
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Static Protected Attributes
static const string	ICON_NAME = "compass"
Static Protected Attributes inherited from SCR_MapRTWBaseUI
static const string	BASE_WORLD_TYPE = "ChimeraWorld"
static const float	CAMERA_VERTICAL_FOV = 43

Detailed Description

Compass in map UI.

Constructor & Destructor Documentation

SCR_MapCompassUI()

void SCR_MapCompassUI.SCR_MapCompassUI

(

)

Member Function Documentation

GetPrefabResource()

override string SCR_MapCompassUI.GetPrefabResource ( )

protected

Get prefab resource for display.

Returns

prefab resource

Implements SCR_MapRTWBaseUI.

Implemented in SCR_MapCompassUIDeploy.

Init()

override void SCR_MapCompassUI.Init

(

)

Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.

Implements SCR_MapUIBaseComponent.

InitPositionVectors()

override void SCR_MapCompassUI.InitPositionVectors

(

)

Initialise RT camera and prefab positon.

Implements SCR_MapRTWBaseUI.

OnInputQuickBind()

void SCR_MapCompassUI.OnInputQuickBind ( float  value, EActionTrigger  reason  )

protected

SetVisible()

override void SCR_MapCompassUI.SetVisible

(

bool

visible

)

Set visibility.

Parameters

[in]

visible

is true/false switch

Implements SCR_MapRTWBaseUI.

SetWidgetNames()

override void SCR_MapCompassUI.SetWidgetNames

(

)

Set widget names.

Implements SCR_MapRTWBaseUI.

Update()

override void SCR_MapCompassUI.Update

(

float

timeSlice

)

Update method for frame operations.

Implements SCR_MapUIBaseComponent.

UpdateCompassEntity()

void SCR_MapCompassUI.UpdateCompassEntity ( )

protected

Update for the compass entity within preview world.

Member Data Documentation

ICON_NAME

const string SCR_MapCompassUI.ICON_NAME = "compass"

staticprotected

m_CompassComp

SCR_CompassComponent SCR_MapCompassUI.m_CompassComp

protected

m_sPrefabResource

string SCR_MapCompassUI.m_sPrefabResource

protected

---

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

• Game/Map/ComponentsUI/SCR_MapCompassUI.c