Jazz2::Actors::Environment::Spring class

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.
static auto GetStrengthOfLegacySpeed(ILevelHandler* levelHandler, float speed, bool horizontal) -> float
Returns the strength a spring launches by for a speed of the original (pixels per tick at 70 Hz).

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.
auto GetLegacyLaunchSpeed() const -> Vector2f
Returns the launch speed of its color as the original has it, in pixels per tick at 70 Hz, the way it faces.
void SetLegacyLaunchSpeed(Vector2f speed)
Launches by a speed as the original has it, which also decides the way it faces.
auto GetTimeSinceLaunch() const -> float
Returns frames elapsed since the last launch, or -1 if it hasn't launched yet.
void Thaw()
Thaws a frozen 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::Actors::Environment::Spring::OnSerializeState(Stream& dest) override protected

Serializes the live state of the object to a level state snapshot.

State set from the event parameters needn't be stored, the object is spawned again with them. Derived classes call the base first and read the data back in the same order.

void Jazz2::Actors::Environment::Spring::OnDeserializeState(Stream& src) override protected

Restores the live state of the object from a level state snapshot.

Called after OnActivatedAsync(), before the object is added to the level. Running transitions aren't restored, so the restored state must not wait for a transition callback.