From 53ee7213e0fb36963034873963c2028f632d2138 Mon Sep 17 00:00:00 2001 From: Richy <72468758+Richy1111@users.noreply.github.com> Date: Fri, 20 Oct 2023 00:01:27 -0400 Subject: [PATCH 1/2] Update and rename lighting.md to variables.md --- src/content/docs/en-US/design/lighting.md | 18 ------------------ src/content/docs/en-US/design/variables.md | 5 +++++ 2 files changed, 5 insertions(+), 18 deletions(-) delete mode 100644 src/content/docs/en-US/design/lighting.md create mode 100644 src/content/docs/en-US/design/variables.md diff --git a/src/content/docs/en-US/design/lighting.md b/src/content/docs/en-US/design/lighting.md deleted file mode 100644 index b92d01156..000000000 --- a/src/content/docs/en-US/design/lighting.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Lighting ---- - -## Setup - -- Time of Day -- Or Map Set to Indoor + Brightness < 100% - -## Map Lights - -## Animations - -- Weather -- Projectiles -- Equipment -- Map Anims -- etc diff --git a/src/content/docs/en-US/design/variables.md b/src/content/docs/en-US/design/variables.md new file mode 100644 index 000000000..6bbc7d5e3 --- /dev/null +++ b/src/content/docs/en-US/design/variables.md @@ -0,0 +1,5 @@ +--- +title: Variables +--- + +Moving Lighting over to Mapping. Renamed to variables.md From 70142eddfa35b3cf78f8326611c76b8edcde592d Mon Sep 17 00:00:00 2001 From: Richy <72468758+Richy1111@users.noreply.github.com> Date: Fri, 20 Oct 2023 13:07:54 -0400 Subject: [PATCH 2/2] Update variables.md Finalized variable editor doc. --- src/content/docs/en-US/design/variables.md | 50 +++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/src/content/docs/en-US/design/variables.md b/src/content/docs/en-US/design/variables.md index 6bbc7d5e3..26361ee2b 100644 --- a/src/content/docs/en-US/design/variables.md +++ b/src/content/docs/en-US/design/variables.md @@ -2,4 +2,52 @@ title: Variables --- -Moving Lighting over to Mapping. Renamed to variables.md +## Overview +Creating variables are done via the `Variable Editor` under the `Game Editors` tab on the main interface. + +![Editor](https://github.com/Richy1111/Intersect-Documentation/assets/72468758/d984e2f1-11df-4e6d-bf40-f4666d2bf228) + +## Managing Variables + +![Management](https://github.com/Richy1111/Intersect-Documentation/assets/72468758/b4da65ff-3e1d-4602-bb00-7663c2460833) + +- Clicking on the first icon will create a new variable. +- Clicking on the variable in the list and clicking the second icon will delete that variable. +- Clicking on the third icon will sort the variables in alphabetical order. +- Clicking on the fourth icon will revert changes to a variable (Does not revert deletion). + +## Adding Variables + +### Variable Type + +![Variable Type](https://github.com/Richy1111/Intersect-Documentation/assets/72468758/3dbc5e48-9ce6-4c1d-ae21-a9c8ffd1d5eb) + +> Clicking these allows you to add/edit the variables defined. (`Player Variables`, `Global Variables`, `Guild Variables`, `User Variables`). + +- *Player variables*: These variables are saved within a character instance. +- *Global variables*: These variables are saved by the server which you can manually change the values within the Variable Editor. +- *Guild variables*: These variables are saved inside a guild instance. +- *User variables*: These variables are saved within an account instance. + +### Variable List + +![Variable List](https://github.com/Richy1111/Intersect-Documentation/assets/72468758/27c1f905-5f7f-45f5-86e8-fcd1d1816c48) + +> Clicking on the variable in this list will open the variable editor container window. + +### Variable Editor + +![Variable Boolean](https://github.com/Richy1111/Intersect-Documentation/assets/72468758/4ca4cd26-23bf-49de-95c2-276285f845e7) + +- *Name*: Allows you to set a name for your variable. +- *Folder*: Clicking on the + next to this field will allow you to create a folder for variable organization. +- *Type*: Allows you to set a variable type. The options are (`Boolean`, `String`, `Integer`) +- *Text Id*: Allows you to set an ID which can be called within a text event command. The variable text commands are below. + + \pv{ID} will show you the player variable within a text event command. + + \gv{ID} will show you the global variable within a text event command. + + \guildvar{ID} will show you the guild variable within a text event command. + + \uservar{ID} will show you the user variable within a text event command.