TaleWorlds.MountAndBlade.View.Screens.MissionScreen Class Reference

Inherits ScreenBase, TaleWorlds.MountAndBlade.IMissionSystemHandler, TaleWorlds.Core.IGameStateListener, TaleWorlds.MountAndBlade.ViewModelCollection.IMissionScreen, and TaleWorlds.MountAndBlade.IMissionListener.

Public Member Functions
delegate void	OnSpectateAgentDelegate (Agent followedAgent)
delegate List< Agent >	GatherCustomAgentListToSpectateDelegate (Agent forcedAgentToInclude)
void	SetOrderFlagVisibility (bool value)
string	GetFollowText ()
string	GetFollowPartyText ()
bool	SetDisplayDialog (bool value)
	MissionScreen (MissionState missionState)
override void	OnFocusChangeOnGameWindow (bool focusGained)
bool	IsOpeningEscapeMenuOnFocusChangeAllowed ()
void	SetExtraCameraParameters (bool newForceCanZoom, float newCameraRayCastStartingPointOffset)
void	SetCustomAgentListToSpectateGatherer (GatherCustomAgentListToSpectateDelegate gatherer)
void	UpdateFreeCamera (MatrixFrame frame)
void	OnMainAgentWeaponChanged ()
bool	IsViewingCharacter ()
float	GetCameraToggleProgress ()
void	AddMissionView (MissionView missionView)
void	ScreenPointToWorldRay (Vec2 screenPoint, out Vec3 rayBegin, out Vec3 rayEnd)
bool	GetProjectedMousePositionOnGround (out Vec3 groundPosition, out Vec3 groundNormal, BodyFlags excludeBodyOwnerFlags, bool checkOccludedSurface)
void	CancelQuickPositionOrder ()
bool	MissionStartedRendering ()
Vec3	GetOrderFlagPosition ()
MatrixFrame	GetOrderFlagFrame ()
void	SetRadialMenuActiveState (bool isActive)
void	SetPhotoModeRequiresMouse (bool isRequired)
void	SetPhotoModeEnabled (bool isEnabled)
void	SetConversationActive (bool isActive)
void	SetCameraLockState (bool isLocked)
void	RegisterView (MissionView missionView)
void	UnregisterView (MissionView missionView)
IAgentVisual	GetPlayerAgentVisuals (MissionPeer lobbyPeer)
void	SetAgentToFollow (Agent agent)
Mission.SpectatorData	GetSpectatingData (Vec3 currentCameraPosition)
void	OnEscape ()
void	OnMissionAfterStarting (Mission mission)
void	OnMissionLoadingFinished (Mission mission)
void	BeforeMissionTick (Mission mission, float realDt)
void	AfterMissionTick (Mission mission, float realDt)
void	UpdateCamera (Mission mission, float realDt)
bool	RenderIsReady ()
IEnumerable< MissionBehavior >	OnAddBehaviors (IEnumerable< MissionBehavior > behaviors, Mission mission, string missionName, bool addDefaultMissionBehaviors)
void	OnActivate ()
void	OnDeactivate ()
void	OnInitialize ()
void	OnFinalize ()
bool	GetDisplayDialog ()
float	GetCameraElevation ()
void	SetOrderFlagVisibility (bool value)
string	GetFollowText ()
string	GetFollowPartyText ()
void	OnEquipItemsFromSpawnEquipmentBegin (Agent agent, Agent.CreationType creationType)
void	OnEquipItemsFromSpawnEquipment (Agent agent, Agent.CreationType creationType)
void	OnEndMission ()
void	OnMissionModeChange (MissionMode oldMissionMode, bool atStart)
void	OnConversationCharacterChanged ()
void	OnResetMission ()
void	OnInitialDeploymentPlanMade (BattleSideEnum battleSide, bool isFirstPlan)

Static Public Member Functions
static string	ToggleFixedMissionCamera (List< String > strings)
static void	SetFixedMissionCameraActive (bool active)
static string	SetShiftCameraSpeed (List< String > strings)
static string	SetCameraPosition (List< String > strings)

Public Attributes
Func< BasicCharacterObject >	GetSpectatedCharacter

Static Public Attributes
const int	LoadingScreenFramesLeftInitial = 15
const float	MinCameraAddedDistance = 0.7f
const float	MinCameraDistanceHardLimit = 0.48f
const float	MaxCameraAddedDistance = 2.4f
const float	DefaultViewAngle = 65.0f
const float	FirstPersonNearClippingDistance = 0.065f
const float	ThirdPersonNearClippingDistance = 0.1f
const float	FarClippingDistance = 12500.0f

Protected Member Functions
override void	OnInitialize ()
	This method is called only ones before onactivate.
override void	OnActivate ()
override void	OnResume ()
override void	OnFrameTick (float dt)
override void	OnDeactivate ()
	On Deactivate handler.
override void	OnFinalize ()

Properties
bool	LockCameraMovement [get]
OrderFlag	OrderFlag [get, set]
Camera	CombatCamera [get]
Camera	CustomCamera [get, set]
float	CameraBearing [get]
float	MaxCameraZoom = 1.0f [get]
float	CameraElevation [get]
float	CameraResultDistanceToTarget [get]
float	CameraViewAngle [get]
bool	IsPhotoModeEnabled [get]
	Represents if the screen and scene is in the Photo mode. Scene setting can change in cpp, but shouldn't.
bool	IsConversationActive [get]
bool	IsDeploymentActive [get]
SceneLayer	SceneLayer [get]
SceneView	SceneView [get]
Mission	Mission [get]
bool	IsCheatGhostMode [get, set]
bool	IsRadialMenuActive [get]
IInputContext	InputManager [get]
Agent	LastFollowedAgent [get]
IAgentVisual	LastFollowedAgentVisuals [get, set]
override bool	MouseVisible [get]
bool	IsMissionTickable [get]
bool	PhotoModeRequiresMouse [get]
bool	IsFocusLost [get]

Events
OnSpectateAgentDelegate	OnSpectateAgentFocusIn
OnSpectateAgentDelegate	OnSpectateAgentFocusOut

Constructor & Destructor Documentation

MissionScreen()

TaleWorlds.MountAndBlade.View.Screens.MissionScreen.MissionScreen

(

MissionState

missionState

)

Member Function Documentation

OnSpectateAgentDelegate()

delegate void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnSpectateAgentDelegate

(

Agent

followedAgent

)

GatherCustomAgentListToSpectateDelegate()

delegate List< Agent > TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GatherCustomAgentListToSpectateDelegate

(

Agent

forcedAgentToInclude

)

SetOrderFlagVisibility()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetOrderFlagVisibility

(

bool

value

)

Implements TaleWorlds.MountAndBlade.ViewModelCollection.IMissionScreen.

GetFollowText()

string TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetFollowText

(

)

Implements TaleWorlds.MountAndBlade.ViewModelCollection.IMissionScreen.

GetFollowPartyText()

string TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetFollowPartyText

(

)

Implements TaleWorlds.MountAndBlade.ViewModelCollection.IMissionScreen.

SetDisplayDialog()

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetDisplayDialog

(

bool

value

)

OnInitialize()

override void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnInitialize ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

OnActivate()

override void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnActivate ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

OnResume()

override void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnResume ( )

protected

OnFocusChangeOnGameWindow()

override void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnFocusChangeOnGameWindow

(

bool

focusGained

)

IsOpeningEscapeMenuOnFocusChangeAllowed()

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsOpeningEscapeMenuOnFocusChangeAllowed

(

)

SetExtraCameraParameters()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetExtraCameraParameters	(	bool	newForceCanZoom,
		float	newCameraRayCastStartingPointOffset
	)

SetCustomAgentListToSpectateGatherer()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetCustomAgentListToSpectateGatherer

(

GatherCustomAgentListToSpectateDelegate

gatherer

)

UpdateFreeCamera()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.UpdateFreeCamera

(

MatrixFrame

frame

)

OnFrameTick()

override void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnFrameTick ( float  dt )

protected

OnMainAgentWeaponChanged()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnMainAgentWeaponChanged

(

)

OnDeactivate()

override void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnDeactivate ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

OnFinalize()

override void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnFinalize ( )

protected

Implements TaleWorlds.Core.IGameStateListener.

ToggleFixedMissionCamera()

static string TaleWorlds.MountAndBlade.View.Screens.MissionScreen.ToggleFixedMissionCamera ( List< String >  strings )

static

SetFixedMissionCameraActive()

static void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetFixedMissionCameraActive ( bool  active )

static

SetShiftCameraSpeed()

static string TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetShiftCameraSpeed ( List< String >  strings )

static

SetCameraPosition()

static string TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetCameraPosition ( List< String >  strings )

static

IsViewingCharacter()

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsViewingCharacter

(

)

GetCameraToggleProgress()

float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetCameraToggleProgress

(

)

AddMissionView()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.AddMissionView

(

MissionView

missionView

)

ScreenPointToWorldRay()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.ScreenPointToWorldRay	(	Vec2	screenPoint,
		out Vec3	rayBegin,
		out Vec3	rayEnd
	)

GetProjectedMousePositionOnGround()

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetProjectedMousePositionOnGround	(	out Vec3	groundPosition,
		out Vec3	groundNormal,
		BodyFlags	excludeBodyOwnerFlags,
		bool	checkOccludedSurface
	)

Parameters

groundPosition

Returns

Returns whether mouse cursor is on ground or not.

CancelQuickPositionOrder()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.CancelQuickPositionOrder

(

)

MissionStartedRendering()

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.MissionStartedRendering

(

)

GetOrderFlagPosition()

Vec3 TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetOrderFlagPosition

(

)

GetOrderFlagFrame()

MatrixFrame TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetOrderFlagFrame

(

)

SetRadialMenuActiveState()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetRadialMenuActiveState

(

bool

isActive

)

SetPhotoModeRequiresMouse()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetPhotoModeRequiresMouse

(

bool

isRequired

)

SetPhotoModeEnabled()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetPhotoModeEnabled

(

bool

isEnabled

)

SetConversationActive()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetConversationActive

(

bool

isActive

)

SetCameraLockState()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetCameraLockState

(

bool

isLocked

)

RegisterView()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.RegisterView

(

MissionView

missionView

)

UnregisterView()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.UnregisterView

(

MissionView

missionView

)

GetPlayerAgentVisuals()

IAgentVisual TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetPlayerAgentVisuals

(

MissionPeer

lobbyPeer

)

SetAgentToFollow()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SetAgentToFollow

(

Agent

agent

)

GetSpectatingData()

Mission.SpectatorData TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetSpectatingData

(

Vec3

currentCameraPosition

)

OnEscape()

void TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnEscape

(

)

Member Data Documentation

LoadingScreenFramesLeftInitial

const int TaleWorlds.MountAndBlade.View.Screens.MissionScreen.LoadingScreenFramesLeftInitial = 15

static

GetSpectatedCharacter

Func<BasicCharacterObject> TaleWorlds.MountAndBlade.View.Screens.MissionScreen.GetSpectatedCharacter

MinCameraAddedDistance

const float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.MinCameraAddedDistance = 0.7f

static

MinCameraDistanceHardLimit

const float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.MinCameraDistanceHardLimit = 0.48f

static

MaxCameraAddedDistance

const float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.MaxCameraAddedDistance = 2.4f

static

DefaultViewAngle

const float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.DefaultViewAngle = 65.0f

static

FirstPersonNearClippingDistance

const float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.FirstPersonNearClippingDistance = 0.065f

static

ThirdPersonNearClippingDistance

const float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.ThirdPersonNearClippingDistance = 0.1f

static

FarClippingDistance

const float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.FarClippingDistance = 12500.0f

static

Property Documentation

LockCameraMovement

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.LockCameraMovement

get

OrderFlag

OrderFlag TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OrderFlag

getset

CombatCamera

Camera TaleWorlds.MountAndBlade.View.Screens.MissionScreen.CombatCamera

get

CustomCamera

Camera TaleWorlds.MountAndBlade.View.Screens.MissionScreen.CustomCamera

getset

CameraBearing

float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.CameraBearing

get

MaxCameraZoom

float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.MaxCameraZoom = 1.0f

get

CameraElevation

float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.CameraElevation

get

CameraResultDistanceToTarget

float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.CameraResultDistanceToTarget

get

CameraViewAngle

float TaleWorlds.MountAndBlade.View.Screens.MissionScreen.CameraViewAngle

get

IsPhotoModeEnabled

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsPhotoModeEnabled

get

IsConversationActive

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsConversationActive

get

IsDeploymentActive

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsDeploymentActive

get

SceneLayer

SceneLayer TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SceneLayer

get

SceneView

SceneView TaleWorlds.MountAndBlade.View.Screens.MissionScreen.SceneView

get

Mission

Mission TaleWorlds.MountAndBlade.View.Screens.MissionScreen.Mission

get

IsCheatGhostMode

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsCheatGhostMode

getset

IsRadialMenuActive

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsRadialMenuActive

get

InputManager

IInputContext TaleWorlds.MountAndBlade.View.Screens.MissionScreen.InputManager

get

LastFollowedAgent

Agent TaleWorlds.MountAndBlade.View.Screens.MissionScreen.LastFollowedAgent

get

LastFollowedAgentVisuals

IAgentVisual TaleWorlds.MountAndBlade.View.Screens.MissionScreen.LastFollowedAgentVisuals

getset

MouseVisible

override bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.MouseVisible

get

IsMissionTickable

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsMissionTickable

get

PhotoModeRequiresMouse

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.PhotoModeRequiresMouse

get

IsFocusLost

bool TaleWorlds.MountAndBlade.View.Screens.MissionScreen.IsFocusLost

get

Event Documentation

OnSpectateAgentFocusIn

OnSpectateAgentDelegate TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnSpectateAgentFocusIn

OnSpectateAgentFocusOut

OnSpectateAgentDelegate TaleWorlds.MountAndBlade.View.Screens.MissionScreen.OnSpectateAgentFocusOut