Difference between revisions of "AI grid panel"

From Divinity Engine Wiki
Jump to: navigation, search
m (Protected "AI grid panel" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite)))
 
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[File:AIGridMenuIcon.png]]
+
== Overview ==
 +
[[File:Overview.png|none|1024px]]
 +
<sub>All 3 tabs of the AI Grid Panel</sub>
  
−
[[File:Overview.png|left|800px]]
+
 
 +
The AI Grid Panel is a panel that allows you to interact with the [[AI Grid]]. The panel has 5 major features:
 +
 
 +
* [[#The Header|The Header]], which features saving/loading, a toggle to set automatic reloading of the AI Grid on leaving [[Game Mode]] and 3 [[#The Interaction Modes|Interaction Modes]]
 +
* [[#The Generate Tab|Generating the AI Grid]], which allows you to regenerate grids ([[AI Grid]], [[Vision Grid]] and [[Material Grid]]) after making changes to your level or placing [[AI Seeders]]
 +
* [[#The Paint Movement Tab|Painting Movement]], which allows you to modify the automatically generated AI Grid with one of the AI Grid paint interaction modes
 +
* [[#The Paint Surfaces Tab|Painting Surfaces]], which allows you to paint [[Surfaces]] on the AI Grid using one of the AI Grid paint Interaction Modes
 +
* [[#The Show Grid Options|The Show Grid Options]], which can be configured to visualize different grids in your game view
 +
 
 +
<br />
 +
== Using the AI Grid Panel ==
 +
[[File:AIGridMenuIcon.png|none]]
 +
<sub>The menu item that opens the AI Grid Panel</sub>
 +
 
 +
 
 +
To open up the AI Grid Panel, click the "AI Grid" [[Menu]] item in the menu bar.
 +
 
 +
<br />
 +
=== The Header ===
 +
[[File:AIGridPanel_Header_SaveLoad.png|none|500px]]
 +
<sub>The Save/Load options</sub>
 +
 
 +
 
 +
The save and load buttons on the AI Grid Panel will save/load the AI Grid, the Material Grid and the Vision Grid. When loading, you will be prompted to save first if there are any unsaved changes. If you choose not to save, any changes made will be discarded.
 +
 
 +
 
 +
[[File:AIGridPanel_Header_AutoReload.png|none|500px]]
 +
<sub>The auto reload toggle</sub>
 +
 
 +
 
 +
The auto reload option sets whether or not the AI grids will automatically be reloaded after exiting game mode.<br />
 +
If this option is checked, any in-game changes to the AI grid (e.g. surfaces from spells cast) will be undone upon exiting game mode.<br />
 +
If this option is not checked, changes made in-game will remain after leaving the game mode, but it will not be possible to modify the AI grid in editor mode without reloading the AI grid first.
 +
 
 +
 
 +
[[File:AIGridPanel_InteractionModes.png|none|500px]]
 +
<sub>The interaction mode toggles<sub>
 +
 
 +
 
 +
The interaction mode toggles are used to activate their respective [[#The Interaction Modes|interaction modes]] and are only enabled if the current tab uses that interaction mode.
 +
 
 +
<br />
 +
=== The Generate Tab ===
 +
[[File:AIGridPanel_Tab_Generate.png|none|500px]]
 +
<sub>The generate tab</sub>
 +
 
 +
 
 +
The Generate tab has 2 major features:
 +
 
 +
* Partial generation of one or more selected grids within the selected area (see [[#The AI Select Interaction Mode|the AI Select Interaction Mode]])
 +
* Full generation of one or more selected grids
 +
 
 +
<br />
 +
=== The Paint Movement Tab ===
 +
[[File:AIGridPanel_Tab_PaintMovement.png|none|500px]]
 +
<sub>The paint movement tab</sub>
 +
 
 +
 
 +
The Paint Movement tab together with either the [[#The AI Paint Circle Interaction Mode|paint circle]] or [[#The AI Paint Square Interaction Mode|paint square]] interaction mode can be used to manually modify the walkable areas of your level.
 +
 
 +
To change which areas are walkable:
 +
# Select which AI Grid layer you want to modify (either the movement layer for characters or the projectile layer for projectiles)
 +
# Select whether you want an area to be walkable (Allow) or not walkable (Block)
 +
# Select which interaction mode you want to use (round or square brush)
 +
# Begin painting! <sup>[1]</sup>
 +
 
 +
 
 +
<sup>[1] An AI Grid regeneration is not needed after changing the walkable tiles</sup>
 +
 
 +
 
 +
When painting movement, the [[#Show AI Grid|grid visualization]] automatically switches to visualize the AI Grid with the corresponding movement layer checked. To disable this, simply scroll down the "Opacity" slider to 0.
 +
 
 +
<br />
 +
=== The Paint Surfaces Tab ===
 +
[[File:AIGridPanel_Tab_PaintSurfaces.png|none|500px]]
 +
<sub>The paint surfaces tab</sub>
 +
 
 +
 
 +
The Paint Surfaces tab together with either the [[#The AI Paint Circle Interaction Mode|paint circle]] or [[#The AI Paint Square Interaction Mode|paint square]] interaction mode can be used to paint surfaces in your level.
 +
 
 +
To paint surfaces in your level:
 +
# Select which layer you want to paint (Ground or Cloud)
 +
# Select which surfaces you want to paint (e.g. Water, Fire, Poison) <sup>[1]</sup> <sup>[2]</sup>
 +
# Select whether you want the surface to be Cursed, Blessed or neither
 +
# Select whether you want the surface to be Frozen, Electrified or neither
 +
# Begin painting! <sup>[3][4]</sup>
 +
 
 +
 
 +
<sup>[1] Surface combinations that are not possible for your current selection are automatically greyed out, a list of all possible surface combinations can be found on the [[Surfaces]] page</sup><br/>
 +
<sup>[2] The "Irreplaceable" surface can be used to paint an area where no surfaces can be created during the game</sup><br/>
 +
<sup>[3] An AI Grid regeneration is not needed after painting surfaces</sup><br/>
 +
<sup>[4] Surfaces painted under items that are marked as "IsSurfaceBlocker" will not be shown in game. The intention of such items (primarily doors) is to prevent surfaces created by spells to spread through/under them, but as a side effect no surfaces can appear under it.</sup>
 +
 
 +
 
 +
When painting surfaces, the [[#Show AI Grid|grid visualization]] automatically switches to visualize the AI Grid with Surfaces checked. To disable this, simply scroll down the "Opacity" slider to 0.
 +
 
 +
<br />
 +
=== The Show Grid Options ===
 +
[[File:AIGridPanel_Footer_Expanded.png|none|500px]]
 +
<sub>All the grid visualization options</sub>
 +
 
 +
 
 +
The Show Grid Options allow you to modify how the AI Grid is visualized in the editor's game render view. There are 4 major options for visualizing the AI Grid:
 +
 
 +
* Turn off grid visualization (None)
 +
* [[#Show AI Grid|Visualizing the AI Grid]] (AI) <sup>[1]</sup>
 +
* [[#Show Vision Grid|Visualizing the Vision Grid]] (Vision)
 +
* [[#Show Material Grid|Visualizing the Material Grid]] (Material)
 +
 
 +
 
 +
All visualization options share the "Opacity" and "View Distance<sup>[2]</sup>" sliders.
 +
 
 +
 
 +
<sup>[1] The AI Grid visualization has extra options as it is multi-layered and customizable</sup><br />
 +
<sup>[2] The View Distance slider determines the distance to which the grid is visualized</sup>
 +
 
 +
<br />
 +
==== Show AI Grid ====
 +
[[File:ShowGridAIOptions.png|none|500px]]
 +
<sub>Visualizing the AI Grid</sub>
 +
 
 +
 
 +
The AI Grid visualization has the following additional options which appear above the "Show Grid" box:
 +
* Global
 +
** Merged: shows the merged grid when checked
 +
** Generated: shows the generated grid when checked
 +
* Type
 +
** Movement: shows the movement layer when checked
 +
** Projectile: shows the projectile layer when checked
 +
* Layers
 +
** Painted layer: shows all the painted changes to movement when checked
 +
** Surfaces layer: shows all the painted changes to surfaces when checked
 +
** Dynamics layer: shows all the dynamic changes to movement (caused by non-static entities' [[AI Bounds]]) when checked
 +
 
 +
 
 +
The AI Grid '''movement''' layer visualization is color coded as follows:
 +
* Grass Green: tile is moveable (generated layer)
 +
* Sky Blue: Tile is blocked (generated layer)
 +
* Green: tile is moveable (merged layer)
 +
* Red: tile is blocked (merged layer)
 +
* Bright Green: Tile is painted moveable
 +
* Purple: Tile is painted blocked
 +
* Yellow: Tile is blocked by a character's AI bounds
 +
* Pink: Tile is blocked by an item's AI bounds
 +
* Other: Tile is colored by a surface
 +
 
 +
 
 +
The AI Grid '''projectile''' layer visualization is color coded the same as the movement layer with the following exceptions:
 +
* Oak: tile is moveable (merged layer)
 +
* Beige: tile is blocked (merged layer)
 +
 
 +
<br />
 +
==== Show Vision Grid ====
 +
[[File:ShowGridVisionOptions.png|none|500px]]
 +
<sub>Visualizing the Vision Grid at 80% opacity</sub>
 +
 
 +
 
 +
The Vision Grid visualization is color coded as follows:
 +
* <span style="color:#FFFF00">#FFFF00</span> Static + vision blocked
 +
* <span style="color:#FF00FF">#FF00FF</span> Static + shoot blocked
 +
* <span style="color:#FFFFFF">#FFFFFF</span> Static + shoot blocked + vision blocked
 +
* <span style="color:#00FF00">#00FF00</span> non static (movable) + vision blocked
 +
* <span style="color:#0000FF">#0000FF</span> non static (movable) + shoot blocked
 +
* <span style="color:#00FFFF">#00FFFF</span> non static (movable) + vision blocked + shoot blocked
 +
* <span style="color:#777777">#777777</span> terrain or static + shoot blocked + vision blocked and on top of terrain
 +
 
 +
<br />
 +
==== Show Material Grid ====
 +
[[File:ShowGridMaterialOptions.png|none|500px]]
 +
<sub>Visualizing the Material Grid at 50% opacity</sub>
 +
 
 +
 
 +
The Material Grid visualization is color coded as follows:
 +
* <span style="color:#FF00FF">#FF00FF</span> Unassigned
 +
* <span style="color:#FAC800">#FAC800</span> Sand
 +
* <span style="color:#6B452B">#6B452B</span> Dirt
 +
* <span style="color:#509E23">#509E23</span> Grass
 +
* <span style="color:#4B5557">#4B5557</span> Metal
 +
* <span style="color:#B85E2E">#B85E2E</span> Wood
 +
* <span style="color:#483896">#483896</span> Stone
 +
* <span style="color:#A678C2">#A678C2</span> Pebbles
 +
* <span style="color:#55DCE6">#55DCE6</span> Puddle
 +
* <span style="color:#BAFAFF">#BAFAFF</span> Ice
 +
* <span style="color:#D4F7FA">#D4F7FA</span> Snow
 +
* <span style="color:#43691A">#43691A</span> Ooze
 +
* <span style="color:#F74A05">#F74A05</span> Fire
 +
* <span style="color:#702252">#702252</span> Cloth
 +
* <span style="color:#C4C92A">#C4C92A</span> Leaves
 +
* <span style="color:#1C1717">#1C1717</span> Oil
 +
* <span style="color:#FF0000">#FF0000</span> Blood
 +
* <span style="color:#6062BA">#6062BA</span> Water
 +
* <span style="color:#D17373">#D17373</span> Flesh
 +
* <span style="color:#E3E08A">#E3E08A</span> Bone
 +
* <span style="color:#5B1F73">#5B1F73</span> Shadow
 +
* <span style="color:#FCA9B5">#FCA9B5</span> Ghost
 +
* <span style="color:#BA5438">#BA5438</span> Leather
 +
* <span style="color:#FF4000">#FF4000</span> Lava
 +
* <span style="color:#80FF80">#80FF80</span> Earth
 +
* <span style="color:#F0F0FF">#F0F0FF</span> Air
 +
* <span style="color:#F0F0FF">#F0F0FF</span> Rug
 +
* <span style="color:#00FFDD">#00FFDD</span> Glass
 +
* <span style="color:#265D00">#265D00</span> Forest
 +
* <span style="color:#BA5D00">#BA5D00</span> Wood_Creaky
 +
* <span style="color:#C8C8C8">#C8C8C8</span> BoneMail
 +
* <span style="color:#808080">#808080</span> ChainMail
 +
* <span style="color:#9C9C9C">#9C9C9C</span> PlateMail
 +
* <span style="color:#5B3512">#5B3512</span> ElvenArmor
 +
* <span style="color:#84720E">#84720E</span> ScaleMail
 +
 
 +
<br />
 +
== The Interaction Modes ==
 +
[[File:AIGridPanel_InteractionModes.png|none|500px]]
 +
<sub>The interaction mode toggles<sub>
 +
 
 +
 
 +
The AI Grid Panel features 3 [[Interaction Modes]]:
 +
 
 +
 
 +
* The [[#The AI Select Interaction Mode|AI Select]] interaction mode, which allows you to select cells on the AI Grid for a partial regenerate of the AI Grid
 +
* The [[#The AI Paint Circle Interaction Mode|Paint Circle]] interaction mode, which allows you to paint movement or surfaces with a round brush
 +
* The [[#The AI Paint Square Interaction Mode|Paint Square]] interaction mode, which allows you to paint movement or surfaces with a square brush
 +
 
 +
<br />
 +
=== The AI Select Interaction Mode ===
 +
[[File:InteractionMode_AISelect_PartialGenerate.png|none|500px]]
 +
<sub>Step-by-step guide showing how to use the AI Select Interaction Mode</sub>
 +
 
 +
<br />
 +
=== The AI Paint Square Interaction Mode ===
 +
[[File:InteractionMode_PaintSquare.png|none|500px]]
 +
<sub>Using the paint square interaction mode to block movement on the AI Grid</sub>
 +
 
 +
 
 +
As with every other interaction mode brush, the paint square interaction mode's brush can be scaled down with the '[' key and scaled up with the ']' key.
 +
 
 +
<br />
 +
=== The AI Paint Circle Interaction Mode ===
 +
[[File:InteractionMode_PaintCircle.png|none|500px]]
 +
<sub>Using the paint circle interaction mode to block movement on the AI Grid</sub>
 +
 
 +
 
 +
As with every other interaction mode brush, the paint circle interaction mode's brush can be scaled down with the '[' key and scaled up with the ']' key.

Latest revision as of 12:39, 2 October 2017

Overview

Overview.png

All 3 tabs of the AI Grid Panel


The AI Grid Panel is a panel that allows you to interact with the AI Grid. The panel has 5 major features:


Using the AI Grid Panel

AIGridMenuIcon.png

The menu item that opens the AI Grid Panel


To open up the AI Grid Panel, click the "AI Grid" Menu item in the menu bar.


The Header

AIGridPanel Header SaveLoad.png

The Save/Load options


The save and load buttons on the AI Grid Panel will save/load the AI Grid, the Material Grid and the Vision Grid. When loading, you will be prompted to save first if there are any unsaved changes. If you choose not to save, any changes made will be discarded.


AIGridPanel Header AutoReload.png

The auto reload toggle


The auto reload option sets whether or not the AI grids will automatically be reloaded after exiting game mode.
If this option is checked, any in-game changes to the AI grid (e.g. surfaces from spells cast) will be undone upon exiting game mode.
If this option is not checked, changes made in-game will remain after leaving the game mode, but it will not be possible to modify the AI grid in editor mode without reloading the AI grid first.


AIGridPanel InteractionModes.png

The interaction mode toggles


The interaction mode toggles are used to activate their respective interaction modes and are only enabled if the current tab uses that interaction mode.


The Generate Tab

AIGridPanel Tab Generate.png

The generate tab


The Generate tab has 2 major features:

  • Partial generation of one or more selected grids within the selected area (see the AI Select Interaction Mode)
  • Full generation of one or more selected grids


The Paint Movement Tab

AIGridPanel Tab PaintMovement.png

The paint movement tab


The Paint Movement tab together with either the paint circle or paint square interaction mode can be used to manually modify the walkable areas of your level.

To change which areas are walkable:

  1. Select which AI Grid layer you want to modify (either the movement layer for characters or the projectile layer for projectiles)
  2. Select whether you want an area to be walkable (Allow) or not walkable (Block)
  3. Select which interaction mode you want to use (round or square brush)
  4. Begin painting! [1]


[1] An AI Grid regeneration is not needed after changing the walkable tiles


When painting movement, the grid visualization automatically switches to visualize the AI Grid with the corresponding movement layer checked. To disable this, simply scroll down the "Opacity" slider to 0.


The Paint Surfaces Tab

AIGridPanel Tab PaintSurfaces.png

The paint surfaces tab


The Paint Surfaces tab together with either the paint circle or paint square interaction mode can be used to paint surfaces in your level.

To paint surfaces in your level:

  1. Select which layer you want to paint (Ground or Cloud)
  2. Select which surfaces you want to paint (e.g. Water, Fire, Poison) [1] [2]
  3. Select whether you want the surface to be Cursed, Blessed or neither
  4. Select whether you want the surface to be Frozen, Electrified or neither
  5. Begin painting! [3][4]


[1] Surface combinations that are not possible for your current selection are automatically greyed out, a list of all possible surface combinations can be found on the Surfaces page
[2] The "Irreplaceable" surface can be used to paint an area where no surfaces can be created during the game
[3] An AI Grid regeneration is not needed after painting surfaces
[4] Surfaces painted under items that are marked as "IsSurfaceBlocker" will not be shown in game. The intention of such items (primarily doors) is to prevent surfaces created by spells to spread through/under them, but as a side effect no surfaces can appear under it.


When painting surfaces, the grid visualization automatically switches to visualize the AI Grid with Surfaces checked. To disable this, simply scroll down the "Opacity" slider to 0.


The Show Grid Options

AIGridPanel Footer Expanded.png

All the grid visualization options


The Show Grid Options allow you to modify how the AI Grid is visualized in the editor's game render view. There are 4 major options for visualizing the AI Grid:


All visualization options share the "Opacity" and "View Distance[2]" sliders.


[1] The AI Grid visualization has extra options as it is multi-layered and customizable
[2] The View Distance slider determines the distance to which the grid is visualized


Show AI Grid

ShowGridAIOptions.png

Visualizing the AI Grid


The AI Grid visualization has the following additional options which appear above the "Show Grid" box:

  • Global
    • Merged: shows the merged grid when checked
    • Generated: shows the generated grid when checked
  • Type
    • Movement: shows the movement layer when checked
    • Projectile: shows the projectile layer when checked
  • Layers
    • Painted layer: shows all the painted changes to movement when checked
    • Surfaces layer: shows all the painted changes to surfaces when checked
    • Dynamics layer: shows all the dynamic changes to movement (caused by non-static entities' AI Bounds) when checked


The AI Grid movement layer visualization is color coded as follows:

  • Grass Green: tile is moveable (generated layer)
  • Sky Blue: Tile is blocked (generated layer)
  • Green: tile is moveable (merged layer)
  • Red: tile is blocked (merged layer)
  • Bright Green: Tile is painted moveable
  • Purple: Tile is painted blocked
  • Yellow: Tile is blocked by a character's AI bounds
  • Pink: Tile is blocked by an item's AI bounds
  • Other: Tile is colored by a surface


The AI Grid projectile layer visualization is color coded the same as the movement layer with the following exceptions:

  • Oak: tile is moveable (merged layer)
  • Beige: tile is blocked (merged layer)


Show Vision Grid

ShowGridVisionOptions.png

Visualizing the Vision Grid at 80% opacity


The Vision Grid visualization is color coded as follows:

  • #FFFF00 Static + vision blocked
  • #FF00FF Static + shoot blocked
  • #FFFFFF Static + shoot blocked + vision blocked
  • #00FF00 non static (movable) + vision blocked
  • #0000FF non static (movable) + shoot blocked
  • #00FFFF non static (movable) + vision blocked + shoot blocked
  • #777777 terrain or static + shoot blocked + vision blocked and on top of terrain


Show Material Grid

ShowGridMaterialOptions.png

Visualizing the Material Grid at 50% opacity


The Material Grid visualization is color coded as follows:

  • #FF00FF Unassigned
  • #FAC800 Sand
  • #6B452B Dirt
  • #509E23 Grass
  • #4B5557 Metal
  • #B85E2E Wood
  • #483896 Stone
  • #A678C2 Pebbles
  • #55DCE6 Puddle
  • #BAFAFF Ice
  • #D4F7FA Snow
  • #43691A Ooze
  • #F74A05 Fire
  • #702252 Cloth
  • #C4C92A Leaves
  • #1C1717 Oil
  • #FF0000 Blood
  • #6062BA Water
  • #D17373 Flesh
  • #E3E08A Bone
  • #5B1F73 Shadow
  • #FCA9B5 Ghost
  • #BA5438 Leather
  • #FF4000 Lava
  • #80FF80 Earth
  • #F0F0FF Air
  • #F0F0FF Rug
  • #00FFDD Glass
  • #265D00 Forest
  • #BA5D00 Wood_Creaky
  • #C8C8C8 BoneMail
  • #808080 ChainMail
  • #9C9C9C PlateMail
  • #5B3512 ElvenArmor
  • #84720E ScaleMail


The Interaction Modes

AIGridPanel InteractionModes.png

The interaction mode toggles


The AI Grid Panel features 3 Interaction Modes:


  • The AI Select interaction mode, which allows you to select cells on the AI Grid for a partial regenerate of the AI Grid
  • The Paint Circle interaction mode, which allows you to paint movement or surfaces with a round brush
  • The Paint Square interaction mode, which allows you to paint movement or surfaces with a square brush


The AI Select Interaction Mode

InteractionMode AISelect PartialGenerate.png

Step-by-step guide showing how to use the AI Select Interaction Mode


The AI Paint Square Interaction Mode

InteractionMode PaintSquare.png

Using the paint square interaction mode to block movement on the AI Grid


As with every other interaction mode brush, the paint square interaction mode's brush can be scaled down with the '[' key and scaled up with the ']' key.


The AI Paint Circle Interaction Mode

InteractionMode PaintCircle.png

Using the paint circle interaction mode to block movement on the AI Grid


As with every other interaction mode brush, the paint circle interaction mode's brush can be scaled down with the '[' key and scaled up with the ']' key.

Retrieved from "https://docs.larian.game/index.php?title=AI_grid_panel&oldid=3510"