indrajith/RCBASIC4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added Nirvana Tile functions to API docs

Browse Source
This commit is contained in:
n00b87
2025-09-09 22:01:00 -05:00
parent 91b7b1b3d7
commit a9d15d69ec
9 changed files with 162 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/doc_files/images/main_toolbar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.4 KiB

BIN
doc/doc_files/images/mesh_animation_panel.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
doc/doc_files/images/mesh_id_panel.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.1 KiB

BIN
doc/doc_files/images/mesh_material_panel.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.0 KiB

BIN
doc/doc_files/images/serenity_fx_var_panel.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.7 KiB

BIN
doc/doc_files/images/sn_project_tree.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

65
doc/doc_files/nirvana_api_tile.html
View File

@@ -11,6 +11,9 @@
<p> <p>
<br> <br>
</p> </p>
<p>
<h2><u><b>TILE MAP</b></u></h2><br>
</p>
<p> <p>
<b>Type Nirvana_TileMap</b> <b>Type Nirvana_TileMap</b>
</p> </p>
@@ -43,10 +46,10 @@
</li> </li>
</ul> </ul>
<p> <p>
<br> <br><br>
</p> </p>
<p> <p>
<b>Function Nirvana_GetLayerTileSetName$(layer_index)</b> <h2><u><b>TILE LAYER PROPERTIES</b></u></h2><br> <b>Function Nirvana_GetLayerTileSetName$(layer_index)</b>
</p> </p>
<ul> <ul>
<li> <li>
@@ -76,7 +79,10 @@
</li> </li>
</ul> </ul>
<p> <p>
<br> <br><br>
</p>
<p>
<h2><u><b>TILE MASK</b></u></h2><br>
</p> </p>
<p> <p>
<b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b> <b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b>
@@ -135,7 +141,58 @@
Returns TRUE if the tile at the given position is flagged in the given mask Returns TRUE if the tile at the given position is flagged in the given mask
<ul> <ul>
<li> <li>
NOTE: (x, y) is a world position and not a row and column position in the tile map NOTE: (x, y) is a world position and not a row/column position in the tile map
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<h2><u><b>SET/GET TILES</b></u></h2><br>
</p>
<p>
<b>Function Nirvana_GetTile(layer_index, x, y)</b>
</p>
<ul>
<li>
Return the tile index of the tile at the given map position
<ul>
<li>
NOTE: (x, y) is a row/colum position and not a world position in the tile map
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Nirvana_GetTileMapPosition(layer_index, stage_x, stage_y) As Nirvana_Vector2D</b>
</p>
<ul>
<li>
Return a Nirvana_Vector2D object with the row/column position of the tile at the absolute world position in the layer
<ul>
<li>
NOTE: (x, y) is a world position and not a row/column position in the tile map
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Nirvana_SetTile(layer_index, tile_index, x, y)</b>
</p>
<ul>
<li>
Sets the tile at the given row/column position in the tile map for the layer
<ul>
<li>
NOTE: (x, y) is a row/column position in the tile map
</li> </li>
</ul> </ul>
</li> </li>

65
doc/nirvana_docs/nirvana_api_tile.html
View File

@@ -11,6 +11,9 @@
<p> <p>
<br> <br>
</p> </p>
<p>
<h2><u><b>TILE MAP</b></u></h2><br>
</p>
<p> <p>
<b>Type Nirvana_TileMap</b> <b>Type Nirvana_TileMap</b>
</p> </p>
@@ -43,10 +46,10 @@
</li> </li>
</ul> </ul>
<p> <p>
<br> <br><br>
</p> </p>
<p> <p>
<b>Function Nirvana_GetLayerTileSetName$(layer_index)</b> <h2><u><b>TILE LAYER PROPERTIES</b></u></h2><br> <b>Function Nirvana_GetLayerTileSetName$(layer_index)</b>
</p> </p>
<ul> <ul>
<li> <li>
@@ -76,7 +79,10 @@
</li> </li>
</ul> </ul>
<p> <p>
<br> <br><br>
</p>
<p>
<h2><u><b>TILE MASK</b></u></h2><br>
</p> </p>
<p> <p>
<b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b> <b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b>
@@ -135,7 +141,58 @@
Returns TRUE if the tile at the given position is flagged in the given mask Returns TRUE if the tile at the given position is flagged in the given mask
<ul> <ul>
<li> <li>
NOTE: (x, y) is a world position and not a row and column position in the tile map NOTE: (x, y) is a world position and not a row/column position in the tile map
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<h2><u><b>SET/GET TILES</b></u></h2><br>
</p>
<p>
<b>Function Nirvana_GetTile(layer_index, x, y)</b>
</p>
<ul>
<li>
Return the tile index of the tile at the given map position
<ul>
<li>
NOTE: (x, y) is a row/colum position and not a world position in the tile map
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Nirvana_GetTileMapPosition(layer_index, stage_x, stage_y) As Nirvana_Vector2D</b>
</p>
<ul>
<li>
Return a Nirvana_Vector2D object with the row/column position of the tile at the absolute world position in the layer
<ul>
<li>
NOTE: (x, y) is a world position and not a row/column position in the tile map
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Nirvana_SetTile(layer_index, tile_index, x, y)</b>
</p>
<ul>
<li>
Sets the tile at the given row/column position in the tile map for the layer
<ul>
<li>
NOTE: (x, y) is a row/column position in the tile map
</li> </li>
</ul> </ul>
</li> </li>

44
doc/nirvana_docs/nirvana_api_tile.txt
View File

@@ -3,6 +3,9 @@
<br> <br>
<h2><u><b>TILE MAP</b></u></h2><br>
<b>Type Nirvana_TileMap</b> <b>Type Nirvana_TileMap</b>
#list ul #list ul
#li Dim TilesetName$ #li Dim TilesetName$
@@ -17,9 +20,10 @@
#list ul #list ul
#li Create a Nirvana TileMap #li Create a Nirvana TileMap
#/list #/list
<br> <br><br>
<h2><u><b>TILE LAYER PROPERTIES</b></u></h2><br>
<b>Function Nirvana_GetLayerTileSetName$(layer_index)</b> <b>Function Nirvana_GetLayerTileSetName$(layer_index)</b>
#list ul #list ul
#li Returns the name of tileset associated with the given layer or empty string if layer is not valid #li Returns the name of tileset associated with the given layer or empty string if layer is not valid
@@ -36,7 +40,9 @@
#list ul #list ul
#li Returns the RCBasic tile map associated with the given layer or -1 if layer is not valid #li Returns the RCBasic tile map associated with the given layer or -1 if layer is not valid
#/list #/list
<br> <br><br>
<h2><u><b>TILE MASK</b></u></h2><br>
<b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b> <b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b>
#list ul #list ul
@@ -53,7 +59,6 @@
#/list #/list
<br> <br>
<b>Function Nirvana_GetTileMaskName$(mask_index)</b> <b>Function Nirvana_GetTileMaskName$(mask_index)</b>
#list ul #list ul
#li Returns the name of the given tile mask or an empty string if the mask index is not valid #li Returns the name of the given tile mask or an empty string if the mask index is not valid
@@ -70,8 +75,39 @@
#list ul #list ul
#li Returns TRUE if the tile at the given position is flagged in the given mask #li Returns TRUE if the tile at the given position is flagged in the given mask
#list ul #list ul
#li NOTE: (x, y) is a world position and not a row and column position in the tile map #li NOTE: (x, y) is a world position and not a row/column position in the tile map
#/list #/list
#/list #/list
<br> <br>
<h2><u><b>SET/GET TILES</b></u></h2><br>
<b>Function Nirvana_GetTile(layer_index, x, y)</b>
#list ul
#li Return the tile index of the tile at the given map position
#list ul
#li NOTE: (x, y) is a row/colum position and not a world position in the tile map
#/list
#/list
<br>
<b>Function Nirvana_GetTileMapPosition(layer_index, stage_x, stage_y) As Nirvana_Vector2D</b>
#list ul
#li Return a Nirvana_Vector2D object with the row/column position of the tile at the absolute world position in the layer
#list ul
#li NOTE: (x, y) is a world position and not a row/column position in the tile map
#/list
#/list
<br>
<b>Function Nirvana_SetTile(layer_index, tile_index, x, y)</b>
#list ul
#li Sets the tile at the given row/column position in the tile map for the layer
#list ul
#li NOTE: (x, y) is a row/column position in the tile map
#/list
#/list
<br>