Skip to content

Commit

Permalink
REQUIRED
Browse files Browse the repository at this point in the history
  • Loading branch information
@iChun
iChun committed May 31, 2021
1 parent 0b510eb commit fb5f35a
Show file tree
Hide file tree
Showing 87 changed files with 248 additions and 248 deletions.
6 changes: 3 additions & 3 deletions docs/components/config/condition/Condition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ cci.component.Condition.description

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | cci.component.Condition.type | |
| `displayName` | String | Display name. What's this for? | |
| `inverseMatch` | Boolean | If the condition isn't met, consider it met and vice versa. | |
| *`type`* | String | cci.component.Condition.type | |
| *`displayName`* | String | Display name. What's this for? | |
| *`inverseMatch`* | Boolean | If the condition isn't met, consider it met and vice versa. | |

///Footnotes Go Here///

Expand Down
6 changes: 3 additions & 3 deletions docs/components/config/condition/ConditionalCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ A condition, that if passes or fails, triggers a specific condition. A pre-check
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `conditional` | Not seen in the Editor. |
| `condition` | Condition | The condition to check first. | |
| `passCondition` | Condition | If the condition passes, return this condition's result. | |
| `failCondition` | Condition | If the condition fails, return this condition's results. Optional. Will return false if the condition is not met and this is not set. | |
| *`condition`* | Condition | The condition to check first. | |
| *`passCondition`* | Condition | If the condition passes, return this condition's result. | |
| *`failCondition`* | Condition | If the condition fails, return this condition's results. Optional. Will return false if the condition is not met and this is not set. | |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/ConstantCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this condition to call a constant condition.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `constant` | Not seen in the Editor. |
| `name` | String | Name of the constant condition. | |
| *`name`* | String | Name of the constant condition. | |

///Footnotes Go Here///

Expand Down
4 changes: 2 additions & 2 deletions docs/components/config/condition/GameSettingsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Checks a Game Setting from the file.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `gameSettings` | Not seen in the Editor. |
| `key` | String | Key to check. | |
| `value` | String | Value to compare to value on file. | |
| *`key`* | String | Key to check. | |
| *`value`* | String | Value to compare to value on file. | |

///Footnotes Go Here///

Expand Down
6 changes: 3 additions & 3 deletions docs/components/config/condition/InventoryCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Checks a for inventory slots and puts the first itemstack into a variable. Fails
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `inventory` | Not seen in the Editor. |
| `target` | String | Target selector string to target. | |
| `index` | String | Index in the inventory to look for. | |
| `variableName` | String | Variable name to put the result into. | |
| *`target`* | String | Target selector string to target. | |
| *`index`* | String | Index in the inventory to look for. | |
| *`variableName`* | String | Variable name to put the result into. | |

///Footnotes Go Here///

Expand Down
4 changes: 2 additions & 2 deletions docs/components/config/condition/JsonSafeCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Makes Strings safe to be inserted into JSON lines
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `jsonSafe` | Not seen in the Editor. |
| `variableName` | String | Source string. | |
| `variableResult` | String | Name of the variable to insert the result into. Will override existing variables. | |
| *`variableName`* | String | Source string. | |
| *`variableResult`* | String | Name of the variable to insert the result into. Will override existing variables. | |

///Footnotes Go Here///

Expand Down
8 changes: 4 additions & 4 deletions docs/components/config/condition/MessageCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Use this to check for a content in the event's message.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `message` | Not seen in the Editor. |
| `optionalVariableName` | String | Do you want to search for a specific variable name? Remove to look for the default variable "message". | |
| `exactPhrase` | Boolean | Does this require an exact phrase? | |
| `caseSensitive` | Boolean | Is this phrase case sensitive? | |
| `phrase` | String | What is the phrase? | |
| *`optionalVariableName`* | String | Do you want to search for a specific variable name? Remove to look for the default variable "message". | |
| *`exactPhrase`* | Boolean | Does this require an exact phrase? | |
| *`caseSensitive`* | Boolean | Is this phrase case sensitive? | |
| *`phrase`* | String | What is the phrase? | |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/ModExistsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this condition to check if a mod is loaded.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `modExists` | Not seen in the Editor. |
| `modId` | String | ID of the mod. | |
| *`modId`* | String | ID of the mod. | |

///Footnotes Go Here///

Expand Down
4 changes: 2 additions & 2 deletions docs/components/config/condition/MultipleConditionCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Use this condition for multiple conditions. Potentially used for a nested OR sta
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `multiple` | Not seen in the Editor. |
| `conditions` | Condition[] | Array of conditions. | |
| `any` | Boolean | Will any of the conditions met trigger this condition? Basically an AND and OR switch. | |
| *`conditions`* | Condition[] | Array of conditions. | |
| *`any`* | Boolean | Will any of the conditions met trigger this condition? Basically an AND and OR switch. | |

///Footnotes Go Here///

Expand Down
12 changes: 6 additions & 6 deletions docs/components/config/condition/NoteCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Use this condition to load a note/note array into a variable. It will fail if th
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `note` | Not seen in the Editor. |
| `noteName` | String | Name of the note. | |
| `variableName` | String | Name of the variable to insert the note/note array. Will override event variables if they already exist. | |
| `loadNotesArray` | Boolean | Load the notes array instead of the simple note? | |
| `meetConditionIfNoteDoesNotExist` | Boolean | Should this condition be met even if the note or note array doesn't exist or has expired? | |
| `defaultVariableValue` | String | If the note does not exist, should there be a default variable value set? (Use commas with a space, for separate objects in arrays) | |
| `allowExpired` | Boolean | Allow the condition to pass even if the note has expired. | |
| *`noteName`* | String | Name of the note. | |
| *`variableName`* | String | Name of the variable to insert the note/note array. Will override event variables if they already exist. | |
| *`loadNotesArray`* | Boolean | Load the notes array instead of the simple note? | |
| *`meetConditionIfNoteDoesNotExist`* | Boolean | Should this condition be met even if the note or note array doesn't exist or has expired? | |
| *`defaultVariableValue`* | String | If the note does not exist, should there be a default variable value set? (Use commas with a space, for separate objects in arrays) | |
| *`allowExpired`* | Boolean | Allow the condition to pass even if the note has expired. | |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/NotesListCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Put the list of note names into an array.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `notesList` | Not seen in the Editor. |
| `variableName` | String | Variable to put the array into. | |
| *`variableName`* | String | Variable to put the array into. | |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/PlayerStateCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Checks a few states of the client player.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `playerState` | Not seen in the Editor. |
| `state` | String | State to check (use one): alive, invisible, onFire, onGround, poisoned, sleeping, sneaking, swimming, usingItem, withering, exists | |
| *`state`* | String | State to check (use one): alive, invisible, onFire, onGround, poisoned, sleeping, sneaking, swimming, usingItem, withering, exists | |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/RandomCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to for a random chance for this condition to be met.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `random` | Not seen in the Editor. |
| `chance` | Double | What is the chance for this condition to be met? 0.0 to 1.0. | |
| *`chance`* | Double | What is the chance for this condition to be met? 0.0 to 1.0. | |

///Footnotes Go Here///

Expand Down
10 changes: 5 additions & 5 deletions docs/components/config/condition/RangedAmountCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Use this to check for a range of values.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `range` | Not seen in the Editor. |
| `optionalVariableName` | String | Do you want to search for a specific variable name? Remove to look for the default variable "amount". | |
| `min` | Double | Minimum range (inclusive). Remove to have no minimum range. | |
| `max` | Double | Maximum range (inclusive). Remove to have no maximum range. | |
| `minVar` | String | Minimum range (inclusive) from a range. Takes priority over the number value. | |
| `maxVar` | String | Maximum range (inclusive) from a range. Takes priority over the number value. | |
| *`optionalVariableName`* | String | Do you want to search for a specific variable name? Remove to look for the default variable "amount". | |
| *`min`* | Double | Minimum range (inclusive). Remove to have no minimum range. | |
| *`max`* | Double | Maximum range (inclusive). Remove to have no maximum range. | |
| *`minVar`* | String | Minimum range (inclusive) from a range. Takes priority over the number value. | |
| *`maxVar`* | String | Maximum range (inclusive) from a range. Takes priority over the number value. | |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/ReadFileCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Gets the lines of a file. Each line will be in variable $<file_name>_<line>, eg
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `readFile` | Not seen in the Editor. |
| `fileName` | String | File Name. | |
| *`fileName`* | String | File Name. | |

///Footnotes Go Here///

Expand Down
4 changes: 2 additions & 2 deletions docs/components/config/condition/SpecificAmountCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Use this to check for a specific value.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `amount` | Not seen in the Editor. |
| `optionalVariableName` | String | Do you want to search for a specific variable name? Remove to look for the default variable "amount". | |
| `amount` | Double | Amount to check for. | |
| *`optionalVariableName`* | String | Do you want to search for a specific variable name? Remove to look for the default variable "amount". | |
| *`amount`* | Double | Amount to check for. | |

///Footnotes Go Here///

Expand Down
4 changes: 2 additions & 2 deletions docs/components/config/condition/SpecificUserCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Use this to check for a specific username.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `user` | Not seen in the Editor. |
| `username` | String | Username to check for. | |
| `caseSensitive` | Boolean | cci.component.SpecificUserCondition.caseSensitive | |
| *`username`* | String | Username to check for. | |
| *`caseSensitive`* | Boolean | cci.component.SpecificUserCondition.caseSensitive | |

///Footnotes Go Here///

Expand Down
4 changes: 2 additions & 2 deletions docs/components/config/condition/StatisticsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Checks for a player statistic. Please look at RequestStatisticsConditions first.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `stats` | Not seen in the Editor. |
| `statToCheck` | String | cci.component.StatisticsCondition.statToCheck | |
| `variableName` | String | The variable to put the statistic number into. Will return false if the statistics lookup failed. | |
| *`statToCheck`* | String | cci.component.StatisticsCondition.statToCheck | |
| *`variableName`* | String | The variable to put the statistic number into. Will return false if the statistics lookup failed. | |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/TargetExistsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to see if a certain target exists or not.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `targetExists` | Not seen in the Editor. |
| `target` | String | Target selector string to target. | |
| *`target`* | String | Target selector string to target. | |

///Footnotes Go Here///

Expand Down
12 changes: 6 additions & 6 deletions docs/components/config/condition/TwoHighSpaceCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Finds for a two block high air space around a target. Works similarly to the spr
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `freeSpace` | Not seen in the Editor. |
| `target` | String | Target selector string to target. | |
| `horiRadius` | String | Horizontal radius the check. | |
| `vertRadius` | String | Vertical radius to check. Make sure two of this is higher than Custom Height. | |
| `tries` | String | How many tries (horizontally) we try and check. Try not to put this too excessively high. | |
| `variableName` | String | Variable name to put the result into. | |
| `customHeight` | String | Custom Height. If left out, defaults to 2. Make sure two of vertRadius is higher than this number. | |
| *`target`* | String | Target selector string to target. | |
| *`horiRadius`* | String | Horizontal radius the check. | |
| *`vertRadius`* | String | Vertical radius to check. Make sure two of this is higher than Custom Height. | |
| *`tries`* | String | How many tries (horizontally) we try and check. Try not to put this too excessively high. | |
| *`variableName`* | String | Variable name to put the result into. | |
| *`customHeight`* | String | Custom Height. If left out, defaults to 2. Make sure two of vertRadius is higher than this number. | |

///Footnotes Go Here///

Expand Down
6 changes: 3 additions & 3 deletions docs/components/config/condition/array/ArrayAppendCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Array Append Condition

## Description

Adds a string to the array. Returns false if the variable is not an array.
Adds a string to the array. Fails if the variable is not an array.

<br />

Expand All @@ -12,8 +12,8 @@ Adds a string to the array. Returns false if the variable is not an array.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `arrayAppend` | Not seen in the Editor. |
| `variableName` | String | The name of the variable that stores the array. | |
| `stringToAdd` | String | String to add to the array. | |
| *`variableName`* | String | The name of the variable that stores the array. | |
| *`stringToAdd`* | String | String to add to the array. | |
| `create` | Boolean | Create the array if it doesn't exist? | |
| `isGlobal` | Boolean | Add to global variables? | |

Expand Down
8 changes: 4 additions & 4 deletions docs/components/config/condition/array/ArrayCombineCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Array Combine Condition

## Description

Combines two arrays.
Combines two arrays. Fails if either variables are not arrays.

<br />

Expand All @@ -12,9 +12,9 @@ Combines two arrays.
| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| *`type`* | String | Internal ID for serialisation: `arrayCombine` | Not seen in the Editor. |
| `variableName1` | String | The name of the variable with the first array. | |
| `variableName2` | String | The name of the variable with the second array. | |
| `variableOutputName` | String | The name of the variable to store the combined array. | |
| *`variableName1`* | String | The name of the variable with the first array. | |
| *`variableName2`* | String | The name of the variable with the second array. | |
| *`variableOutputName`* | String | The name of the variable to store the combined array. | |

///Footnotes Go Here///

Expand Down

0 comments on commit fb5f35a

Please sign in to comment.