BirdCage class
Bird cage.
Solid cage holding a captive companion bird (Chuck or Birdy). When the player breaks it open—by shooting it, hitting it with TNT, or smashing it while invincible—the bird is released and becomes the player's companion.
Base classes
- class Jazz2::Actors::SolidObjectBase
- Base class of a (pushable) solid object.
Public static functions
- static void Preload(const ActorActivationDetails& details)
- Preloads all assets required by this actor.
Constructors, destructors, conversion operators
- BirdCage()
- Creates a new instance.
Public functions
- auto OnHandleCollision(ActorBase* other) -> bool override
- Called when the object collides with another object.
- auto CanCauseDamage(ActorBase* collider) -> bool override
- Called to check whether
collidercan cause damage to the object.
Protected functions
- auto OnActivatedAsync(const ActorActivationDetails& details) -> Task<bool> override
- Called when the object is created and activated.
- 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:: BirdCage:: 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:: BirdCage:: 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.