Skip to content

Commit

Permalink
Adapter documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
gabber235 committed May 11, 2024
1 parent a0ce841 commit 5092cf3
Show file tree
Hide file tree
Showing 16 changed files with 239 additions and 14 deletions.
1 change: 1 addition & 0 deletions documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ first.
| [Chat Contains Text Event](./entries/event/on_message_contains_text.mdx) | When the player sends a chat message containing certain text |
| [Craft Item Event](./entries/event/craft_item_event.mdx) | Called when a player crafts an item |
| [Detect Command Ran Event](./entries/event/on_detect_command_ran.mdx) | When a player runs an existing command |
| [Fire Trigger Event](./entries/event/fire_trigger_event.mdx) | Trigger the event when a player runs `/tw fire <entry id/name> [player]` |
| [Interact Block Event](./entries/event/on_interact_with_block.mdx) | When the player interacts with a block |
| [Pickup Item Event](./entries/event/on_item_pickup.mdx) | When the player picks up an item |
| [Player Death Event](./entries/event/on_player_death.mdx) | When a player dies |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Fire Trigger Event

The `FireTriggerEventEntry` is an event that fires its triggers when the player runs `/tw fire <entry id/name> [player]`

## How could this be used?
This could be used to trigger an event when a player runs `/tw fire <entry id/name> [player]`


## Fields

<fields.EntryField name='Triggers' required multiple>
</fields.EntryField>
23 changes: 11 additions & 12 deletions documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,6 @@ first.
| ---- | ----------- |
| [Direct Entity Instance Path Stream](./entries/audience/direct_entity_instance_path_stream.mdx) | A Path Stream to a Direct Entity Instance |

### Audiences

| Name | Description |
| ---- | ----------- |
| [Direct Entity Instance Path Stream](./entries/audience/direct_entity_instance_path_stream.mdx) | A Path Stream to a Direct Entity Instance |

### Audiences

| Name | Description |
| ---- | ----------- |
| [Direct Entity Instance Path Stream](./entries/audience/direct_entity_instance_path_stream.mdx) | A Path Stream to a Direct Entity Instance |

### Cinematics

| Name | Description |
Expand All @@ -57,6 +45,7 @@ first.
| [Chested Horse Chest Data](./entries/data/chested_horse_chest_meta.mdx) | If the horse has a chest. |
| [Collar Color Data](./entries/data/collar_color_data.mdx) | The color of the cat's or wolfs collar |
| [Custom Name Data](./entries/data/custom_name_data.mdx) | The custom name of the entity |
| [Dancing Data](./entries/data/dancing_data.mdx) | Whether an entity is dancing |
| [Glowing Effect Data](./entries/data/glowing_effect_data.mdx) | If the entity is glowing |
| [Horse Eating Data](./entries/data/horse_eating_data.mdx) | If the horse is eating. |
| [Horse Rearing Data](./entries/data/horse_rearing_data.mdx) | If the horse is rearing. |
Expand All @@ -79,14 +68,24 @@ first.
| Name | Description |
| ---- | ----------- |
| [Cow Instance](./entries/entity/cow_instance.mdx) | An instance of a cow entity |
| [Enderman Instance](./entries/entity/enderman_instance.mdx) | An instance of a enderman entity |
| [Hoglin Instance](./entries/entity/hoglin_instance.mdx) | An instance of a hoglin entity |
| [Husk Instance](./entries/entity/husk_instance.mdx) | An instance of a husk entity |
| [Interaction Indicator Definition](./entries/entity/interaction_indicator_definition.mdx) | Interaction Indicator |
| [Iron Golem Instance](./entries/entity/iron_golem_instance.mdx) | An instance of an iron golem entity |
| [Item Display Instance](./entries/entity/item_display_instance.mdx) | An instance of an item display entity |
| [Npc Instance](./entries/entity/npc_instance.mdx) | An instance of a simplified premade npc |
| [Piglin Brute Instance](./entries/entity/piglin_brute_instance.mdx) | An instance of a piglin brute entity |
| [Piglin Instance](./entries/entity/piglin_instance.mdx) | An instance of a piglin entity |
| [Player Instance](./entries/entity/player_instance.mdx) | An instance of a player entity |
| [Self Npc Definition](./entries/entity/self_npc_definition.mdx) | The definition of the self NPC |
| [Skeleton Instance](./entries/entity/skeleton_instance.mdx) | An instance of a skeleton entity |
| [Stacked Entity Definition](./entries/entity/stacked_entity_definition.mdx) | A stacking of entities |
| [Text Display Instance](./entries/entity/text_display_instance.mdx) | An instance of a text display entity |
| [Villager Instance](./entries/entity/villager_instance.mdx) | An instance of a villager entity |
| [Warden Instance](./entries/entity/warden_instance.mdx) | An instance of a warden entity |
| [Witch Instance](./entries/entity/witch_instance.mdx) | An instance of a witch entity |
| [Zombie Instance](./entries/entity/zombie_instance.mdx) | An instance of a zombie entity |

### Events

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ import Link from '@docusaurus/Link';

# Fixed Location Activity

The "Fixed Location Activity" makes the entity always be in the same location.
The `FixedLocationActivityEntry` is an activity that freezes the entity in a specific location.

## How could this be used?
This could be used to freeze an entity in a specific location.


## Fields

<fields.EntryField name='Priority Override' optional>
The location of the activity
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Dancing Data

Whether an entity is dancing


## Fields

<fields.EntryField name='Dancing' required>
Whether the piglin is dancing.
</fields.EntryField>
<fields.EntryField name='Priority Override' optional>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Enderman Instance

An instance of a enderman 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Hoglin Instance

An instance of a hoglin 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Husk Instance

An instance of a husk 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Iron Golem Instance

An instance of an iron golem 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Piglin Brute Instance

An instance of a piglin brute 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Piglin Instance

An instance of a piglin 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Skeleton Instance

An instance of a skeleton 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Warden Instance

An instance of a warden 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Witch Instance

An instance of a witch 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as fields from '@site/src/components/EntryField';
import Admonition from '@theme/Admonition';
import Link from '@docusaurus/Link';

# Zombie Instance

An instance of a zombie 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='Activities' required multiple>
</fields.EntryField>
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ When such an objective is active, it will show an icon above any NPC.
The entity that the player needs to interact with.
</fields.EntryField>
<fields.EntryField name='Override Display' optional>
The objective display that will be shown to the player. Use <entity> to replace the entity name.
</fields.EntryField>
<fields.EntryField name='Priority Override' optional>
</fields.EntryField>

0 comments on commit 5092cf3

Please sign in to comment.