Vehicle System interface

struct IVehicleSystem {
};

IVehicleSystem.h

Interface used to implement the vehicle system.

virtual ~IVehicleSystem();

Registers a newly spawned vehicle in the vehicle system

virtual void AddVehicle(EntityId entityId, IVehicle* pProxy) = 0;

virtual TVehicleObjectId AssignVehicleObjectId() = 0;

virtual TVehicleObjectId AssignVehicleObjectId(const string& className) = 0;

Announces OnUse events for vehicles.

virtual void BroadcastVehicleUsageEvent(const EVehicleEvent eventId, const EntityId playerId, IVehicle* pVehicle) = 0;

RegisterVehicleUsageEventListener UnregisterVehicleEventListener

Spawns a new vehicle instance

virtual IVehicle* CreateVehicle(uint16 channelId, const char * name, const char * vehicleClass, const Vec3 & pos, const Quat & rot, const Vec3 & scale, EntityId id = 0) = 0;

A pointer to the correct vehicle proxy. The value 0 is returned in case that the specified vehicle couldn't be created.

Will spawn an entity based on the vehicle class requested. Usually called by the entity system when a vehicle entity is spawned.

virtual IVehicleAction* CreateVehicleAction(const string& name) = 0;

virtual IVehicleDamageBehavior* CreateVehicleDamageBehavior(const string& name) = 0;

virtual IVehicleIteratorPtr CreateVehicleIterator() = 0;

virtual IVehicleMovement* CreateVehicleMovement(const string& name) = 0;

virtual IVehiclePart* CreateVehiclePart(const string& name) = 0;

virtual IVehicleSeatAction* CreateVehicleSeatAction(const string& name) = 0;

virtual IVehicleView* CreateVehicleView(const string& name) = 0;

DECLARE_GAMEOBJECT_FACTORY(IVehicleAction);

DECLARE_GAMEOBJECT_FACTORY(IVehicleDamageBehavior);

DECLARE_GAMEOBJECT_FACTORY(IVehicleMovement);

DECLARE_GAMEOBJECT_FACTORY(IVehiclePart);

DECLARE_GAMEOBJECT_FACTORY(IVehicleSeatAction);

DECLARE_GAMEOBJECT_FACTORY(IVehicleView);

virtual IVehicleDamagesTemplateRegistry* GetDamagesTemplateRegistry() = 0;

virtual bool GetOptionalScript(const char* vehicleName, char* buf, size_t len) = 0;

Gets the Vehicle proxy of an entity

virtual IVehicle* GetVehicle(EntityId entityId) = 0;

A pointer to the correct vehicle proxy. The value 0 is returned in case that the proxy wasn't found.

Will return the correct vehicle proxy of a vehicle entity.

virtual IVehicle* GetVehicleByChannelId(uint16 channelId) = 0;

Returns the vehicle client class implementation

virtual IVehicleClient* GetVehicleClient() = 0;

A pointer to the current vehicle client implementation, or null if none as been registrated

RegisterVehicleClient

Used to get the count of all vehicle instance

virtual uint32 GetVehicleCount() = 0;

The count of all the vehicle instance created by the vehicle system

virtual void GetVehicleImplementations(SVehicleImpls& impls) = 0;

virtual TVehicleObjectId GetVehicleObjectId(const string& className) const = 0;

virtual bool Init() = 0;

virtual bool IsVehicleClass(const char * name) const = 0;

Performs the registration of vehicle client implementation

virtual void RegisterVehicleClient(IVehicleClient* pVehicleClient) = 0;

GetVehicleClient

Performs the registration of all the different vehicle classes

virtual void RegisterVehicles(IGameFramework* pGameFramework) = 0;

The vehicle system will read all the xml files which are inside the directory "Scripts/Entities/Vehicles/Implementations/Xml/". All the valid vehicle classes will be registered as game object extension with IGameObjectSystem.

Several default vehicle parts, views, actions and damage behaviors classes are registered in this function as well.

Performs the registration of a class which wants to know when a specific player starts to use a vehicle

virtual void RegisterVehicleUsageEventListener(const EntityId playerId, IVehicleUsageEventListener* pEventListener) = 0;

IVehicle::RegisterVehicleEventListener()

virtual void Release() = 0;

Registers a newly removed vehicle in the vehicle system

virtual void RemoveVehicle(EntityId entityId) = 0;

virtual void Reset() = 0;

Unregisters class listening to the current player's vehicle.

virtual void UnregisterVehicleUsageEventListener(const EntityId playerId, IVehicleUsageEventListener* pEventListener) = 0;

IVehicle::RegisterVehicleEventListener()

virtual void Update(float deltaTime) = 0;