Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.84 KB

notify-macro.md

File metadata and controls

51 lines (33 loc) · 2.84 KB
Raw

The Notify Macro

Back to the main readme.

This macro pops a message up that slides out from the right side of the screen, a short notification that's less distracting than a dialog or alert, for things like inventory changes, experience gains, or even achievements.

Note

Unlike most of my code, this macro requires you to install the CSS code as well in your story's Stylesheet section.

THE CODE: Minified JS Minified CSS. Pretty JS Pretty CSS.
DEMO: Available.
GUIDE: Not available.

Macro: <<notify>>

Syntax:<<notify [delay] [classList]>>...<</notify>>

The <<notify>> macro displays everything between it's tags in a small message box on the top right of the screen that slides in and slides out after a brief delay.

  • delay (optional) The amount of time the notification should remain visible, in milliseconds or CSS time. Defaults to two seconds.
  • classList (optional) An array of strings, list of space seperated stings, or some combination of the two, will be added to the notification as classes for styling.

Usage:

/% a simple, two-second-long notification with no added classes %/
<<notify>>Achievement unlocked!<</notify>>

/% a one-second-long notification with the 'inventory-update' class %/
<<notify 1s 'inventory-update'>>Found gold.<</notify>>

/% a lengthy five-second-long notification %/
<<notify 5s>>$xp experience points earned.<</notify>>

Function: setup.notify()

Syntax: setup.notify(message, delay, classes)

Simply a JavaScript version of the macro, for when you're working in JavaScript. Pass in the message to display as the first argument. Like with the macro, everything else is optional.

Returns: nothing.

Arguments:

  • message (string) the message the notification should display.
  • delay (number) (optional) The amount of time the notification should remain visible, in milliseconds. Defaults to 2000.
  • classList (string|string array) (optional) An array of strings, or list of space seperated stings, which will be added to the notification as classes for styling.

Other Usage Notes:

[!DANGER] Note that giving the player unlimited control over these notifications, or trying to show several at once or right after each other will cause them to trip over themselves as they try to animate, so try to keep them spaced out, and don't assign them to links or buttons you expect the player to press repeatedly.