-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
283 lines of code -> 93 files of documentation.
- Loading branch information
Showing
102 changed files
with
1,853 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Condition | ||
============= | ||
|
||
## Description | ||
|
||
cci.component.Condition.description | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| 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. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Conditional Condition | ||
============= | ||
|
||
## Description | ||
|
||
A condition, that if passes or fails, triggers a specific condition. A pre-check if you want. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Constant Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this condition to call a constant condition. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `name` | String | Name of the constant condition. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Game Settings Condition | ||
============= | ||
|
||
## Description | ||
|
||
Checks a Game Setting from the file. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `key` | String | Key to check. | | | ||
| `value` | String | Value to compare to value on file. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Inventory Condition | ||
============= | ||
|
||
## Description | ||
|
||
Checks a for inventory slots and puts the first itemstack into a variable. Fails if we can't find a single inventory slot from all targets. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Json Safe Condition | ||
============= | ||
|
||
## Description | ||
|
||
Makes Strings safe to be inserted into JSON lines | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `variableName` | String | Source string. | | | ||
| `variableResult` | String | Name of the variable to insert the result into. Will override existing variables. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Message Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this to check for a content in the event's message. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Mod Exists Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this condition to check if a mod is loaded. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `modId` | String | ID of the mod. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
19 changes: 19 additions & 0 deletions
19
docs/components/config/condition/MultipleConditionCondition.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Multiple Condition Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this condition for multiple conditions. Potentially used for a nested OR statement if "any" is turned on. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
Note Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this condition to load a note/note array into a variable. It will fail if the note/note array doesn't exist. Put note conditions higher up so the later conditions and outcomes will be able to use what's in the variable. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Notes List Condition | ||
============= | ||
|
||
## Description | ||
|
||
Put the list of note names into an array. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `variableName` | String | Variable to put the array into. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Player State Condition | ||
============= | ||
|
||
## Description | ||
|
||
Checks a few states of the client player. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `state` | String | State to check (use one): alive, invisible, onFire, onGround, poisoned, sleeping, sneaking, swimming, usingItem, withering, exists | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Random Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this to for a random chance for this condition to be met. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `chance` | Double | What is the chance for this condition to be met? 0.0 to 1.0. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Ranged Amount Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this to check for a range of values. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Read File Condition | ||
============= | ||
|
||
## Description | ||
|
||
Gets the lines of a file. Each line will be in variable $<file_name>_<line>, eg "$file_1", "$file_2". Total lines will be in $<file_name>_count, eg "$file_count". | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `fileName` | String | File Name. | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Server Condition | ||
============= | ||
|
||
## Description | ||
|
||
Condition will be met if you can trigger server-side outcomes. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
19 changes: 19 additions & 0 deletions
19
docs/components/config/condition/SpecificAmountCondition.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Specific Amount Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this to check for a specific value. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Specific User Condition | ||
============= | ||
|
||
## Description | ||
|
||
Use this to check for a specific username. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `username` | String | Username to check for. | | | ||
| `caseSensitive` | Boolean | cci.component.SpecificUserCondition.caseSensitive | | | ||
|
||
///Footnotes Go Here/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Statistics Condition | ||
============= | ||
|
||
## Description | ||
|
||
Checks for a player statistic. Please look at RequestStatisticsConditions first. | ||
|
||
<br /> | ||
|
||
## Fields | ||
|
||
| Name | Type | Description | Additional Info | | ||
| -------- | ------ | ----------- | --------------- | | ||
| `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/// | ||
|
||
[^-1]: Fields in *italics* are required for the Object to be valid. |
Oops, something went wrong.