SteamNote class
Steam note.
Decorative musical note that periodically puffs into view with a sound effect and then fades out, repeating on a cycle. It lifts a player in it while it is shown, it has no other effect on the player.
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
- SteamNote()
- Creates a new instance.
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 OnAnimationFinished() override
- Called when an animation finished.
- auto OnHandleCollision(ActorBase* other) -> bool override
- Called when the object collides with another object.
- 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:: SteamNote:: 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:: SteamNote:: 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.