ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Stark::FollowPathLight Class Reference

Make a light follow pre-computed path. More...

#include <followpathlight.h>

Inheritance diagram for Stark::FollowPathLight:
Collaboration diagram for Stark::FollowPathLight:

List of all members.

Public Member Functions

 FollowPathLight (Resources::ItemVisual *item)
virtual ~FollowPathLight ()
void start () override
 Initiate the movement.
void onGameLoop () override
 Called once per game loop.
void stop (bool force=false) override
 Stop / abort the movement.
uint32 getType () const override
 Obtain the effective movement type.
void saveLoad (ResourceSerializer *serializer) override
 Persist / restore the state of the movement so it can be resumed using 'start'.
void setPath (Resources::Path *path)
 Set the path to follow.
void setLight (Resources::Light *light)
 Set the light to move.
void setSpeed (float speed)
 Set the movement speed on the path.

Private Attributes

Resources::Path_path
Resources::Light_light
float _speed
float _position
bool _previouslyEnabled

Detailed Description

Make a light follow pre-computed path.

Definition at line 38 of file followpathlight.h.


Constructor & Destructor Documentation

Stark::FollowPathLight::FollowPathLight ( Resources::ItemVisual item  ) 

Definition at line 37 of file followpathlight.cpp.

Stark::FollowPathLight::~FollowPathLight (  )  [virtual]

Definition at line 46 of file followpathlight.cpp.


Member Function Documentation

uint32 Stark::FollowPathLight::getType (  )  const [override, virtual]

Obtain the effective movement type.

Implements Stark::Movement.

Definition at line 105 of file followpathlight.cpp.

void Stark::FollowPathLight::onGameLoop (  )  [override, virtual]

Called once per game loop.

Implements Stark::Movement.

Definition at line 65 of file followpathlight.cpp.

void Stark::FollowPathLight::saveLoad ( ResourceSerializer serializer  )  [override, virtual]

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

Implements Stark::Movement.

Definition at line 109 of file followpathlight.cpp.

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

Set the light to move.

Definition at line 101 of file followpathlight.cpp.

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

Set the path to follow.

Definition at line 93 of file followpathlight.cpp.

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

Set the movement speed on the path.

Definition at line 97 of file followpathlight.cpp.

void Stark::FollowPathLight::start (  )  [override, virtual]

Initiate the movement.

Reimplemented from Stark::Movement.

Definition at line 49 of file followpathlight.cpp.

void Stark::FollowPathLight::stop ( bool  force = false  )  [override, virtual]

Stop / abort the movement.

Reimplemented from Stark::Movement.

Definition at line 59 of file followpathlight.cpp.


Member Data Documentation

Definition at line 61 of file followpathlight.h.

Definition at line 60 of file followpathlight.h.

Definition at line 64 of file followpathlight.h.

Definition at line 65 of file followpathlight.h.

Definition at line 62 of file followpathlight.h.


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


Generated on Sat May 25 2019 05:06:36 for ResidualVM by doxygen 1.7.1
curved edge   curved edge