SandBox.View.Map.MapScreen Class Reference

Inherits ScreenBase, TaleWorlds.CampaignSystem.GameState.IMapStateHandler, and TaleWorlds.Core.IGameStateListener.

Public Member Functions
	MapScreen (MapState mapState)
void	OnHoverMapEntity (IMapEntity mapEntity)
void	SetupMapTooltipForTrack (Track track)
void	RemoveMapTooltip ()
void	ClearGPUMemory ()
override void	OnFocusChangeOnGameWindow (bool focusGained)
MapView	AddMapView< T > (params object[] parameters)
T	GetMapView< T > ()
void	RemoveMapView (MapView mapView)
void	AddEncounterOverlay (GameOverlays.MenuOverlayType type)
void	AddArmyOverlay (GameOverlays.MapOverlayType type)
void	RemoveEncounterOverlay ()
void	RemoveArmyOverlay ()
void	OnHourlyTick ()
void	SetMapScreenSceneDebugInfo (bool enabled)
void	OnExit ()
void	GetCursorIntersectionPoint (ref Vec3 clippedMouseNear, ref Vec3 clippedMouseFar, out float closestDistanceSquared, out Vec3 intersectionPoint, ref PathFaceRecord currentFace, BodyFlags excludedBodyFlags=BodyFlags.CommonFocusRayCastExcludeFlags)
void	FastMoveCameraToPosition (Vec2 target)
void	SetIsInTownManagement (bool isInTownManagement)
void	SetIsInHideoutTroopManage (bool isInHideoutTroopManage)
void	SetIsInArmyManagement (bool isInArmyManagement)
void	SetIsInRecruitment (bool isInRecruitment)
void	SetIsBarExtended (bool isBarExtended)
void	SetIsInCampaignOptions (bool isInCampaignOptions)
void	SetIsMarriageOfferPopupActive (bool isMarriageOfferPopupActive)
void	SetIsMapCheatsActive (bool isMapCheatsActive)
void	SetMouseVisible (bool value)
bool	GetMouseVisible ()
void	RestartAmbientSounds ()
void	PauseAmbientSounds ()
void	StopSoundSceneProps ()
void	ApplySoundSceneProps (float dt)
void	OnPauseTick (float dt)
MBCampaignEvent	CreatePeriodicUIEvent (CampaignTime triggerPeriod, CampaignTime initialWait)
void	DeletePeriodicUIEvent (MBCampaignEvent campaignEvent)
void	OpenOptions ()
void	OpenEncyclopedia ()
void	OpenSaveLoad (bool isSaving)
void	CloseGameplayCheats ()
void	CloseEscapeMenu ()
void	OpenEscapeMenu ()
void	CloseCampaignOptions ()
void	OpenInventory ()
void	OpenFacegenScreenAux ()
void	FastMoveCameraToMainParty ()
void	ResetCamera (bool resetDistance, bool teleportToMainParty)
void	TeleportCameraToMainParty ()
bool	IsCameraLockedToPlayerParty ()
void	OnRefreshState ()
void	OnMainPartyEncounter ()
void	BeforeTick (float dt)
void	Tick (float dt)
void	AfterTick (float dt)
void	AfterWaitTick (float dt)
void	OnIdleTick (float dt)
void	OnSignalPeriodicEvents ()
void	OnExit ()
void	ResetCamera (bool resetDistance, bool teleportToMainParty)
void	TeleportCameraToMainParty ()
void	FastMoveCameraToMainParty ()
bool	IsCameraLockedToPlayerParty ()
void	StartCameraAnimation (Vec2 targetPosition, float animationStopDuration)
void	OnHourlyTick ()
void	OnMenuModeTick (float dt)
void	OnEnteringMenuMode (MenuContext menuContext)
void	OnExitingMenuMode ()
void	OnBattleSimulationStarted (BattleSimulation battleSimulation)
void	OnBattleSimulationEnded ()
void	OnGameplayCheatsEnabled ()
void	OnMapConversationStarts (ConversationCharacterData playerCharacterData, ConversationCharacterData conversationPartnerData)
void	OnMapConversationOver ()
void	OnPlayerSiegeActivated ()
void	OnPlayerSiegeDeactivated ()
void	OnSiegeEngineClick (MatrixFrame siegeEngineFrame)
void	OnActivate ()
void	OnDeactivate ()
void	OnInitialize ()
void	OnFinalize ()

Public Attributes
MapCameraView	_mapCameraView
Dictionary< Tuple< Material, BannerCode >, Material >	_characterBannerMaterialCache = new Dictionary<Tuple<Material, BannerCode>, Material>()
IMapTracksCampaignBehavior	MapTracksCampaignBehavior
bool	TooltipHandlingDisabled = false

Protected Member Functions
override void	OnResume ()
override void	OnPause ()
override void	OnActivate ()
override void	OnDeactivate ()
override void	OnInitialize ()
override void	OnFinalize ()
override void	OnFrameTick (float dt)

Properties
CampaignMapSiegePrefabEntityCache	PrefabEntityCache [get]
MapEncyclopediaView	EncyclopediaScreenManager [get]
MapNotificationView	MapNotificationView [get]
bool	IsInMenu [get]
bool	IsEscapeMenuOpened [get]
PartyVisual	CurrentVisualOfTooltip [get]
SceneLayer	SceneLayer [get]
IInputContext	Input [get]
bool	IsReady [get]
static MapScreen	Instance [get]
bool	IsInBattleSimulation [get]
bool	IsInTownManagement [get]
bool	IsInHideoutTroopManage [get]
bool	IsInArmyManagement [get]
bool	IsInRecruitment [get]
bool	IsBarExtended [get]
bool	IsInCampaignOptions [get]
bool	IsMarriageOfferPopupActive [get]
bool	IsMapCheatsActive [get]
Dictionary< Tuple< Material, BannerCode >, Material >	BannerTexturedMaterialCache [get]
bool	MapSceneCursorActive [get, set]
GameEntity	ContourMaskEntity [get]
List< Mesh >	InactiveLightMeshes [get]
List< Mesh >	ActiveLightMeshes [get]
static Dictionary< UIntPtr, PartyVisual >	VisualsOfEntities [get]

Constructor & Destructor Documentation

MapScreen()

SandBox.View.Map.MapScreen.MapScreen

(

MapState

mapState

)

Member Function Documentation

OnHoverMapEntity()

void SandBox.View.Map.MapScreen.OnHoverMapEntity

(

IMapEntity

mapEntity

)

SetupMapTooltipForTrack()

void SandBox.View.Map.MapScreen.SetupMapTooltipForTrack

(

Track

track

)

RemoveMapTooltip()

void SandBox.View.Map.MapScreen.RemoveMapTooltip

(

)

OnResume()

override void SandBox.View.Map.MapScreen.OnResume ( )

protected

OnPause()

override void SandBox.View.Map.MapScreen.OnPause ( )

protected

OnActivate()

override void SandBox.View.Map.MapScreen.OnActivate ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

ClearGPUMemory()

void SandBox.View.Map.MapScreen.ClearGPUMemory

(

)

OnDeactivate()

override void SandBox.View.Map.MapScreen.OnDeactivate ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

OnFocusChangeOnGameWindow()

override void SandBox.View.Map.MapScreen.OnFocusChangeOnGameWindow

(

bool

focusGained

)

AddMapView< T >()

MapView SandBox.View.Map.MapScreen.AddMapView< T >

(

params object[]

parameters

)

Type Constraints

T	:	MapView
T	:	new()

GetMapView< T >()

T SandBox.View.Map.MapScreen.GetMapView< T >

(

)

Type Constraints

T

:

MapView

RemoveMapView()

void SandBox.View.Map.MapScreen.RemoveMapView

(

MapView

mapView

)

AddEncounterOverlay()

void SandBox.View.Map.MapScreen.AddEncounterOverlay

(

GameOverlays::MenuOverlayType

type

)

AddArmyOverlay()

void SandBox.View.Map.MapScreen.AddArmyOverlay

(

GameOverlays::MapOverlayType

type

)

RemoveEncounterOverlay()

void SandBox.View.Map.MapScreen.RemoveEncounterOverlay

(

)

RemoveArmyOverlay()

void SandBox.View.Map.MapScreen.RemoveArmyOverlay

(

)

OnInitialize()

override void SandBox.View.Map.MapScreen.OnInitialize ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

OnFinalize()

override void SandBox.View.Map.MapScreen.OnFinalize ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

OnHourlyTick()

void SandBox.View.Map.MapScreen.OnHourlyTick

(

)

Implements TaleWorlds.CampaignSystem.GameState.IMapStateHandler.

OnFrameTick()

override void SandBox.View.Map.MapScreen.OnFrameTick ( float  dt )

protected

SetMapScreenSceneDebugInfo()

void SandBox.View.Map.MapScreen.SetMapScreenSceneDebugInfo

(

bool

enabled

)

OnExit()

void SandBox.View.Map.MapScreen.OnExit

(

)

Implements TaleWorlds.CampaignSystem.GameState.IMapStateHandler.

GetCursorIntersectionPoint()

void SandBox.View.Map.MapScreen.GetCursorIntersectionPoint	(	ref Vec3	clippedMouseNear,
		ref Vec3	clippedMouseFar,
		out float	closestDistanceSquared,
		out Vec3	intersectionPoint,
		ref PathFaceRecord	currentFace,
		BodyFlags	excludedBodyFlags = BodyFlags::CommonFocusRayCastExcludeFlags
	)

FastMoveCameraToPosition()

void SandBox.View.Map.MapScreen.FastMoveCameraToPosition

(

Vec2

target

)

SetIsInTownManagement()

void SandBox.View.Map.MapScreen.SetIsInTownManagement

(

bool

isInTownManagement

)

SetIsInHideoutTroopManage()

void SandBox.View.Map.MapScreen.SetIsInHideoutTroopManage

(

bool

isInHideoutTroopManage

)

SetIsInArmyManagement()

void SandBox.View.Map.MapScreen.SetIsInArmyManagement

(

bool

isInArmyManagement

)

SetIsInRecruitment()

void SandBox.View.Map.MapScreen.SetIsInRecruitment

(

bool

isInRecruitment

)

SetIsBarExtended()

void SandBox.View.Map.MapScreen.SetIsBarExtended

(

bool

isBarExtended

)

SetIsInCampaignOptions()

void SandBox.View.Map.MapScreen.SetIsInCampaignOptions

(

bool

isInCampaignOptions

)

SetIsMarriageOfferPopupActive()

void SandBox.View.Map.MapScreen.SetIsMarriageOfferPopupActive

(

bool

isMarriageOfferPopupActive

)

SetIsMapCheatsActive()

void SandBox.View.Map.MapScreen.SetIsMapCheatsActive

(

bool

isMapCheatsActive

)

SetMouseVisible()

void SandBox.View.Map.MapScreen.SetMouseVisible

(

bool

value

)

GetMouseVisible()

bool SandBox.View.Map.MapScreen.GetMouseVisible

(

)

RestartAmbientSounds()

void SandBox.View.Map.MapScreen.RestartAmbientSounds

(

)

PauseAmbientSounds()

void SandBox.View.Map.MapScreen.PauseAmbientSounds

(

)

StopSoundSceneProps()

void SandBox.View.Map.MapScreen.StopSoundSceneProps

(

)

ApplySoundSceneProps()

void SandBox.View.Map.MapScreen.ApplySoundSceneProps

(

float

dt

)

OnPauseTick()

void SandBox.View.Map.MapScreen.OnPauseTick

(

float

dt

)

CreatePeriodicUIEvent()

MBCampaignEvent SandBox.View.Map.MapScreen.CreatePeriodicUIEvent	(	CampaignTime	triggerPeriod,
		CampaignTime	initialWait
	)

DeletePeriodicUIEvent()

void SandBox.View.Map.MapScreen.DeletePeriodicUIEvent

(

MBCampaignEvent

campaignEvent

)

OpenOptions()

void SandBox.View.Map.MapScreen.OpenOptions

(

)

OpenEncyclopedia()

void SandBox.View.Map.MapScreen.OpenEncyclopedia

(

)

OpenSaveLoad()

void SandBox.View.Map.MapScreen.OpenSaveLoad

(

bool

isSaving

)

CloseGameplayCheats()

void SandBox.View.Map.MapScreen.CloseGameplayCheats

(

)

CloseEscapeMenu()

void SandBox.View.Map.MapScreen.CloseEscapeMenu

(

)

OpenEscapeMenu()

void SandBox.View.Map.MapScreen.OpenEscapeMenu

(

)

CloseCampaignOptions()

void SandBox.View.Map.MapScreen.CloseCampaignOptions

(

)

OpenInventory()

void SandBox.View.Map.MapScreen.OpenInventory

(

)

OpenFacegenScreenAux()

void SandBox.View.Map.MapScreen.OpenFacegenScreenAux

(

)

FastMoveCameraToMainParty()

void SandBox.View.Map.MapScreen.FastMoveCameraToMainParty

(

)

Implements TaleWorlds.CampaignSystem.GameState.IMapStateHandler.

ResetCamera()

void SandBox.View.Map.MapScreen.ResetCamera	(	bool	resetDistance,
		bool	teleportToMainParty
	)

Implements TaleWorlds.CampaignSystem.GameState.IMapStateHandler.

TeleportCameraToMainParty()

void SandBox.View.Map.MapScreen.TeleportCameraToMainParty

(

)

Implements TaleWorlds.CampaignSystem.GameState.IMapStateHandler.

IsCameraLockedToPlayerParty()

bool SandBox.View.Map.MapScreen.IsCameraLockedToPlayerParty

(

)

Implements TaleWorlds.CampaignSystem.GameState.IMapStateHandler.

Member Data Documentation

_mapCameraView

MapCameraView SandBox.View.Map.MapScreen._mapCameraView

_characterBannerMaterialCache

Dictionary<Tuple<Material, BannerCode>, Material> SandBox.View.Map.MapScreen._characterBannerMaterialCache = new Dictionary<Tuple<Material, BannerCode>, Material>()

MapTracksCampaignBehavior

IMapTracksCampaignBehavior SandBox.View.Map.MapScreen.MapTracksCampaignBehavior

TooltipHandlingDisabled

bool SandBox.View.Map.MapScreen.TooltipHandlingDisabled = false

Property Documentation

PrefabEntityCache

CampaignMapSiegePrefabEntityCache SandBox.View.Map.MapScreen.PrefabEntityCache

get

EncyclopediaScreenManager

MapEncyclopediaView SandBox.View.Map.MapScreen.EncyclopediaScreenManager

get

MapNotificationView

MapNotificationView SandBox.View.Map.MapScreen.MapNotificationView

get

IsInMenu

bool SandBox.View.Map.MapScreen.IsInMenu

get

IsEscapeMenuOpened

bool SandBox.View.Map.MapScreen.IsEscapeMenuOpened

get

CurrentVisualOfTooltip

PartyVisual SandBox.View.Map.MapScreen.CurrentVisualOfTooltip

get

SceneLayer

SceneLayer SandBox.View.Map.MapScreen.SceneLayer

get

Input

IInputContext SandBox.View.Map.MapScreen.Input

get

IsReady

bool SandBox.View.Map.MapScreen.IsReady

get

Instance

MapScreen SandBox.View.Map.MapScreen.Instance

staticget

IsInBattleSimulation

bool SandBox.View.Map.MapScreen.IsInBattleSimulation

get

IsInTownManagement

bool SandBox.View.Map.MapScreen.IsInTownManagement

get

IsInHideoutTroopManage

bool SandBox.View.Map.MapScreen.IsInHideoutTroopManage

get

IsInArmyManagement

bool SandBox.View.Map.MapScreen.IsInArmyManagement

get

IsInRecruitment

bool SandBox.View.Map.MapScreen.IsInRecruitment

get

IsBarExtended

bool SandBox.View.Map.MapScreen.IsBarExtended

get

IsInCampaignOptions

bool SandBox.View.Map.MapScreen.IsInCampaignOptions

get

IsMarriageOfferPopupActive

bool SandBox.View.Map.MapScreen.IsMarriageOfferPopupActive

get

IsMapCheatsActive

bool SandBox.View.Map.MapScreen.IsMapCheatsActive

get

BannerTexturedMaterialCache

Dictionary<Tuple<Material, BannerCode>, Material> SandBox.View.Map.MapScreen.BannerTexturedMaterialCache

get

MapSceneCursorActive

bool SandBox.View.Map.MapScreen.MapSceneCursorActive

getset

ContourMaskEntity

GameEntity SandBox.View.Map.MapScreen.ContourMaskEntity

get

InactiveLightMeshes

List<Mesh> SandBox.View.Map.MapScreen.InactiveLightMeshes

get

ActiveLightMeshes

List<Mesh> SandBox.View.Map.MapScreen.ActiveLightMeshes

get

VisualsOfEntities

Dictionary<UIntPtr, PartyVisual> SandBox.View.Map.MapScreen.VisualsOfEntities

staticget