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, in CampaignVec2 position)
void	GetMapBorders (out Vec2 minimumPosition, out Vec2 maximumPosition, out float maximumHeight)
void	Load ()
void	SetSnowAndRainDataWithDimension (Texture snowRainTexture, int weatherNodeGridWidthAndHeight)
void	AfterLoad ()
void	Destroy ()
void	DisableUnwalkableNavigationMeshes ()
PathFaceRecord	GetFaceIndex (in CampaignVec2 vec2)
TerrainType	GetTerrainTypeAtPosition (in CampaignVec2 position)
TerrainType	GetFaceTerrainType (PathFaceRecord navMeshFace)
CampaignVec2	GetNearestFaceCenterForPosition (in CampaignVec2 position, int[] excludedFaceIds)
CampaignVec2	GetNearestFaceCenterForPositionWithPath (PathFaceRecord pathFaceRecord, bool targetIsLand, float maxDist, int[] excludedFaceIds)
List< TerrainType >	GetEnvironmentTerrainTypes (in CampaignVec2 originPosition)
List< TerrainType >	GetEnvironmentTerrainTypesCount (in CampaignVec2 originPosition, out TerrainType currentPositionTerrainType)
MapPatchData	GetMapPatchAtPosition (in CampaignVec2 position)
CampaignVec2	GetAccessiblePointNearPosition (in CampaignVec2 pos, float radius)
bool	GetPathBetweenAIFaces (PathFaceRecord startingFace, PathFaceRecord endingFace, Vec2 startingPosition, Vec2 endingPosition, float agentRadius, NavigationPath path, int[] excludedFaceIds, float extraCostMultiplier, int regionSwitchCostFromLandToSea, int regionSwitchCostFromSeaToLand)
	The path between pointA to pointB and pointB to pointA may differ but the path between pointA to pointB will always return same.
bool	GetPathDistanceBetweenAIFaces (PathFaceRecord startingAiFace, PathFaceRecord endingAiFace, Vec2 startingPosition, Vec2 endingPosition, float agentRadius, float distanceLimit, out float distance, int[] excludedFaceIds, int regionSwitchCostFromLandToSea, int regionSwitchCostFromSeaToLand)
	The distance between pointA to pointB and pointB to pointA may differ but distance between pointA to pointB will always return same.
bool	IsLineToPointClear (PathFaceRecord startingFace, Vec2 position, Vec2 destination, float agentRadius)
Vec2	GetLastPointOnNavigationMeshFromPositionToDestination (PathFaceRecord startingFace, Vec2 position, Vec2 destination, int[] excludedFaceIds=null)
Vec2	GetLastPositionOnNavMeshFaceForPointAndDirection (PathFaceRecord startingFace, Vec2 position, Vec2 destination)
Vec2	GetNavigationMeshCenterPosition (PathFaceRecord face)
Vec2	GetNavigationMeshCenterPosition (int faceIndex)
int	GetNumberOfNavigationMeshFaces ()
PathFaceRecord	GetFaceAtIndex (int faceIndex)
bool	GetHeightAtPoint (in CampaignVec2 point, ref float height)
float	GetWinterTimeFactor ()
float	GetFaceVertexZ (PathFaceRecord navMeshFace)
Vec3	GetGroundNormal (Vec2 position)
void	GetSiegeCampFrames (Settlement settlement, out List< MatrixFrame > siegeCamp1GlobalFrames, out List< MatrixFrame > siegeCamp2GlobalFrames)
void	GetTerrainHeightAndNormal (Vec2 position, out float height, out Vec3 normal)
string	GetTerrainTypeName (TerrainType type)
uint	GetSceneXmlCrc ()
uint	GetSceneNavigationMeshCrc ()
Vec2	GetWindAtPosition (Vec2 position)
float	GetSnowAmountAtPosition (Vec2 position)
float	GetRainAmountAtPosition (Vec2 position)
void	SetupWaterWake (float wakeWorldSize, float wakeCameraOffset)

Static Public Attributes
const int	FlowMapTextureDimension = 512

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,
		in CampaignVec2	position )

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetMapBorders()

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

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

Load()

void SandBox.MapScene.Load

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

SetSnowAndRainDataWithDimension()

void SandBox.MapScene.SetSnowAndRainDataWithDimension	(	Texture	snowRainTexture,
		int	weatherNodeGridWidthAndHeight )

AfterLoad()

void SandBox.MapScene.AfterLoad

(

)

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

(

in CampaignVec2

vec2

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetTerrainTypeAtPosition()

TerrainType SandBox.MapScene.GetTerrainTypeAtPosition

(

in CampaignVec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetFaceTerrainType()

TerrainType SandBox.MapScene.GetFaceTerrainType

(

PathFaceRecord

navMeshFace

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNearestFaceCenterForPosition()

CampaignVec2 SandBox.MapScene.GetNearestFaceCenterForPosition	(	in CampaignVec2	position,
		int[]	excludedFaceIds )

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNearestFaceCenterForPositionWithPath()

CampaignVec2 SandBox.MapScene.GetNearestFaceCenterForPositionWithPath	(	PathFaceRecord	pathFaceRecord,
		bool	targetIsLand,
		float	maxDist,
		int[]	excludedFaceIds )

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetEnvironmentTerrainTypes()

List< TerrainType > SandBox.MapScene.GetEnvironmentTerrainTypes

(

in CampaignVec2

originPosition

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetEnvironmentTerrainTypesCount()

List< TerrainType > SandBox.MapScene.GetEnvironmentTerrainTypesCount	(	in CampaignVec2	originPosition,
		out TerrainType	currentPositionTerrainType )

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetMapPatchAtPosition()

MapPatchData SandBox.MapScene.GetMapPatchAtPosition

(

in CampaignVec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetAccessiblePointNearPosition()

CampaignVec2 SandBox.MapScene.GetAccessiblePointNearPosition	(	in CampaignVec2	pos,
		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,
		float	extraCostMultiplier,
		int	regionSwitchCostFromLandToSea,
		int	regionSwitchCostFromSeaToLand )

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,
		int[]	excludedFaceIds,
		int	regionSwitchCostFromLandToSea,
		int	regionSwitchCostFromSeaToLand )

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,
		int[]	excludedFaceIds = null )

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetLastPositionOnNavMeshFaceForPointAndDirection()

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

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNavigationMeshCenterPosition() [1/2]

Vec2 SandBox.MapScene.GetNavigationMeshCenterPosition

(

PathFaceRecord

face

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNavigationMeshCenterPosition() [2/2]

Vec2 SandBox.MapScene.GetNavigationMeshCenterPosition

(

int

faceIndex

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetNumberOfNavigationMeshFaces()

int SandBox.MapScene.GetNumberOfNavigationMeshFaces

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetFaceAtIndex()

PathFaceRecord SandBox.MapScene.GetFaceAtIndex

(

int

faceIndex

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetHeightAtPoint()

bool SandBox.MapScene.GetHeightAtPoint	(	in CampaignVec2	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.

GetSiegeCampFrames()

void SandBox.MapScene.GetSiegeCampFrames	(	Settlement	settlement,
		out List< MatrixFrame >	siegeCamp1GlobalFrames,
		out List< MatrixFrame >	siegeCamp2GlobalFrames )

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.

GetSceneXmlCrc()

uint SandBox.MapScene.GetSceneXmlCrc

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetSceneNavigationMeshCrc()

uint SandBox.MapScene.GetSceneNavigationMeshCrc

(

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetWindAtPosition()

Vec2 SandBox.MapScene.GetWindAtPosition

(

Vec2

position

)

GetSnowAmountAtPosition()

float SandBox.MapScene.GetSnowAmountAtPosition

(

Vec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

GetRainAmountAtPosition()

float SandBox.MapScene.GetRainAmountAtPosition

(

Vec2

position

)

Implements TaleWorlds.CampaignSystem.Map.IMapScene.

SetupWaterWake()

void SandBox.MapScene.SetupWaterWake	(	float	wakeWorldSize,
		float	wakeCameraOffset )

Member Data Documentation

FlowMapTextureDimension

const int SandBox.MapScene.FlowMapTextureDimension = 512

static

Property Documentation

Scene

Scene SandBox.MapScene.Scene

get