CrowdControlEffectParameter

Inherits: Resource < RefCounted < Object

Defines configurable generic options for a CrowdControlEffect.

Description

CrowdControlEffectParameter allows effects to have options or dropdowns that viewers can fill out when triggering the effect. For example, selecting a specific color or target player.

Properties

Dictionary

options

{}

String

parameter_name

""

String

parameter_type

"options"

Methods

Dictionary

to_json() const

Property Descriptions

Dictionary options = {} 🔗

Used when the parameter represents a predefined set of values (e.g., dropdown or choice list).

Keys typically represent option identifiers, while values define their display names or metadata.

String parameter_name = "" 🔗

  • void set_parameter_name(value: String)

  • String get_parameter_name()

Used to identify and reference this parameter when passing values to an effect.

Must be consistent with the expected parameter key in the effect's configuration.

String parameter_type = "options" 🔗

  • void set_parameter_type(value: String)

  • String get_parameter_type()

Defines how the parameter value should be interpreted and presented.

Common types include "options", "number", "string", or "boolean".

The default "options" type indicates that selectable values are provided via the options dictionary.

Method Descriptions

Dictionary to_json() const 🔗

Serializes this CrowdControlEffectParameter into a JSON-compatible dictionary for API transmission.