Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Layers"

From Roll20 Wiki

Jump to: navigation, search
m
m (API)
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<div style="background:#f0e2a1; border: 3px solid #dbc870; padding: 10px;">
+
{{revdate}}{{HCbox| {{hc|articles/360039675053-Layers Layers}} }}
<big>'''''Attention:'''''
+
{{gm only tool}}
''Roll20 is no longer maintaining this document on the community wiki. For the most up-to-date information please visit this page on our [http://Roll20.net/help Help Center] for assistance: [https://roll20.zendesk.com/hc/en-us/articles/360039675053-Layers Here]. For more information you can email us at Team@roll20.net''</big>
+
Roll20 organizes the graphics on the page into several layers. This makes it easier for the [[Game Master]] to work with just a subset of the graphics, so for example you aren't moving the map around when you only mean to be interacting with the [[tokens]] on top of the map.
</div>
+
{{ToolboxNav}}
Roll20 organizes the graphics on the page into several layers. This makes it easier to work with just the set of graphics that you want, so for example you aren't moving the map around when you only mean to be interacting with the tokens on top of the map.
+
'''The "Layers Tool" is only visible to the [[GM]], not [[players]].'''
  
The '''Layers''' tool is found in the [[Toolbox]], on the left side of the [[Interface]].
+
The <span style="font-family:Pictos;">b</span> '''Layers''' tool is found in the [[Toolbox]], on the left side of the [[Interface]].[[File:Layer-selected.png|thumbnail|right|450px| The '''Layer'''-tool is highlighted on the [[Toolbar]], showing the four layers.]]
 +
__TOC__
  
== The Layers ==
+
= The Layers =
[[File:Layer-selected.png|thumb|right|450px]]
+
Depending on which layer you have selected, Roll20 shows, hides or "grays out" content on the map. Lines on the <span style="font-family:Pictos Custom;">r</span> Dynamic Lighting Layer''' is only visible when the layer is selected.
 +
==Map & Background==
 +
The  '''<span style="font-family:Pictos;">@</span> Map & Background Layer''' is intended for objects that will remain static throughout the game, such as the background map or pieces of furniture/decorations. So also move tokens of defeated character to the map layer to keep the visual while changing so that it doesn't interfere with other active tokens.
  
* '''<span style="font-family:Pictos;">@</span> Map & Background Layer''' is intended for objects that will remain static throughout the game, such as the background map or pieces of furniture/decorations.
+
When you have this layer selected, all tokens on the '''<span style="font-family:Pictos;">b</span> Objects & Tokens''' layer are "greyed out" and unselectable.
 +
{{#evp:youtube|a4BX0BsLjj0|Intro to {{Layers}}|right|500}}
 +
==Objects & Tokens==
 +
The '''<span style="font-family:Pictos;">b</span> Objects & Tokens Layer''' is intended for [[Token|tokens]] that you and the players will be manipulating throughout the game. Objects on this layer have a [[Token#Token_Features|special radial menu]] to allow you to quickly change their properties, and also show [[Token#Basic_tab|bars]] and [[Token Markers|token markers]].
  
* '''<span style="font-family:Pictos;">b</span> Objects/Tokens Layer''' is intended for tokens that you and the players will be manipulating throughout the game. Objects on this layer have a special radial menu to allow you to quickly change their properties, and also show bars and status markers.
+
==GM Info Overlay==
 +
The '''<span style="font-family:Pictos;">E</span> GM Info Overlay Layer''' can only be seen by the [[GM]]. It's a great place to put drawings or text to remind you of traps or other information about the map that only the GM should see. You can also move tokens to this layer to hide them from [[players]].
  
* '''<span style="font-family:Pictos;">E</span> GM Info Layer''' can only be seen by the GM. It's a great place to put drawings or text to remind you of traps or other information about the map that only the GM should see. You can also move tokens to this layer to hide them from players.
+
Any tokens on this layer are "greyed out" regardless of which layer is selected, to indicate that they are hidden from the player.
 +
{{clear}}
 +
==Dynamic Lighting==
 
{{plus only|section=true}}
 
{{plus only|section=true}}
* '''<span style="font-family:Pictos Custom;">r</span> Dynamic Lighting Layer''' is used for laying down lines and shapes that will serve as walls and/or obstacles that will block out light or line of sight.  Read more about [[Dynamic Lighting]] or [[Advanced Fog of War]].
+
'''<span style="font-family:Pictos Custom;">r</span> Dynamic Lighting Layer''' is used for laying down lines and shapes that will serve as walls and/or obstacles that will block out light, line of sight, and movement.  Read more about [[Dynamic Lighting]].
  
== Changing Layers ==
+
Lines and walls on the DL layer are only visible when you have this layer selected.
 
+
[[File:layersbutton.jpg]]
+
  
 +
When you have this layer selected, all tokens on both '''<span style="font-family:Pictos;">b</span> Objects & Tokens''' and '''<span style="font-family:Pictos;">E</span> GM Info Overlay'''-layers are "greyed out" and unselectable.
 +
{{#evp:youtube|gysii1q2GLU| [[Drawing Tools]] with [[DL|Dynamic Lighting]]|center|600}}
 +
{{clear}}
 +
= Changing Layers =
 +
[[File:layersbutton.jpg|right]]
 
To change between the available layers, just mouseover the Layers button on the Toolbox. You'll see the three available layers, click to switch to a new layer.
 
To change between the available layers, just mouseover the Layers button on the Toolbox. You'll see the three available layers, click to switch to a new layer.
  
 
You can also use the keyboard shortcuts:
 
You can also use the keyboard shortcuts:
 
+
* {{button|Ctrl}}/{{button|Cmd}}+{{button|M}}: Switch to <span style="font-family:Pictos;">@</span> '''Map/Background''' layer
* CTRL+M (CMD+M on Mac): Switch to the <span style="font-family:Pictos;">@</span> Maps layer
+
* {{button|Ctrl}}/{{button|Cmd}}+{{button|O}}: Switch to <span style="font-family:Pictos;">b</span> '''Object/Token''' layer
* CTRL+O (CMD+O on Mac): Switch to the <span style="font-family:Pictos;">b</span> Object/Tokens layer
+
* {{button|Ctrl}}/{{button|Cmd}}+{{button|K}}: Switch to <span style="font-family:Pictos;">E</span> '''GM Info''' layer
* CTRL+K (CMD+K on Mac): Switch to the <span style="font-family:Pictos;">E</span> GM Info layer
+
* CTRL+, (?CMD+, on Mac?): Switch to the <span style="font-family:Pictos Custom;">r</span> Dynamic Lighting layer
+
  
 
== Moving Objects Between Layers ==
 
== Moving Objects Between Layers ==
  
By default, when you create an object (such as by dragging and dropping a token image or a map onto the tabletop), it's placed on whatever the currently active layer is. Sometimes you may want to move objects between layers, though. To do so, you can right-click on the object, and from the Layers option in the menu that appears, select the new layer to which you would like to move the object.
+
By default, when you create an object (such as by dragging and dropping a [[token]] image or a map onto the tabletop), it's placed on whatever the currently active layer is. Sometimes you may want to move objects between layers, though. To do so, you can right-click on the object, and from the Layers option in the menu that appears, select the new layer to which you would like to move the object.
  
 
You can also use the keyboard shortcuts:
 
You can also use the keyboard shortcuts:
  
* CTRL+SHFT+M (CMD+SHIFT+M on Mac): Switch to the <span style="font-family:Pictos;">@</span> Maps layer AND move any selected objects to that layer
+
* {{button|Ctrl}}/{{button|Cmd}}+{{button|Shift}}+{{button|M}}: Switch to the <span style="font-family:Pictos;">@</span> Maps layer AND move any selected objects to that layer
* CTRL+SHFT+O (CMD+SHIFT+O on Mac): Switch to the <span style="font-family:Pictos;">b</span> Objects/Tokens layer AND move any selected objects to that layer
+
* {{button|Ctrl}}/{{button|Cmd}}+{{button|Shift}}+{{button|O}}: Switch to the <span style="font-family:Pictos;">b</span> Objects/Tokens layer AND move any selected objects to that layer
* CTRL+SHFT+K (CMD+SHIFT+K on Mac): Switch to the <span style="font-family:Pictos;">E</span> GM Info layer AND move any selected objects to that layer
+
* {{button|Ctrl}}/{{button|Cmd}}+{{button|Shift}}+{{button|K}}: Switch to the <span style="font-family:Pictos;">E</span> GM Info layer AND move any selected objects to that layer
* CTRL+SHFT+, (CMD+SHIFT+, on Mac): Switch to the <span style="font-family:Pictos Custom;">r</span> Dynamic Lighting layer AND move any selected objects to that layer (??)
+
 
<br>
 
<br>
 
A common use case of this is to move tokens from the <span style="font-family:Pictos;">E</span> GM Info layer (where they are not visible to players) to the <span style="font-family:Pictos;">b</span> Objects layer (where they are) when you want to &quot;reveal&quot; enemies to the players in a surprise attack.
 
A common use case of this is to move tokens from the <span style="font-family:Pictos;">E</span> GM Info layer (where they are not visible to players) to the <span style="font-family:Pictos;">b</span> Objects layer (where they are) when you want to &quot;reveal&quot; enemies to the players in a surprise attack.
  
=[[Toolbox]]=
+
=Modules=
* <span style="font-family:Pictos Custom;">w</span> [[Select and Pan Tool]]
+
In Roll20 marketplace modules, tokens, maps, info etc. are placed on the appropriate layer for the GM.
* <span style="font-family:Pictos;">b</span> [[Layers]]
+
 
* <span style="font-family:Pictos Three;">c</span> [[Drawing Tools]]
+
If a token is meant to be hidden/invisible to the player by default, it have been placed on the '''<span style="font-family:Pictos;">E</span> GM Info Overlay Layer''' and will look "greyed out". It will only be select-able when on the layer.
* <span style="font-family:Pictos;">e</span> [[Custom FX|FX Tool]]
+
 
* <span style="font-family:Pictos;">s</span> [[Zoom|Zoom Tool]]
+
Dynamic Lighting walls, doors and other features that are meant to restrict vision are places on the '''<span style="font-family:Pictos Custom;">r</span> Dynamic Lighting Layer'''. Doors, and hidden passages are usually color-coded differently from the walls to make them easier to spot and separate from the rest.
* [[File:Ruler.png|middle|15px]] [[Ruler|Ruler Tool]]
+
 
* <span style="font-family:Pictos;">E</span> [[Fog of War]]
+
=API=
* <span style="font-family:Pictos;">t</span> [[Turn Tracker]]
+
{{pro only|section}}
* <big><span style="font-family:dicefontd20;">t</span></big> [[Dice Rolling GUI]]
+
There area good number of API that can streamline moving tokens/graphics between layers, or even linking token between layers. Also see [[API:Script Index|API Index]] for more.
* <span style="font-family:Pictos;">?</span> [[Toolbox_Overview|Help Tool]]  
+
 
<br>
+
* [[TokenMod]] move token between layers with commands
<br>
+
** <code>!token-mod --set layer|?{Move to Layer|Map/Background,map|Object/Token,objects|GM Layer,gmlayer|Dynamic Lighting,walls}</code>
 +
* [[Script:Move Lighting|Move Lighting]] move drawings/DL lines between layers
 +
** <code>!movelight ?{Move to Layer|Map/Background,map|Object/Token,objects|GM Layer,gmlayer|Dynamic Lighting,walls} @{selected|token_id}</code>
 +
* [[Script:EncounterHelper|EncounterHelper]] -- Group tokens into encounters that can be shown, hidden, and reset to their initial values. With quick commands can move groups of tokens between layers quickly.
 +
* {{forum|10661242 Bump}} - provides a way to invisibly manipulate tokens on the GM Layer from the Objects Layer, and vice versa.
 +
 
 +
{{see toolbox}}
 +
 
 
[[Category:Docs]]
 
[[Category:Docs]]
 +
[[Category:Dynamic Lighting]]
 +
[[Category:Toolbar]]
 +
[[Category:Maps]]

Revision as of 17:54, 9 March 2022

Attention: This page is community-maintained. For the official Roll20 version of this article, see the Help Center for assistance: Layers .

Roll20 organizes the graphics on the page into several layers. This makes it easier for the Game Master to work with just a subset of the graphics, so for example you aren't moving the map around when you only mean to be interacting with the tokens on top of the map.

The "Layers Tool" is only visible to the GM, not players.

The b Layers tool is found in the Toolbox, on the left side of the Interface.
The Layer-tool is highlighted on the Toolbar, showing the four layers.

Contents


The Layers

Depending on which layer you have selected, Roll20 shows, hides or "grays out" content on the map. Lines on the r Dynamic Lighting Layer is only visible when the layer is selected.

Map & Background

The @ Map & Background Layer is intended for objects that will remain static throughout the game, such as the background map or pieces of furniture/decorations. So also move tokens of defeated character to the map layer to keep the visual while changing so that it doesn't interfere with other active tokens.

When you have this layer selected, all tokens on the b Objects & Tokens layer are "greyed out" and unselectable.

Intro to b Layers

Objects & Tokens

The b Objects & Tokens Layer is intended for tokens that you and the players will be manipulating throughout the game. Objects on this layer have a special radial menu to allow you to quickly change their properties, and also show bars and token markers.

GM Info Overlay

The E GM Info Overlay Layer can only be seen by the GM. It's a great place to put drawings or text to remind you of traps or other information about the map that only the GM should see. You can also move tokens to this layer to hide them from players.

Any tokens on this layer are "greyed out" regardless of which layer is selected, to indicate that they are hidden from the player.

Dynamic Lighting

r Dynamic Lighting Layer is used for laying down lines and shapes that will serve as walls and/or obstacles that will block out light, line of sight, and movement. Read more about Dynamic Lighting.

Lines and walls on the DL layer are only visible when you have this layer selected.

When you have this layer selected, all tokens on both b Objects & Tokens and E GM Info Overlay-layers are "greyed out" and unselectable.

Changing Layers

Layersbutton.jpg

To change between the available layers, just mouseover the Layers button on the Toolbox. You'll see the three available layers, click to switch to a new layer.

You can also use the keyboard shortcuts:

  • Ctrl/Cmd+M: Switch to @ Map/Background layer
  • Ctrl/Cmd+O: Switch to b Object/Token layer
  • Ctrl/Cmd+K: Switch to E GM Info layer

Moving Objects Between Layers

By default, when you create an object (such as by dragging and dropping a token image or a map onto the tabletop), it's placed on whatever the currently active layer is. Sometimes you may want to move objects between layers, though. To do so, you can right-click on the object, and from the Layers option in the menu that appears, select the new layer to which you would like to move the object.

You can also use the keyboard shortcuts:

  • Ctrl/Cmd+Shift+M: Switch to the @ Maps layer AND move any selected objects to that layer
  • Ctrl/Cmd+Shift+O: Switch to the b Objects/Tokens layer AND move any selected objects to that layer
  • Ctrl/Cmd+Shift+K: Switch to the E GM Info layer AND move any selected objects to that layer


A common use case of this is to move tokens from the E GM Info layer (where they are not visible to players) to the b Objects layer (where they are) when you want to "reveal" enemies to the players in a surprise attack.

Modules

In Roll20 marketplace modules, tokens, maps, info etc. are placed on the appropriate layer for the GM.

If a token is meant to be hidden/invisible to the player by default, it have been placed on the E GM Info Overlay Layer and will look "greyed out". It will only be select-able when on the layer.

Dynamic Lighting walls, doors and other features that are meant to restrict vision are places on the r Dynamic Lighting Layer. Doors, and hidden passages are usually color-coded differently from the walls to make them easier to spot and separate from the rest.

API

There area good number of API that can streamline moving tokens/graphics between layers, or even linking token between layers. Also see API Index for more.

  • TokenMod move token between layers with commands
    • !token-mod --set layer|?{Move to Layer|Map/Background,map|Object/Token,objects|GM Layer,gmlayer|Dynamic Lighting,walls}
  • Move Lighting move drawings/DL lines between layers
    • !movelight ?{Move to Layer|Map/Background,map|Object/Token,objects|GM Layer,gmlayer|Dynamic Lighting,walls} @{selected|token_id}
  • EncounterHelper -- Group tokens into encounters that can be shown, hidden, and reset to their initial values. With quick commands can move groups of tokens between layers quickly.
  • Bump(Forum) - provides a way to invisibly manipulate tokens on the GM Layer from the Objects Layer, and vice versa.

Toolbox