IVehicleAnimation

Handles animations on the vehicle model

C++
struct IVehicleAnimation {
};
File

IVehicleSystem.h

IVehicleAnimation::~IVehicleAnimation Destructor
C++
virtual ~IVehicleAnimation();
IVehicleAnimation::ChangeState Method

Performs a change of state

C++
virtual bool ChangeState(TVehicleAnimStateId stateId) = 0;
Parameters
Parameters
Description
TVehicleAnimStateId stateId
An id of the state
Returns

A bool which indicates if the state could be used

Remarks

The function GetStateId can return an appropriate stateId which can be used as parameter for this function.

See Also
IVehicleAnimation::GetAnimTime Method

Returns the current time in the animation

C++
virtual float GetAnimTime(bool raw = false) = 0;
Returns

a value usually between 0 to 1

IVehicleAnimation::GetMemoryUsage Method
C++
virtual void GetMemoryUsage(ICrySizer * pSizer) const = 0;
IVehicleAnimation::GetState Method

Returns the current animation state

C++
virtual TVehicleAnimStateId GetState() = 0;
Returns

A stateId of the current animation state in use

See Also
IVehicleAnimation::GetStateId Method
C++
virtual TVehicleAnimStateId GetStateId(const string& name) = 0;
IVehicleAnimation::GetStateName Method
C++
virtual string GetStateName(TVehicleAnimStateId stateId) = 0;
IVehicleAnimation::Init Method
C++
virtual bool Init(IVehicle* pVehicle, const CVehicleParams& table) = 0;
IVehicleAnimation::IsUsingManualUpdates Method
C++
virtual bool IsUsingManualUpdates() = 0;
IVehicleAnimation::Release Method
C++
virtual void Release() = 0;
IVehicleAnimation::Reset Method
C++
virtual void Reset() = 0;
IVehicleAnimation::SetSpeed Method

Changes the speed of the animation

C++
virtual void SetSpeed(float speed) = 0;
Parameters
Parameters
Description
float speed
a value between 0 to 1
IVehicleAnimation::SetTime Method
C++
virtual void SetTime(float time, bool force = false) = 0;
IVehicleAnimation::StartAnimation Method

Triggers the animation to start

C++
virtual bool StartAnimation() = 0;
Returns

A bool which indicates the success

IVehicleAnimation::StopAnimation Method

Triggers the animation to stop

C++
virtual void StopAnimation() = 0;
IVehicleAnimation::ToggleManualUpdate Method
C++
virtual void ToggleManualUpdate(bool isEnabled) = 0;