module

Boss Splash Screen

Endorsements
0
Installs
0.76%
Comments
0
Latest version1.1.11
Minimum Core10
Compatible Core12
Last updated5 months ago
Created7 months ago
Authors
Languages English
Systems All systems
Project source Project URL
A splash screen will be sent to all players that lasts 5 seconds


Settings

 

 

Activate the splash screen via 3 methods:

 

Token HUD




Actor Directory Context Menu

 

 


Macro
```
/**
 * Displays a splash screen with the Actor Image and Text
 * Any options not included will use their default values from the module settings.
 * If options message and actorImg are both included you do not need a target actor of selected token.
    * @param {string} actor  id of actor.
    * @param {string} sound  Path to an audio file to be played when splash screen is rendered.
    * @param {string} colorFirst  Hex value for the color of the top bar in the banner.
    * @param {string} colorSecond  Hex value for the color of the middle bar in the banner.
    * @param {string} colorThird  Hex value for the color of the middle bar in the banner.
    * @param {string} colorFont  Hex value for the text color of the message.
    * @param {string} colorShadow  Hex value for the drop shadow color of the message.
    * @param {string} message  The message to be rendered in the color bar. {{name}} will be replaced with the actor name
    * @param {string} fontFamily Font Family name for the message.
    * @param {string} actorImg  Path to an image to display on the banner.
    * @param {number} timer  Number of miliseconds for splash screen to be rendered.
    * @param {number} animationDuration  Number of seconds to complete the slide in animation.
    * @param {bool} close  Closes open overlay for all players.
    *
 */

let options = {
  actor: null,
  sound: null,
  colorFirst: null,
  colorSecond:null,
  colorThird: null,
  colorFont: null,
  colorShadow: null,
  message: null,
  fontFamily: null,
  actorImg: null,
  timer: null,
  animationDuration: null,
  close: null
};

game.bossSplash.splashBoss(options);
```

Examples

Splash currently selected Token's Actor

```game.bossSplash.splashBoss()```

Splash A specific Actor

```game.bossSplash.splashBoss({actor:"WNX5OQKPh4uaV7mW"})```

Splash the currently selected Token with all black bars

```game.bossSplash.splashBoss({colorFirst:"#000000",colorSecond:"#000000",colorThird:"#000000"})```

Splash specific art and message

```game.bossSplash.splashBoss({message:"Valeros The Mighty!", actorImg:"modules/pf2e-beginner-box/assets/portraits-heroes/iconics/valeros-2.webp"})```

Open boss splash with no dismisal timer
```game.bossSplash.splashBoss({timer:0})```

Close all open splash screens for all players
```game.bossSplash.splashBoss({close:true})```

 

Subscribe
Notify of
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x