Skip to content

Alter Minimap

Alter Minimap

Shows or hides areas of the current map's minimap fog of war, such as revealing the entire map once the party has found every key point.

Note: Only affects maps with Fog of War enabled; the change is saved with the game.

Properties

System

Name Explanation Type
All Levels Whether every level of the minimap is affected, rather than a single level. Toggle
Area The area of the level to show or hide: the entire level, every tile of a region, or every tile within a radius of a point.
Hide Whether the area is covered by fog again rather than revealed. Toggle
Level The index of the minimap level to affect, when not affecting all levels. Variable or Value
Radius The radius, in tiles, of the affected circle. Variable or Value
Region The region whose tiles are affected. Variable or Value
X The x-coordinate, in tiles, of the center of the affected circle. Variable or Value
Z The z-coordinate, in tiles, of the center of the affected circle. Variable or Value

Minimap Area

Name Explanation
Entire Level Affects every tile of the level.
Region Affects every tile with the given region.
Radius Affects every tile within a radius of a point.

Examples

Reveal the Entire Map

This removes the fog of war from every level of the current map's minimap, such as after the party has found every key point.

alter_minimap();

{"Data":{"Area":0,"IsAllLevels":1,"IsHidden":0,"Level":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Radius":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"3","VariableIndex":0,"Metadata":null},"Region":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Z":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.UserInterfaces.AlterMinimapCommand"}

Hide the Entire Map

This covers every level of the current map's minimap with fog of war again.

alter_minimap(hide);

{"Data":{"Area":0,"IsAllLevels":1,"IsHidden":1,"Level":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Radius":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"3","VariableIndex":0,"Metadata":null},"Region":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Z":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.UserInterfaces.AlterMinimapCommand"}

Reveal a Single Level

This removes the fog of war from level 1 of the current map's minimap only.

alter_minimap(level: 1);

{"Data":{"Area":0,"IsAllLevels":0,"IsHidden":0,"Level":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Radius":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"3","VariableIndex":0,"Metadata":null},"Region":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Z":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.UserInterfaces.AlterMinimapCommand"}

Reveal a Region

This reveals every tile of region 4 on every level of the current map's minimap.

alter_minimap(region: 4);

{"Data":{"Area":1,"IsAllLevels":1,"IsHidden":0,"Level":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Radius":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"3","VariableIndex":0,"Metadata":null},"Region":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"4","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Z":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.UserInterfaces.AlterMinimapCommand"}

Reveal a Radius Around a Point

This reveals a circle of radius 5 tiles on level 0, centered on the tile whose X and Z are stored in variables 1 and 2.

alter_minimap(level: 0, x: $gv[1], z: $gv[2], radius: 5);

{"Data":{"Area":2,"IsAllLevels":0,"IsHidden":0,"Level":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"Radius":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"5","VariableIndex":0,"Metadata":null},"Region":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"X":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":1,"Metadata":null},"Z":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":2,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.RPGCore.Models.Scripts.Commands.UserInterfaces.AlterMinimapCommand"}