SCR_AIChangeCompartment Interface Reference

Inheritance diagram for SCR_AIChangeCompartment:

Public Member Functions
override TStringArray	GetVariablesIn ()
override void	OnInit (AIAgent owner)
override void	OnEnter (AIAgent owner)
override ENodeResult	EOnTaskSimulate (AIAgent owner, float dt)
	Scripted nodes are suposed to return SUCCESS, FAIL or RUNNING state.
ENodeResult	UpdateCompartmentSwitchState (int currentState, out int newState)
	Returns node result and state of the compartment switching process.
bool	EjectOccupant (ChimeraCharacter occupant)
Public Member Functions inherited from AITaskScripted
void	OnAbort (AIAgent owner, Node nodeCausingAbort)
Public Member Functions inherited from Node
proto external int	GetNodeID ()
proto external TypeName	GetVariableType (bool inputPort, string name)
proto bool	GetVariableIn (string name, out void val)
proto void	SetVariableOut (string name, void val)
proto void	ClearVariable (string name)
proto void	GetCallstackStr (out string val)
proto void	GetParentTreeName (out string val)

Static Public Member Functions
static override bool	VisibleInPalette ()
static override bool	CanReturnRunning ()
static override string	GetOnHoverDescription ()

Public Attributes
ECompartmentType	m_eCompartmentType

Protected Attributes
SCR_CompartmentAccessComponent	m_compartmentAccess
SCR_CompartmentAccessComponent	m_compartmentAccessOccupant
ChimeraCharacter	m_target
int	m_compartmentSwitchState
BaseCompartmentSlot	m_compartmentSlot
IEntity	m_vehicle
bool	m_TeleportInside

Static Protected Attributes
static const int	COMPARTMENT_INIT = 0
static const int	COMPARTMENT_WITH_CORPSE = 1
static const int	COMPARTMENT_EMPTYING = 2
static const int	COMPARTMENT_EMPTY = 3
static const int	COMPARTMENT_CHANGING = 4
static const int	COMPARTMENT_CHANGED = 5
static const int	NO_COMPARTMENT_AVAILABLE = 6
static const string	TARGET_VEHICLE_PORT = "TargetVehicle"
static const string	COMPARTMENT_TYPE_PORT = "CompartmentType"
static const string	TELEPORT_IN_PORT = "TeleportInside"
static ref TStringArray	s_aVarsIn = { TARGET_VEHICLE_PORT, COMPARTMENT_TYPE_PORT, TELEPORT_IN_PORT }
Static Protected Attributes inherited from Node
static ref TStringArray	m_aEmptyVars = {}

Additional Inherited Members
Protected Member Functions inherited from AITaskScripted
string	GetNodeMiddleText ()
Protected Member Functions inherited from Node
TStringArray	GetVariablesOut ()

Member Function Documentation

CanReturnRunning()

static override bool SCR_AIChangeCompartment.CanReturnRunning ( )

static

Implements Node.

EjectOccupant()

bool SCR_AIChangeCompartment.EjectOccupant

(

ChimeraCharacter

occupant

)

EOnTaskSimulate()

override ENodeResult SCR_AIChangeCompartment.EOnTaskSimulate	(	AIAgent	owner,
		float	dt )

Scripted nodes are suposed to return SUCCESS, FAIL or RUNNING state.

Implements AITaskScripted.

GetOnHoverDescription()

static override string SCR_AIChangeCompartment.GetOnHoverDescription ( )

static

Implements Node.

GetVariablesIn()

override TStringArray SCR_AIChangeCompartment.GetVariablesIn

(

)

Implements Node.

OnEnter()

override void SCR_AIChangeCompartment.OnEnter

(

AIAgent

owner

)

Implements AITaskScripted.

OnInit()

override void SCR_AIChangeCompartment.OnInit

(

AIAgent

owner

)

Implements AITaskScripted.

UpdateCompartmentSwitchState()

ENodeResult SCR_AIChangeCompartment.UpdateCompartmentSwitchState	(	int	currentState,
		out int	newState )

Returns node result and state of the compartment switching process.

VisibleInPalette()

static override bool SCR_AIChangeCompartment.VisibleInPalette ( )

static

Implements Node.

Member Data Documentation

COMPARTMENT_CHANGED

const int SCR_AIChangeCompartment.COMPARTMENT_CHANGED = 5

staticprotected

COMPARTMENT_CHANGING

const int SCR_AIChangeCompartment.COMPARTMENT_CHANGING = 4

staticprotected

COMPARTMENT_EMPTY

const int SCR_AIChangeCompartment.COMPARTMENT_EMPTY = 3

staticprotected

COMPARTMENT_EMPTYING

const int SCR_AIChangeCompartment.COMPARTMENT_EMPTYING = 2

staticprotected

COMPARTMENT_INIT

const int SCR_AIChangeCompartment.COMPARTMENT_INIT = 0

staticprotected

COMPARTMENT_TYPE_PORT

const string SCR_AIChangeCompartment.COMPARTMENT_TYPE_PORT = "CompartmentType"

staticprotected

COMPARTMENT_WITH_CORPSE

const int SCR_AIChangeCompartment.COMPARTMENT_WITH_CORPSE = 1

staticprotected

m_compartmentAccess

SCR_CompartmentAccessComponent SCR_AIChangeCompartment.m_compartmentAccess

protected

m_compartmentAccessOccupant

SCR_CompartmentAccessComponent SCR_AIChangeCompartment.m_compartmentAccessOccupant

protected

m_compartmentSlot

BaseCompartmentSlot SCR_AIChangeCompartment.m_compartmentSlot

protected

m_compartmentSwitchState

int SCR_AIChangeCompartment.m_compartmentSwitchState

protected

m_eCompartmentType

ECompartmentType SCR_AIChangeCompartment.m_eCompartmentType

m_target

ChimeraCharacter SCR_AIChangeCompartment.m_target

protected

m_TeleportInside

bool SCR_AIChangeCompartment.m_TeleportInside

protected

m_vehicle

IEntity SCR_AIChangeCompartment.m_vehicle

protected

NO_COMPARTMENT_AVAILABLE

const int SCR_AIChangeCompartment.NO_COMPARTMENT_AVAILABLE = 6

staticprotected

s_aVarsIn

ref TStringArray SCR_AIChangeCompartment.s_aVarsIn = { TARGET_VEHICLE_PORT, COMPARTMENT_TYPE_PORT, TELEPORT_IN_PORT }

staticprotected

TARGET_VEHICLE_PORT

const string SCR_AIChangeCompartment.TARGET_VEHICLE_PORT = "TargetVehicle"

staticprotected

TELEPORT_IN_PORT

const string SCR_AIChangeCompartment.TELEPORT_IN_PORT = "TeleportInside"

staticprotected

---

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

• Game/AI/ScriptedNodes/Vehicles/SCR_AIChangeCompartment.c