Skip to content

Commit

Permalink
Pre-genned docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@iChun
iChun committed May 31, 2021
1 parent 710a0dd commit 4c785ee
Show file tree
Hide file tree
Showing 10 changed files with 98 additions and 59 deletions.
12 changes: 6 additions & 6 deletions docs/components/config/Configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ First filter in [EventConfiguration](../EventConfiguration/). Filters Events by

## Fields

| Name | Type | Description | Additional Info |
| -------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `types` | LinkedHashMap<String, [Event](url.tbd) Array> | List of event types. | |
| `queue` | String Array | List of event types to be queued. | Each String in this Array defines a queue. The String may have a combination of several event types which will share the same queue |
| `ignoredTypes` | String Array | List of event types to ignore.<br /><br />These event types will not be triggered (and won't clutter your cache). | |
| `_for` | String | Which account/platform is this configuration for. If `null`, will be applied to all accounts.<br /><br />This goes downwards so if a `null` for is found, the configurations below will be omitted entirely (it short circuits). | Serialised as `for`. Erroneously named, remnants of the time when CCI was built for Streamlabs only. |
| Name | Type | Description | Additional Info |
| -------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `types` | LinkedHashMap&lt;String, [Event](url.tbd) Array&gt; | List of event types. | |
| `queue` | String Array | List of event types to be queued. | Each String in this Array defines a queue. The String may have a combination of several event types which will share the same queue |
| `ignoredTypes` | String Array | List of event types to ignore. | These event types will not be triggered (and won't clutter your cache). |
| `_for` | String | Which account/platform is this configuration for. If `null`, will be applied to all accounts. | This goes downwards so if a `null` for is found, the configurations below will be omitted entirely (it short circuits).<br /><br /> Serialised as `for`. Erroneously named, remnants of the time when CCI was built for Streamlabs only. |
6 changes: 3 additions & 3 deletions docs/components/config/Constants.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Constants contain `String` -> `Event Object` mappings for reference in [Event](.

## Fields

| Name | Type | Description | Additional Info |
| ------------ | ------------------------------------- | -------------------------------------- | ---------------------------------------------- |
| `info` | String | Additional info (for library purposes) | Read [Libraries](../../../advanced/libraries/) |
| Name | Type | Description | Additional Info |
| ------------ | ------------------------------------------- | -------------------------------------- | ---------------------------------------------- |
| `info` | String | Additional info (for library purposes) | Read [Libraries](../../../advanced/libraries/) |
| `conditions` | TreeMap&lt;String, [Condition](url.tbd)&gt; | Mapping of condition constants | |
| `outcomes` | TreeMap&lt;String, [Outcome](url.tbd)&gt; | Mapping of condition constants | |
| `events` | TreeMap&lt;String, [Event](url.tbd)&gt; | Mapping of condition constants | |
30 changes: 15 additions & 15 deletions docs/components/config/Event.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@ Deeper explanation of use available [here](../../../intermediate/configspecifics

## Fields

| Name | Type | Description | Additional Info |
| ----------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `name` | String | Optional name for this event, for Editor readability. | |
| `constantName` | String | The name of mapping to the Constant Event to reference. If this is set, we check against the Constant Event's conditions and trigger their outcomes. | Read [Constants](../../../intermediate/constants/) |
| `disabled` | Boolean | Disable this event? | |
| `conditions` | [Condition](url.tbd) Array | List of conditions required to trigger the event. | |
| `outcomes` | [Outcome](url.tbd) Array | List of outcomes to trigger if the event meets the conditions. | |
| `triggersFromAnyConditionMet` | Boolean | Does this event trigger from any condition that is met? | |
| `allowsOtherEventsToTrigger` | Boolean | Does triggering this event still allow other events to trigger? | |
| `singleOutcomeOnly` | Boolean | If there are multiple outcomes for the event, only the first outcome that succeeds? | |
| `playTime` | String | How long to play the event, in ticks. Only if the event type has been registered a queue. Set to -1 to skip the queue. | |
| `playTimeEvent` | [Event](url.tbd) | An event to trigger during the playTime of the Event ticks. Will have variables `$currentPlayTime` and `$totalPlayTime` inserted. | |
| `delay` | String | How long of a delay, in ticks, before playing the event. Supports variable insertion. | |
| `cooldown` | String | How often this event can be triggered, in ticks. Remove to have no cooldown. | |
| `disableShortCircuitWhenOnCooldown` | Boolean | Normally, if this event is on cooldown (and `allowsOtherEventsToTrigger` is disabled) and the conditions are met, this event stops other events triggering. This disables that. | |
| Name | Type | Description | Additional Info |
| ----------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `name` | String | Optional name for this event, for Editor readability. | |
| `constantName` | String | The name of mapping to the Constant Event to reference. If this is set, we check against the Constant Event's conditions and trigger their outcomes. | Read [Constants](../../../intermediate/constants/) |
| `disabled` | Boolean | Disable this event? | |
| `conditions` | [Condition](url.tbd) Array | List of conditions required to trigger the event. | |
| `outcomes` | [Outcome](url.tbd) Array | List of outcomes to trigger if the event meets the conditions. | |
| `triggersFromAnyConditionMet` | Boolean | Does this event trigger from any condition that is met? | |
| `allowsOtherEventsToTrigger` | Boolean | Does triggering this event still allow other events to trigger? | |
| `singleOutcomeOnly` | Boolean | If there are multiple outcomes for the event, only the first outcome that succeeds? | |
| `playTime` | String | How long to play the event, in ticks. Only if the event type has been registered a queue. | Set to -1 to skip the queue. |
| `playTimeEvent` | [Event](url.tbd) | An event to trigger during the playTime of the Event ticks. | Will have variables `$currentPlayTime` and `$totalPlayTime` inserted. |
| `delay` | String | How long of a delay, in ticks, before playing the event. | |
| `cooldown` | String | How often this event can be triggered, in ticks. | |
| `disableShortCircuitWhenOnCooldown` | Boolean | Normally, if this event is on cooldown (and `allowsOtherEventsToTrigger` is disabled) and the conditions are met, this event stops other events triggering. This disables that. | |

0 comments on commit 4c785ee

Please sign in to comment.