From 5092cf32eeeba65604a15d60d720ce2325fc83ee Mon Sep 17 00:00:00 2001 From: Gabber235 Date: Sat, 11 May 2024 20:07:03 +0200 Subject: [PATCH] Adapter documentation update --- .../adapters/BasicAdapter/BasicAdapter.mdx | 1 + .../entries/event/fire_trigger_event.mdx | 16 +++++++++++++ .../adapters/EntityAdapter/EntityAdapter.mdx | 23 +++++++++---------- .../activity/fixed_location_activity.mdx | 6 +++-- .../entries/data/dancing_data.mdx | 16 +++++++++++++ .../entries/entity/enderman_instance.mdx | 19 +++++++++++++++ .../entries/entity/hoglin_instance.mdx | 19 +++++++++++++++ .../entries/entity/husk_instance.mdx | 19 +++++++++++++++ .../entries/entity/iron_golem_instance.mdx | 19 +++++++++++++++ .../entries/entity/piglin_brute_instance.mdx | 19 +++++++++++++++ .../entries/entity/piglin_instance.mdx | 19 +++++++++++++++ .../entries/entity/skeleton_instance.mdx | 19 +++++++++++++++ .../entries/entity/warden_instance.mdx | 19 +++++++++++++++ .../entries/entity/witch_instance.mdx | 19 +++++++++++++++ .../entries/entity/zombie_instance.mdx | 19 +++++++++++++++ .../quest/interact_entity_objective.mdx | 1 + 16 files changed, 239 insertions(+), 14 deletions(-) create mode 100644 documentation/docs/adapters/BasicAdapter/entries/event/fire_trigger_event.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/data/dancing_data.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/enderman_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/hoglin_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/husk_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/iron_golem_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/piglin_brute_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/piglin_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/skeleton_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/warden_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/witch_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/zombie_instance.mdx diff --git a/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx b/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx index cf04d26375..afd10c9ec4 100644 --- a/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx +++ b/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx @@ -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 [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 | diff --git a/documentation/docs/adapters/BasicAdapter/entries/event/fire_trigger_event.mdx b/documentation/docs/adapters/BasicAdapter/entries/event/fire_trigger_event.mdx new file mode 100644 index 0000000000..eb8ba8588e --- /dev/null +++ b/documentation/docs/adapters/BasicAdapter/entries/event/fire_trigger_event.mdx @@ -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 [player]` + +## How could this be used? +This could be used to trigger an event when a player runs `/tw fire [player]` + + +## Fields + + + diff --git a/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx b/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx index 832857e41a..85354e9b5d 100644 --- a/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx +++ b/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx @@ -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 | @@ -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. | @@ -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 diff --git a/documentation/docs/adapters/EntityAdapter/entries/activity/fixed_location_activity.mdx b/documentation/docs/adapters/EntityAdapter/entries/activity/fixed_location_activity.mdx index ef98ea4e5f..cfc31c275d 100644 --- a/documentation/docs/adapters/EntityAdapter/entries/activity/fixed_location_activity.mdx +++ b/documentation/docs/adapters/EntityAdapter/entries/activity/fixed_location_activity.mdx @@ -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 - The location of the activity diff --git a/documentation/docs/adapters/EntityAdapter/entries/data/dancing_data.mdx b/documentation/docs/adapters/EntityAdapter/entries/data/dancing_data.mdx new file mode 100644 index 0000000000..74c7617fc9 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/data/dancing_data.mdx @@ -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 + + + Whether the piglin is dancing. + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/enderman_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/enderman_instance.mdx new file mode 100644 index 0000000000..e16f24b129 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/enderman_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/hoglin_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/hoglin_instance.mdx new file mode 100644 index 0000000000..20618ce3bd --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/hoglin_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/husk_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/husk_instance.mdx new file mode 100644 index 0000000000..53ea76dc4e --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/husk_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/iron_golem_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/iron_golem_instance.mdx new file mode 100644 index 0000000000..75ef90691a --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/iron_golem_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/piglin_brute_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/piglin_brute_instance.mdx new file mode 100644 index 0000000000..23813666b2 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/piglin_brute_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/piglin_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/piglin_instance.mdx new file mode 100644 index 0000000000..5848eeff5e --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/piglin_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/skeleton_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/skeleton_instance.mdx new file mode 100644 index 0000000000..cd1139e698 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/skeleton_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/warden_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/warden_instance.mdx new file mode 100644 index 0000000000..4a6a0d45ad --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/warden_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/witch_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/witch_instance.mdx new file mode 100644 index 0000000000..1247297ad1 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/witch_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/zombie_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/zombie_instance.mdx new file mode 100644 index 0000000000..7913336734 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/zombie_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/quest/interact_entity_objective.mdx b/documentation/docs/adapters/EntityAdapter/entries/quest/interact_entity_objective.mdx index 7d2c9ef904..8cf3526c73 100644 --- a/documentation/docs/adapters/EntityAdapter/entries/quest/interact_entity_objective.mdx +++ b/documentation/docs/adapters/EntityAdapter/entries/quest/interact_entity_objective.mdx @@ -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. + The objective display that will be shown to the player. Use to replace the entity name.