Vehicle Interface Reference

Inheritance diagram for Vehicle:

Public Member Functions
ScriptInvoker	GetOnPhysicsActive ()
override void	EOnPhysicsActive (IEntity owner, bool activeState)
Faction	GetFaction ()
SCR_VehicleFactionAffiliationComponent	GetFactionAffiliation ()
Faction	GetDefaultFaction ()
bool	IsOccupied ()
VehicleControllerComponent	GetVehicleController ()
	Get vehicle controller.
PilotCompartmentSlot	GetPilotCompartmentSlot ()
	Get primary pilot compartment slot.
IEntity	GetPilot ()
SCR_ResourceComponent	GetResourceComponent ()
void	UpdateResourceComponent ()
override array< ref WB_UIMenuItem >	_WB_GetContextMenuItems ()
override void	_WB_OnContextMenu (int id)
void	Vehicle (IEntitySource src, IEntity parent)
override void	EOnInit (IEntity owner)
Public Member Functions inherited from BaseVehicle
proto external SCR_DamageManagerComponent	GetDamageManager ()
proto external void	SetWreckModel (ResourceName newModel)
	Sets the wreck model of the vehicle.
proto external bool	IsAccessible ()
	Returns true if the vehicle is not upside down.
Public Member Functions inherited from BaseGameEntity
proto external void	Teleport (vector mat[4])
	Teleport the entity to a coordinate.
proto external RplComponent	GetRplComponent ()
	Returns the replication component associated to this entity.

Public Attributes
EVehicleType	m_eVehicleType
SCR_VehicleFactionAffiliationComponent	m_pFactionComponent
SCR_VehiclePerceivableComponent	m_pPerceivableComponent

Protected Attributes
ref ScriptInvoker< IEntity, bool >	m_OnPhysicsActive
VehicleControllerComponent	m_VehicleController
SCR_ResourceComponent	m_ResourceComponent

Constructor & Destructor Documentation

Vehicle()

void Vehicle.Vehicle	(	IEntitySource	src,
		IEntity	parent )

Parameters

[in]	src
[in]	parent

Member Function Documentation

_WB_GetContextMenuItems()

override array< ref WB_UIMenuItem > Vehicle._WB_GetContextMenuItems

(

)

_WB_OnContextMenu()

override void Vehicle._WB_OnContextMenu

(

int

id

)

EOnInit()

override void Vehicle.EOnInit

(

IEntity

owner

)

EOnPhysicsActive()

override void Vehicle.EOnPhysicsActive	(	IEntity	owner,
		bool	activeState )

GetDefaultFaction()

Faction Vehicle.GetDefaultFaction

(

)

Returns

GetFaction()

Faction Vehicle.GetFaction

(

)

Returns

GetFactionAffiliation()

SCR_VehicleFactionAffiliationComponent Vehicle.GetFactionAffiliation

(

)

Returns

GetOnPhysicsActive()

ScriptInvoker Vehicle.GetOnPhysicsActive

(

)

Returns

GetPilot()

IEntity Vehicle.GetPilot

(

)

Returns

pilot of the vehicle - occupant of the primary pilot compartment

GetPilotCompartmentSlot()

PilotCompartmentSlot Vehicle.GetPilotCompartmentSlot

(

)

Get primary pilot compartment slot.

GetResourceComponent()

SCR_ResourceComponent Vehicle.GetResourceComponent

(

)

Returns

GetVehicleController()

VehicleControllerComponent Vehicle.GetVehicleController

(

)

Get vehicle controller.

IsOccupied()

bool Vehicle.IsOccupied

(

)

Returns

UpdateResourceComponent()

void Vehicle.UpdateResourceComponent

(

)

Member Data Documentation

m_eVehicleType

EVehicleType Vehicle.m_eVehicleType

m_OnPhysicsActive

ref ScriptInvoker<IEntity, bool> Vehicle.m_OnPhysicsActive

protected

m_pFactionComponent

SCR_VehicleFactionAffiliationComponent Vehicle.m_pFactionComponent

m_pPerceivableComponent

SCR_VehiclePerceivableComponent Vehicle.m_pPerceivableComponent

m_ResourceComponent

SCR_ResourceComponent Vehicle.m_ResourceComponent

protected

m_VehicleController

VehicleControllerComponent Vehicle.m_VehicleController

protected

---

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

• GameCode/Vehicle/Vehicle.c