jjv360 / HF-Zone-Message

A High Fidelity zone entity script which displays a message to the user when they enter your zone.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

High Fidelity: Zone Message

This is a zone client entity script for High Fidelity. It displays a message to users when they enter a zone.

Building

Call npm run build, and the script will be compiled into the dist/ folder.

Features

  • Webpack + Babel for latest JavaScript and npm package support
  • Display message to user
  • Display alert icon
  • Animate in
  • Message timeout
  • Control script for zone admin
  • Change in real-time
  • Layout and position options
  • Alert sound
  • Option to show only once
  • Upload to Marketplace

Advanced

Message data

The details of the message to display are taken from the userData property of the zone entity the script is attached to. Example:

"userData": {
    "com.jjv360.hf-zone-alert.current": {
        "icon": "info",
        "title": "Hello!",
        "text": "Welcome to my zone!",
        "footer": "Made by jjv360",
        "timeout": 15
    }
}

About

A High Fidelity zone entity script which displays a message to the user when they enter your zone.


Languages

Language:JavaScript 100.0%