-
-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
266 additions
and
83 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
27 changes: 27 additions & 0 deletions
27
documentation/docs/adapters/BasicAdapter/entries/action/firework.mdx
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,27 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Firework Action | ||
|
||
The `Firework Action Entry` is an action that spawns a firework. | ||
|
||
## How could this be used? | ||
This could be used to create a firework that displays a specific effect. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Triggers' required multiple> | ||
</fields.EntryField> | ||
<fields.CriteriaField /> | ||
<fields.ModifiersField /> | ||
<fields.EntryField name='Location' required> | ||
The location to spawn the firework. | ||
</fields.EntryField> | ||
<fields.EntryField name='Effects' required multiple> | ||
The effects to display on the firework. | ||
</fields.EntryField> | ||
<fields.EntryField name='Power' required> | ||
The power of the firework. | ||
</fields.EntryField> |
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
20 changes: 20 additions & 0 deletions
20
documentation/docs/adapters/BasicAdapter/entries/audience/cron_audience.mdx
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 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Cron Audience | ||
|
||
The `Cron Audience` entry filters an audience based on if the real-world time matches a cron expression. | ||
This will use the server's time, not the player's time. | ||
|
||
## How could this be used? | ||
This could be used for limited time events, like a holiday. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Children' required multiple> | ||
</fields.EntryField> | ||
<fields.EntryField name='Cron' required> | ||
The <Link to="https://www.netiq.com/documentation/cloud-manager-2-5/ncm-reference/data/bexyssf.html">Cron Expression</Link> when the fact expires. | ||
</fields.EntryField> |
21 changes: 21 additions & 0 deletions
21
...tion/docs/adapters/BasicAdapter/entries/audience/item_in_inventory_audience.mdx
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 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Item In Inventory Audience | ||
|
||
The `Item In Inventory Audience` entry filters an audience based on if they have a specific item in their inventory. | ||
|
||
## How could this be used? | ||
This could show a boss bar or sidebar based on if a player has a specific item in their inventory. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Children' required multiple> | ||
</fields.EntryField> | ||
<fields.EntryField name='Item' required> | ||
The item to check for in the inventory. | ||
</fields.EntryField> | ||
<fields.EntryField name='Inverted' required> | ||
</fields.EntryField> |
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
22 changes: 22 additions & 0 deletions
22
documentation/docs/adapters/BasicAdapter/entries/event/on_fish.mdx
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 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Fish Event | ||
|
||
The `Player Fish Event` is triggered when a player catches a fish or an item. | ||
|
||
## How could this be used? | ||
You can create custom fishing mechanics, such as catching a specific item when fishing in a specific location. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Triggers' required multiple> | ||
</fields.EntryField> | ||
<fields.EntryField name='Item In Hand' required> | ||
The item the player must be holding when the fish or item is caught. | ||
</fields.EntryField> | ||
<fields.EntryField name='Caught' required> | ||
The item that the player caught. | ||
</fields.EntryField> |
25 changes: 25 additions & 0 deletions
25
documentation/docs/adapters/BasicAdapter/entries/fact/countdown_fact.mdx
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,25 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Countdown Fact | ||
|
||
The `Cooldown Fact` is a fact reflects the time since the last set value. | ||
|
||
When the value is set, it will count every second down from the set value. | ||
|
||
Suppose the value is set to 10. | ||
Then after 3 seconds, the value will be 7. | ||
|
||
The countdown will continue regardless if the player is online/offline or if the server is online/offline. | ||
|
||
## How could this be used? | ||
This can be used to create a cooldown on a specific action. | ||
For example, daily rewards that the player can only get once a day. | ||
|
||
|
||
## Fields | ||
|
||
<fields.CommentField /> | ||
<fields.EntryField name='Group' required> | ||
</fields.EntryField> |
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
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
23 changes: 23 additions & 0 deletions
23
documentation/docs/adapters/EntityAdapter/entries/activity/path_activity.mdx
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 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Path Activity | ||
|
||
The `Path Activity` is an activity that moves along a predefined path. | ||
The entity will move to each location in the set in order. | ||
Once the entity reaches the last location, it will do the idle activity. | ||
|
||
## How could this be used? | ||
This could be used to have a tour guide that moves along the post-important paths. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Road Network' required> | ||
</fields.EntryField> | ||
<fields.EntryField name='Nodes' required multiple> | ||
</fields.EntryField> | ||
<fields.EntryField name='Idle Activity' required> | ||
The activity that will be used when the entity is at the final location. | ||
</fields.EntryField> |
24 changes: 24 additions & 0 deletions
24
documentation/docs/adapters/EntityAdapter/entries/activity/trigger_activity.mdx
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,24 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Trigger Activity | ||
|
||
The `Trigger Activity` entry is an activity that triggers a sequence when the activity starts or stops. | ||
|
||
## How could this be used? | ||
This could be used to trigger dialogue when the entity arrives at a certain location. | ||
Like a tour guide that triggers dialogue when the entity arrives at a point of interest. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Activity' required> | ||
The activity to use when this is active. | ||
</fields.EntryField> | ||
<fields.EntryField name='On Start' required> | ||
The sequence to trigger when the activity starts. | ||
</fields.EntryField> | ||
<fields.EntryField name='On Stop' required> | ||
The sequence to trigger when the activity stops. | ||
</fields.EntryField> |
16 changes: 0 additions & 16 deletions
16
documentation/docs/adapters/EntityAdapter/entries/data/horse_eating_data.mdx
This file was deleted.
Oops, something went wrong.
16 changes: 0 additions & 16 deletions
16
documentation/docs/adapters/EntityAdapter/entries/data/horse_rearing_data.mdx
This file was deleted.
Oops, something went wrong.
16 changes: 0 additions & 16 deletions
16
documentation/docs/adapters/EntityAdapter/entries/data/sheep_sheared_data.mdx
This file was deleted.
Oops, something went wrong.
16 changes: 0 additions & 16 deletions
16
documentation/docs/adapters/EntityAdapter/entries/data/wolf_begging_data.mdx
This file was deleted.
Oops, something went wrong.
23 changes: 23 additions & 0 deletions
23
documentation/docs/adapters/EntityAdapter/entries/entity/cat_instance.mdx
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 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Cat Instance | ||
|
||
The `Cat Instance` class is an entry that represents an instance of a cat entity. | ||
|
||
## How could this be used? | ||
|
||
This could be used to create a cat entity. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Definition' required> | ||
</fields.EntryField> | ||
<fields.EntryField name='Spawn Location' required> | ||
</fields.EntryField> | ||
<fields.EntryField name='Data' required multiple> | ||
</fields.EntryField> | ||
<fields.EntryField name='Activity' required> | ||
</fields.EntryField> |
25 changes: 25 additions & 0 deletions
25
documentation/docs/adapters/EntityAdapter/entries/entity/hit_box_definition.mdx
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,25 @@ | ||
import * as fields from '@site/src/components/EntryField'; | ||
import Admonition from '@theme/Admonition'; | ||
import Link from '@docusaurus/Link'; | ||
|
||
# Hit Box Definition | ||
|
||
The `HitBoxDefinition` class is an entry that represents a hit box for an entity to allow interaction with a different entity. | ||
|
||
## How could this be used? | ||
This could be when using a display entity since they don't have a hit box to allow interaction with. | ||
|
||
|
||
## Fields | ||
|
||
<fields.EntryField name='Base Entity' required> | ||
</fields.EntryField> | ||
<fields.EntryField name='Offset' required> | ||
The offset of the hit box relative to the base entity. | ||
</fields.EntryField> | ||
<fields.EntryField name='Width' required> | ||
The width of the hit box. | ||
</fields.EntryField> | ||
<fields.EntryField name='Height' required> | ||
The height of the hit box. | ||
</fields.EntryField> |
Oops, something went wrong.