Visual-Narrative-Website

Documentation

Quick documentation all the functions and how to use them. I think every one is used in sample_room.html.

Note: this document is not up to date anymore. I have not been updating it.

void add_clicker(x, y, width, height, id, picture_src, js)

The new clicker adding method. create a clicker at x, y, with size width, height.

It has an id (used for coding and logic), a background picture (optional!), and a function that executes on click.

void remove_clicker(id)

Removes the clicker that has the specified id. cannot be used to remove non-clicker elements (a bit of a no-brainer, but worth remembering)

bool inventory_has_item(name)

Returns true if there's an item with the name name in the inventory, false if not.

void inventory_add_item(name, img_src)

Add an item to the inventory, with a String name and a String img_src. the image should be 50x50 pixels, and formatted like this example: items/key.png. It won't add the item if you already have one with the same name.

void inventory_remove_item(name)

Remove the first item with the name name from the inventory.

void inventory_clear()

Remove everything from the inventory.

void subtitle_set(message)

Sets the subtitle beneath the inventory bar to the String message. Does not persist between rooms like the inventory. Use it for stuff like telling the player if a door is locked.

void picture_set(url)

Sets the background picture to url. Used at the creation of the room, but can be used for other cool stuff, if needed.

void background_set(color)

Sets the background color, outside of the viewing area.

void border_set(color)

Sets the border of the viewing area to a color. best used in conjunction with background_set for max cool

void nav_left(link)/ nav_right(link)/ nav_up(link)/ nav_down(link)

These functions set what room the left/right/top/bottom clickable areas send the player to.

new Sound(src)

Create a Sound object. with the source src.

void Sound.play()

Play the sound, once.

void Sound.playLooping()

Play the sound on repeat. NOTE: starts it from a RANDOM point, to make room transitions less repetitive

void Sound.pause()

Stop the sound.

void show_inline_view(picture_src, on_load)

show an inline view with the specified picture as the background.

executes the on_load function every time it loads. use this to create the inline clickers for it with add_inline_clicker()

void hide_inline_view()

hides the current inline view. clears all inline clickers.

void add_inline_clicker(x, y, width, height, id, picture_src, js)

same functionality as add_clicker(), but for the inline view. use this in the on_load function for show_inline_view.

void remove_inline_clicker(id)

same functionality as remove_clicker() but for the inline view. note: hide_inline_view() removes every inline clicker automatically.

void lose(message)

give the user a nice jumpscare, and end the game. (still needs sound!)

fun note: if the player tries to continue playing by pressing the back button, they get ANOTHER jumpscare and a reprimand for trying to CHEAT.

---

Debug

I have a debug variable set up right now. It prints the inventory in the top left corner, and outlines all the clickers in transparent yellow. If you want to turn it off, go into script.js and change

var debug = true;

to

var debug = false;

but be really careful about committing that tiny change to the github 'cause it could be really confusing idk

Todo