Skip to content

Commit

Permalink
A
Browse files Browse the repository at this point in the history
  • Loading branch information
@iChun
iChun committed May 31, 2021
1 parent 7f76024 commit a3e994c
Show file tree
Hide file tree
Showing 91 changed files with 91 additions and 91 deletions.
2 changes: 1 addition & 1 deletion docs/components/config/condition/ConditionalCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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` | |
| `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. | |
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 @@ -11,7 +11,7 @@ Use this condition to call a constant condition.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `constant` | |
| `type` | String | Internal ID for serialisation: `constant` | Not seen in the Editor. |
| `name` | String | Name of the constant condition. | |

///Footnotes Go Here///
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/GameSettingsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Checks a Game Setting from the file.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `gameSettings` | |
| `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. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/InventoryCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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` | |
| `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. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/JsonSafeCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Makes Strings safe to be inserted into JSON lines

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `jsonSafe` | |
| `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. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/MessageCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use this to check for a content in the event's message.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `message` | |
| `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? | |
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 @@ -11,7 +11,7 @@ Use this condition to check if a mod is loaded.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `modExists` | |
| `type` | String | Internal ID for serialisation: `modExists` | Not seen in the Editor. |
| `modId` | String | ID of the mod. | |

///Footnotes Go Here///
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/MultipleConditionCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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` | |
| `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. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/NoteCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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` | |
| `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? | |
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 @@ -11,7 +11,7 @@ Put the list of note names into an array.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `notesList` | |
| `type` | String | Internal ID for serialisation: `notesList` | Not seen in the Editor. |
| `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 @@ -11,7 +11,7 @@ Checks a few states of the client player.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `playerState` | |
| `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 | |

///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 @@ -11,7 +11,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` | |
| `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. | |

///Footnotes Go Here///
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/RangedAmountCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use this to check for a range of values.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `range` | |
| `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. | |
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 @@ -11,7 +11,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` | |
| `type` | String | Internal ID for serialisation: `readFile` | Not seen in the Editor. |
| `fileName` | String | File Name. | |

///Footnotes Go Here///
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/ServerCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Condition will be met if you can trigger server-side outcomes.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `server` | |
| `type` | String | Internal ID for serialisation: `server` | Not seen in the Editor. |

///Footnotes Go Here///

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/SpecificAmountCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use this to check for a specific value.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `amount` | |
| `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. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/SpecificUserCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use this to check for a specific username.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `user` | |
| `type` | String | Internal ID for serialisation: `user` | Not seen in the Editor. |
| `username` | String | Username to check for. | |
| `caseSensitive` | Boolean | cci.component.SpecificUserCondition.caseSensitive | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/StatisticsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Checks for a player statistic. Please look at RequestStatisticsConditions first.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `stats` | |
| `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. | |

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 @@ -11,7 +11,7 @@ Use this to see if a certain target exists or not.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `targetExists` | |
| `type` | String | Internal ID for serialisation: `targetExists` | Not seen in the Editor. |
| `target` | String | Target selector string to target. | |

///Footnotes Go Here///
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/TwoHighSpaceCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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` | |
| `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. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/array/ArrayAppendCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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` | |
| `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. | |
| `create` | Boolean | Create the array if it doesn't exist? | |
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/array/ArrayCombineCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Combines two arrays.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `arrayCombine` | |
| `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. | |
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/array/ArrayCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use this to check for a String in an array from a specific variable.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `array` | |
| `type` | String | Internal ID for serialisation: `array` | Not seen in the Editor. |
| `variableName` | String | The name of the variable you are targeting. | |
| `variableResult` | String | The result you are hoping to match with within the array. | |
| `caseSensitive` | Boolean | Be case sensitive? | |
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/array/ArrayDeleteCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Deletes a string from the array. Returns false if the variable is not an array o

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `arrayDelete` | |
| `type` | String | Internal ID for serialisation: `arrayDelete` | Not seen in the Editor. |
| `variableName` | String | The name of the variable that stores the array. | |
| `stringToRemove` | String | String to remove from the array. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/array/ArrayExplodeCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Explodes the array into a different variable per object. Returns false if the va

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `arrayExplode` | |
| `type` | String | Internal ID for serialisation: `arrayExplode` | Not seen in the Editor. |
| `variableName` | String | The name of the variable that stores the array. | |
| `variableOutputName` | String | The name of the variable to store the results. Size of array will be stored in variable <name>Length, and each individual object will be stored in variable <name>0-(length-1) | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/array/ArrayLengthCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Gets the length of an array. Returns false if the variable isn't an array.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `arrayLength` | |
| `type` | String | Internal ID for serialisation: `arrayLength` | Not seen in the Editor. |
| `variableName` | String | The name of the variable that stores the array. | |
| `variableOutputName` | String | The name of the variable to store the result. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/string/StringContainsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Checks if a string contains a target string

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `stringContains` | |
| `type` | String | Internal ID for serialisation: `stringContains` | Not seen in the Editor. |
| `source` | String | Source String. | |
| `target` | String | Target String. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/string/StringEndsWithCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Checks if a string ends with a target string

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `stringEnds` | |
| `type` | String | Internal ID for serialisation: `stringEnds` | Not seen in the Editor. |
| `source` | String | Source String. | |
| `target` | String | Target String. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/string/StringEqualsCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Checks if a string equals to the target string

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `stringEquals` | |
| `type` | String | Internal ID for serialisation: `stringEquals` | Not seen in the Editor. |
| `source` | String | Source String. | |
| `target` | String | Target String. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/string/StringStartsWithCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Checks if a string starts with a target string

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `stringStarts` | |
| `type` | String | Internal ID for serialisation: `stringStarts` | Not seen in the Editor. |
| `source` | String | Source String. | |
| `target` | String | Target String. | |

Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/string/StringSubStringCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Takes a part of a String based on the given parameters. Returns false if the ind

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `stringSubstr` | |
| `type` | String | Internal ID for serialisation: `stringSubstr` | Not seen in the Editor. |
| `source` | String | Source String. | |
| `beginIndex` | Integer | Start index for substring | |
| `endIndex` | Integer | End index for substring (optional) | |
Expand Down
2 changes: 1 addition & 1 deletion docs/components/config/condition/string/unconditional/Base64DecodeCondition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Decodes a string from Base64 and inserts it into a variable. Unconditional.

| Name | Type | Description | Additional Info |
| -------- | ------ | ----------- | --------------- |
| `type` | String | Internal ID for serialisation: `base64Decode` | |
| `type` | String | Internal ID for serialisation: `base64Decode` | Not seen in the Editor. |
| `value` | String | Value to decode. | |
| `variableResult` | String | cci.component.Base64DecodeCondition.variableResult | |

Expand Down

0 comments on commit a3e994c

Please sign in to comment.