Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
get_all_regions_info [2026/08/27 03:48] hermann |
get_all_regions_info [2026/08/28 03:20] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Get All Regions Info ====== | ====== Get All Regions Info ====== | ||
| - | === Description === | + | ===== Description ===== |
| Returns a table with the boundaries of every region held by a region manager, one row per region. | Returns a table with the boundaries of every region held by a region manager, one row per region. | ||
| - | === Inputs === | + | ===== Inputs ===== |
| None. | None. | ||
| - | === Optional Inputs === | + | ===== Optional Inputs ===== |
| - | ^ Name ^ Type ^ Default ^ Description ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Region Manager | [[region_manager_type|Region Manager Type]] | Provided automatically | The region manager to read. When this functor is placed inside a [[Region Manager]], [[Region]], or [[For Each Region]] container, this port connects to that container's region manager automatically. | | + | | Region Manager | [[Region Manager Type]] | The region manager to read. When this functor is placed inside a [[Region Manager]], [[Region]], or [[For Each Region]] container, this port connects to that container's region manager automatically. | Provided automatically | |
| - | === Outputs === | + | ===== Outputs ===== |
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Regions Info | [[table_type|Table Type]] | Table with one row per region, with the columns Region Id (key), Region Lines, Region Columns, Region Top Y Coordinate, Region Left X Coordinate, Region Bottom Y Coordinate, and Region Right X Coordinate — the number of lines and columns of the region's map, and the coordinates of its top, left, bottom, and right boundaries. | | + | | Regions Info | [[Table Type]] | Table with one row per region, with the columns Region Id (key), Region Lines, Region Columns, Region Top Y Coordinate, Region Left X Coordinate, Region Bottom Y Coordinate, and Region Right X Coordinate — the number of lines and columns of the region's map, and the coordinates of its top, left, bottom, and right boundaries. | |
| - | === Group === | + | ===== Group ===== |
| - | [[functor_list#region|Region]] | + | [[Functor List#Region | Region]] |
| - | === Notes === | + | ===== Notes ===== |
| None. | None. | ||
| - | === Internal Name === | + | ===== Internal Name ===== |
| GetAllRegionsInfo | GetAllRegionsInfo | ||