Added new functions to documentation
49
doc/doc_files/getactorshape.html
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>GetActorShape [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>function GetActorShape(actor) </h2></p>
|
||||||
|
<p>
|
||||||
|
Returns the shape of an actor
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Possible Actor Shapes
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_NONE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_BOX
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_SPHERE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CYLINDER
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CAPSULE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CONE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CONVEXHULL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_TRIMESH
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="setactorshape.html">SetActorShape</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
21
doc/doc_files/getmeshboundingbox.html
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>GetMeshBoundingBox [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Sub GetMeshBoundingBox( mesh, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z ) </h2></p>
|
||||||
|
<p>
|
||||||
|
Gets the min and max corners of a mesh's bounding box
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="setmeshboundingbox.html">SetMeshBoundingBox</a>
|
||||||
|
<a href="recalculatemeshboundingbox.html">ReCalculateMeshBoundingBox</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
45
doc/doc_files/getspriteshape.html
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>GetSpriteShape [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Function GetSpriteShape(spr_id) </h2></p>
|
||||||
|
<p>
|
||||||
|
Returns the shape of a sprite.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Possible Shapes
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_NONE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_BOX - A rectangular shape
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_POLYGON - A polygon (any shape with 3 or more sides)
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_CIRCLE - A circle
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_CHAIN - A open polygon shape
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Mainly used for terrain
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="setspriteshape.html">SetSpriteShape</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
20
doc/doc_files/getspriteshapeoffset.html
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>GetSpriteShapeOffset [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Sub GetSpriteShapeOffset( spr_id, ByRef x, ByRef y ) </h2></p>
|
||||||
|
<p>
|
||||||
|
Gets the relative location the sprite shape is from where it is rendered
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="setspriteshapeoffset.html">SetSpriteShapeOffset</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
BIN
doc/doc_files/images/material_preview_light.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
BIN
doc/doc_files/images/material_preview_settings.png
Normal file
|
After Width: | Height: | Size: 1.5 KiB |
BIN
doc/doc_files/images/new_stage_button.png
Normal file
|
After Width: | Height: | Size: 947 B |
BIN
doc/doc_files/images/nirvana_collision_shapes.png
Normal file
|
After Width: | Height: | Size: 34 KiB |
BIN
doc/doc_files/images/nirvana_image_settings.png
Normal file
|
After Width: | Height: | Size: 4.3 KiB |
BIN
doc/doc_files/images/nirvana_layer_settings.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
doc/doc_files/images/nirvana_project_stage_tab.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
doc/doc_files/images/nirvana_sprite_animation_editor.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
doc/doc_files/images/nirvana_sprite_shape_editor.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
doc/doc_files/images/nirvana_sprite_tools.png
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
doc/doc_files/images/nirvana_stage_copy_button.png
Normal file
|
After Width: | Height: | Size: 905 B |
BIN
doc/doc_files/images/nirvana_stage_editor_full_display.png
Normal file
|
After Width: | Height: | Size: 190 KiB |
BIN
doc/doc_files/images/nirvana_stage_editor_section1.png
Normal file
|
After Width: | Height: | Size: 155 KiB |
BIN
doc/doc_files/images/nirvana_stage_properties_button.png
Normal file
|
After Width: | Height: | Size: 759 B |
BIN
doc/doc_files/images/nirvana_tile_animation_editor.png
Normal file
|
After Width: | Height: | Size: 55 KiB |
BIN
doc/doc_files/images/nirvana_tile_mask_editor.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
doc/doc_files/images/nirvana_tilemap_tools.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
doc/doc_files/images/serenity_material_properties.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
doc/doc_files/images/serenity_material_texture_panel.png
Normal file
|
After Width: | Height: | Size: 7.7 KiB |
BIN
doc/doc_files/images/serenity_mesh_editor.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
doc/doc_files/images/serenity_scene_editor.png
Normal file
|
After Width: | Height: | Size: 855 KiB |
BIN
doc/doc_files/images/serenity_texture_view.png
Normal file
|
After Width: | Height: | Size: 9.4 KiB |
BIN
doc/doc_files/images/yeet_stage_button.png
Normal file
|
After Width: | Height: | Size: 734 B |
673
doc/doc_files/nirvana_api.html
Normal file
@@ -0,0 +1,673 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D API </h2></p>
|
||||||
|
<p>
|
||||||
|
This API is what allows developers to access objects created in the Nirvana2D editor inside RCBasic.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<h3><u>Nirvana Types</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim X
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Y
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Width
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Height
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Sprite</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim BaseName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Name_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_TileMap</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim TilesetName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Tileset_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim TileMap_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Background</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Image_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim RenderSetting
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Shape</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim ShapeType
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Layer</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim LayerType
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Visible
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Alpha
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Scroll_Speed As Nirvana_Vector2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Ref_Canvas
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_TileMap As Nirvana_TileMap
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Sprite_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Shape_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Bkg As Nirvana_Background
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Stage</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Active
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Tile_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Stage_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Viewport_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Stage_Offset As Nirvana_Vector2D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a 2D Vector
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a 2D Size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a Nirvana Sprite
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: spriteDefinition_name$ is the name of the base sprite created in the Sprite Editor
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a Nirvana TileMap
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>Nirvana Stages</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Loads a stage and sets the part of the window to render it to
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Sub Nirvana_Update()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
This update function must be used in place of Update() when using Nirvana2D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>Nirvana Layers</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerIndex(layer_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the internal nirvana index associated with the given layer name or -1 if layer name is not an existing layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerCanvasID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic canvas of the given nirvana layer index or -1 if layer_index is not a valid layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerType(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the layer type or -1 if layer_index is not a valid layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Layer Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_TILEMAP
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_SPRITE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_CANVAS_2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_CANVAS_3D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerName$(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given layer or an empty string if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerAlpha(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the layer alpha value set in the layer settings in Nirvana
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the HScroll and VScroll speed as a vector
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileSetName$(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of tileset associated with the given layer or empty string if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileSetID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic tileset associated with the given Nirvana layer or -1 if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMapID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic tile map associated with the given layer or -1 if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of tile mask on a layers tileset
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Nirvana tile mask index for the given mask number in a layer or -1 if not a valid layer or mask number
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
mask_num should be a number from 0 to Nirvana_GetLayerTileMaskCount(layer_index)-1
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerSpriteCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of sprites in a layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Nirvana sprite index of the given sprite name in the given layer or -1 if sprite is not found
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerShapeCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of stage collision shapes in the given layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundImageID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic image id of the image set on the given layer or -1 if no image is set
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundImage(layer_index, image_id)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets a new image on the given layer (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundRenderType(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the render type of the layer image set in Nirvana2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets the render type of the layer image (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>TILE MASK</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetTileMaskName$(mask_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given tile mask or an empty string if the mask index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetTileMaskMatrix(mask_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic matrix id of the given mask or -1 if the mask is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns TRUE if the tile at the given position is flagged in the given mask
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: (x, y) is a world position and not a row and column position in the tile map
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>SPRITES</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteID(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic sprite id of the given Nirvana sprite index or -1 if the sprite index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteName$(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sprite name of the given Nirvana sprite index or an empty string if sprite index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteDefinitionName$(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sprite definition name of the given sprite index
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Sprite Definition name is the name of the base sprite created in the Sprite Editor and not the name of the sprite in the stage
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NOTE: There is almost no reason to get this definition name unless you wanted to look up sprites in the stage by the base sprite
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteAnimationCount(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of animations for the given Nirvana sprite index
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given Nirvana Sprite Index animation number
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>CAMERA</u></h3> <b>Sub Nirvana_SetStageOffset(offset As Nirvana_Vector2D)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets the camera position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetStageOffset() As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the camera position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>VIEWPORT</u></h3> <b>Sub Nirvana_SetStageViewport(v_position As Nirvana_Vector2D, v_size As Nirvana_Size2D)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport position and size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetViewportPosition() As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetViewportSize() As Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
86
doc/doc_files/nirvana_api_background.html
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D Background API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundImageID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic image id of the image set on the given layer or -1 if no image is set
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundImage(layer_index, image_id)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets a new image on the given layer (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundRenderType(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the render type of the layer image set in Nirvana2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets the render type of the layer image (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
100
doc/doc_files/nirvana_api_layers.html
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D API </h2></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerIndex(layer_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the internal nirvana index associated with the given layer name or -1 if layer name is not an existing layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerCanvasID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic canvas of the given nirvana layer index or -1 if layer_index is not a valid layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerType(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the layer type or -1 if layer_index is not a valid layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Layer Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_TILEMAP
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_SPRITE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_CANVAS_2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_CANVAS_3D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerName$(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given layer or an empty string if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerAlpha(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the layer alpha value set in the layer settings in Nirvana
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the HScroll and VScroll speed as a vector
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
195
doc/doc_files/nirvana_api_sprite.html
Normal file
@@ -0,0 +1,195 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Sprite</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim BaseName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Name_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Shape</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim ShapeType
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a Nirvana Sprite
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: spriteDefinition_name$ is the name of the base sprite created in the Sprite Editor
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerSpriteCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of sprites in a layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Nirvana sprite index of the given sprite name in the given layer or -1 if sprite is not found
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerShapeCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of stage collision shapes in the given layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteID(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic sprite id of the given Nirvana sprite index or -1 if the sprite index is not valid
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: If the sprite is detached then this will return the ID of the render sprite
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteName$(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sprite name of the given Nirvana sprite index or an empty string if sprite index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteDefinitionName$(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sprite definition name of the given sprite index
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Sprite Definition name is the name of the base sprite created in the Sprite Editor and not the name of the sprite in the stage
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NOTE: There is almost no reason to get this definition name unless you wanted to look up sprites in the stage by the base sprite
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteIsDetached(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns true if the sprite has a detached render body and dynamics body
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetDetachedSpriteID(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sprite dynamics body ID
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: This is the body that should be used for physics operations
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteAnimationCount(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of animations for the given Nirvana sprite index
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given Nirvana Sprite Index animation number
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
91
doc/doc_files/nirvana_api_stages.html
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D Stages API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Loads a stage and sets the part of the window to render it to
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Sub Nirvana_SetStageViewport(v_position As Nirvana_Vector2D, v_size As Nirvana_Size2D)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport position and size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetViewportPosition() As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetViewportSize() As Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Sub Nirvana_SetStageOffset(offset As Nirvana_Vector2D)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets the camera position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetStageOffset() As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the camera position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Sub Nirvana_Update()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
This update function must be used in place of Update() when using Nirvana2D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
149
doc/doc_files/nirvana_api_tile.html
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D API </h2></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_TileMap</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim TilesetName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Tileset_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim TileMap_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br><br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a Nirvana TileMap
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileSetName$(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of tileset associated with the given layer or empty string if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileSetID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic tileset associated with the given Nirvana layer or -1 if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMapID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic tile map associated with the given layer or -1 if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of tile mask on a layers tileset
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Nirvana tile mask index for the given mask number in a layer or -1 if not a valid layer or mask number
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
mask_num should be a number from 0 to Nirvana_GetLayerTileMaskCount(layer_index)-1
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetTileMaskName$(mask_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given tile mask or an empty string if the mask index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetTileMaskMatrix(mask_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic matrix id of the given mask or -1 if the mask is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns TRUE if the tile at the given position is flagged in the given mask
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: (x, y) is a world position and not a row and column position in the tile map
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
205
doc/doc_files/nirvana_api_types.html
Normal file
@@ -0,0 +1,205 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim X
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Y
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Width
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Height
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Sprite</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim BaseName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Name_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_TileMap</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim TilesetName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Tileset_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim TileMap_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Background</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Image_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim RenderSetting
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Shape</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim ShapeType
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Layer</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim LayerType
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Visible
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Alpha
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Scroll_Speed As Nirvana_Vector2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Ref_Canvas
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_TileMap As Nirvana_TileMap
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Sprite_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Shape_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Bkg As Nirvana_Background
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Stage</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Active
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Tile_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Stage_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Viewport_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Stage_Offset As Nirvana_Vector2D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a 2D Vector
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a 2D Size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
139
doc/doc_files/nirvana_sprite_editor.html
Normal file
@@ -0,0 +1,139 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D Sprite Editor </h2></p>
|
||||||
|
<p>
|
||||||
|
The sprite editor allows you to edit sprite definitions used to create sprites in the stage editor. A definition can have animations and the collider shapes uses in physics simulations.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
At the far left of the screen there are 2 buttons:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Load Sprite - Loads a sprite sheet into the definition list.
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: This will also load any existing animation and collision data for the sheet as well.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Delete Sprite - Removes a sprite definition from the editor.
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: This will remove any sprites in the stage that use this definition.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
At the top of the Sprite Editor is a text field labeled "Sprite ID" where you can change the name of the Sprite. To the right of the Sprite ID field, the dimensions of the sprite frame are shown.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<h2>Animation Editor</h2>
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_sprite_animation_editor.png" width=640 height=380></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Animation List - This is the list of animations for the selected Sprite. Above the list are buttons for adding an animation and removing the selected animation.</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Animation ID - This is the name of the current selected animation. You can change it from this field.</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Sprite Sheet - This is where you can view the current sprite sheet and select a sheet frame to set as the currently selected animation frame in the Animation Frames Panel (#4).
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Movement - With the mouse hovered over the Sprite Sheet, you can use W/A/S/D to move around the sheet
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#4 - Animation Frames - A horizontal layout of each frame in the animation.
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Setting a frame - To set a frame, first select the animation frame on the frame panel then select the desired frame on the sprite sheet
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Long Animations - If the number of frames in the animation exceed the viewable frames on the frame panel, use the buttons to the left and right of the panel to scroll the panel
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#5 - Frame Count - Sets the number of frames in the current animation</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#6 - Speed - Sets the number of frames per second the animation plays at</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#7 - Preview - Plays the selected animation.</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<h2>Shape Editor</h2>
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_sprite_shape_editor.png" width=720 height=440></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Editor Viewport - Here you can draw a polygon shape or move and resize box and circle shapes.</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Tool Bar - Tools for editing the shape.
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Select - Selects a single point
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Hold Ctrl to keep previous points selected
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Box Select - Selects multiple points
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Select - Selects a single point
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Hold Ctrl to keep previous points selected
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Move - Moves the selected points
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Draw Polygon - When polygon shape is selected, this allows you to draw points
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Shape Selection - Select the shape type</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#4 - Shape Parameters - Change Parameters for the shape
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Parameters are different depending on shape type
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
461
doc/doc_files/nirvana_stage_editor.html
Normal file
@@ -0,0 +1,461 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D Stage Editor </h2></p>
|
||||||
|
<p><img src="images/nirvana_stage_editor_full_display.png" width=480 height=240></p>
|
||||||
|
<p>
|
||||||
|
The stage editor is where tiles, sprites, and background layers are brought together to form the stages that you load into your game.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h2>The Viewport</h2> The main part of the stage editor you will interact with is the viewport.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_stage_editor_section1.png" width=640 height=380></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Layer Selection - Select the active layer
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
The active layer type will determine which tools are usable
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Tile Layers are the only layers where the tile info in #6 and #7 are shown
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Sprites and Collision shapes are only able to be added or edited on a Sprite Layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
If the grid is shown, it will be aligned with the active layer.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Set Camera - You can use this to move instantly to a desired position in the stage</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Placement Mode - The left button is for free placement and the second button is for grid snapping</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#4 - Editor Viewport - This is where a majority of editing is done
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Movement - While the mouse is hovered over the viewport, use W/A/S/D to navigate. The speed of this movement can be changed from settings.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
If a select tool (ie. tile select, sprite select, or shape select) is active, you can hold Ctrl to select multiple items
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Multiple selections can also be made by holding Ctrl with Box select
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#5 - Screen Mouse Info - The position of the mouse on the screen</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#6 - Stage Mouse Info - The position of the mouse in the stage
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
The Tile Positions are the top left corner of the tile the mouse is located in
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#7 - Camera Info - The position of the camera in the stage
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
The Tile Positions are the top left corner of the tile at the top left corner of the screen
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h2>Stage Manager</h2>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
This is where you create stages and manage stage properties
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_project_stage_tab.png" ></p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<image src="images/new_stage_button.png"> - Create new Stage
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<image src="images/yeet_stage_button.png"> - Delete highlighted stage
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<image src="images/nirvana_stage_properties_button.png"> - Edit the properties for a stage
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<image src="images/nirvana_stage_copy_button.png"> - Copy a stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br> <h2>Layer Settings</h2>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
This is where you create layers and edit layer settings
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_layer_settings.png" ></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Tool Bar
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
New Layer - Create a new layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Copy Layer - Copies a layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Show All - Makes all layers visible
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Hide All - Hides all layers
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Organizer - Change the order of layers or delete layers</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Layer List - Select a layer in the list to edit its properties and toggle the check box to view/hide individual layer</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#4 - Layer Settings
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Type - The type of layer selected. There are 4 types of layers: sprite, tile, canvas 2d, and canvas 3d.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Name - The name of the layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
HScroll - The speed the layer scrolls horizontally
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
VScrol - The speed the layer scrolls vertically
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Alpha - The transparency value
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h2>Editor Settings</h2>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
This is where you can change editor settings
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Viewport
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Show Shapes - This determines whether stage collision shapes are viewable when the layer they are created on is not active
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Show Grid - Show the tile grid
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Tile grid is aligned to the active layer so layers with different HScroll and VScroll speeds will have different grid alignments
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Grid Color - The color of the grid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Camera
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Move Speed - The speed the viewport scrolls at when using W/A/S/D movement
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h2>Tile Map Tools</h2>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
These tools are only usable when a tile layer is selected.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_tilemap_tools.png" ></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Tools
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Select - Select a single tile
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Hold Ctrl to do multiple selections
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Box Select - Select all tiles in box
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Hold Ctrl to do multiple selections
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Move - Move the selected tiles
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Set Tile - Place selected tiles in stage
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
You can select multiple tiles in the tile select viewport
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Right click to delete the tile at the mouse position in stage viewport
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Copy Tile - Copies the selected tiles
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Fill Tile - Flood fills with a selected tile
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Delete Selected Tiles - Delete selected tiles
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Tileset - Shows the tileset for the current layer</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Viewport - Tileset Selection</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h2>Sprite Tools</h2>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
These tools are only usable when a sprite layer is selected.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_sprite_tools.png" ></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Sprite Tools
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Select - Select a single sprite
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Hold Ctrl to do multiple selections
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Box Select - Select all tiles in box
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Hold Ctrl to do multiple selections
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Move - Move the selected sprites
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
If Placement mode is set to Tile Snap then the sprite will snap to the closest tile position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Rotate - Rotates the selected sprites
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Scale - Scale the selected sprites
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
New Sprite - Add a sprite to the current layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Delete Sprite - Delete the selected sprite
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Copy Sprite - Copy the selected sprite
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Center on sprite - Center the viewport on the selected sprite
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Sprite List - Select a sprite</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Sprite Properties
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sprite ID - Name of the selected sprite
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Body Type - Type of physics body
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Animation - The default animation set on the sprite when stage first loads
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Position - The position of the sprite
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Rotation - The angle the sprite is rotated by
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Scale - The scale of the sprite
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Render Settings - Additional render settings
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h2>Collision Shape Tools</h2>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
These tools are only usable when a sprite layer is selected.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_collision_shapes.png" ></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Shape Tools
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Select - Select a single point
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Hold Ctrl to do multiple selections
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NOTE: While Ctrl is down, only points on the selected shape will be selected
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Box Select - Select all points in box
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Hold Ctrl to do multiple selections
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NOTE: While Ctrl is down, only points on the selected shape will be selected
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Move - Move the selected points
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
If Placement mode is set to Tile Snap then the points will snap to the closest tile position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Draw Shape - Draw the shape in the stage viewport
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Create Shapes
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Box - An axis aligned rectangle
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Polygon - A closed polygon
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Chain - A shape made of connected points
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Circle - A circle
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Delete Shape - Deletes the selected shape
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Shape List - List of shapes in the current layer</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Shape Properties - Different properties are available for different shapes</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h2>Background Image</h2>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
A background image can only be set for a Canvas 2D layer.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_image_settings.png" ></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Render Type - Determines how the image will be drawn
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Normal - Draw the image at its native resolution
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Stretched - Stretch the image to the size of the viewport
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Tiled - Tile the image as the stage scrolls
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Background tile will scroll at layer scroll speed
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Layer Image - The image to draw on the layer</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
117
doc/doc_files/nirvana_tile_editor.html
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D Tile Editor </h2></p>
|
||||||
|
<p>
|
||||||
|
The Tile editor allows you to edit tile sets used to create tile maps in the stage editor. A tile set can have animations and tile mask which are ways of flaging tiles.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
At the far left of the screen there are 2 buttons:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Load Tileset - Loads a tile sheet into the tile set list.
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: This will also load any existing animation and mask data for the sheet as well.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Delete Tileset - Removes a tile set from the editor.
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: This will remove any layer in the stage that uses this tile set.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
At the top of the Tile Editor is a text field labeled "Tileset ID" where you can change the name of the Tileset. To the right of the Tileset ID field, the dimensions of the tile selected.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<h2>Animation Editor</h2>
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_tile_animation_editor.png" width=640 height=380></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Tile Sheet - View and select tiles
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Movement - With the mouse hovered over the Sprite Sheet, you can use W/A/S/D to move around the sheet
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Frame Panel - Select the animation frame to set
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Must be in animate mode to change a frame from the tile sheet. Otherwise selecting a tile on the tile sheet will change the base tile to animate.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Select Base Tile - Switches to Base Tile Select Mode</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#4 - Animate Tile - Switches to Animate Mode</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#5 - Frame Count - Sets the number of frames in the base tile animation</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#6 - Speed - Sets the frames per second the base tile animation plays at</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#7 - Preview - Play the sprite animation</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<h2>Mask Editor</h2>
|
||||||
|
</p>
|
||||||
|
<p><img src="images/nirvana_tile_mask_editor.png" width=720 height=440></p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - Mask List - Select a mask to edit
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
New Mask - Create a new mask in the current tile set
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Delete Mask - Delete the selected mask
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#2 - Mask ID - Change the mask ID from this field</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#3 - Tile Sheet - View and select tiles
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Movement - With the mouse hovered over the Sprite Sheet, you can use W/A/S/D to move around the sheet
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Flag Tile - To flag a tile in the mask, left click the tile. To unflag a tile, Right Click on it.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
17
doc/doc_files/rc_doc_error.html
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title><title>[arg]</title></title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>[arg]</h2></p>
|
||||||
|
<p>
|
||||||
|
./nirvana_stage_editor.html ./nirvana_stage_editor.html
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
21
doc/doc_files/recalculatemeshboundingbox.html
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>ReCalculateMeshBoundingBox [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Sub ReCalculateMeshBoundingBox( mesh ) </h2></p>
|
||||||
|
<p>
|
||||||
|
Sets the bounding box for a mesh based of its current data
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="getmeshboundingbox.html">GetMeshBoundingBox</a>
|
||||||
|
<a href="setmeshboundingbox.html">SetMeshBoundingBox</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
56
doc/doc_files/serenity_api.html
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D API </h2></p>
|
||||||
|
<p>
|
||||||
|
This API is what allows developers to access objects created in the Serenity3D editor inside RCBasic.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
'-------SKY------- Function Serenity_GetSkyShape()
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_GetSkyBox() As Serenity_Sky_Box
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_GetSkyDome() As Serenity_Sky_Dome
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_StageHasSky()
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
'-------STAGES------- Function Serenity_GetStageIndex(stage_name$)
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_GetStageName$(stage_index)
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_GetStageCount()
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Sub Serenity_ClearStage()
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Sub Serenity_LoadStage(stage_name$)
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_GetCurrentStageIndex()
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
'-------GROUPS------- Function Serenity_GetGroupCount()
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_GetGroupIndex(group_name$)
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Function Serenity_GetGroupName$(group_index)
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
175
doc/doc_files/serenity_api_actors.html
Normal file
@@ -0,0 +1,175 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Actors API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorIndex(actor_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Actor Index which is used to access actor data in the API
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorCount()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of actors in the current stage
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: This count only includes actors that were created in Serenity3D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorID(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic Actor ID
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorName$(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the actor from the given Serenity Actor Index
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorType(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the actor type
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible values are
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_ANIMATED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_OCTREE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_LIGHT
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_BILLBOARD
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_TERRAIN
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_WATER
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_PARTICLE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_CUBE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_SPHERE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_ACTOR_TYPE_PLANE
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorMeshIndex(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Mesh index the actor was created from
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorOverrideMaterialIndex(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the material index set in an actors properties on the Stage Editor tab
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorTerrainHeightMap$(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the height map file for a terrain actor
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorCubeSize(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the cube size for a cube actor
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorSphereRadius(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sphere radius for a sphere actor
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetActorGroupIndex(actor_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Group Index the actor is grouped in or -1 if the actor is not part of a group
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
47
doc/doc_files/serenity_api_groups.html
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Groups API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetGroupCount()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of groups in the current stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetGroupIndex(group_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Group index from the group name or -1 if group does not exists in current stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetGroupName$(group_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the group name
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
47
doc/doc_files/serenity_api_materials.html
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Materials API </h2></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMaterialIndex(material_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Material Index which is used to access material data in the API
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMaterialID(material_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic material ID or -1 if material_index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMaterialTextureIndex(material_index, texture_level)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Texture Index which is used to access texture data in the API
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
190
doc/doc_files/serenity_api_meshes.html
Normal file
@@ -0,0 +1,190 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Mesh API </h2></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetAN8Count()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of Anim8or objects loaded with the current stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetAN8ID(an8_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic Anim8or ID
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: an8_index should be from 0 to Serenity_GetAN8Count()-1
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshIndex(mesh_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Mesh Index which is used to access mesh data in the API
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshID(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic Mesh ID of the given mesh index or -1 if mesh_index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshName$(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the mesh name fron the given mesh index
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshType(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the mesh type
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible values are:
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
SN_MESH_TYPE_NORMAL - Unless the mesh is loaded from an Anim8or project or a zip its going to be this
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_MESH_TYPE_ZIPPED - A mesh loaded from an archive like a *.pak file
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_MESH_TYPE_AN8_SCENE - Anim8or mesh
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshAN8Index(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Anim8or object index
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshAN8Scene$(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the scene name$ in Anim8or that this mesh is loaded from
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshArchiveName$(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the archive that the mesh is loaded from
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshFile$(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the mesh file that the mesh is loaded from
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshMaterialCount(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of materials on given mesh
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshMaterialIndex(mesh_index, material_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Material Index from the material number on the given mesh
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshAnimationCount(mesh_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of animations on the given mesh
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetMeshAnimationID(mesh_index, animation_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic mesh animation id
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
143
doc/doc_files/serenity_api_stages.html
Normal file
@@ -0,0 +1,143 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Stages API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetSkyShape()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Actor Index which is used to access actor data in the API
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible values are:
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
SN_SKY_TYPE_NONE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_SKY_TYPE_BOX
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SN_SKY_TYPE_DOME
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetSkyBox() As Serenity_Sky_Box</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sky box for the current stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetSkyDome() As Serenity_Sky_Dome</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sky dome for the current stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_StageHasSky()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns TRUE if the stage has a sky object and FALSE otherwise
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetStageIndex(stage_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Stage Index or -1 if the stage name was not found in the project
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetStageName$(stage_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the stage from the index
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetStageCount()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of stages in the project
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Sub Serenity_ClearStage()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Clears the currently loaded stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Sub Serenity_LoadStage(stage_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Loads a stage
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Its a good idea to get the stage index first to make sure the stage exists
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetCurrentStageIndex()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the index of the currently loaded stage
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
69
doc/doc_files/serenity_api_textures.html
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Texture API </h2></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetTextureIndex(texture_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Serenity Texture Index which is used to access texture data in the API
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetTextureID(texture_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic texture ID or -1 if texture_index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetTextureFile$(texture_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the texture file
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetTextureColorKey(texture_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the color key of the texture
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Serenity_GetTextureIsColorKey(texture_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns TRUE if texture colorkey flag was set in Serenity3D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
67
doc/doc_files/serenity_material_editor.html
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Material Editor </h2></p>
|
||||||
|
<p>
|
||||||
|
The material editor allows you to create, edit, and view materials. On the left side is the material list and above it is buttons for creating materials, loading existing materials, and deleting materials.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The main properties panel is where a majority of settings for the material is set.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/serenity_material_properties.png" ></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The texture panel is where you set textures for the material. Each material can have multiple texture levels which you can set here.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/serenity_material_texture_panel.png" ></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The material preview allows you to view the current material on a mesh.
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Preview Controls - Hold the Middle Mouse button and move left/right to rotate the camera around the object
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<p>#1 - The default mesh is a cube but you can change it by clicking material mesh preview button on the tool bar below the preview.</p> <p>#2 -The last option allows you to edit the camera actions on the material view.</p>
|
||||||
|
</p>
|
||||||
|
<p><img src="images/material_preview_settings.png" ></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
If lighting is checked, then you will need to enable a light on the preview window to view it.
|
||||||
|
</p>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
No Light
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Directional Light
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Spot Light
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<p><img src="images/material_preview_light.png" ></p>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
57
doc/doc_files/serenity_mesh_editor.html
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Mesh Editor </h2></p>
|
||||||
|
<p>
|
||||||
|
The mesh editor performs the following functions
|
||||||
|
</p>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
Load Mesh from file
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Create Mesh from a mesh primitive shape
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Remove mesh from project
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The mesh preview window has the same controls as the material preview.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Hold the middle mouse button down and move the mouse left/right to rotate around the mesh.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/serenity_mesh_editor.png" width=640 height=400></p>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
ID - Must be a valid RCBasic variable
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
File - The file the mesh was loaded from
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Materials - Add materials and set them
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Animations - Add and remove animations from mesh
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: MD2 meshes will load default animations
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
49
doc/doc_files/serenity_scene_editor.html
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Scene Editor </h2></p>
|
||||||
|
<p>
|
||||||
|
The scene editor performs the following functions
|
||||||
|
</p>
|
||||||
|
<ol>
|
||||||
|
<li>
|
||||||
|
Create Stages
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Create Actors and Place them in a stage
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Set Actor Properties
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The scene view is where most of the work is done.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/serenity_scene_editor.png" width=640 height=400></p>
|
||||||
|
<p>
|
||||||
|
These are the main controls for navigating through the scene:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Hold the middle mouse button in the viewport to go into navigate mode
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
While the middle mouse is down, you can around with W/A/S/D and move vertically with R/F
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Moving the mouse will rotate the camera
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
33
doc/doc_files/serenity_texture_view.html
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Serenity3D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Serenity3D Texture Manager </h2></p>
|
||||||
|
<p>
|
||||||
|
From the texture manager, you will load all the textures that will be used in your project. On the left side of the view you have your texture list along with buttons to add and remove textures.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
You have these properties you can edit.
|
||||||
|
</p>
|
||||||
|
<p><img src="images/serenity_texture_view.png" ></p>
|
||||||
|
<p>
|
||||||
|
Texture ID - Must be a valid RCBasic variable name. It is the name your texture can be looked up by.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
File - This field will show the file name associated with this ID.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Use Colorkey - This is a flag to tell the editor to use the provided color key.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Colorkey - This is the color key value used.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
49
doc/doc_files/setactorshape.html
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>SetActorShape [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>sub SetActorShape( actor, shape_type, mass) </h2></p>
|
||||||
|
<p>
|
||||||
|
Sets the shape of an actor
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Possible Actor Shapes
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_NONE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_BOX
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_SPHERE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CYLINDER
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CAPSULE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CONE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_CONVEXHULL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
ACTOR_SHAPE_TRIMESH
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="getactorshape.html">GetActorShape</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
24
doc/doc_files/setmeshboundingbox.html
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>SetMeshBoundingBox [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Sub SetMeshBoundingBox( mesh, min_x, min_y, min_z, max_x, max_y, max_z ) </h2></p>
|
||||||
|
<p>
|
||||||
|
Sets the min and max corners of a meshes bounding box.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
NOTE: Physics shapes are determined from the bounding box data so you should adjust this before setting the shape.
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="getmeshboundingbox.html">GetMeshBoundingBox</a>
|
||||||
|
<a href="recalculatemeshboundingbox.html">ReCalculateMeshBoundingBox</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
45
doc/doc_files/setspriteshape.html
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>SetSpriteShape [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Sub SetSpriteShape(spr_id, shape) </h2></p>
|
||||||
|
<p>
|
||||||
|
Sets the shape of a sprite.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Possible Shapes
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_NONE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_BOX - A rectangular shape
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_POLYGON - A polygon (any shape with 3 or more sides)
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_CIRCLE - A circle
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
SPRITE_SHAPE_CHAIN - A open polygon shape
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Mainly used for terrain
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="getspriteshape.html">GetSpriteShape</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
20
doc/doc_files/setspriteshapeoffset.html
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>SetSpriteShapeOffset [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Sub SetSpriteShapeOffset( spr_id, x, y ) </h2></p>
|
||||||
|
<p>
|
||||||
|
Sets the relative location the sprite shape is from where it is rendered
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="getspriteshapeoffset.html">GetSpriteShapeOffset</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
26
doc/doc_files/steam_addachievement.html
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Steam_AddAchievement [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>sub Steam_AddAchievement( ach_id$, ach_name$ ) </h2></p>
|
||||||
|
<p>
|
||||||
|
Add a steam achievement to the current program
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
NOTE: This only works for desktop applications
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="steam_clearachievements.html">Steam_ClearAchievements</a>
|
||||||
|
<a href="steam_finalizeachievements.html">Steam_FinalizeAchievements</a>
|
||||||
|
<a href="steam_getid.html">Steam_GetID</a>
|
||||||
|
<a href="steam_triggerachievement.html">Steam_TriggerAchievement</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
23
doc/doc_files/steam_clearachievements.html
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Steam_ClearAchievements [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>sub Steam_ClearAchievements() </h2></p>
|
||||||
|
<p>
|
||||||
|
Clear all steam achievements from the application
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="steam_addachievement.html">Steam_AddAchievement</a>
|
||||||
|
<a href="steam_finalizeachievements.html">Steam_FinalizeAchievements</a>
|
||||||
|
<a href="steam_getid.html">Steam_GetID</a>
|
||||||
|
<a href="steam_triggerachievement.html">Steam_TriggerAchievement</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
23
doc/doc_files/steam_finalizeachievements.html
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Steam_FinalizeAchievements [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>sub Steam_FinalizeAchievements() </h2></p>
|
||||||
|
<p>
|
||||||
|
This function must be called once all steam achievements have been added
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="steam_addachievement.html">Steam_AddAchievement</a>
|
||||||
|
<a href="steam_clearachievements.html">Steam_ClearAchievements</a>
|
||||||
|
<a href="steam_getid.html">Steam_GetID</a>
|
||||||
|
<a href="steam_triggerachievement.html">Steam_TriggerAchievement</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
23
doc/doc_files/steam_getid.html
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Steam_GetID$ [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>function Steam_GetID$() </h2></p>
|
||||||
|
<p>
|
||||||
|
Returns the steam ID of the application which is needed to use the Steamworks API
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="steam_addachievement.html">Steam_AddAchievement</a>
|
||||||
|
<a href="steam_clearachievements.html">Steam_ClearAchievements</a>
|
||||||
|
<a href="steam_finalizeachievements.html">Steam_FinalizeAchievements</a>
|
||||||
|
<a href="steam_triggerachievement.html">Steam_TriggerAchievement</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
26
doc/doc_files/steam_triggerachievement.html
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Steam_TriggerAchievement [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>function Steam_TriggerAchievement( ach_name$ ) </h2></p>
|
||||||
|
<p>
|
||||||
|
Unlocks a steam achievement in the current application.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Returns True if the achievement was triggered and false if not.
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="steam_addachievement.html">Steam_AddAchievement</a>
|
||||||
|
<a href="steam_clearachievements.html">Steam_ClearAchievements</a>
|
||||||
|
<a href="steam_finalizeachievements.html">Steam_FinalizeAchievements</a>
|
||||||
|
<a href="steam_getid.html">Steam_GetID</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
20
doc/doc_files/tilemapexists.html
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>TileMapExists [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Function TileMapExists(tilemap) </h2></p>
|
||||||
|
<p>
|
||||||
|
Returns true if the given tilemap is an active tilemap in the program
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="tilesetexists.html">TileSetExists</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
20
doc/doc_files/tilesetexists.html
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>TileSetExists [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Function TileSetExists(tileset) </h2></p>
|
||||||
|
<p>
|
||||||
|
Returns true if the given tileset is an active tileset in the program
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="tilemapexists.html">TileMapExists</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
22
doc/doc_files/touchx.html
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>TouchX [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>function TouchX() </h2></p>
|
||||||
|
<p>
|
||||||
|
Return the X Position of a touch event
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="touchy.html">TouchY</a>
|
||||||
|
<a href="gettouch.html">GetTouch</a>
|
||||||
|
<a href="gettouchfinger.html">GetTouchFinger</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
22
doc/doc_files/touchy.html
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>TouchY [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>function TouchY() </h2></p>
|
||||||
|
<p>
|
||||||
|
Return the Y Position of a touch event
|
||||||
|
</p>
|
||||||
|
<br><p>Related:
|
||||||
|
<a href="touchx.html">TouchX</a>
|
||||||
|
<a href="gettouch.html">GetTouch</a>
|
||||||
|
<a href="gettouchfinger.html">GetTouchFinger</a>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
18
doc/files/getactorshape.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
#title GetActorShape [RCBasic Doc]
|
||||||
|
#header function GetActorShape(actor)
|
||||||
|
|
||||||
|
Returns the shape of an actor
|
||||||
|
|
||||||
|
Possible Actor Shapes
|
||||||
|
#list ul
|
||||||
|
#li ACTOR_SHAPE_NONE
|
||||||
|
#li ACTOR_SHAPE_BOX
|
||||||
|
#li ACTOR_SHAPE_SPHERE
|
||||||
|
#li ACTOR_SHAPE_CYLINDER
|
||||||
|
#li ACTOR_SHAPE_CAPSULE
|
||||||
|
#li ACTOR_SHAPE_CONE
|
||||||
|
#li ACTOR_SHAPE_CONVEXHULL
|
||||||
|
#li ACTOR_SHAPE_TRIMESH
|
||||||
|
#/list
|
||||||
|
|
||||||
|
#ref SetActorShape
|
||||||
6
doc/files/getmeshboundingbox.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title GetMeshBoundingBox [RCBasic Doc]
|
||||||
|
#header Sub GetMeshBoundingBox( mesh, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z )
|
||||||
|
|
||||||
|
Gets the min and max corners of a mesh's bounding box
|
||||||
|
|
||||||
|
#ref SetMeshBoundingBox ReCalculateMeshBoundingBox
|
||||||
18
doc/files/getspriteshape.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
#title GetSpriteShape [RCBasic Doc]
|
||||||
|
#header Function GetSpriteShape(spr_id)
|
||||||
|
|
||||||
|
Returns the shape of a sprite.
|
||||||
|
|
||||||
|
Possible Shapes
|
||||||
|
#list ul
|
||||||
|
#li SPRITE_SHAPE_NONE
|
||||||
|
#li SPRITE_SHAPE_BOX - A rectangular shape
|
||||||
|
#li SPRITE_SHAPE_POLYGON - A polygon (any shape with 3 or more sides)
|
||||||
|
#li SPRITE_SHAPE_CIRCLE - A circle
|
||||||
|
#li SPRITE_SHAPE_CHAIN - A open polygon shape
|
||||||
|
#list ul
|
||||||
|
#li NOTE: Mainly used for terrain
|
||||||
|
#/list
|
||||||
|
#/list
|
||||||
|
|
||||||
|
#ref SetSpriteShape
|
||||||
6
doc/files/getspriteshapeoffset.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title GetSpriteShapeOffset [RCBasic Doc]
|
||||||
|
#header Sub GetSpriteShapeOffset( spr_id, ByRef x, ByRef y )
|
||||||
|
|
||||||
|
Gets the relative location the sprite shape is from where it is rendered
|
||||||
|
|
||||||
|
#ref SetSpriteShapeOffset
|
||||||
6
doc/files/recalculatemeshboundingbox.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title ReCalculateMeshBoundingBox [RCBasic Doc]
|
||||||
|
#header Sub ReCalculateMeshBoundingBox( mesh )
|
||||||
|
|
||||||
|
Sets the bounding box for a mesh based of its current data
|
||||||
|
|
||||||
|
#ref GetMeshBoundingBox SetMeshBoundingBox
|
||||||
18
doc/files/setactorshape.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
#title SetActorShape [RCBasic Doc]
|
||||||
|
#header sub SetActorShape( actor, shape_type, mass)
|
||||||
|
|
||||||
|
Sets the shape of an actor
|
||||||
|
|
||||||
|
Possible Actor Shapes
|
||||||
|
#list ul
|
||||||
|
#li ACTOR_SHAPE_NONE
|
||||||
|
#li ACTOR_SHAPE_BOX
|
||||||
|
#li ACTOR_SHAPE_SPHERE
|
||||||
|
#li ACTOR_SHAPE_CYLINDER
|
||||||
|
#li ACTOR_SHAPE_CAPSULE
|
||||||
|
#li ACTOR_SHAPE_CONE
|
||||||
|
#li ACTOR_SHAPE_CONVEXHULL
|
||||||
|
#li ACTOR_SHAPE_TRIMESH
|
||||||
|
#/list
|
||||||
|
|
||||||
|
#ref GetActorShape
|
||||||
8
doc/files/setmeshboundingbox.txt
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
#title SetMeshBoundingBox [RCBasic Doc]
|
||||||
|
#header Sub SetMeshBoundingBox( mesh, min_x, min_y, min_z, max_x, max_y, max_z )
|
||||||
|
|
||||||
|
Sets the min and max corners of a meshes bounding box.
|
||||||
|
|
||||||
|
NOTE: Physics shapes are determined from the bounding box data so you should adjust this before setting the shape.
|
||||||
|
|
||||||
|
#ref GetMeshBoundingBox ReCalculateMeshBoundingBox
|
||||||
19
doc/files/setspriteshape.txt
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
#title SetSpriteShape [RCBasic Doc]
|
||||||
|
#header Sub SetSpriteShape(spr_id, shape)
|
||||||
|
|
||||||
|
Sets the shape of a sprite.
|
||||||
|
|
||||||
|
Possible Shapes
|
||||||
|
#list ul
|
||||||
|
#li SPRITE_SHAPE_NONE
|
||||||
|
#li SPRITE_SHAPE_BOX - A rectangular shape
|
||||||
|
#li SPRITE_SHAPE_POLYGON - A polygon (any shape with 3 or more sides)
|
||||||
|
#li SPRITE_SHAPE_CIRCLE - A circle
|
||||||
|
#li SPRITE_SHAPE_CHAIN - A open polygon shape
|
||||||
|
#list ul
|
||||||
|
#li NOTE: Mainly used for terrain
|
||||||
|
#/list
|
||||||
|
#/list
|
||||||
|
|
||||||
|
#ref GetSpriteShape
|
||||||
|
|
||||||
7
doc/files/setspriteshapeoffset.txt
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
#title SetSpriteShapeOffset [RCBasic Doc]
|
||||||
|
#header Sub SetSpriteShapeOffset( spr_id, x, y )
|
||||||
|
|
||||||
|
Sets the relative location the sprite shape is from where it is rendered
|
||||||
|
|
||||||
|
#ref GetSpriteShapeOffset
|
||||||
|
|
||||||
8
doc/files/steam_addachievement.txt
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
#title Steam_AddAchievement [RCBasic Doc]
|
||||||
|
#header sub Steam_AddAchievement( ach_id$, ach_name$ )
|
||||||
|
|
||||||
|
Add a steam achievement to the current program
|
||||||
|
|
||||||
|
NOTE: This only works for desktop applications
|
||||||
|
|
||||||
|
#ref Steam_ClearAchievements Steam_FinalizeAchievements Steam_GetID Steam_TriggerAchievement
|
||||||
6
doc/files/steam_clearachievements.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title Steam_ClearAchievements [RCBasic Doc]
|
||||||
|
#header sub Steam_ClearAchievements()
|
||||||
|
|
||||||
|
Clear all steam achievements from the application
|
||||||
|
|
||||||
|
#ref Steam_AddAchievement Steam_FinalizeAchievements Steam_GetID Steam_TriggerAchievement
|
||||||
6
doc/files/steam_finalizeachievements.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title Steam_FinalizeAchievements [RCBasic Doc]
|
||||||
|
#header sub Steam_FinalizeAchievements()
|
||||||
|
|
||||||
|
This function must be called once all steam achievements have been added
|
||||||
|
|
||||||
|
#ref Steam_AddAchievement Steam_ClearAchievements Steam_GetID Steam_TriggerAchievement
|
||||||
6
doc/files/steam_getid.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title Steam_GetID$ [RCBasic Doc]
|
||||||
|
#header function Steam_GetID$()
|
||||||
|
|
||||||
|
Returns the steam ID of the application which is needed to use the Steamworks API
|
||||||
|
|
||||||
|
#ref Steam_AddAchievement Steam_ClearAchievements Steam_FinalizeAchievements Steam_TriggerAchievement
|
||||||
9
doc/files/steam_triggerachievement.txt
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
#title Steam_TriggerAchievement [RCBasic Doc]
|
||||||
|
#header function Steam_TriggerAchievement( ach_name$ )
|
||||||
|
|
||||||
|
Unlocks a steam achievement in the current application.
|
||||||
|
|
||||||
|
Returns True if the achievement was triggered and false if not.
|
||||||
|
|
||||||
|
|
||||||
|
#ref Steam_AddAchievement Steam_ClearAchievements Steam_FinalizeAchievements Steam_GetID
|
||||||
6
doc/files/tilemapexists.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title TileMapExists [RCBasic Doc]
|
||||||
|
#header Function TileMapExists(tilemap)
|
||||||
|
|
||||||
|
Returns true if the given tilemap is an active tilemap in the program
|
||||||
|
|
||||||
|
#ref TileSetExists
|
||||||
6
doc/files/tilesetexists.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title TileSetExists [RCBasic Doc]
|
||||||
|
#header Function TileSetExists(tileset)
|
||||||
|
|
||||||
|
Returns true if the given tileset is an active tileset in the program
|
||||||
|
|
||||||
|
#ref TileMapExists
|
||||||
6
doc/files/touchx.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
#title TouchX [RCBasic Doc]
|
||||||
|
#header function TouchX()
|
||||||
|
|
||||||
|
Return the X Position of a touch event
|
||||||
|
|
||||||
|
#ref TouchY GetTouch GetTouchFinger
|
||||||
7
doc/files/touchy.txt
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
#title TouchY [RCBasic Doc]
|
||||||
|
#header function TouchY()
|
||||||
|
|
||||||
|
Return the Y Position of a touch event
|
||||||
|
|
||||||
|
#ref TouchX GetTouch GetTouchFinger
|
||||||
|
|
||||||
BIN
doc/nirvana_docs/images/new_stage_button.png
Normal file
|
After Width: | Height: | Size: 947 B |
BIN
doc/nirvana_docs/images/nirvana_collision_shapes.png
Normal file
|
After Width: | Height: | Size: 34 KiB |
BIN
doc/nirvana_docs/images/nirvana_image_settings.png
Normal file
|
After Width: | Height: | Size: 4.3 KiB |
BIN
doc/nirvana_docs/images/nirvana_layer_settings.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
doc/nirvana_docs/images/nirvana_project_stage_tab.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
doc/nirvana_docs/images/nirvana_sprite_animation_editor.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
doc/nirvana_docs/images/nirvana_sprite_shape_editor.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
doc/nirvana_docs/images/nirvana_sprite_tools.png
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
doc/nirvana_docs/images/nirvana_stage_copy_button.png
Normal file
|
After Width: | Height: | Size: 905 B |
BIN
doc/nirvana_docs/images/nirvana_stage_editor_full_display.png
Normal file
|
After Width: | Height: | Size: 190 KiB |
BIN
doc/nirvana_docs/images/nirvana_stage_editor_section1.png
Normal file
|
After Width: | Height: | Size: 155 KiB |
BIN
doc/nirvana_docs/images/nirvana_stage_properties_button.png
Normal file
|
After Width: | Height: | Size: 759 B |
BIN
doc/nirvana_docs/images/nirvana_tile_animation_editor.png
Normal file
|
After Width: | Height: | Size: 55 KiB |
BIN
doc/nirvana_docs/images/nirvana_tile_mask_editor.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
doc/nirvana_docs/images/nirvana_tilemap_tools.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
doc/nirvana_docs/images/yeet_stage_button.png
Normal file
|
After Width: | Height: | Size: 734 B |
673
doc/nirvana_docs/nirvana_api.html
Normal file
@@ -0,0 +1,673 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D API </h2></p>
|
||||||
|
<p>
|
||||||
|
This API is what allows developers to access objects created in the Nirvana2D editor inside RCBasic.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<h3><u>Nirvana Types</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim X
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Y
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Width
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Height
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Sprite</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim BaseName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Name_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Animation_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_TileMap</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim TilesetName$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Tileset_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim TileMap_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Index
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Mask_Count
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Background</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Image_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim RenderSetting
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Shape</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Sprite_ID
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim ShapeType
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Layer</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim LayerType
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Visible
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Alpha
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Scroll_Speed As Nirvana_Vector2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Ref_Canvas
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_TileMap As Nirvana_TileMap
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Sprite_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Shape_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Bkg As Nirvana_Background
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Type Nirvana_Stage</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Dim Active
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Name$
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Tile_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Stage_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Layer_Count
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Viewport_Size As Nirvana_Size2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Dim Stage_Offset As Nirvana_Vector2D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a 2D Vector
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a 2D Size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a Nirvana Sprite
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: spriteDefinition_name$ is the name of the base sprite created in the Sprite Editor
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Create a Nirvana TileMap
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>Nirvana Stages</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Loads a stage and sets the part of the window to render it to
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Sub Nirvana_Update()</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
This update function must be used in place of Update() when using Nirvana2D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>Nirvana Layers</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerIndex(layer_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the internal nirvana index associated with the given layer name or -1 if layer name is not an existing layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerCanvasID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic canvas of the given nirvana layer index or -1 if layer_index is not a valid layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerType(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the layer type or -1 if layer_index is not a valid layer
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Layer Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_TILEMAP
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_SPRITE
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_CANVAS_2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_LAYER_TYPE_CANVAS_3D
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerName$(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given layer or an empty string if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerAlpha(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the layer alpha value set in the layer settings in Nirvana
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the HScroll and VScroll speed as a vector
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileSetName$(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of tileset associated with the given layer or empty string if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileSetID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic tileset associated with the given Nirvana layer or -1 if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMapID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic tile map associated with the given layer or -1 if layer is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMaskCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of tile mask on a layers tileset
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Nirvana tile mask index for the given mask number in a layer or -1 if not a valid layer or mask number
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
mask_num should be a number from 0 to Nirvana_GetLayerTileMaskCount(layer_index)-1
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerSpriteCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of sprites in a layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the Nirvana sprite index of the given sprite name in the given layer or -1 if sprite is not found
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerShapeCount(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of stage collision shapes in the given layer
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundImageID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic image id of the image set on the given layer or -1 if no image is set
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundImage(layer_index, image_id)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets a new image on the given layer (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundRenderType(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the render type of the layer image set in Nirvana2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets the render type of the layer image (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>TILE MASK</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetTileMaskName$(mask_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given tile mask or an empty string if the mask index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetTileMaskMatrix(mask_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic matrix id of the given mask or -1 if the mask is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns TRUE if the tile at the given position is flagged in the given mask
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: (x, y) is a world position and not a row and column position in the tile map
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>SPRITES</u></h3>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteID(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic sprite id of the given Nirvana sprite index or -1 if the sprite index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteName$(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sprite name of the given Nirvana sprite index or an empty string if sprite index is not valid
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteDefinitionName$(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the sprite definition name of the given sprite index
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NOTE: Sprite Definition name is the name of the base sprite created in the Sprite Editor and not the name of the sprite in the stage
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NOTE: There is almost no reason to get this definition name unless you wanted to look up sprites in the stage by the base sprite
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteAnimationCount(sprite_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the number of animations for the given Nirvana sprite index
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the name of the given Nirvana Sprite Index animation number
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>CAMERA</u></h3> <b>Sub Nirvana_SetStageOffset(offset As Nirvana_Vector2D)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets the camera position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetStageOffset() As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the camera position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<br> <h3><u>VIEWPORT</u></h3> <b>Sub Nirvana_SetStageViewport(v_position As Nirvana_Vector2D, v_size As Nirvana_Size2D)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport position and size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetViewportPosition() As Nirvana_Vector2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport position
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetViewportSize() As Nirvana_Size2D</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the current viewport size
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
86
doc/nirvana_docs/nirvana_api_background.html
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" href="style.css">
|
||||||
|
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
|
||||||
|
<title>Nirvana2D [RCBasic Doc] </title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<p><h2>Nirvana2D Background API </h2></p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundImageID(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the RCBasic image id of the image set on the given layer or -1 if no image is set
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundImage(layer_index, image_id)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets a new image on the given layer (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundRenderType(layer_index)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Returns the render type of the layer image set in Nirvana2D
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type)</b>
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
Sets the render type of the layer image (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Possible Render Types
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<p>
|
||||||
|
<br>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
39
doc/nirvana_docs/nirvana_api_background.txt
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
#title Nirvana2D [RCBasic Doc]
|
||||||
|
#header Nirvana2D Background API
|
||||||
|
|
||||||
|
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundImageID(layer_index)</b>
|
||||||
|
#list ul
|
||||||
|
#li Returns the RCBasic image id of the image set on the given layer or -1 if no image is set
|
||||||
|
#/list
|
||||||
|
<br>
|
||||||
|
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundImage(layer_index, image_id)</b>
|
||||||
|
#list ul
|
||||||
|
#li Sets a new image on the given layer (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
#/list
|
||||||
|
<br>
|
||||||
|
|
||||||
|
<b>Function Nirvana_GetLayerBackgroundRenderType(layer_index)</b>
|
||||||
|
#list ul
|
||||||
|
#li Returns the render type of the layer image set in Nirvana2D
|
||||||
|
#li Possible Render Types
|
||||||
|
#list ul
|
||||||
|
#li NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
#li NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
#li NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
#/list
|
||||||
|
#/list
|
||||||
|
<br>
|
||||||
|
|
||||||
|
<b>Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type)</b>
|
||||||
|
#list ul
|
||||||
|
#li Sets the render type of the layer image (NOTE: Layer must be a Canvas2D layer)
|
||||||
|
#li Possible Render Types
|
||||||
|
#list ul
|
||||||
|
#li NIRVANA_IMG_RENDER_SETTING_NORMAL
|
||||||
|
#li NIRVANA_IMG_RENDER_SETTING_STRETCHED
|
||||||
|
#li NIRVANA_IMG_RENDER_SETTING_TILED
|
||||||
|
#/list
|
||||||
|
#/list
|
||||||
|
<br>
|
||||||