From 0d3d4463a24a5076f97d489191facb33638b3b07 Mon Sep 17 00:00:00 2001 From: Gabber235 Date: Fri, 12 Jul 2024 18:12:23 +0200 Subject: [PATCH] Update Adapter Documentation --- .../adapters/BasicAdapter/BasicAdapter.mdx | 5 ++++ .../BasicAdapter/entries/action/firework.mdx | 27 +++++++++++++++++++ .../entries/action/spawn_particles.mdx | 3 +++ .../entries/audience/cron_audience.mdx | 20 ++++++++++++++ .../audience/item_in_inventory_audience.mdx | 21 +++++++++++++++ .../entries/audience/trigger_audience.mdx | 2 ++ .../BasicAdapter/entries/event/on_fish.mdx | 22 +++++++++++++++ .../entries/fact/countdown_fact.mdx | 25 +++++++++++++++++ .../entries/fact/value_placeholder.mdx | 3 ++- .../adapters/EntityAdapter/EntityAdapter.mdx | 9 ++++--- .../entries/activity/path_activity.mdx | 23 ++++++++++++++++ .../entries/activity/trigger_activity.mdx | 24 +++++++++++++++++ .../entries/data/horse_eating_data.mdx | 16 ----------- .../entries/data/horse_rearing_data.mdx | 16 ----------- .../entries/data/sheep_sheared_data.mdx | 16 ----------- .../entries/data/wolf_begging_data.mdx | 16 ----------- .../entries/entity/cat_instance.mdx | 23 ++++++++++++++++ .../entries/entity/hit_box_definition.mdx | 25 +++++++++++++++++ .../entity/named_entity_definition.mdx | 6 ----- .../entity/stacked_entity_definition.mdx | 4 --- .../group_advanced_entity_instance.mdx | 25 +++++++++++++++++ .../individual_advanced_entity_instance.mdx | 8 +++++- .../shared_advanced_entity_instance.mdx | 6 ++++- .../event/mythicmobs_interact_event.mdx | 2 +- .../entries/event/on_mythic_mob_die.mdx | 2 +- 25 files changed, 266 insertions(+), 83 deletions(-) create mode 100644 documentation/docs/adapters/BasicAdapter/entries/action/firework.mdx create mode 100644 documentation/docs/adapters/BasicAdapter/entries/audience/cron_audience.mdx create mode 100644 documentation/docs/adapters/BasicAdapter/entries/audience/item_in_inventory_audience.mdx create mode 100644 documentation/docs/adapters/BasicAdapter/entries/event/on_fish.mdx create mode 100644 documentation/docs/adapters/BasicAdapter/entries/fact/countdown_fact.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/activity/path_activity.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/activity/trigger_activity.mdx delete mode 100644 documentation/docs/adapters/EntityAdapter/entries/data/horse_eating_data.mdx delete mode 100644 documentation/docs/adapters/EntityAdapter/entries/data/horse_rearing_data.mdx delete mode 100644 documentation/docs/adapters/EntityAdapter/entries/data/sheep_sheared_data.mdx delete mode 100644 documentation/docs/adapters/EntityAdapter/entries/data/wolf_begging_data.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/cat_instance.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/entity/hit_box_definition.mdx create mode 100644 documentation/docs/adapters/EntityAdapter/entries/instance/group_advanced_entity_instance.mdx diff --git a/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx b/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx index 035ecaccd4..f0d2a57d82 100644 --- a/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx +++ b/documentation/docs/adapters/BasicAdapter/BasicAdapter.mdx @@ -18,6 +18,7 @@ first. | [Console Command Action](./entries/action/console_run_command.mdx) | Run command from console | | [Delayed Action](./entries/action/delayed_action.mdx) | Delay an action for a certain amount of time | | [Drop Item Action](./entries/action/drop_item.mdx) | Drop an item at location, or on player | +| [Firework Action](./entries/action/firework.mdx) | Spawns a firework | | [Give Item Action](./entries/action/give_item.mdx) | Give an item to the player | | [Group Trigger Action](./entries/action/group_trigger_action.mdx) | Trigger the next entries for everyone in the same group as the player | | [Message Action](./entries/action/send_message.mdx) | Send a message to a player | @@ -43,10 +44,12 @@ first. | [Cinematic Audience](./entries/audience/cinematic_audience.mdx) | Filters an audience based on if they are in a cinematic | | [Closest Group Member Path Stream](./entries/audience/closest_group_member_path_stream.mdx) | A Path Stream to the Closest Group Member | | [Criteria Audience](./entries/audience/criteria_audience.mdx) | An audience filter based on criteria | +| [Cron Audience](./entries/audience/cron_audience.mdx) | Filters an audience based if the time matches a cron expression | | [Direct Location Path Stream](./entries/audience/direct_location_path_stream.mdx) | A Path Stream to a Direct Location | | [Game Time Audience](./entries/audience/game_time_audience.mdx) | Filters an audience based on the game time | | [Group Members Path Stream](./entries/audience/group_members_path_stream.mdx) | A Path Stream to Group Members | | [Holding Item Audience](./entries/audience/holding_item_audience.mdx) | Filters an audience based on if they are holding a specific item | +| [Item In Inventory Audience](./entries/audience/item_in_inventory_audience.mdx) | Filters an audience based on if they have a specific item in their inventory | | [Item In Slot Audience](./entries/audience/item_in_slot_audience.mdx) | Filters an audience based on if they have a specific item in a specific slot | | [Location Objectives Path Stream](./entries/audience/location_objectives_path_stream.mdx) | A Path Stream to tracked Location Objectives | | [Looping Cinematic Audience](./entries/audience/looping_cinematic_audience.mdx) | Show the audience members a cinematic that loops | @@ -99,6 +102,7 @@ first. | [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]` | +| [Fish Event](./entries/event/on_fish.mdx) | When the a player caught a fish or an item | | [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 | @@ -114,6 +118,7 @@ first. | Name | Description | | ---- | ----------- | +| [Countdown Fact](./entries/fact/countdown_fact.mdx) | A fact that counts down from the set value | | [Cron Fact](./entries/fact/cron_fact.mdx) | Saved until a specified date, like (0 0 * * 1 | | [In Audience Fact](./entries/fact/in_audience_fact.mdx) | The fact that the player is in the audience | | [In Cinematic Fact](./entries/fact/in_cinematic_fact.mdx) | If the player is in a cinematic | diff --git a/documentation/docs/adapters/BasicAdapter/entries/action/firework.mdx b/documentation/docs/adapters/BasicAdapter/entries/action/firework.mdx new file mode 100644 index 0000000000..a05249455e --- /dev/null +++ b/documentation/docs/adapters/BasicAdapter/entries/action/firework.mdx @@ -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 + + + + + + + The location to spawn the firework. + + + The effects to display on the firework. + + + The power of the firework. + diff --git a/documentation/docs/adapters/BasicAdapter/entries/action/spawn_particles.mdx b/documentation/docs/adapters/BasicAdapter/entries/action/spawn_particles.mdx index 67e0140a26..bab1f7d692 100644 --- a/documentation/docs/adapters/BasicAdapter/entries/action/spawn_particles.mdx +++ b/documentation/docs/adapters/BasicAdapter/entries/action/spawn_particles.mdx @@ -35,3 +35,6 @@ This action can be useful in a variety of situations. You can use it to create v The offset from the location on the Z axis. + + The speed of the particles. For some particles, this is the \"extra\" data value to control particle behavior. + diff --git a/documentation/docs/adapters/BasicAdapter/entries/audience/cron_audience.mdx b/documentation/docs/adapters/BasicAdapter/entries/audience/cron_audience.mdx new file mode 100644 index 0000000000..939b182f76 --- /dev/null +++ b/documentation/docs/adapters/BasicAdapter/entries/audience/cron_audience.mdx @@ -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 + + + + + The Cron Expression when the fact expires. + diff --git a/documentation/docs/adapters/BasicAdapter/entries/audience/item_in_inventory_audience.mdx b/documentation/docs/adapters/BasicAdapter/entries/audience/item_in_inventory_audience.mdx new file mode 100644 index 0000000000..095dafa98c --- /dev/null +++ b/documentation/docs/adapters/BasicAdapter/entries/audience/item_in_inventory_audience.mdx @@ -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 + + + + + The item to check for in the inventory. + + + diff --git a/documentation/docs/adapters/BasicAdapter/entries/audience/trigger_audience.mdx b/documentation/docs/adapters/BasicAdapter/entries/audience/trigger_audience.mdx index abfe82e2f9..7f18b671a7 100644 --- a/documentation/docs/adapters/BasicAdapter/entries/audience/trigger_audience.mdx +++ b/documentation/docs/adapters/BasicAdapter/entries/audience/trigger_audience.mdx @@ -13,6 +13,8 @@ This can be used to bridge the gap between audiences and sequence pages. ## Fields + The sequence to trigger when the player enters the audience. + The sequence to trigger when the player exits the audience. diff --git a/documentation/docs/adapters/BasicAdapter/entries/event/on_fish.mdx b/documentation/docs/adapters/BasicAdapter/entries/event/on_fish.mdx new file mode 100644 index 0000000000..8fcda3f087 --- /dev/null +++ b/documentation/docs/adapters/BasicAdapter/entries/event/on_fish.mdx @@ -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 + + + + + The item the player must be holding when the fish or item is caught. + + + The item that the player caught. + diff --git a/documentation/docs/adapters/BasicAdapter/entries/fact/countdown_fact.mdx b/documentation/docs/adapters/BasicAdapter/entries/fact/countdown_fact.mdx new file mode 100644 index 0000000000..4bbd63d244 --- /dev/null +++ b/documentation/docs/adapters/BasicAdapter/entries/fact/countdown_fact.mdx @@ -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 + + + + diff --git a/documentation/docs/adapters/BasicAdapter/entries/fact/value_placeholder.mdx b/documentation/docs/adapters/BasicAdapter/entries/fact/value_placeholder.mdx index ec7f2e3120..c415d70362 100644 --- a/documentation/docs/adapters/BasicAdapter/entries/fact/value_placeholder.mdx +++ b/documentation/docs/adapters/BasicAdapter/entries/fact/value_placeholder.mdx @@ -35,6 +35,7 @@ ADVENTURE: 2 SPECTATOR: 3 ``` If the placeholder returns `CREATIVE`, the fact value will be `1`. - If no value matches, the fact value will be `0`. + +Values can have placeholders inside them. diff --git a/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx b/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx index 449c6a88b9..d0f938b922 100644 --- a/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx +++ b/documentation/docs/adapters/EntityAdapter/EntityAdapter.mdx @@ -18,11 +18,13 @@ first. | [Game Time Activity](./entries/activity/game_time_activity.mdx) | A game time activity | | [In Dialogue Activity](./entries/activity/in_dialogue_activity.mdx) | An in dialogue activity | | [Look Close Activity](./entries/activity/look_close_activity.mdx) | A look close activity | +| [Path Activity](./entries/activity/path_activity.mdx) | Moving along a predefined path | | [Patrol Activity](./entries/activity/patrol_activity.mdx) | Moving around a set of locations | | [Player Close By Activity](./entries/activity/player_close_by_activity.mdx) | A player close by activity | | [Random Look Activity](./entries/activity/random_look_activity.mdx) | A random look activity | | [Target Location Activity](./entries/activity/target_location_activity.mdx) | A location activity | | [Timed Activity](./entries/activity/timed_activity.mdx) | Allows child activities for a limited amount of time | +| [Trigger Activity](./entries/activity/trigger_activity.mdx) | Triggers a sequence when the activity active or inactive | ### Audiences @@ -48,8 +50,6 @@ first. | [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. | | [Horse Variant Data](./entries/data/horse_variant_dat.mdx) | The variant of the horse. | | [Llama Carpet Color Data](./entries/data/llama_carpet_color_data.mdx) | The color of the llama's carpet. | | [Llama Variant Data](./entries/data/llama_variant_data.mdx) | The variant of the Llama. | @@ -59,17 +59,17 @@ first. | [Potion Effect Color Data](./entries/data/potion_effect_color_data.mdx) | The color of the potion effect particles | | [Rabbit Type Data](./entries/data/rabbit_type_data.mdx) | The type of the rabbit | | [Saddled Data](./entries/data/saddled_data.mdx) | If the entity has a saddle. | -| [Sheep Sheared Data](./entries/data/sheep_sheared_data.mdx) | If the sheep is sheared. | | [Skin Data](./entries/data/skin_data.mdx) | Skin data for players | | [Villager Data](./entries/data/villager_data.mdx) | A villager data | -| [Wolf Begging Data](./entries/data/wolf_begging_data.mdx) | The begging state of the wolf | ### Entitys | Name | Description | | ---- | ----------- | +| [Cat Instance](./entries/entity/cat_instance.mdx) | An instance of a cat entity | | [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 | +| [Hit Box Definition](./entries/entity/hit_box_definition.mdx) | A hit box for an entity to allow interaction with a different 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 | @@ -99,6 +99,7 @@ first. | Name | Description | | ---- | ----------- | +| [Group Advanced Entity Instance](./entries/instance/group_advanced_entity_instance.mdx) | An advanced instance of an entity | | [Individual Advanced Entity Instance](./entries/instance/individual_advanced_entity_instance.mdx) | An advanced instance of an entity | | [Shared Advanced Entity Instance](./entries/instance/shared_advanced_entity_instance.mdx) | An advanced instance of an entity | diff --git a/documentation/docs/adapters/EntityAdapter/entries/activity/path_activity.mdx b/documentation/docs/adapters/EntityAdapter/entries/activity/path_activity.mdx new file mode 100644 index 0000000000..0dd9dc783a --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/activity/path_activity.mdx @@ -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 + + + + + + + The activity that will be used when the entity is at the final location. + diff --git a/documentation/docs/adapters/EntityAdapter/entries/activity/trigger_activity.mdx b/documentation/docs/adapters/EntityAdapter/entries/activity/trigger_activity.mdx new file mode 100644 index 0000000000..f8452d357c --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/activity/trigger_activity.mdx @@ -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 + + + The activity to use when this is active. + + + The sequence to trigger when the activity starts. + + + The sequence to trigger when the activity stops. + diff --git a/documentation/docs/adapters/EntityAdapter/entries/data/horse_eating_data.mdx b/documentation/docs/adapters/EntityAdapter/entries/data/horse_eating_data.mdx deleted file mode 100644 index 398a936588..0000000000 --- a/documentation/docs/adapters/EntityAdapter/entries/data/horse_eating_data.mdx +++ /dev/null @@ -1,16 +0,0 @@ -import * as fields from '@site/src/components/EntryField'; -import Admonition from '@theme/Admonition'; -import Link from '@docusaurus/Link'; - -# Horse Eating Data - -If the horse is eating. - - -## Fields - - - If the horse is eating. - - - diff --git a/documentation/docs/adapters/EntityAdapter/entries/data/horse_rearing_data.mdx b/documentation/docs/adapters/EntityAdapter/entries/data/horse_rearing_data.mdx deleted file mode 100644 index 1ec4552b99..0000000000 --- a/documentation/docs/adapters/EntityAdapter/entries/data/horse_rearing_data.mdx +++ /dev/null @@ -1,16 +0,0 @@ -import * as fields from '@site/src/components/EntryField'; -import Admonition from '@theme/Admonition'; -import Link from '@docusaurus/Link'; - -# Horse Rearing Data - -If the horse is rearing. - - -## Fields - - - If the horse is rearing. - - - diff --git a/documentation/docs/adapters/EntityAdapter/entries/data/sheep_sheared_data.mdx b/documentation/docs/adapters/EntityAdapter/entries/data/sheep_sheared_data.mdx deleted file mode 100644 index 041fe82d42..0000000000 --- a/documentation/docs/adapters/EntityAdapter/entries/data/sheep_sheared_data.mdx +++ /dev/null @@ -1,16 +0,0 @@ -import * as fields from '@site/src/components/EntryField'; -import Admonition from '@theme/Admonition'; -import Link from '@docusaurus/Link'; - -# Sheep Sheared Data - -If the sheep is sheared. - - -## Fields - - - If the sheep is sheared. - - - diff --git a/documentation/docs/adapters/EntityAdapter/entries/data/wolf_begging_data.mdx b/documentation/docs/adapters/EntityAdapter/entries/data/wolf_begging_data.mdx deleted file mode 100644 index ac89676af5..0000000000 --- a/documentation/docs/adapters/EntityAdapter/entries/data/wolf_begging_data.mdx +++ /dev/null @@ -1,16 +0,0 @@ -import * as fields from '@site/src/components/EntryField'; -import Admonition from '@theme/Admonition'; -import Link from '@docusaurus/Link'; - -# Wolf Begging Data - -The begging state of the wolf - - -## Fields - - - The begging state of the wolf. - - - diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/cat_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/cat_instance.mdx new file mode 100644 index 0000000000..23d128eb31 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/cat_instance.mdx @@ -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 + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/hit_box_definition.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/hit_box_definition.mdx new file mode 100644 index 0000000000..f08fed75a1 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/hit_box_definition.mdx @@ -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 + + + + + The offset of the hit box relative to the base entity. + + + The width of the hit box. + + + The height of the hit box. + diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/named_entity_definition.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/named_entity_definition.mdx index b8100ddd4f..0954532a40 100644 --- a/documentation/docs/adapters/EntityAdapter/entries/entity/named_entity_definition.mdx +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/named_entity_definition.mdx @@ -13,11 +13,5 @@ This can be used to allow for all entities to have a name and an indicator. ## Fields - - - - - - diff --git a/documentation/docs/adapters/EntityAdapter/entries/entity/stacked_entity_definition.mdx b/documentation/docs/adapters/EntityAdapter/entries/entity/stacked_entity_definition.mdx index 21d70ec155..fdd1471c4b 100644 --- a/documentation/docs/adapters/EntityAdapter/entries/entity/stacked_entity_definition.mdx +++ b/documentation/docs/adapters/EntityAdapter/entries/entity/stacked_entity_definition.mdx @@ -20,10 +20,6 @@ Like having a hologram above a mob. ## Fields - - - - The entities that will be stacked on top of each other. First entity will be the bottom entity. diff --git a/documentation/docs/adapters/EntityAdapter/entries/instance/group_advanced_entity_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/instance/group_advanced_entity_instance.mdx new file mode 100644 index 0000000000..dfc0491745 --- /dev/null +++ b/documentation/docs/adapters/EntityAdapter/entries/instance/group_advanced_entity_instance.mdx @@ -0,0 +1,25 @@ +import * as fields from '@site/src/components/EntryField'; +import Admonition from '@theme/Admonition'; +import Link from '@docusaurus/Link'; + +# Group Advanced Entity Instance + +The `Group Advanced Entity Instance` entry is an entity instance +that has the activity shared between a group of players viewing the instance. + +## How could this be used? +For example, having a party sees the npc in the same place. + + +## Fields + + + + + + + + + + + diff --git a/documentation/docs/adapters/EntityAdapter/entries/instance/individual_advanced_entity_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/instance/individual_advanced_entity_instance.mdx index 5f450e3d57..70562e78bb 100644 --- a/documentation/docs/adapters/EntityAdapter/entries/instance/individual_advanced_entity_instance.mdx +++ b/documentation/docs/adapters/EntityAdapter/entries/instance/individual_advanced_entity_instance.mdx @@ -4,7 +4,13 @@ import Link from '@docusaurus/Link'; # Individual Advanced Entity Instance -An advanced instance of an entity +The `Individual Advanced Entity Instance` entry is an entity instance +that has the activity unique to each player viewing the instance. + +It means that two players can see the same instance in different places. + +## How could this be used? +For escort quests where the player needs to follow the npc such as a guide. ## Fields diff --git a/documentation/docs/adapters/EntityAdapter/entries/instance/shared_advanced_entity_instance.mdx b/documentation/docs/adapters/EntityAdapter/entries/instance/shared_advanced_entity_instance.mdx index 7ad50e1d6a..7a484591f0 100644 --- a/documentation/docs/adapters/EntityAdapter/entries/instance/shared_advanced_entity_instance.mdx +++ b/documentation/docs/adapters/EntityAdapter/entries/instance/shared_advanced_entity_instance.mdx @@ -4,7 +4,11 @@ import Link from '@docusaurus/Link'; # Shared Advanced Entity Instance -An advanced instance of an entity +The `Shared Advanced Entity Instance` entry is an entity instance +that has the activity shared between all players viewing the instance. + +## How could this be used? +Simple npc's where everyone needs to see the same npc. ## Fields diff --git a/documentation/docs/adapters/MythicMobsAdapter/entries/event/mythicmobs_interact_event.mdx b/documentation/docs/adapters/MythicMobsAdapter/entries/event/mythicmobs_interact_event.mdx index 9d4a2b4351..267eee0c7f 100644 --- a/documentation/docs/adapters/MythicMobsAdapter/entries/event/mythicmobs_interact_event.mdx +++ b/documentation/docs/adapters/MythicMobsAdapter/entries/event/mythicmobs_interact_event.mdx @@ -15,6 +15,6 @@ This can be used to create a variety of interactions that can occur between a My - + The specific MythicMob type to listen for diff --git a/documentation/docs/adapters/MythicMobsAdapter/entries/event/on_mythic_mob_die.mdx b/documentation/docs/adapters/MythicMobsAdapter/entries/event/on_mythic_mob_die.mdx index 2103441406..586dd180a3 100644 --- a/documentation/docs/adapters/MythicMobsAdapter/entries/event/on_mythic_mob_die.mdx +++ b/documentation/docs/adapters/MythicMobsAdapter/entries/event/on_mythic_mob_die.mdx @@ -15,6 +15,6 @@ After killing a final boss, a dialogue or cinematic section can start. The playe - + Only trigger when a specific mob dies.