SCR_AIWorld Interface Reference

Inheritance diagram for SCR_AIWorld:

Public Member Functions
ScriptInvoker_AIWorldControlModeChanged	GetOnControlModeChanged ()
	Get event called every time any group changes its control mode.
override void	EOnInit (IEntity owner)
override void	OnDebugAgentTeleport (AIAgent agent)
override void	OnDebugCameraTeleport (vector pos)
override void	AddedAIAgent (AIAgent agent)
override void	RemovingAIAgent (AIAgent agent)
TypeName	GetGoalMessageOfType (EMessageType_Goal eventType)
TypeName	GetInfoMessageOfType (EMessageType_Info eventType)
TypeName	GetOrderMessageOfType (EOrderType_Character eventType)
void	RequestNavmeshRebuildAreas (notnull array< ref Tuple2< vector, vector > > areas, notnull array< bool > redoRoads)
	Regenerate navmesh in given areas.
void	RequestNavmeshRebuildEntity (IEntity entity)
	Regenerate navmesh around entity and its child entities.
void	GetNavmeshRebuildAreas (IEntity entity, out notnull array< ref Tuple2< vector, vector > > outAreas, out notnull array< bool > redoRoads)
	Get navmesh regeneration areas based on entity and its children.
Public Member Functions inherited from ChimeraAIWorld
proto external void	RequestRoadNetworkRebuild (vector min, vector max)
proto external RoadNetworkManager	GetRoadNetworkManager ()
Public Member Functions inherited from AIWorld
proto external int	GetCurrentAmountOfLimitedAIs ()
proto external int	GetAILimit ()
proto external void	SetAILimit (int max)
proto external bool	CanLimitedAIBeAdded ()
proto external int	GetCurrentNumOfActiveAIs ()
proto external int	GetLimitOfActiveAIs ()
proto external void	SetLimitOfActiveAIs (int max)
proto external bool	CanAIBeActivated ()
proto external void	GetAIAgents (out notnull array< AIAgent > agents)
proto external void	RequestBroadcastDangerEvent (AIDangerEvent pEvent)
proto external AIFormationDefinition	GetFormation (string pName)
proto external NavmeshWorldComponent	GetNavmeshWorldComponent (string name)
proto external void	RequestNavmeshRebuild (vector min, vector max)
proto external void	RequestNavmeshLoad (vector pos)

Public Attributes
ref array< ref SCR_AIMessageGoal >	m_aGoalMessages
ref array< ref SCR_AIMessageGoal >	m_aGoalMessagesPacked = new array<ref SCR_AIMessageGoal>()
ref array< ref SCR_AIMessageInfo >	m_aInfoMessages
ref array< ref SCR_AIMessageInfo >	m_aInfoMessagesPacked = new array<ref SCR_AIMessageInfo>()
ref array< ref SCR_AIOrderBase >	m_aOrders
ref array< ref SCR_AIOrderBase >	m_aOrdersPacked = new array<ref SCR_AIOrderBase>()

Static Public Attributes
static const float	MAX_NAVMESH_REBUILD_SIZE = 100 * 100
static ref ScriptInvoker	s_OnAgentSpawned = new ScriptInvoker()
static ref ScriptInvoker	s_OnAgentRemoved = new ScriptInvoker()
static bool	s_bDiagRegistered

Protected Member Functions
void	RegisterDbgCategory ()
vector	GetAreaCenter (vector min, vector max)
bool	HasVehicleNavlink (IEntity entity)

Protected Attributes
ref ScriptInvoker_AIWorldControlModeChanged	m_OnControlModeChanged = new ScriptInvoker_AIWorldControlModeChanged()

Member Function Documentation

AddedAIAgent()

override void SCR_AIWorld.AddedAIAgent

(

AIAgent

agent

)

Implements AIWorld.

EOnInit()

override void SCR_AIWorld.EOnInit

(

IEntity

owner

)

GetAreaCenter()

vector SCR_AIWorld.GetAreaCenter ( vector min, vector max )

protected

GetGoalMessageOfType()

TypeName SCR_AIWorld.GetGoalMessageOfType

(

EMessageType_Goal

eventType

)

GetInfoMessageOfType()

TypeName SCR_AIWorld.GetInfoMessageOfType

(

EMessageType_Info

eventType

)

GetNavmeshRebuildAreas()

void SCR_AIWorld.GetNavmeshRebuildAreas	(	IEntity	entity,
		out notnull array< ref Tuple2< vector, vector > >	outAreas,
		out notnull array< bool >	redoRoads )

Get navmesh regeneration areas based on entity and its children.

Parameters

[out]

areas

Array of areas in format (min bounds, max bounds). Not cleared, will expand on existing areas.

GetOnControlModeChanged()

ScriptInvoker_AIWorldControlModeChanged SCR_AIWorld.GetOnControlModeChanged

(

)

Get event called every time any group changes its control mode.

Called from SCR_AIGroupInfoComponent.

Returns

Script invoker

GetOrderMessageOfType()

TypeName SCR_AIWorld.GetOrderMessageOfType

(

EOrderType_Character

eventType

)

HasVehicleNavlink()

bool SCR_AIWorld.HasVehicleNavlink ( IEntity entity )

protected

OnDebugAgentTeleport()

override void SCR_AIWorld.OnDebugAgentTeleport

(

AIAgent

agent

)

Implements AIWorld.

OnDebugCameraTeleport()

override void SCR_AIWorld.OnDebugCameraTeleport

(

vector

pos

)

Implements AIWorld.

RegisterDbgCategory()

void SCR_AIWorld.RegisterDbgCategory ( )

protected

RemovingAIAgent()

override void SCR_AIWorld.RemovingAIAgent

(

AIAgent

agent

)

Implements AIWorld.

RequestNavmeshRebuildAreas()

void SCR_AIWorld.RequestNavmeshRebuildAreas	(	notnull array< ref Tuple2< vector, vector > >	areas,
		notnull array< bool >	redoRoads )

Regenerate navmesh in given areas.

Parameters

areas

Array of areas in format (min bounds, max bounds)

RequestNavmeshRebuildEntity()

void SCR_AIWorld.RequestNavmeshRebuildEntity

(

IEntity

entity

)

Regenerate navmesh around entity and its child entities.

Parameters

entity

Affected entity

Member Data Documentation

m_aGoalMessages

ref array<ref SCR_AIMessageGoal> SCR_AIWorld.m_aGoalMessages

m_aGoalMessagesPacked

ref array<ref SCR_AIMessageGoal> SCR_AIWorld.m_aGoalMessagesPacked = new array<ref SCR_AIMessageGoal>()

m_aInfoMessages

ref array<ref SCR_AIMessageInfo> SCR_AIWorld.m_aInfoMessages

m_aInfoMessagesPacked

ref array<ref SCR_AIMessageInfo> SCR_AIWorld.m_aInfoMessagesPacked = new array<ref SCR_AIMessageInfo>()

m_aOrders

ref array<ref SCR_AIOrderBase> SCR_AIWorld.m_aOrders

m_aOrdersPacked

ref array<ref SCR_AIOrderBase> SCR_AIWorld.m_aOrdersPacked = new array<ref SCR_AIOrderBase>()

m_OnControlModeChanged

ref ScriptInvoker_AIWorldControlModeChanged SCR_AIWorld.m_OnControlModeChanged = new ScriptInvoker_AIWorldControlModeChanged()

protected

MAX_NAVMESH_REBUILD_SIZE

const float SCR_AIWorld.MAX_NAVMESH_REBUILD_SIZE = 100 * 100

static

s_bDiagRegistered

bool SCR_AIWorld.s_bDiagRegistered

static

s_OnAgentRemoved

ref ScriptInvoker SCR_AIWorld.s_OnAgentRemoved = new ScriptInvoker()

static

s_OnAgentSpawned

ref ScriptInvoker SCR_AIWorld.s_OnAgentSpawned = new ScriptInvoker()

static

---

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

• Game/AI/SCR_AIWorld.c