SandBox.MapScene Class Reference

Inherits TaleWorlds.CampaignSystem.Map.IMapScene.

Public Member Functions
	MapScene ()
Vec2	GetTerrainSize ()
uint	GetSceneLevel (string name)
void	SetSceneLevels (List< string > levels)
List< AtmosphereState >	GetAtmosphereStates ()
void	ValidateAgentVisualsReseted ()
void	SetAtmosphereColorgrade (TerrainType terrainType)
void	AddNewEntityToMapScene (string entityId, Vec2 position)
void	GetFaceIndexForMultiplePositions (int movedPartyCount, float[] positionArray, PathFaceRecord[] resultArray)
void	GetMapBorders (out Vec2 minimumPosition, out Vec2 maximumPosition, out float maximumHeight)
	WARNING: Cache these values since obtaining them is costly.
void	Load ()
void	Destroy ()
void	DisableUnwalkableNavigationMeshes ()
PathFaceRecord	GetFaceIndex (Vec2 position)
bool	AreFacesOnSameIsland (PathFaceRecord startingFace, PathFaceRecord endFace, bool ignoreDisabled)
TerrainType	GetTerrainTypeAtPosition (Vec2 position)
TerrainType	GetFaceTerrainType (PathFaceRecord navMeshFace)
List< TerrainType >	GetEnvironmentTerrainTypes (Vec2 position)
List< TerrainType >	GetEnvironmentTerrainTypesCount (Vec2 position, out TerrainType currentPositionTerrainType)
MapPatchData	GetMapPatchAtPosition (Vec2 position)
Vec2	GetAccessiblePointNearPosition (Vec2 position, float radius)
bool	GetPathBetweenAIFaces (PathFaceRecord startingFace, PathFaceRecord endingFace, Vec2 startingPosition, Vec2 endingPosition, float agentRadius, NavigationPath path, int[] excludedFaceIds=null)
bool	GetPathDistanceBetweenAIFaces (PathFaceRecord startingAiFace, PathFaceRecord endingAiFace, Vec2 startingPosition, Vec2 endingPosition, float agentRadius, float distanceLimit, out float distance)
bool	IsLineToPointClear (PathFaceRecord startingFace, Vec2 position, Vec2 destination, float agentRadius)
Vec2	GetLastPointOnNavigationMeshFromPositionToDestination (PathFaceRecord startingFace, Vec2 position, Vec2 destination)
Vec2	GetNavigationMeshCenterPosition (PathFaceRecord face)
int	GetNumberOfNavigationMeshFaces ()
bool	GetHeightAtPoint (Vec2 point, ref float height)
float	GetWinterTimeFactor ()
float	GetFaceVertexZ (PathFaceRecord navMeshFace)
Vec3	GetGroundNormal (Vec2 position)
void	GetTerrainHeightAndNormal (Vec2 position, out float height, out Vec3 normal)
string	GetTerrainTypeName (TerrainType type)
void	GetSnowAmountData (byte[] snowData)
void	Load ()
void	Destroy ()
PathFaceRecord	GetFaceIndex (Vec2 position)
bool	AreFacesOnSameIsland (PathFaceRecord startingFace, PathFaceRecord endFace, bool ignoreDisabled)
TerrainType	GetTerrainTypeAtPosition (Vec2 position)
List< TerrainType >	GetEnvironmentTerrainTypes (Vec2 position)
List< TerrainType >	GetEnvironmentTerrainTypesCount (Vec2 position, out TerrainType currentPositionTerrainType)
MapPatchData	GetMapPatchAtPosition (Vec2 position)
TerrainType	GetFaceTerrainType (PathFaceRecord faceIndex)
Vec2	GetAccessiblePointNearPosition (Vec2 position, float radius)
bool	GetPathBetweenAIFaces (PathFaceRecord startingFace, PathFaceRecord endingFace, Vec2 startingPosition, Vec2 endingPosition, float agentRadius, NavigationPath path, int[] excludedFaceIds=null)
bool	GetPathDistanceBetweenAIFaces (PathFaceRecord startingAiFace, PathFaceRecord endingAiFace, Vec2 startingPosition, Vec2 endingPosition, float agentRadius, float distanceLimit, out float distance)
bool	IsLineToPointClear (PathFaceRecord startingFace, Vec2 position, Vec2 destination, float agentRadius)
Vec2	GetLastPointOnNavigationMeshFromPositionToDestination (PathFaceRecord startingFace, Vec2 position, Vec2 destination)
Vec2	GetNavigationMeshCenterPosition (PathFaceRecord face)
int	GetNumberOfNavigationMeshFaces ()
bool	GetHeightAtPoint (Vec2 point, ref float height)
float	GetWinterTimeFactor ()
void	GetTerrainHeightAndNormal (Vec2 position, out float height, out Vec3 normal)
float	GetFaceVertexZ (PathFaceRecord navMeshFace)
Vec3	GetGroundNormal (Vec2 position)
String	GetTerrainTypeName (TerrainType type)
Vec2	GetTerrainSize ()
uint	GetSceneLevel (string name)
void	SetSceneLevels (List< string > levels)
List< AtmosphereState >	GetAtmosphereStates ()
void	SetAtmosphereColorgrade (TerrainType terrainType)
void	AddNewEntityToMapScene (string entityId, Vec2 position)
void	GetFaceIndexForMultiplePositions (int movedPartyCount, float[] positionArray, PathFaceRecord[] resultArray)
void	GetMapBorders (out Vec2 minimumPosition, out Vec2 maximumPosition, out float maximumHeight)
void	GetSnowAmountData (byte[] snowData)

Static Public Member Functions
static int	GetNavigationMeshIndexOfTerrainType (TerrainType terrainType)

Properties
Scene	Scene [get]

Constructor & Destructor Documentation

MapScene()

SandBox.MapScene.MapScene

(

)

Member Function Documentation

GetTerrainSize()

Vec2 SandBox.MapScene.GetTerrainSize

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetSceneLevel()

uint SandBox.MapScene.GetSceneLevel

(

string

name

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

SetSceneLevels()

void SandBox.MapScene.SetSceneLevels

(

List< string >

levels

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetAtmosphereStates()

List< AtmosphereState > SandBox.MapScene.GetAtmosphereStates

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

ValidateAgentVisualsReseted()

void SandBox.MapScene.ValidateAgentVisualsReseted

(

)

SetAtmosphereColorgrade()

void SandBox.MapScene.SetAtmosphereColorgrade

(

TerrainType

terrainType

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

AddNewEntityToMapScene()

void SandBox.MapScene.AddNewEntityToMapScene	(	string	entityId,
		Vec2	position
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetFaceIndexForMultiplePositions()

void SandBox.MapScene.GetFaceIndexForMultiplePositions	(	int	movedPartyCount,
		float[]	positionArray,
		PathFaceRecord[]	resultArray
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetMapBorders()

void SandBox.MapScene.GetMapBorders	(	out Vec2	minimumPosition,
		out Vec2	maximumPosition,
		out float	maximumHeight
	)

Parameters

minimumPosition
maximumPosition
maximumHeight

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

Load()

void SandBox.MapScene.Load

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

Destroy()

void SandBox.MapScene.Destroy

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

DisableUnwalkableNavigationMeshes()

void SandBox.MapScene.DisableUnwalkableNavigationMeshes

(

)

GetFaceIndex()

PathFaceRecord SandBox.MapScene.GetFaceIndex

(

Vec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

AreFacesOnSameIsland()

bool SandBox.MapScene.AreFacesOnSameIsland	(	PathFaceRecord	startingFace,
		PathFaceRecord	endFace,
		bool	ignoreDisabled
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetTerrainTypeAtPosition()

TerrainType SandBox.MapScene.GetTerrainTypeAtPosition

(

Vec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetFaceTerrainType()

TerrainType SandBox.MapScene.GetFaceTerrainType

(

PathFaceRecord

navMeshFace

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNavigationMeshIndexOfTerrainType()

static int SandBox.MapScene.GetNavigationMeshIndexOfTerrainType ( TerrainType  terrainType )

static

GetEnvironmentTerrainTypes()

List< TerrainType > SandBox.MapScene.GetEnvironmentTerrainTypes

(

Vec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetEnvironmentTerrainTypesCount()

List< TerrainType > SandBox.MapScene.GetEnvironmentTerrainTypesCount	(	Vec2	position,
		out TerrainType	currentPositionTerrainType
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetMapPatchAtPosition()

MapPatchData SandBox.MapScene.GetMapPatchAtPosition

(

Vec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetAccessiblePointNearPosition()

Vec2 SandBox.MapScene.GetAccessiblePointNearPosition	(	Vec2	position,
		float	radius
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetPathBetweenAIFaces()

bool SandBox.MapScene.GetPathBetweenAIFaces	(	PathFaceRecord	startingFace,
		PathFaceRecord	endingFace,
		Vec2	startingPosition,
		Vec2	endingPosition,
		float	agentRadius,
		NavigationPath	path,
		int[]	excludedFaceIds = null
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetPathDistanceBetweenAIFaces()

bool SandBox.MapScene.GetPathDistanceBetweenAIFaces	(	PathFaceRecord	startingAiFace,
		PathFaceRecord	endingAiFace,
		Vec2	startingPosition,
		Vec2	endingPosition,
		float	agentRadius,
		float	distanceLimit,
		out float	distance
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

IsLineToPointClear()

bool SandBox.MapScene.IsLineToPointClear	(	PathFaceRecord	startingFace,
		Vec2	position,
		Vec2	destination,
		float	agentRadius
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetLastPointOnNavigationMeshFromPositionToDestination()

Vec2 SandBox.MapScene.GetLastPointOnNavigationMeshFromPositionToDestination	(	PathFaceRecord	startingFace,
		Vec2	position,
		Vec2	destination
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNavigationMeshCenterPosition()

Vec2 SandBox.MapScene.GetNavigationMeshCenterPosition

(

PathFaceRecord

face

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNumberOfNavigationMeshFaces()

int SandBox.MapScene.GetNumberOfNavigationMeshFaces

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetHeightAtPoint()

bool SandBox.MapScene.GetHeightAtPoint	(	Vec2	point,
		ref float	height
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetWinterTimeFactor()

float SandBox.MapScene.GetWinterTimeFactor

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetFaceVertexZ()

float SandBox.MapScene.GetFaceVertexZ

(

PathFaceRecord

navMeshFace

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetGroundNormal()

Vec3 SandBox.MapScene.GetGroundNormal

(

Vec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetTerrainHeightAndNormal()

void SandBox.MapScene.GetTerrainHeightAndNormal	(	Vec2	position,
		out float	height,
		out Vec3	normal
	)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetTerrainTypeName()

string SandBox.MapScene.GetTerrainTypeName

(

TerrainType

type

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetSnowAmountData()

void SandBox.MapScene.GetSnowAmountData

(

byte[]

snowData

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

Property Documentation

Scene

Scene SandBox.MapScene.Scene

get