setViewArea

From RPTools Wiki
Revision as of 21:22, 3 May 2015 by Wolph42 (talk | contribs) (Created page with "{{MacroFunction |name=setViewArea |version=1.4 |description= Sets the currently viewed screen area, set by two cell coordinates, so that the two cells are at the edge of the scre...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

{{MacroFunction |name=setViewArea |version=1.4 |description= Sets the currently viewed screen area, set by two cell coordinates, so that the two cells are at the edge of the screen. If the map is "gridless", the coordinates will be pixel coordinates. A final optional parameter causes the view of any connected players to be set the same. Only GMs or trusted macros can trigger the view of all players to change.

|usage=

setViewArea(startX,startY,endX,endY [,allPlayers])

Parameters

  • startX - the x coordinate of the cell that will mark the upper left corner of the displayed area.
  • startY - the y coordinate of the cell that will mark the upper left corner of the displayed area.
  • endX - the x coordinate of the cell that will mark the lower right corner of the displayed area.
  • endYv - the x coordinate of the cell that will mark the lower right corner of the displayed area
  • allPlayers - Optional: If set to true (1) and called from a trusted macro, all players views will be set. Defaults to 0