CrowdControlGamePack
Inherits: Resource < RefCounted < Object
A collection of effects, parameters, and metadata defining a CrowdControl session.
Description
CrowdControlGamePack encapsulates all the CrowdControlEffects available in your game. It also stores metadata through CrowdControlGamePackMeta. This pack can be exported to JSON for use in the CrowdControl Developer Portal.
Properties
|
||
Methods
void |
add_effect(effect: CrowdControlEffect) |
export_to_json(path: String) |
|
get_effect(effect_id: String) const |
|
void |
remove_effect(effect_id: String) |
to_json() const |
Property Descriptions
Array[CrowdControlEffect] effects = [] 🔗
void set_effects(value: Array[CrowdControlEffect])
Array[CrowdControlEffect] get_effects()
There is currently no description for this property. Please help us by contributing one!
CrowdControlGamePackMeta pack_meta 🔗
void set_pack_meta(value: CrowdControlGamePackMeta)
CrowdControlGamePackMeta get_pack_meta()
There is currently no description for this property. Please help us by contributing one!
Method Descriptions
void add_effect(effect: CrowdControlEffect) 🔗
Adds a new CrowdControlEffect to the game pack. Alternatively, you can edit the effects array directly.
Error export_to_json(path: String) 🔗
Exports the entire game pack (including all effects and metadata) to a JSON file at path. The generated file can be uploaded directly to the CrowdControl Developer Portal to rapidly define your game's interactivity schema.
CrowdControlEffect get_effect(effect_id: String) const 🔗
Searches the pack and returns the CrowdControlEffect with the matching effect_id. Returns null if none is found.
void remove_effect(effect_id: String) 🔗
Removes the CrowdControlEffect matching the given effect_id from the pack.
Dictionary to_json() const 🔗
Serializes this CrowdControlGamePack into a JSON-compatible dictionary. Normally called internally by export_to_json().