Spring class
#include <Jazz2/Actors/Environment/Spring.h>
Spring.
Bouncy spring that launches the player when stepped on or run into. Vertical springs come in three strengths—red, green, and blue—that fling the rabbit progressively higher, while horizontal springs shove the player sideways; a frozen spring must be thawed before it works.
Base classes
- class Jazz2::Actors::ActorBase
- Base class of an object.
Public static functions
- static void Preload(const ActorActivationDetails& details)
- Preloads all assets required by this actor.
Constructors, destructors, conversion operators
- Spring()
- Creates a new instance.
Public functions
- auto OnHandleCollision(ActorBase* other) -> bool override
- Called when the object collides with another object.
- auto Activate() -> Vector2f
- Activates the spring.
Public variables
- bool KeepSpeedX
- Whether player horizontal speed should be kept.
- bool KeepSpeedY
- Whether player vertical speed should be kept.
Protected functions
- auto OnActivatedAsync(const ActorActivationDetails& details) -> Task<bool> override
- Called when the object is created and activated.
- void OnUpdate(float timeMult) override
- Called every frame to update the object state.
- void OnUpdateHitbox() override
- Called when the hitbox needs to be updated.
- void OnSerializeState(Stream& dest) override
- Serializes the live state of the object to a level state snapshot.
- void OnDeserializeState(Stream& src) override
- Restores the live state of the object from a level state snapshot.
Function documentation
void Jazz2::
Serializes the live state of the object to a level state snapshot.
Called only if IsSerializable() returns true. Anything that is initialized from the event parameters in OnActivatedAsync() doesn't need to be stored, because the object is spawned again with the same parameters before OnDeserializeState() is called. Derived classes must call the base implementation first and read the data back in the same order.
void Jazz2::
Restores the live state of the object from a level state snapshot.
Called right after the object was spawned again (i.e., after OnActivatedAsync()) and before it's added to the level. Running transitions are not restored, because their callbacks cannot be serialized, so derived classes have to put the object into a state that doesn't wait for such a callback.