How to display location
The locations are the places where the story take place.
You can add new locations in the admin panel in the Asset manager > Locations menu.
Each location is associated with a different background image.
LOCATION STATEMENT
The location statement is used to change location. In other word, it changes the background image of the stage.
A location statement consists of a single logical line beginning with the keyword location, followed by the location short code, followed by zero or more properties.
To display no location and therefore a black background, replace the location short code by none.
Optional parameters:
WITH
The transition animation used to change location.
Possible values:
- fade: the scene fades out then fade in with the new background image. By default, the scene fades to black but it is possible to define another color by adding the hexadecimal code of the color (ex: #ffffff, like explained here) or their CSS name (red, white...)
- dissolve: a gradual transition from the old background to the new one. Even if this transition is not functional now and is replaced by none, it should be soon supported. You can therefore use it, knowing that it will look better in the future.
- none: no transition, the background image disappears suddently
> location city with fade white
> location lake with fade #ffffff
AT
Define the alignment of the background image.
Possible values: center, top, bottom, left, right
> location forest at top
> location forest at bottom
It is possible to combine values:
EFFECT
Add an effect to the whole stage, including the characters sprite
Possible values:
- blur, blur light or blur heavy: blur the stage
- grayscale: the stageis displayed in black and white
- sepia: add a sepia filter to the stage
- dark, dark light or dark heavy: darken the stage
- bright, bright light or bright heavy: brighten the stage
- zoom, zoom light or zoom heavy: zoom in the stage, relatively x2, x1.5 and x3
- rain, rain light or rain heavy: add a rain effect to the stage
- snow, snow light or snow heavy: add a snow effect to the stage
- fog, fog light or fog heavy: add a fog effect to the stage
- flash: briefly display a white flash. By default, the flash is white but it is possible to define another color by adding the hexadecimal code of the color (ex: #ff0000, more here) or their CSS name (red, white...)
> location city effect flash #ff0000
It is possible to apply several effect at the same time by separating them with coma.
Some effects are not compatible together and cannot be applied at the same time:
- blur, grayscale, sepia, dark, bright
- rain, snow, fog
BEHIND
By default, a change of location resets everything onscreen. All characters are removed from the stage, as well as all effects.
To prevent this, simply add the parameter behind with no value.