ScummVM API documentation
Stark::FollowPathLight Class Reference

#include <followpathlight.h>

Inheritance diagram for Stark::FollowPathLight:
Stark::Movement

Public Member Functions

 FollowPathLight (Resources::ItemVisual *item)
 
void start () override
 
void onGameLoop () override
 
void stop (bool force=false) override
 
uint32 getType () const override
 
void saveLoad (ResourceSerializer *serializer) override
 
void setPath (Resources::Path *path)
 
void setLight (Resources::Light *light)
 
void setSpeed (float speed)
 
- Public Member Functions inherited from Stark::Movement
 Movement (Resources::ItemVisual *item)
 
bool hasEnded () const
 
virtual bool hasReachedDestination () const
 

Additional Inherited Members

- Public Types inherited from Stark::Movement
enum  MovementType { kTypeWalk = 1, kTypeFollowPath = 2, kTypeFollowPathLight = 3, kTypeTurn = 4 }
 
- Static Public Member Functions inherited from Stark::Movement
static Movementconstruct (uint32 type, Resources::ItemVisual *item)
 
- Protected Types inherited from Stark::Movement
enum  TurnDirection { kTurnNone, kTurnLeft, kTurnRight }
 
- Protected Member Functions inherited from Stark::Movement
float computeAngleBetweenVectorsXYPlane (const Math::Vector3d &v1, const Math::Vector3d &v2) const
 
- Protected Attributes inherited from Stark::Movement
const float _defaultTurnAngleSpeed
 
bool _ended
 
Resources::ItemVisual_item
 

Detailed Description

Make a light follow pre-computed path

Member Function Documentation

◆ start()

void Stark::FollowPathLight::start ( )
overridevirtual

Initiate the movement

Reimplemented from Stark::Movement.

◆ onGameLoop()

void Stark::FollowPathLight::onGameLoop ( )
overridevirtual

Called once per game loop

Implements Stark::Movement.

◆ stop()

void Stark::FollowPathLight::stop ( bool  force = false)
overridevirtual

Stop / abort the movement

Reimplemented from Stark::Movement.

◆ getType()

uint32 Stark::FollowPathLight::getType ( ) const
overridevirtual

Obtain the effective movement type

Implements Stark::Movement.

◆ saveLoad()

void Stark::FollowPathLight::saveLoad ( ResourceSerializer serializer)
overridevirtual

Persist / restore the state of the movement so it can be resumed using 'start'

Implements Stark::Movement.

◆ setPath()

void Stark::FollowPathLight::setPath ( Resources::Path path)

Set the path to follow

◆ setLight()

void Stark::FollowPathLight::setLight ( Resources::Light light)

Set the light to move

◆ setSpeed()

void Stark::FollowPathLight::setSpeed ( float  speed)

Set the movement speed on the path


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