This is an old revision of the document!
Hydrate
Content warning: One of the external shells contains mild gore. The thumbnail is in a spoiler section.
Hydrate is a collaborative ghost made by Zdzisiu and Zichqec, in celebration of “hydrate day” on 8/201). The ghost is focused on one single function; reminding the user to drink water at a regular, customizable interval, and giving positive reinforcement when a drink is taken. No random dialogue is available.
Features
- Tracks stats such as how many drinks you've taken in total, how many drinks you've taken that day, and displays them in a stats menu.
- An option for the user to indicate that they've taken an extra sip of water outside of the timed reminders.
- A dynamic shell and dressup menu built into the main menu.
- Motivational quotes, encouragement, and water facts in the right click menu.
- Uses only a single surface, making it easy to create custom shells.
- If other ghosts send a communication to Hydrate, Hydrate will return the user's drinking stats, as well as information about what shell and dressups it's currently using.
Communication Features
Hydrate comes with communication features that allow it to interact with other ghosts, without needing to update Hydrate itself. There are two methods for getting the stats, which can be used separately or in conjunction with each other.
The Commu Ping Method
When Hydrate is pinged by other ghosts using the OnCommunicate function, it will respond by sending back a message telling the ghost to Hydrate, and silently passing along the user's stats, hidden by a \e
If the developer includes HydrateStatsSilent
as a part of their message to Hydrate, Hydrate will send the stats silently, without displaying anything to the user.
The user's stats are sent as a simple array, and can be broken down with this code, or similar:
ConvoTag = SPLIT(reference1,"\e")[1] //This is splitting off everything after the \e in Hydrate's message, so the commas in the dialogue don't mess up the array _replyto = ConvoTag[0] //Anything the dev sent after the \e will be in here. _in_ checks should be used to check the contents of this, since it can contain other things. _session = TOINT(ConvoTag[1]) //How many drinks the user has taken this session _streak = TOINT(ConvoTag[2]) //How many drinks in a row the user has currently taken _total = TOINT(ConvoTag[3]) //How many total drinks the user has taken (note that this was not tracked until v1.1.0) _extratoday = TOINT(ConvoTag[4]) //How many extra sips the user has taken this session _extratotal = TOINT(ConvoTag[5]) //How many extra sips the user has taken total _shell = ConvoTag[6] //Name of the shell Hydrate is currently in _dressups = REPLACE(ConvoTag[7],"|-|",",") //Simple array of all the dressups Hydrate is currently using. How many there are will vary depending on the shell being used, but _in_ checks can be used to check for specific ones. _scale = TOINT(ConvoTag[8]) //Hydrate's current shell scaling, as a percentage.
This method is ideal for making comments about Hydrate's shell and dressups, to ensure that the ghost is using up-to-date info.
The raiseother Method
Every hour on the hour, Hydrate will use a raiseother command to send its stats to all other open ghosts. Any ghost can receive this event simply by adding this function.
OnHydrateGhostStats { Hydrate.session = TOINT(reference1) //How many drinks the user has taken this session Hydrate.streak = TOINT(reference2) //How many drinks in a row the user has currently taken Hydrate.total = TOINT(reference3) //How many total drinks the user has taken (note that this was not tracked until v1.1.0) Hydrate.extratoday = TOINT(reference4) //How many extra sips the user has taken this session Hydrate.extratotal = TOINT(reference5) //How many extra sips the user has taken total Hydrate.shell = reference6 //Name of the shell Hydrate is currently in Hydrate.dressups = REPLACE(reference7,"|-|",",") //Simple array of all the dressups Hydrate is currently using. How many there are will vary depending on the shell being used, but _in_ checks can be used to check for specific ones. Hydrate.scale = TOINT(reference8) //Hydrate's current shell scaling, as a percentage. }
This method is ideal for tracking the user's stats to comment on them over time.
This event is sent with raise and not notify, since it may be helpful in some situations, but it is recommended not to put dialogue in this function.
Balloon
Hydrate comes bundled with the H2O balloon, which is a small water-themed balloon created for use with Hydrate.
Shells
Name | Description | |
---|---|---|
![]() | Clear | The default shell. A clear plastic water bottle. |
External shells | ||
![]() | Teacup | A simple teacup with a rainbow dressup. |
![]() | Alkohol | A martini glass with liquids of various colors available as dressups. |
![]() | Poison | A bottle of poison with dressups to customize the color and label. |
![]() | Potion | A potion bottle with dressups to customize the color and label. |
![]() | Lava in a Cup | A mug of lava, with a metal straw dressup. |
Thumbnail hidden for mild gore | Martini Gore | A martini glass of blood with an eye floating in it. Dressups are available to change the color of the eye. |
![]() | Fishbowl | A fishbowl with a fish in it. Comes with multiple straw dressups in different colors. |
![]() | Rilakkuma | A cup of coffee with a bear face on it. |
![]() | LOL Mug | A mug with the word LOL printed on it, with different colors available as dressups. |
![]() | Ramune | A bottle of Ramune, with different flavors available as dressups. |
![]() | Milk | A small carton of milk, with different flavors available as dressups. |
![]() | Can | A soda can, with different flavors available as dressups. |
![]() | Metal Bottle | A metal bottle with different designs available as dressups. |
![]() | Not Haunted Water-Based Vegetarian Shoe | A shoe filled with water, which moves back and forth at random. |
![]() | Bishoujo Hydrate | A glass shaped like an anime girl, filled with water and including a giant straw. |
![]() | Geoffrey | An unsettling face holding a water bottle, which moves back and forth. |
![]() | Syringe | A syringe, with different lengths of needle and different colors of liquid available as dressups. Is also a shell for the ghost Needle. |
![]() | Ballpoint Pen | A ballpoint pen with different ink colors available as dressups. |
![]() | Bowie Bottle | A bottle with a straw, styled after the WIP ghost Bowie. |