+ Returns the shape of an actor +
++ Possible Actor Shapes +
+Related: + SetActorShape +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmeshboundingbox.html b/doc/doc_files/getmeshboundingbox.html new file mode 100644 index 0000000..4b8457a --- /dev/null +++ b/doc/doc_files/getmeshboundingbox.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the min and max corners of a mesh's bounding box +
+Related: + SetMeshBoundingBox + ReCalculateMeshBoundingBox +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspriteshape.html b/doc/doc_files/getspriteshape.html new file mode 100644 index 0000000..fc4ae61 --- /dev/null +++ b/doc/doc_files/getspriteshape.html @@ -0,0 +1,45 @@ + + +
+ + ++ Returns the shape of a sprite. +
++ Possible Shapes +
+Related: + SetSpriteShape +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspriteshapeoffset.html b/doc/doc_files/getspriteshapeoffset.html new file mode 100644 index 0000000..73c4f41 --- /dev/null +++ b/doc/doc_files/getspriteshapeoffset.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the relative location the sprite shape is from where it is rendered +
+Related: + SetSpriteShapeOffset +
++ + + \ No newline at end of file diff --git a/doc/doc_files/images/material_preview_light.png b/doc/doc_files/images/material_preview_light.png new file mode 100644 index 0000000..dc92a9d Binary files /dev/null and b/doc/doc_files/images/material_preview_light.png differ diff --git a/doc/doc_files/images/material_preview_settings.png b/doc/doc_files/images/material_preview_settings.png new file mode 100644 index 0000000..7e2df7e Binary files /dev/null and b/doc/doc_files/images/material_preview_settings.png differ diff --git a/doc/doc_files/images/new_stage_button.png b/doc/doc_files/images/new_stage_button.png new file mode 100644 index 0000000..b5f9eaf Binary files /dev/null and b/doc/doc_files/images/new_stage_button.png differ diff --git a/doc/doc_files/images/nirvana_collision_shapes.png b/doc/doc_files/images/nirvana_collision_shapes.png new file mode 100644 index 0000000..65fec30 Binary files /dev/null and b/doc/doc_files/images/nirvana_collision_shapes.png differ diff --git a/doc/doc_files/images/nirvana_image_settings.png b/doc/doc_files/images/nirvana_image_settings.png new file mode 100644 index 0000000..ae7aab8 Binary files /dev/null and b/doc/doc_files/images/nirvana_image_settings.png differ diff --git a/doc/doc_files/images/nirvana_layer_settings.png b/doc/doc_files/images/nirvana_layer_settings.png new file mode 100644 index 0000000..672052c Binary files /dev/null and b/doc/doc_files/images/nirvana_layer_settings.png differ diff --git a/doc/doc_files/images/nirvana_project_stage_tab.png b/doc/doc_files/images/nirvana_project_stage_tab.png new file mode 100644 index 0000000..7f3ca44 Binary files /dev/null and b/doc/doc_files/images/nirvana_project_stage_tab.png differ diff --git a/doc/doc_files/images/nirvana_sprite_animation_editor.png b/doc/doc_files/images/nirvana_sprite_animation_editor.png new file mode 100644 index 0000000..f8a5371 Binary files /dev/null and b/doc/doc_files/images/nirvana_sprite_animation_editor.png differ diff --git a/doc/doc_files/images/nirvana_sprite_shape_editor.png b/doc/doc_files/images/nirvana_sprite_shape_editor.png new file mode 100644 index 0000000..ff7d378 Binary files /dev/null and b/doc/doc_files/images/nirvana_sprite_shape_editor.png differ diff --git a/doc/doc_files/images/nirvana_sprite_tools.png b/doc/doc_files/images/nirvana_sprite_tools.png new file mode 100644 index 0000000..123609b Binary files /dev/null and b/doc/doc_files/images/nirvana_sprite_tools.png differ diff --git a/doc/doc_files/images/nirvana_stage_copy_button.png b/doc/doc_files/images/nirvana_stage_copy_button.png new file mode 100644 index 0000000..20e717a Binary files /dev/null and b/doc/doc_files/images/nirvana_stage_copy_button.png differ diff --git a/doc/doc_files/images/nirvana_stage_editor_full_display.png b/doc/doc_files/images/nirvana_stage_editor_full_display.png new file mode 100644 index 0000000..6f4261e Binary files /dev/null and b/doc/doc_files/images/nirvana_stage_editor_full_display.png differ diff --git a/doc/doc_files/images/nirvana_stage_editor_section1.png b/doc/doc_files/images/nirvana_stage_editor_section1.png new file mode 100644 index 0000000..05e6b42 Binary files /dev/null and b/doc/doc_files/images/nirvana_stage_editor_section1.png differ diff --git a/doc/doc_files/images/nirvana_stage_properties_button.png b/doc/doc_files/images/nirvana_stage_properties_button.png new file mode 100644 index 0000000..e271657 Binary files /dev/null and b/doc/doc_files/images/nirvana_stage_properties_button.png differ diff --git a/doc/doc_files/images/nirvana_tile_animation_editor.png b/doc/doc_files/images/nirvana_tile_animation_editor.png new file mode 100644 index 0000000..48df713 Binary files /dev/null and b/doc/doc_files/images/nirvana_tile_animation_editor.png differ diff --git a/doc/doc_files/images/nirvana_tile_mask_editor.png b/doc/doc_files/images/nirvana_tile_mask_editor.png new file mode 100644 index 0000000..c969e04 Binary files /dev/null and b/doc/doc_files/images/nirvana_tile_mask_editor.png differ diff --git a/doc/doc_files/images/nirvana_tilemap_tools.png b/doc/doc_files/images/nirvana_tilemap_tools.png new file mode 100644 index 0000000..bb3d75d Binary files /dev/null and b/doc/doc_files/images/nirvana_tilemap_tools.png differ diff --git a/doc/doc_files/images/serenity_material_properties.png b/doc/doc_files/images/serenity_material_properties.png new file mode 100644 index 0000000..aa1bf7a Binary files /dev/null and b/doc/doc_files/images/serenity_material_properties.png differ diff --git a/doc/doc_files/images/serenity_material_texture_panel.png b/doc/doc_files/images/serenity_material_texture_panel.png new file mode 100644 index 0000000..5c6c59a Binary files /dev/null and b/doc/doc_files/images/serenity_material_texture_panel.png differ diff --git a/doc/doc_files/images/serenity_mesh_editor.png b/doc/doc_files/images/serenity_mesh_editor.png new file mode 100644 index 0000000..99a14dd Binary files /dev/null and b/doc/doc_files/images/serenity_mesh_editor.png differ diff --git a/doc/doc_files/images/serenity_scene_editor.png b/doc/doc_files/images/serenity_scene_editor.png new file mode 100644 index 0000000..d4e31e1 Binary files /dev/null and b/doc/doc_files/images/serenity_scene_editor.png differ diff --git a/doc/doc_files/images/serenity_texture_view.png b/doc/doc_files/images/serenity_texture_view.png new file mode 100644 index 0000000..5a853e9 Binary files /dev/null and b/doc/doc_files/images/serenity_texture_view.png differ diff --git a/doc/doc_files/images/yeet_stage_button.png b/doc/doc_files/images/yeet_stage_button.png new file mode 100644 index 0000000..c097fae Binary files /dev/null and b/doc/doc_files/images/yeet_stage_button.png differ diff --git a/doc/doc_files/nirvana_api.html b/doc/doc_files/nirvana_api.html new file mode 100644 index 0000000..93e8b9a --- /dev/null +++ b/doc/doc_files/nirvana_api.html @@ -0,0 +1,673 @@ + + +
+ + ++ This API is what allows developers to access objects created in the Nirvana2D editor inside RCBasic. +
++
+ Type Nirvana_Vector2D +
+
+
+
+ Type Nirvana_Size2D +
+
+
+
+ Type Nirvana_Sprite +
+
+
+
+ Type Nirvana_TileMap +
+
+
+
+ Type Nirvana_Background +
+
+
+
+ Type Nirvana_Shape +
+
+
+
+ Type Nirvana_Layer +
+
+
+
+ Type Nirvana_Stage +
+
+
+
+ Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D +
+
+
+
+ Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite +
+
+
+
+ Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap +
+
+
+
+
+ Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h) +
+
+
+
+ Sub Nirvana_Update() +
+
+
+
+
+ Function Nirvana_GetLayerIndex(layer_name$) +
+
+
+
+ Function Nirvana_GetLayerCanvasID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerType(layer_index) +
+
+
+
+ Function Nirvana_GetLayerName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerAlpha(layer_index) +
+
+
+
+ Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetLayerTileSetName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileSetID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMapID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num) +
+
+
+
+ Function Nirvana_GetLayerSpriteCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$) +
+
+
+
+ Function Nirvana_GetLayerShapeCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerBackgroundImageID(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundImage(layer_index, image_id) +
+
+
+
+ Function Nirvana_GetLayerBackgroundRenderType(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type) +
+
+
+
+
+ Function Nirvana_GetTileMaskName$(mask_index) +
+
+
+
+ Function Nirvana_GetTileMaskMatrix(mask_index) +
+
+
+
+ Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y) +
+
+
+
+
+ Function Nirvana_GetSpriteID(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteDefinitionName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationCount(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num) +
+
+
+
+
+
+
+ Function Nirvana_GetStageOffset() As Nirvana_Vector2D +
+
+
+
+
+
+
+ Function Nirvana_GetViewportPosition() As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetViewportSize() As Nirvana_Size2D +
++ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_api_background.html b/doc/doc_files/nirvana_api_background.html new file mode 100644 index 0000000..cc08344 --- /dev/null +++ b/doc/doc_files/nirvana_api_background.html @@ -0,0 +1,86 @@ + + +
+ + ++ Function Nirvana_GetLayerBackgroundImageID(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundImage(layer_index, image_id) +
+
+
+
+ Function Nirvana_GetLayerBackgroundRenderType(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type) +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_api_layers.html b/doc/doc_files/nirvana_api_layers.html new file mode 100644 index 0000000..a9c52ba --- /dev/null +++ b/doc/doc_files/nirvana_api_layers.html @@ -0,0 +1,100 @@ + + +
+ + +
+
+
+ Function Nirvana_GetLayerIndex(layer_name$) +
+
+
+
+ Function Nirvana_GetLayerCanvasID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerType(layer_index) +
+
+
+
+ Function Nirvana_GetLayerName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerAlpha(layer_index) +
+
+
+
+ Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_api_sprite.html b/doc/doc_files/nirvana_api_sprite.html new file mode 100644 index 0000000..907425a --- /dev/null +++ b/doc/doc_files/nirvana_api_sprite.html @@ -0,0 +1,195 @@ + + +
+ + ++ Type Nirvana_Sprite +
+
+
+
+ Type Nirvana_Shape +
+
+
+
+ Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite +
+
+
+
+ Function Nirvana_GetLayerSpriteCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$) +
+
+
+
+ Function Nirvana_GetLayerShapeCount(layer_index) +
+
+
+
+ Function Nirvana_GetSpriteID(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteDefinitionName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteIsDetached(sprite_index) +
+
+
+
+ Function Nirvana_GetDetachedSpriteID(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationCount(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num) +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_api_stages.html b/doc/doc_files/nirvana_api_stages.html new file mode 100644 index 0000000..7a23df2 --- /dev/null +++ b/doc/doc_files/nirvana_api_stages.html @@ -0,0 +1,91 @@ + + +
+ + ++ Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h) +
+
+
+
+ Sub Nirvana_SetStageViewport(v_position As Nirvana_Vector2D, v_size As Nirvana_Size2D) +
+
+
+
+ Function Nirvana_GetViewportPosition() As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetViewportSize() As Nirvana_Size2D +
+
+
+
+ Sub Nirvana_SetStageOffset(offset As Nirvana_Vector2D) +
+
+
+
+ Function Nirvana_GetStageOffset() As Nirvana_Vector2D +
+
+
+
+ Sub Nirvana_Update() +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_api_tile.html b/doc/doc_files/nirvana_api_tile.html new file mode 100644 index 0000000..dee4c1c --- /dev/null +++ b/doc/doc_files/nirvana_api_tile.html @@ -0,0 +1,149 @@ + + +
+ + +
+
+
+ Type Nirvana_TileMap +
+
+
+
+ Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap +
+
+
+
+ Function Nirvana_GetLayerTileSetName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileSetID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMapID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num) +
+
+
+
+ Function Nirvana_GetTileMaskName$(mask_index) +
+
+
+
+ Function Nirvana_GetTileMaskMatrix(mask_index) +
+
+
+
+ Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y) +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_api_types.html b/doc/doc_files/nirvana_api_types.html new file mode 100644 index 0000000..632bfdb --- /dev/null +++ b/doc/doc_files/nirvana_api_types.html @@ -0,0 +1,205 @@ + + +
+ + ++ Type Nirvana_Vector2D +
+
+
+
+ Type Nirvana_Size2D +
+
+
+
+ Type Nirvana_Sprite +
+
+
+
+ Type Nirvana_TileMap +
+
+
+
+ Type Nirvana_Background +
+
+
+
+ Type Nirvana_Shape +
+
+
+
+ Type Nirvana_Layer +
+
+
+
+ Type Nirvana_Stage +
+
+
+
+ Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_sprite_editor.html b/doc/doc_files/nirvana_sprite_editor.html new file mode 100644 index 0000000..6e722e6 --- /dev/null +++ b/doc/doc_files/nirvana_sprite_editor.html @@ -0,0 +1,139 @@ + + +
+ + ++ 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. +
++ At the far left of the screen there are 2 buttons: +
++ 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. +
++
+
#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.
+ ++
#2 - Animation ID - This is the name of the current selected animation. You can change it from this field.
+ ++
#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). +
++
+ ++
#4 - Animation Frames - A horizontal layout of each frame in the animation. +
++
+ ++
#5 - Frame Count - Sets the number of frames in the current animation
+ ++
#6 - Speed - Sets the number of frames per second the animation plays at
+ ++
#7 - Preview - Plays the selected animation.
+ ++
+
#1 - Editor Viewport - Here you can draw a polygon shape or move and resize box and circle shapes.
+ ++
#2 - Tool Bar - Tools for editing the shape. +
++
+ ++
#3 - Shape Selection - Select the shape type
+ ++
#4 - Shape Parameters - Change Parameters for the shape +
++
+ ++ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_stage_editor.html b/doc/doc_files/nirvana_stage_editor.html new file mode 100644 index 0000000..1bc8706 --- /dev/null +++ b/doc/doc_files/nirvana_stage_editor.html @@ -0,0 +1,461 @@ + + +
+ + +
+ The stage editor is where tiles, sprites, and background layers are brought together to form the stages that you load into your game. +
+
+
+
#1 - Layer Selection - Select the active layer +
++
+ ++
#2 - Set Camera - You can use this to move instantly to a desired position in the stage
+ ++
#3 - Placement Mode - The left button is for free placement and the second button is for grid snapping
+ ++
#4 - Editor Viewport - This is where a majority of editing is done +
++
+ ++
#5 - Screen Mouse Info - The position of the mouse on the screen
+ ++
#6 - Stage Mouse Info - The position of the mouse in the stage +
++
+ ++
#7 - Camera Info - The position of the camera in the stage +
++
+ +
+
+ This is where you create stages and manage stage properties +
+
+
+ This is where you create layers and edit layer settings +
+
+
#1 - Tool Bar +
++
+ ++
#2 - Organizer - Change the order of layers or delete layers
+ ++
#3 - Layer List - Select a layer in the list to edit its properties and toggle the check box to view/hide individual layer
+ ++
#4 - Layer Settings +
++
+ +
+
+ This is where you can change editor settings +
++
#1 - Viewport +
++
+ ++
#2 - Camera +
++
+ +
+
+ These tools are only usable when a tile layer is selected. +
+
+
#1 - Tools +
++
+ ++
#2 - Tileset - Shows the tileset for the current layer
+ ++
#3 - Viewport - Tileset Selection
+ +
+
+ These tools are only usable when a sprite layer is selected. +
+
+
#1 - Sprite Tools +
++
+ ++
#2 - Sprite List - Select a sprite
+ ++
#3 - Sprite Properties +
++
+ +
+
+ These tools are only usable when a sprite layer is selected. +
+
+
#1 - Shape Tools +
++
+ ++
#2 - Shape List - List of shapes in the current layer
+ ++
#3 - Shape Properties - Different properties are available for different shapes
+ +
+
+ A background image can only be set for a Canvas 2D layer. +
+
+
#1 - Render Type - Determines how the image will be drawn +
++
+ ++
#2 - Layer Image - The image to draw on the layer
+ ++ + + \ No newline at end of file diff --git a/doc/doc_files/nirvana_tile_editor.html b/doc/doc_files/nirvana_tile_editor.html new file mode 100644 index 0000000..0e07a45 --- /dev/null +++ b/doc/doc_files/nirvana_tile_editor.html @@ -0,0 +1,117 @@ + + +
+ + ++ 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. +
++ At the far left of the screen there are 2 buttons: +
++ 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. +
++
+
#1 - Tile Sheet - View and select tiles +
++
+ ++
#2 - Frame Panel - Select the animation frame to set +
++
+ ++
#3 - Select Base Tile - Switches to Base Tile Select Mode
+ ++
#4 - Animate Tile - Switches to Animate Mode
+ ++
#5 - Frame Count - Sets the number of frames in the base tile animation
+ ++
#6 - Speed - Sets the frames per second the base tile animation plays at
+ ++
#7 - Preview - Play the sprite animation
+ ++
+
#1 - Mask List - Select a mask to edit +
++
+ ++
#2 - Mask ID - Change the mask ID from this field
+ ++
#3 - Tile Sheet - View and select tiles +
++
+ ++ + + \ No newline at end of file diff --git a/doc/doc_files/rc_doc_error.html b/doc/doc_files/rc_doc_error.html new file mode 100644 index 0000000..3939d4c --- /dev/null +++ b/doc/doc_files/rc_doc_error.html @@ -0,0 +1,17 @@ + + +
+ + ++ ./nirvana_stage_editor.html ./nirvana_stage_editor.html +
++ + + \ No newline at end of file diff --git a/doc/doc_files/recalculatemeshboundingbox.html b/doc/doc_files/recalculatemeshboundingbox.html new file mode 100644 index 0000000..716572d --- /dev/null +++ b/doc/doc_files/recalculatemeshboundingbox.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the bounding box for a mesh based of its current data +
+Related: + GetMeshBoundingBox + SetMeshBoundingBox +
++ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_api.html b/doc/doc_files/serenity_api.html new file mode 100644 index 0000000..3db877f --- /dev/null +++ b/doc/doc_files/serenity_api.html @@ -0,0 +1,56 @@ + + +
+ + ++ This API is what allows developers to access objects created in the Serenity3D editor inside RCBasic. +
++ '-------SKY------- Function Serenity_GetSkyShape() +
++ Function Serenity_GetSkyBox() As Serenity_Sky_Box +
++ Function Serenity_GetSkyDome() As Serenity_Sky_Dome +
++ Function Serenity_StageHasSky() +
++ '-------STAGES------- Function Serenity_GetStageIndex(stage_name$) +
++ Function Serenity_GetStageName$(stage_index) +
++ Function Serenity_GetStageCount() +
++ Sub Serenity_ClearStage() +
++ Sub Serenity_LoadStage(stage_name$) +
++ Function Serenity_GetCurrentStageIndex() +
++ '-------GROUPS------- Function Serenity_GetGroupCount() +
++ Function Serenity_GetGroupIndex(group_name$) +
++ Function Serenity_GetGroupName$(group_index) +
++ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_api_actors.html b/doc/doc_files/serenity_api_actors.html new file mode 100644 index 0000000..579959c --- /dev/null +++ b/doc/doc_files/serenity_api_actors.html @@ -0,0 +1,175 @@ + + +
+ + ++ Function Serenity_GetActorIndex(actor_name$) +
+
+
+
+ Function Serenity_GetActorCount() +
+
+
+
+ Function Serenity_GetActorID(actor_index) +
+
+
+
+ Function Serenity_GetActorName$(actor_index) +
+
+
+
+ Function Serenity_GetActorType(actor_index) +
+
+
+
+ Function Serenity_GetActorMeshIndex(actor_index) +
+
+
+
+ Function Serenity_GetActorOverrideMaterialIndex(actor_index) +
+
+
+
+ Function Serenity_GetActorTerrainHeightMap$(actor_index) +
+
+
+
+ Function Serenity_GetActorCubeSize(actor_index) +
+
+
+
+ Function Serenity_GetActorSphereRadius(actor_index) +
+
+
+
+ Function Serenity_GetActorGroupIndex(actor_index) +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_api_groups.html b/doc/doc_files/serenity_api_groups.html new file mode 100644 index 0000000..13e7169 --- /dev/null +++ b/doc/doc_files/serenity_api_groups.html @@ -0,0 +1,47 @@ + + +
+ + ++ Function Serenity_GetGroupCount() +
+
+
+
+ Function Serenity_GetGroupIndex(group_name$) +
+
+
+
+ Function Serenity_GetGroupName$(group_index) +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_api_materials.html b/doc/doc_files/serenity_api_materials.html new file mode 100644 index 0000000..4e6cf74 --- /dev/null +++ b/doc/doc_files/serenity_api_materials.html @@ -0,0 +1,47 @@ + + +
+ + +
+
+
+ Function Serenity_GetMaterialIndex(material_name$) +
+
+
+
+ Function Serenity_GetMaterialID(material_index) +
+
+
+
+ Function Serenity_GetMaterialTextureIndex(material_index, texture_level) +
++ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_api_meshes.html b/doc/doc_files/serenity_api_meshes.html new file mode 100644 index 0000000..e3a2862 --- /dev/null +++ b/doc/doc_files/serenity_api_meshes.html @@ -0,0 +1,190 @@ + + +
+ + +
+
+
+ Function Serenity_GetAN8Count() +
+
+
+
+ Function Serenity_GetAN8ID(an8_index) +
+
+
+
+ Function Serenity_GetMeshIndex(mesh_name$) +
+
+
+
+ Function Serenity_GetMeshID(mesh_index) +
+
+
+
+ Function Serenity_GetMeshName$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshType(mesh_index) +
+
+
+
+ Function Serenity_GetMeshAN8Index(mesh_index) +
+
+
+
+ Function Serenity_GetMeshAN8Scene$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshArchiveName$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshFile$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshMaterialCount(mesh_index) +
+
+
+
+ Function Serenity_GetMeshMaterialIndex(mesh_index, material_num) +
+
+
+
+ Function Serenity_GetMeshAnimationCount(mesh_index) +
+
+
+
+ Function Serenity_GetMeshAnimationID(mesh_index, animation_num) +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_api_stages.html b/doc/doc_files/serenity_api_stages.html new file mode 100644 index 0000000..148d5dc --- /dev/null +++ b/doc/doc_files/serenity_api_stages.html @@ -0,0 +1,143 @@ + + +
+ + ++ Function Serenity_GetSkyShape() +
+
+
+
+ Function Serenity_GetSkyBox() As Serenity_Sky_Box +
+
+
+
+ Function Serenity_GetSkyDome() As Serenity_Sky_Dome +
+
+
+
+ Function Serenity_StageHasSky() +
+
+
+
+ Function Serenity_GetStageIndex(stage_name$) +
+
+
+
+ Function Serenity_GetStageName$(stage_index) +
+
+
+
+ Function Serenity_GetStageCount() +
+
+
+
+ Sub Serenity_ClearStage() +
+
+
+
+ Sub Serenity_LoadStage(stage_name$) +
+
+
+
+ Function Serenity_GetCurrentStageIndex() +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_api_textures.html b/doc/doc_files/serenity_api_textures.html new file mode 100644 index 0000000..5ee9365 --- /dev/null +++ b/doc/doc_files/serenity_api_textures.html @@ -0,0 +1,69 @@ + + +
+ + +
+
+
+ Function Serenity_GetTextureIndex(texture_name$) +
+
+
+
+ Function Serenity_GetTextureID(texture_index) +
+
+
+
+ Function Serenity_GetTextureFile$(texture_index) +
+
+
+
+ Function Serenity_GetTextureColorKey(texture_index) +
+
+
+
+ Function Serenity_GetTextureIsColorKey(texture_index) +
++ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_material_editor.html b/doc/doc_files/serenity_material_editor.html new file mode 100644 index 0000000..3a890c6 --- /dev/null +++ b/doc/doc_files/serenity_material_editor.html @@ -0,0 +1,67 @@ + + +
+ + ++ 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. +
++ The main properties panel is where a majority of settings for the material is set. +
+
+
+
+ The texture panel is where you set textures for the material. Each material can have multiple texture levels which you can set here. +
+
+
+
+ The material preview allows you to view the current material on a mesh. +
+
+
+
+
#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.
#2 -The last option allows you to edit the camera actions on the material view.
+ +
+
+
+ If lighting is checked, then you will need to enable a light on the preview window to view it. +
+
+
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_mesh_editor.html b/doc/doc_files/serenity_mesh_editor.html new file mode 100644 index 0000000..fb5e991 --- /dev/null +++ b/doc/doc_files/serenity_mesh_editor.html @@ -0,0 +1,57 @@ + + +
+ + ++ The mesh editor performs the following functions +
+
+
+
+ The mesh preview window has the same controls as the material preview. +
++ Hold the middle mouse button down and move the mouse left/right to rotate around the mesh. +
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_scene_editor.html b/doc/doc_files/serenity_scene_editor.html new file mode 100644 index 0000000..219daf5 --- /dev/null +++ b/doc/doc_files/serenity_scene_editor.html @@ -0,0 +1,49 @@ + + +
+ + ++ The scene editor performs the following functions +
+
+
+
+ The scene view is where most of the work is done. +
+
+ These are the main controls for navigating through the scene: +
++ + + \ No newline at end of file diff --git a/doc/doc_files/serenity_texture_view.html b/doc/doc_files/serenity_texture_view.html new file mode 100644 index 0000000..35f163a --- /dev/null +++ b/doc/doc_files/serenity_texture_view.html @@ -0,0 +1,33 @@ + + +
+ + ++ 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. +
++ You have these properties you can edit. +
+
+ Texture ID - Must be a valid RCBasic variable name. It is the name your texture can be looked up by. +
++ File - This field will show the file name associated with this ID. +
++ Use Colorkey - This is a flag to tell the editor to use the provided color key. +
++ Colorkey - This is the color key value used. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorshape.html b/doc/doc_files/setactorshape.html new file mode 100644 index 0000000..aa227c2 --- /dev/null +++ b/doc/doc_files/setactorshape.html @@ -0,0 +1,49 @@ + + +
+ + ++ Sets the shape of an actor +
++ Possible Actor Shapes +
+Related: + GetActorShape +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmeshboundingbox.html b/doc/doc_files/setmeshboundingbox.html new file mode 100644 index 0000000..b784e8b --- /dev/null +++ b/doc/doc_files/setmeshboundingbox.html @@ -0,0 +1,24 @@ + + +
+ + ++ 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. +
+Related: + GetMeshBoundingBox + ReCalculateMeshBoundingBox +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteshape.html b/doc/doc_files/setspriteshape.html new file mode 100644 index 0000000..b3baa01 --- /dev/null +++ b/doc/doc_files/setspriteshape.html @@ -0,0 +1,45 @@ + + +
+ + ++ Sets the shape of a sprite. +
++ Possible Shapes +
+Related: + GetSpriteShape +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteshapeoffset.html b/doc/doc_files/setspriteshapeoffset.html new file mode 100644 index 0000000..195a68c --- /dev/null +++ b/doc/doc_files/setspriteshapeoffset.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the relative location the sprite shape is from where it is rendered +
+Related: + GetSpriteShapeOffset +
++ + + \ No newline at end of file diff --git a/doc/doc_files/steam_addachievement.html b/doc/doc_files/steam_addachievement.html new file mode 100644 index 0000000..92e155d --- /dev/null +++ b/doc/doc_files/steam_addachievement.html @@ -0,0 +1,26 @@ + + +
+ + ++ Add a steam achievement to the current program +
++ NOTE: This only works for desktop applications +
+Related: + Steam_ClearAchievements + Steam_FinalizeAchievements + Steam_GetID + Steam_TriggerAchievement +
++ + + \ No newline at end of file diff --git a/doc/doc_files/steam_clearachievements.html b/doc/doc_files/steam_clearachievements.html new file mode 100644 index 0000000..f1b39ff --- /dev/null +++ b/doc/doc_files/steam_clearachievements.html @@ -0,0 +1,23 @@ + + +
+ + ++ Clear all steam achievements from the application +
+Related: + Steam_AddAchievement + Steam_FinalizeAchievements + Steam_GetID + Steam_TriggerAchievement +
++ + + \ No newline at end of file diff --git a/doc/doc_files/steam_finalizeachievements.html b/doc/doc_files/steam_finalizeachievements.html new file mode 100644 index 0000000..b71fda5 --- /dev/null +++ b/doc/doc_files/steam_finalizeachievements.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function must be called once all steam achievements have been added +
+Related: + Steam_AddAchievement + Steam_ClearAchievements + Steam_GetID + Steam_TriggerAchievement +
++ + + \ No newline at end of file diff --git a/doc/doc_files/steam_getid.html b/doc/doc_files/steam_getid.html new file mode 100644 index 0000000..a92d0d0 --- /dev/null +++ b/doc/doc_files/steam_getid.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the steam ID of the application which is needed to use the Steamworks API +
+Related: + Steam_AddAchievement + Steam_ClearAchievements + Steam_FinalizeAchievements + Steam_TriggerAchievement +
++ + + \ No newline at end of file diff --git a/doc/doc_files/steam_triggerachievement.html b/doc/doc_files/steam_triggerachievement.html new file mode 100644 index 0000000..095ece7 --- /dev/null +++ b/doc/doc_files/steam_triggerachievement.html @@ -0,0 +1,26 @@ + + +
+ + ++ Unlocks a steam achievement in the current application. +
++ Returns True if the achievement was triggered and false if not. +
+Related: + Steam_AddAchievement + Steam_ClearAchievements + Steam_FinalizeAchievements + Steam_GetID +
++ + + \ No newline at end of file diff --git a/doc/doc_files/tilemapexists.html b/doc/doc_files/tilemapexists.html new file mode 100644 index 0000000..f990462 --- /dev/null +++ b/doc/doc_files/tilemapexists.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if the given tilemap is an active tilemap in the program +
+Related: + TileSetExists +
++ + + \ No newline at end of file diff --git a/doc/doc_files/tilesetexists.html b/doc/doc_files/tilesetexists.html new file mode 100644 index 0000000..29b57d7 --- /dev/null +++ b/doc/doc_files/tilesetexists.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if the given tileset is an active tileset in the program +
+Related: + TileMapExists +
++ + + \ No newline at end of file diff --git a/doc/doc_files/touchx.html b/doc/doc_files/touchx.html new file mode 100644 index 0000000..6df8b2c --- /dev/null +++ b/doc/doc_files/touchx.html @@ -0,0 +1,22 @@ + + +
+ + ++ Return the X Position of a touch event +
+Related: + TouchY + GetTouch + GetTouchFinger +
++ + + \ No newline at end of file diff --git a/doc/doc_files/touchy.html b/doc/doc_files/touchy.html new file mode 100644 index 0000000..b6dee75 --- /dev/null +++ b/doc/doc_files/touchy.html @@ -0,0 +1,22 @@ + + +
+ + ++ Return the Y Position of a touch event +
+Related: + TouchX + GetTouch + GetTouchFinger +
++ + + \ No newline at end of file diff --git a/doc/files/getactorshape.txt b/doc/files/getactorshape.txt new file mode 100644 index 0000000..6f8df88 --- /dev/null +++ b/doc/files/getactorshape.txt @@ -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 diff --git a/doc/files/getmeshboundingbox.txt b/doc/files/getmeshboundingbox.txt new file mode 100644 index 0000000..cbdc329 --- /dev/null +++ b/doc/files/getmeshboundingbox.txt @@ -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 diff --git a/doc/files/getspriteshape.txt b/doc/files/getspriteshape.txt new file mode 100644 index 0000000..643cb69 --- /dev/null +++ b/doc/files/getspriteshape.txt @@ -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 diff --git a/doc/files/getspriteshapeoffset.txt b/doc/files/getspriteshapeoffset.txt new file mode 100644 index 0000000..ddc24dd --- /dev/null +++ b/doc/files/getspriteshapeoffset.txt @@ -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 diff --git a/doc/files/recalculatemeshboundingbox.txt b/doc/files/recalculatemeshboundingbox.txt new file mode 100644 index 0000000..7a219c8 --- /dev/null +++ b/doc/files/recalculatemeshboundingbox.txt @@ -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 diff --git a/doc/files/setactorshape.txt b/doc/files/setactorshape.txt new file mode 100644 index 0000000..de7bffb --- /dev/null +++ b/doc/files/setactorshape.txt @@ -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 diff --git a/doc/files/setmeshboundingbox.txt b/doc/files/setmeshboundingbox.txt new file mode 100644 index 0000000..1cce5a8 --- /dev/null +++ b/doc/files/setmeshboundingbox.txt @@ -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 diff --git a/doc/files/setspriteshape.txt b/doc/files/setspriteshape.txt new file mode 100644 index 0000000..4615020 --- /dev/null +++ b/doc/files/setspriteshape.txt @@ -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 + diff --git a/doc/files/setspriteshapeoffset.txt b/doc/files/setspriteshapeoffset.txt new file mode 100644 index 0000000..4becc11 --- /dev/null +++ b/doc/files/setspriteshapeoffset.txt @@ -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 + diff --git a/doc/files/steam_addachievement.txt b/doc/files/steam_addachievement.txt new file mode 100644 index 0000000..5d6649c --- /dev/null +++ b/doc/files/steam_addachievement.txt @@ -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 diff --git a/doc/files/steam_clearachievements.txt b/doc/files/steam_clearachievements.txt new file mode 100644 index 0000000..dd3a2c6 --- /dev/null +++ b/doc/files/steam_clearachievements.txt @@ -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 diff --git a/doc/files/steam_finalizeachievements.txt b/doc/files/steam_finalizeachievements.txt new file mode 100644 index 0000000..2ab16b7 --- /dev/null +++ b/doc/files/steam_finalizeachievements.txt @@ -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 diff --git a/doc/files/steam_getid.txt b/doc/files/steam_getid.txt new file mode 100644 index 0000000..ce07c23 --- /dev/null +++ b/doc/files/steam_getid.txt @@ -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 diff --git a/doc/files/steam_triggerachievement.txt b/doc/files/steam_triggerachievement.txt new file mode 100644 index 0000000..5fa79dd --- /dev/null +++ b/doc/files/steam_triggerachievement.txt @@ -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 diff --git a/doc/files/tilemapexists.txt b/doc/files/tilemapexists.txt new file mode 100644 index 0000000..0460330 --- /dev/null +++ b/doc/files/tilemapexists.txt @@ -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 diff --git a/doc/files/tilesetexists.txt b/doc/files/tilesetexists.txt new file mode 100644 index 0000000..49dce1d --- /dev/null +++ b/doc/files/tilesetexists.txt @@ -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 diff --git a/doc/files/touchx.txt b/doc/files/touchx.txt new file mode 100644 index 0000000..37df950 --- /dev/null +++ b/doc/files/touchx.txt @@ -0,0 +1,6 @@ +#title TouchX [RCBasic Doc] +#header function TouchX() + +Return the X Position of a touch event + +#ref TouchY GetTouch GetTouchFinger diff --git a/doc/files/touchy.txt b/doc/files/touchy.txt new file mode 100644 index 0000000..91a8ee0 --- /dev/null +++ b/doc/files/touchy.txt @@ -0,0 +1,7 @@ +#title TouchY [RCBasic Doc] +#header function TouchY() + +Return the Y Position of a touch event + +#ref TouchX GetTouch GetTouchFinger + diff --git a/doc/nirvana_docs/images/new_stage_button.png b/doc/nirvana_docs/images/new_stage_button.png new file mode 100644 index 0000000..b5f9eaf Binary files /dev/null and b/doc/nirvana_docs/images/new_stage_button.png differ diff --git a/doc/nirvana_docs/images/nirvana_collision_shapes.png b/doc/nirvana_docs/images/nirvana_collision_shapes.png new file mode 100644 index 0000000..65fec30 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_collision_shapes.png differ diff --git a/doc/nirvana_docs/images/nirvana_image_settings.png b/doc/nirvana_docs/images/nirvana_image_settings.png new file mode 100644 index 0000000..ae7aab8 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_image_settings.png differ diff --git a/doc/nirvana_docs/images/nirvana_layer_settings.png b/doc/nirvana_docs/images/nirvana_layer_settings.png new file mode 100644 index 0000000..672052c Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_layer_settings.png differ diff --git a/doc/nirvana_docs/images/nirvana_project_stage_tab.png b/doc/nirvana_docs/images/nirvana_project_stage_tab.png new file mode 100644 index 0000000..7f3ca44 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_project_stage_tab.png differ diff --git a/doc/nirvana_docs/images/nirvana_sprite_animation_editor.png b/doc/nirvana_docs/images/nirvana_sprite_animation_editor.png new file mode 100644 index 0000000..f8a5371 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_sprite_animation_editor.png differ diff --git a/doc/nirvana_docs/images/nirvana_sprite_shape_editor.png b/doc/nirvana_docs/images/nirvana_sprite_shape_editor.png new file mode 100644 index 0000000..ff7d378 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_sprite_shape_editor.png differ diff --git a/doc/nirvana_docs/images/nirvana_sprite_tools.png b/doc/nirvana_docs/images/nirvana_sprite_tools.png new file mode 100644 index 0000000..123609b Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_sprite_tools.png differ diff --git a/doc/nirvana_docs/images/nirvana_stage_copy_button.png b/doc/nirvana_docs/images/nirvana_stage_copy_button.png new file mode 100644 index 0000000..20e717a Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_stage_copy_button.png differ diff --git a/doc/nirvana_docs/images/nirvana_stage_editor_full_display.png b/doc/nirvana_docs/images/nirvana_stage_editor_full_display.png new file mode 100644 index 0000000..6f4261e Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_stage_editor_full_display.png differ diff --git a/doc/nirvana_docs/images/nirvana_stage_editor_section1.png b/doc/nirvana_docs/images/nirvana_stage_editor_section1.png new file mode 100644 index 0000000..05e6b42 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_stage_editor_section1.png differ diff --git a/doc/nirvana_docs/images/nirvana_stage_properties_button.png b/doc/nirvana_docs/images/nirvana_stage_properties_button.png new file mode 100644 index 0000000..e271657 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_stage_properties_button.png differ diff --git a/doc/nirvana_docs/images/nirvana_tile_animation_editor.png b/doc/nirvana_docs/images/nirvana_tile_animation_editor.png new file mode 100644 index 0000000..48df713 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_tile_animation_editor.png differ diff --git a/doc/nirvana_docs/images/nirvana_tile_mask_editor.png b/doc/nirvana_docs/images/nirvana_tile_mask_editor.png new file mode 100644 index 0000000..c969e04 Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_tile_mask_editor.png differ diff --git a/doc/nirvana_docs/images/nirvana_tilemap_tools.png b/doc/nirvana_docs/images/nirvana_tilemap_tools.png new file mode 100644 index 0000000..bb3d75d Binary files /dev/null and b/doc/nirvana_docs/images/nirvana_tilemap_tools.png differ diff --git a/doc/nirvana_docs/images/yeet_stage_button.png b/doc/nirvana_docs/images/yeet_stage_button.png new file mode 100644 index 0000000..c097fae Binary files /dev/null and b/doc/nirvana_docs/images/yeet_stage_button.png differ diff --git a/doc/nirvana_docs/nirvana_api.html b/doc/nirvana_docs/nirvana_api.html new file mode 100644 index 0000000..93e8b9a --- /dev/null +++ b/doc/nirvana_docs/nirvana_api.html @@ -0,0 +1,673 @@ + + +
+ + ++ This API is what allows developers to access objects created in the Nirvana2D editor inside RCBasic. +
++
+ Type Nirvana_Vector2D +
+
+
+
+ Type Nirvana_Size2D +
+
+
+
+ Type Nirvana_Sprite +
+
+
+
+ Type Nirvana_TileMap +
+
+
+
+ Type Nirvana_Background +
+
+
+
+ Type Nirvana_Shape +
+
+
+
+ Type Nirvana_Layer +
+
+
+
+ Type Nirvana_Stage +
+
+
+
+ Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D +
+
+
+
+ Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite +
+
+
+
+ Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap +
+
+
+
+
+ Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h) +
+
+
+
+ Sub Nirvana_Update() +
+
+
+
+
+ Function Nirvana_GetLayerIndex(layer_name$) +
+
+
+
+ Function Nirvana_GetLayerCanvasID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerType(layer_index) +
+
+
+
+ Function Nirvana_GetLayerName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerAlpha(layer_index) +
+
+
+
+ Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetLayerTileSetName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileSetID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMapID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num) +
+
+
+
+ Function Nirvana_GetLayerSpriteCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$) +
+
+
+
+ Function Nirvana_GetLayerShapeCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerBackgroundImageID(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundImage(layer_index, image_id) +
+
+
+
+ Function Nirvana_GetLayerBackgroundRenderType(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type) +
+
+
+
+
+ Function Nirvana_GetTileMaskName$(mask_index) +
+
+
+
+ Function Nirvana_GetTileMaskMatrix(mask_index) +
+
+
+
+ Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y) +
+
+
+
+
+ Function Nirvana_GetSpriteID(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteDefinitionName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationCount(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num) +
+
+
+
+
+
+
+ Function Nirvana_GetStageOffset() As Nirvana_Vector2D +
+
+
+
+
+
+
+ Function Nirvana_GetViewportPosition() As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetViewportSize() As Nirvana_Size2D +
++ + + \ No newline at end of file diff --git a/doc/nirvana_docs/nirvana_api_background.html b/doc/nirvana_docs/nirvana_api_background.html new file mode 100644 index 0000000..cc08344 --- /dev/null +++ b/doc/nirvana_docs/nirvana_api_background.html @@ -0,0 +1,86 @@ + + +
+ + ++ Function Nirvana_GetLayerBackgroundImageID(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundImage(layer_index, image_id) +
+
+
+
+ Function Nirvana_GetLayerBackgroundRenderType(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type) +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/nirvana_docs/nirvana_api_background.txt b/doc/nirvana_docs/nirvana_api_background.txt
new file mode 100644
index 0000000..8e85abe
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_background.txt
@@ -0,0 +1,39 @@
+#title Nirvana2D [RCBasic Doc]
+#header Nirvana2D Background API
+
+
+Function Nirvana_GetLayerBackgroundImageID(layer_index)
+#list ul
+#li Returns the RCBasic image id of the image set on the given layer or -1 if no image is set
+#/list
+
+
+Function Nirvana_SetLayerBackgroundImage(layer_index, image_id)
+#list ul
+#li Sets a new image on the given layer (NOTE: Layer must be a Canvas2D layer)
+#/list
+
+
+Function Nirvana_GetLayerBackgroundRenderType(layer_index)
+#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
+
+
+Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type)
+#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
+
diff --git a/doc/nirvana_docs/nirvana_api_layers.html b/doc/nirvana_docs/nirvana_api_layers.html
new file mode 100644
index 0000000..a9c52ba
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_layers.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+ Function Nirvana_GetLayerIndex(layer_name$) +
+
+
+
+ Function Nirvana_GetLayerCanvasID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerType(layer_index) +
+
+
+
+ Function Nirvana_GetLayerName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerAlpha(layer_index) +
+
+
+
+ Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/nirvana_docs/nirvana_api_layers.txt b/doc/nirvana_docs/nirvana_api_layers.txt
new file mode 100644
index 0000000..75d26c5
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_layers.txt
@@ -0,0 +1,48 @@
+#title Nirvana2D [RCBasic Doc]
+#header Nirvana2D API
+
+
+
+Function Nirvana_GetLayerIndex(layer_name$)
+#list ul
+#li Returns the internal nirvana index associated with the given layer name or -1 if layer name is not an existing layer
+#/list
+
+
+Function Nirvana_GetLayerCanvasID(layer_index)
+#list ul
+#li Returns the RCBasic canvas of the given nirvana layer index or -1 if layer_index is not a valid layer
+#/list
+
+
+Function Nirvana_GetLayerType(layer_index)
+#list ul
+#li Returns the layer type or -1 if layer_index is not a valid layer
+#li Possible Layer Types
+#list ul
+#li NIRVANA_LAYER_TYPE_TILEMAP
+#li NIRVANA_LAYER_TYPE_SPRITE
+#li NIRVANA_LAYER_TYPE_CANVAS_2D
+#li NIRVANA_LAYER_TYPE_CANVAS_3D
+#/list
+#/list
+
+
+Function Nirvana_GetLayerName$(layer_index)
+#list ul
+#li Returns the name of the given layer or an empty string if layer is not valid
+#/list
+
+
+Function Nirvana_GetLayerAlpha(layer_index)
+#list ul
+#li Returns the layer alpha value set in the layer settings in Nirvana
+#/list
+
+
+Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D
+#list ul
+#li Returns the HScroll and VScroll speed as a vector
+#/list
+
+
diff --git a/doc/nirvana_docs/nirvana_api_sprite.html b/doc/nirvana_docs/nirvana_api_sprite.html
new file mode 100644
index 0000000..907425a
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_sprite.html
@@ -0,0 +1,195 @@
+
+
+
+ Type Nirvana_Sprite +
+
+
+
+ Type Nirvana_Shape +
+
+
+
+ Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite +
+
+
+
+ Function Nirvana_GetLayerSpriteCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$) +
+
+
+
+ Function Nirvana_GetLayerShapeCount(layer_index) +
+
+
+
+ Function Nirvana_GetSpriteID(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteDefinitionName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteIsDetached(sprite_index) +
+
+
+
+ Function Nirvana_GetDetachedSpriteID(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationCount(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num) +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/nirvana_docs/nirvana_api_sprite.txt b/doc/nirvana_docs/nirvana_api_sprite.txt
new file mode 100644
index 0000000..9f95abb
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_sprite.txt
@@ -0,0 +1,104 @@
+#title Nirvana2D [RCBasic Doc]
+#header Nirvana2D API
+
+
+Type Nirvana_Sprite
+#list ul
+#li Dim Name$
+#li Dim BaseName$
+#li Dim Sprite_ID
+#li Dim Animation_Name_Index
+#li Dim Animation_Count
+#/list
+
+
+
+Type Nirvana_Shape
+#list ul
+#li Dim Sprite_ID
+#li Dim ShapeType
+#/list
+
+
+
+Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite
+#list ul
+#li Create a Nirvana Sprite
+#list ul
+#li NOTE: spriteDefinition_name$ is the name of the base sprite created in the Sprite Editor
+#/list
+#/list
+
+
+
+Function Nirvana_GetLayerSpriteCount(layer_index)
+#list ul
+#li Returns the number of sprites in a layer
+#/list
+
+
+Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$)
+#list ul
+#li Returns the Nirvana sprite index of the given sprite name in the given layer or -1 if sprite is not found
+#/list
+
+
+Function Nirvana_GetLayerShapeCount(layer_index)
+#list ul
+#li Returns the number of stage collision shapes in the given layer
+#/list
+
+
+
+Function Nirvana_GetSpriteID(sprite_index)
+#list ul
+#li Returns the RCBasic sprite id of the given Nirvana sprite index or -1 if the sprite index is not valid
+#list ul
+#li NOTE: If the sprite is detached then this will return the ID of the render sprite
+#/list
+#/list
+
+
+Function Nirvana_GetSpriteName$(sprite_index)
+#list ul
+#li Returns the sprite name of the given Nirvana sprite index or an empty string if sprite index is not valid
+#/list
+
+
+Function Nirvana_GetSpriteDefinitionName$(sprite_index)
+#list ul
+#li Returns the sprite definition name of the given sprite index
+#list 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 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
+#/list
+#/list
+
+
+Function Nirvana_GetSpriteIsDetached(sprite_index)
+#list ul
+#li Returns true if the sprite has a detached render body and dynamics body
+#/list
+
+
+Function Nirvana_GetDetachedSpriteID(sprite_index)
+#list ul
+#li Returns the sprite dynamics body ID
+#list ul
+#li NOTE: This is the body that should be used for physics operations
+#/list
+#/list
+
+
+Function Nirvana_GetSpriteAnimationCount(sprite_index)
+#list ul
+#li Returns the number of animations for the given Nirvana sprite index
+#/list
+
+
+Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num)
+#list ul
+#li Returns the name of the given Nirvana Sprite Index animation number
+#/list
+
+
diff --git a/doc/nirvana_docs/nirvana_api_stages.html b/doc/nirvana_docs/nirvana_api_stages.html
new file mode 100644
index 0000000..7a23df2
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_stages.html
@@ -0,0 +1,91 @@
+
+
+
+ Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h) +
+
+
+
+ Sub Nirvana_SetStageViewport(v_position As Nirvana_Vector2D, v_size As Nirvana_Size2D) +
+
+
+
+ Function Nirvana_GetViewportPosition() As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetViewportSize() As Nirvana_Size2D +
+
+
+
+ Sub Nirvana_SetStageOffset(offset As Nirvana_Vector2D) +
+
+
+
+ Function Nirvana_GetStageOffset() As Nirvana_Vector2D +
+
+
+
+ Sub Nirvana_Update() +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/nirvana_docs/nirvana_api_stages.txt b/doc/nirvana_docs/nirvana_api_stages.txt
new file mode 100644
index 0000000..1016874
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_stages.txt
@@ -0,0 +1,46 @@
+#title Nirvana2D [RCBasic Doc]
+#header Nirvana2D Stages API
+
+
+Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h)
+#list ul
+#li Loads a stage and sets the part of the window to render it to
+#/list
+
+
+Sub Nirvana_SetStageViewport(v_position As Nirvana_Vector2D, v_size As Nirvana_Size2D)
+#list ul
+#li Returns the current viewport position and size
+#/list
+
+
+Function Nirvana_GetViewportPosition() As Nirvana_Vector2D
+#list ul
+#li Returns the current viewport position
+#/list
+
+
+
+Function Nirvana_GetViewportSize() As Nirvana_Size2D
+#list ul
+#li Returns the current viewport size
+#/list
+
+
+Sub Nirvana_SetStageOffset(offset As Nirvana_Vector2D)
+#list ul
+#li Sets the camera position
+#/list
+
+
+Function Nirvana_GetStageOffset() As Nirvana_Vector2D
+#list ul
+#li Returns the camera position
+#/list
+
+
+Sub Nirvana_Update()
+#list ul
+#li This update function must be used in place of Update() when using Nirvana2D
+#/list
+
diff --git a/doc/nirvana_docs/nirvana_api_tile.html b/doc/nirvana_docs/nirvana_api_tile.html
new file mode 100644
index 0000000..dee4c1c
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_tile.html
@@ -0,0 +1,149 @@
+
+
+
+
+
+ Type Nirvana_TileMap +
+
+
+
+ Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap +
+
+
+
+ Function Nirvana_GetLayerTileSetName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileSetID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMapID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num) +
+
+
+
+ Function Nirvana_GetTileMaskName$(mask_index) +
+
+
+
+ Function Nirvana_GetTileMaskMatrix(mask_index) +
+
+
+
+ Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y) +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/nirvana_docs/nirvana_api_tile.txt b/doc/nirvana_docs/nirvana_api_tile.txt
new file mode 100644
index 0000000..8a3be3d
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_tile.txt
@@ -0,0 +1,77 @@
+#title Nirvana2D [RCBasic Doc]
+#header Nirvana2D API
+
+
+
+Type Nirvana_TileMap
+#list ul
+#li Dim TilesetName$
+#li Dim Tileset_ID
+#li Dim TileMap_ID
+#li Dim Mask_Index
+#li Dim Mask_Count
+#/list
+
+
+Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap
+#list ul
+#li Create a Nirvana TileMap
+#/list
+
+
+
+Function Nirvana_GetLayerTileSetName$(layer_index)
+#list ul
+#li Returns the name of tileset associated with the given layer or empty string if layer is not valid
+#/list
+
+
+Function Nirvana_GetLayerTileSetID(layer_index)
+#list ul
+#li Returns the RCBasic tileset associated with the given Nirvana layer or -1 if layer is not valid
+#/list
+
+
+Function Nirvana_GetLayerTileMapID(layer_index)
+#list ul
+#li Returns the RCBasic tile map associated with the given layer or -1 if layer is not valid
+#/list
+
+
+Function Nirvana_GetLayerTileMaskCount(layer_index)
+#list ul
+#li Returns the number of tile mask on a layers tileset
+#/list
+
+
+Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num)
+#list 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
+#list ul
+#li mask_num should be a number from 0 to Nirvana_GetLayerTileMaskCount(layer_index)-1
+#/list
+#/list
+
+
+
+Function Nirvana_GetTileMaskName$(mask_index)
+#list ul
+#li Returns the name of the given tile mask or an empty string if the mask index is not valid
+#/list
+
+
+Function Nirvana_GetTileMaskMatrix(mask_index)
+#list ul
+#li Returns the RCBasic matrix id of the given mask or -1 if the mask is not valid
+#/list
+
+
+Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y)
+#list ul
+#li Returns TRUE if the tile at the given position is flagged in the given mask
+#list ul
+#li NOTE: (x, y) is a world position and not a row and column position in the tile map
+#/list
+#/list
+
+
diff --git a/doc/nirvana_docs/nirvana_api_types.html b/doc/nirvana_docs/nirvana_api_types.html
new file mode 100644
index 0000000..632bfdb
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_types.html
@@ -0,0 +1,205 @@
+
+
+
+ Type Nirvana_Vector2D +
+
+
+
+ Type Nirvana_Size2D +
+
+
+
+ Type Nirvana_Sprite +
+
+
+
+ Type Nirvana_TileMap +
+
+
+
+ Type Nirvana_Background +
+
+
+
+ Type Nirvana_Shape +
+
+
+
+ Type Nirvana_Layer +
+
+
+
+ Type Nirvana_Stage +
+
+
+
+ Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/nirvana_docs/nirvana_api_types.txt b/doc/nirvana_docs/nirvana_api_types.txt
new file mode 100644
index 0000000..78529b8
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_api_types.txt
@@ -0,0 +1,93 @@
+#title Nirvana2D [RCBasic Doc]
+#header Nirvana2D API
+
+Type Nirvana_Vector2D
+#list ul
+#li Dim X
+#li Dim Y
+#/list
+
+
+Type Nirvana_Size2D
+#list ul
+#li Dim Width
+#li Dim Height
+#/list
+
+
+Type Nirvana_Sprite
+#list ul
+#li Dim Name$
+#li Dim BaseName$
+#li Dim Sprite_ID
+#li Dim Animation_Name_Index
+#li Dim Animation_Count
+#/list
+
+
+Type Nirvana_TileMap
+#list ul
+#li Dim TilesetName$
+#li Dim Tileset_ID
+#li Dim TileMap_ID
+#li Dim Mask_Index
+#li Dim Mask_Count
+#/list
+
+
+Type Nirvana_Background
+#list ul
+#li Dim Image_ID
+#li Dim RenderSetting
+#/list
+
+
+Type Nirvana_Shape
+#list ul
+#li Dim Sprite_ID
+#li Dim ShapeType
+#/list
+
+
+Type Nirvana_Layer
+#list ul
+#li Dim Name$
+#li Dim LayerType
+#li Dim Visible
+#li Dim Alpha
+#li Dim Scroll_Speed As Nirvana_Vector2D
+#li Dim Ref_Canvas
+#li Dim Layer_TileMap As Nirvana_TileMap
+#li Dim Layer_Sprite_Count
+#li Dim Layer_Shape_Count
+#li Dim Bkg As Nirvana_Background
+#/list
+
+
+Type Nirvana_Stage
+#list ul
+#li Dim Active
+#li Dim Name$
+#li Dim Tile_Size As Nirvana_Size2D
+#li Dim Stage_Size As Nirvana_Size2D
+#li Dim Layer_Count
+#li Dim Viewport_Size As Nirvana_Size2D
+#li Dim Stage_Offset As Nirvana_Vector2D
+#/list
+
+
+
+Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D
+#list ul
+#li Create a 2D Vector
+#/list
+
+
+Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D
+#list ul
+#li Create a 2D Size
+#/list
+
+
+
+
diff --git a/doc/nirvana_docs/nirvana_sprite_editor.html b/doc/nirvana_docs/nirvana_sprite_editor.html
new file mode 100644
index 0000000..6e722e6
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_sprite_editor.html
@@ -0,0 +1,139 @@
+
+
+
+ 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. +
++ At the far left of the screen there are 2 buttons: +
++ 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. +
++
+
#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.
+ ++
#2 - Animation ID - This is the name of the current selected animation. You can change it from this field.
+ ++
#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). +
++
+ ++
#4 - Animation Frames - A horizontal layout of each frame in the animation. +
++
+ ++
#5 - Frame Count - Sets the number of frames in the current animation
+ ++
#6 - Speed - Sets the number of frames per second the animation plays at
+ ++
#7 - Preview - Plays the selected animation.
+ ++
+
#1 - Editor Viewport - Here you can draw a polygon shape or move and resize box and circle shapes.
+ ++
#2 - Tool Bar - Tools for editing the shape. +
++
+ ++
#3 - Shape Selection - Select the shape type
+ ++
#4 - Shape Parameters - Change Parameters for the shape +
++
+ ++ + + \ No newline at end of file diff --git a/doc/nirvana_docs/nirvana_sprite_editor.txt b/doc/nirvana_docs/nirvana_sprite_editor.txt new file mode 100644 index 0000000..b7ce444 --- /dev/null +++ b/doc/nirvana_docs/nirvana_sprite_editor.txt @@ -0,0 +1,75 @@ +#title Nirvana2D [RCBasic Doc] +#header Nirvana2D Sprite Editor + +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. + +At the far left of the screen there are 2 buttons: +#list ul +#li Load Sprite - Loads a sprite sheet into the definition list. +#list ul +#li NOTE: This will also load any existing animation and collision data for the sheet as well. +#/list +#li Delete Sprite - Removes a sprite definition from the editor. +#list ul +#li NOTE: This will remove any sprites in the stage that use this definition. +#/list +#/list + +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. + + +
#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.
+ +#2 - Animation ID - This is the name of the current selected animation. You can change it from this field.
+ +#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). +#list ul +#li Movement - With the mouse hovered over the Sprite Sheet, you can use W/A/S/D to move around the sheet +#/list +
+ +#4 - Animation Frames - A horizontal layout of each frame in the animation. +#list 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 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 +#/list +
+ +#5 - Frame Count - Sets the number of frames in the current animation
+ +#6 - Speed - Sets the number of frames per second the animation plays at
+ +#7 - Preview - Plays the selected animation.
+ + +#1 - Editor Viewport - Here you can draw a polygon shape or move and resize box and circle shapes.
+ +#2 - Tool Bar - Tools for editing the shape. +#list ul +#li Select - Selects a single point +#list ul +#li NOTE: Hold Ctrl to keep previous points selected +#/list +#li Box Select - Selects multiple points +#li Select - Selects a single point +#list ul +#li NOTE: Hold Ctrl to keep previous points selected +#/list +#li Move - Moves the selected points +#li Draw Polygon - When polygon shape is selected, this allows you to draw points +#/list +
+ +#3 - Shape Selection - Select the shape type
+ +#4 - Shape Parameters - Change Parameters for the shape +#list ul +#li NOTE: Parameters are different depending on shape type +#/list +
diff --git a/doc/nirvana_docs/nirvana_stage_editor.html b/doc/nirvana_docs/nirvana_stage_editor.html new file mode 100644 index 0000000..1bc8706 --- /dev/null +++ b/doc/nirvana_docs/nirvana_stage_editor.html @@ -0,0 +1,461 @@ + + + + + +
+ The stage editor is where tiles, sprites, and background layers are brought together to form the stages that you load into your game. +
+
+
+
#1 - Layer Selection - Select the active layer +
++
+ ++
#2 - Set Camera - You can use this to move instantly to a desired position in the stage
+ ++
#3 - Placement Mode - The left button is for free placement and the second button is for grid snapping
+ ++
#4 - Editor Viewport - This is where a majority of editing is done +
++
+ ++
#5 - Screen Mouse Info - The position of the mouse on the screen
+ ++
#6 - Stage Mouse Info - The position of the mouse in the stage +
++
+ ++
#7 - Camera Info - The position of the camera in the stage +
++
+ +
+
+ This is where you create stages and manage stage properties +
+
+
+ This is where you create layers and edit layer settings +
+
+
#1 - Tool Bar +
++
+ ++
#2 - Organizer - Change the order of layers or delete layers
+ ++
#3 - Layer List - Select a layer in the list to edit its properties and toggle the check box to view/hide individual layer
+ ++
#4 - Layer Settings +
++
+ +
+
+ This is where you can change editor settings +
++
#1 - Viewport +
++
+ ++
#2 - Camera +
++
+ +
+
+ These tools are only usable when a tile layer is selected. +
+
+
#1 - Tools +
++
+ ++
#2 - Tileset - Shows the tileset for the current layer
+ ++
#3 - Viewport - Tileset Selection
+ +
+
+ These tools are only usable when a sprite layer is selected. +
+
+
#1 - Sprite Tools +
++
+ ++
#2 - Sprite List - Select a sprite
+ ++
#3 - Sprite Properties +
++
+ +
+
+ These tools are only usable when a sprite layer is selected. +
+
+
#1 - Shape Tools +
++
+ ++
#2 - Shape List - List of shapes in the current layer
+ ++
#3 - Shape Properties - Different properties are available for different shapes
+ +
+
+ A background image can only be set for a Canvas 2D layer. +
+
+
#1 - Render Type - Determines how the image will be drawn +
++
+ ++
#2 - Layer Image - The image to draw on the layer
+ +
+
+
+
\ No newline at end of file
diff --git a/doc/nirvana_docs/nirvana_stage_editor.txt b/doc/nirvana_docs/nirvana_stage_editor.txt
new file mode 100644
index 0000000..334b3ea
--- /dev/null
+++ b/doc/nirvana_docs/nirvana_stage_editor.txt
@@ -0,0 +1,250 @@
+#title Nirvana2D [RCBasic Doc]
+#header Nirvana2D Stage Editor
+
+#image "images/nirvana_stage_editor_full_display.png", w=480, h=240
+
+The stage editor is where tiles, sprites, and background layers are brought together to form the stages that you load into your game.
+
+
+
#1 - Layer Selection - Select the active layer +#list ul +#li The active layer type will determine which tools are usable +#li Tile Layers are the only layers where the tile info in #6 and #7 are shown +#li Sprites and Collision shapes are only able to be added or edited on a Sprite Layer +#li If the grid is shown, it will be aligned with the active layer. +#/list +
+ +#2 - Set Camera - You can use this to move instantly to a desired position in the stage
+ +#3 - Placement Mode - The left button is for free placement and the second button is for grid snapping
+ +#4 - Editor Viewport - This is where a majority of editing is done +#list 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 If a select tool (ie. tile select, sprite select, or shape select) is active, you can hold Ctrl to select multiple items +#li Multiple selections can also be made by holding Ctrl with Box select +#/list +
+ +#5 - Screen Mouse Info - The position of the mouse on the screen
+ +#6 - Stage Mouse Info - The position of the mouse in the stage +#list ul +#li The Tile Positions are the top left corner of the tile the mouse is located in +#/list +
+ +#7 - Camera Info - The position of the camera in the stage +#list ul +#li The Tile Positions are the top left corner of the tile at the top left corner of the screen +#/list +
+ + +#1 - Tool Bar +#list ul +#li New Layer - Create a new layer +#li Copy Layer - Copies a layer +#li Show All - Makes all layers visible +#li Hide All - Hides all layers +#/list +
+ +#2 - Organizer - Change the order of layers or delete layers
+ +#3 - Layer List - Select a layer in the list to edit its properties and toggle the check box to view/hide individual layer
+ +#4 - Layer Settings +#list ul +#li Type - The type of layer selected. There are 4 types of layers: sprite, tile, canvas 2d, and canvas 3d. +#li Name - The name of the layer +#li HScroll - The speed the layer scrolls horizontally +#li VScrol - The speed the layer scrolls vertically +#li Alpha - The transparency value +#/list +
+ + +#1 - Viewport +#list ul +#li Show Shapes - This determines whether stage collision shapes are viewable when the layer they are created on is not active +#li Show Grid - Show the tile grid +#list ul +#li NOTE: Tile grid is aligned to the active layer so layers with different HScroll and VScroll speeds will have different grid alignments +#/list +#li Grid Color - The color of the grid +#/list +
+ +#2 - Camera +#list ul +#li Move Speed - The speed the viewport scrolls at when using W/A/S/D movement +#/list +
+ + +#1 - Tools +#list +#li Select - Select a single tile +#list ul +#li Hold Ctrl to do multiple selections +#/list +#li Box Select - Select all tiles in box +#list ul +#li Hold Ctrl to do multiple selections +#/list +#li Move - Move the selected tiles +#li Set Tile - Place selected tiles in stage +#list ul +#li You can select multiple tiles in the tile select viewport +#li Right click to delete the tile at the mouse position in stage viewport +#/list +#li Copy Tile - Copies the selected tiles +#li Fill Tile - Flood fills with a selected tile +#li Delete Selected Tiles - Delete selected tiles +#/list +
+ +#2 - Tileset - Shows the tileset for the current layer
+ +#3 - Viewport - Tileset Selection
+ + + +#1 - Sprite Tools +#list ul +#li Select - Select a single sprite +#list ul +#li Hold Ctrl to do multiple selections +#/list +#li Box Select - Select all tiles in box +#list ul +#li Hold Ctrl to do multiple selections +#/list +#li Move - Move the selected sprites +#list ul +#li If Placement mode is set to Tile Snap then the sprite will snap to the closest tile position +#/list +#li Rotate - Rotates the selected sprites +#li Scale - Scale the selected sprites +#li New Sprite - Add a sprite to the current layer +#li Delete Sprite - Delete the selected sprite +#li Copy Sprite - Copy the selected sprite +#li Center on sprite - Center the viewport on the selected sprite +#/list +
+ +#2 - Sprite List - Select a sprite
+ +#3 - Sprite Properties +#list ul +#li Sprite ID - Name of the selected sprite +#li Body Type - Type of physics body +#li Animation - The default animation set on the sprite when stage first loads +#li Position - The position of the sprite +#li Rotation - The angle the sprite is rotated by +#li Scale - The scale of the sprite +#li Render Settings - Additional render settings +#/list +
+ + +#1 - Shape Tools +#list ul +#li Select - Select a single point +#list ul +#li Hold Ctrl to do multiple selections +#li NOTE: While Ctrl is down, only points on the selected shape will be selected +#/list +#li Box Select - Select all points in box +#list ul +#li Hold Ctrl to do multiple selections +#li NOTE: While Ctrl is down, only points on the selected shape will be selected +#/list +#li Move - Move the selected points +#list ul +#li If Placement mode is set to Tile Snap then the points will snap to the closest tile position +#/list +#li Draw Shape - Draw the shape in the stage viewport +#li Create Shapes +#list ul +#li Box - An axis aligned rectangle +#li Polygon - A closed polygon +#li Chain - A shape made of connected points +#li Circle - A circle +#/list +#li Delete Shape - Deletes the selected shape +#/list +
+ +#2 - Shape List - List of shapes in the current layer
+ +#3 - Shape Properties - Different properties are available for different shapes
+ + + +#1 - Render Type - Determines how the image will be drawn +#list ul +#li Normal - Draw the image at its native resolution +#li Stretched - Stretch the image to the size of the viewport +#li Tiled - Tile the image as the stage scrolls +#list ul +#li NOTE: Background tile will scroll at layer scroll speed +#/list +#/list +
+ +#2 - Layer Image - The image to draw on the layer
diff --git a/doc/nirvana_docs/nirvana_tile_editor.html b/doc/nirvana_docs/nirvana_tile_editor.html new file mode 100644 index 0000000..0e07a45 --- /dev/null +++ b/doc/nirvana_docs/nirvana_tile_editor.html @@ -0,0 +1,117 @@ + + + + + ++ 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. +
++ At the far left of the screen there are 2 buttons: +
++ 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. +
++
+
#1 - Tile Sheet - View and select tiles +
++
+ ++
#2 - Frame Panel - Select the animation frame to set +
++
+ ++
#3 - Select Base Tile - Switches to Base Tile Select Mode
+ ++
#4 - Animate Tile - Switches to Animate Mode
+ ++
#5 - Frame Count - Sets the number of frames in the base tile animation
+ ++
#6 - Speed - Sets the frames per second the base tile animation plays at
+ ++
#7 - Preview - Play the sprite animation
+ ++
+
#1 - Mask List - Select a mask to edit +
++
+ ++
#2 - Mask ID - Change the mask ID from this field
+ ++
#3 - Tile Sheet - View and select tiles +
++
+ ++ + + \ No newline at end of file diff --git a/doc/nirvana_docs/nirvana_tile_editor.txt b/doc/nirvana_docs/nirvana_tile_editor.txt new file mode 100644 index 0000000..f379e5d --- /dev/null +++ b/doc/nirvana_docs/nirvana_tile_editor.txt @@ -0,0 +1,64 @@ +#title Nirvana2D [RCBasic Doc] +#header Nirvana2D Tile Editor + +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. + +At the far left of the screen there are 2 buttons: +#list ul +#li Load Tileset - Loads a tile sheet into the tile set list. +#list ul +#li NOTE: This will also load any existing animation and mask data for the sheet as well. +#/list +#li Delete Tileset - Removes a tile set from the editor. +#list ul +#li NOTE: This will remove any layer in the stage that uses this tile set. +#/list +#/list + +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. + + +
#1 - Tile Sheet - View and select tiles +#list ul +#li Movement - With the mouse hovered over the Sprite Sheet, you can use W/A/S/D to move around the sheet +#/list +
+ +#2 - Frame Panel - Select the animation frame to set +#list 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. +#/list +
+ +#3 - Select Base Tile - Switches to Base Tile Select Mode
+ +#4 - Animate Tile - Switches to Animate Mode
+ +#5 - Frame Count - Sets the number of frames in the base tile animation
+ +#6 - Speed - Sets the frames per second the base tile animation plays at
+ +#7 - Preview - Play the sprite animation
+ + +#1 - Mask List - Select a mask to edit +#list ul +#li New Mask - Create a new mask in the current tile set +#li Delete Mask - Delete the selected mask +#/list +
+ +#2 - Mask ID - Change the mask ID from this field
+ +#3 - Tile Sheet - View and select tiles +#list ul +#li Movement - With the mouse hovered over the Sprite Sheet, you can use W/A/S/D to move around the sheet +#li Flag Tile - To flag a tile in the mask, left click the tile. To unflag a tile, Right Click on it. +#/list +
diff --git a/doc/nirvana_docs/rc_doc_error.html b/doc/nirvana_docs/rc_doc_error.html new file mode 100644 index 0000000..3939d4c --- /dev/null +++ b/doc/nirvana_docs/rc_doc_error.html @@ -0,0 +1,17 @@ + + + + + ++ ./nirvana_stage_editor.html ./nirvana_stage_editor.html +
++ + + \ No newline at end of file diff --git a/doc/nirvana_docs/rc_doc_error.txt b/doc/nirvana_docs/rc_doc_error.txt new file mode 100644 index 0000000..67bbe5e --- /dev/null +++ b/doc/nirvana_docs/rc_doc_error.txt @@ -0,0 +1,2 @@ +./nirvana_stage_editor.html +./nirvana_stage_editor.html diff --git a/doc/nirvana_docs/update_doc.sh b/doc/nirvana_docs/update_doc.sh new file mode 100755 index 0000000..9b47955 --- /dev/null +++ b/doc/nirvana_docs/update_doc.sh @@ -0,0 +1,6 @@ +#!/bin/bash +export PATH=~/Programs/rcbasic3 +export RC_DOC_HOME=/home/n00b/Projects/rc_docs/RCDocs +rcbasic_run --version +cd /home/n00b/Projects/rc_docs/RCDocs/rc_doc_run +rcbasic_run /home/n00b/Projects/rc_docs/RCDocs/rc_doc_run . . diff --git a/doc/serenity_docs/images/material_preview_light.png b/doc/serenity_docs/images/material_preview_light.png new file mode 100644 index 0000000..dc92a9d Binary files /dev/null and b/doc/serenity_docs/images/material_preview_light.png differ diff --git a/doc/serenity_docs/images/material_preview_settings.png b/doc/serenity_docs/images/material_preview_settings.png new file mode 100644 index 0000000..7e2df7e Binary files /dev/null and b/doc/serenity_docs/images/material_preview_settings.png differ diff --git a/doc/serenity_docs/images/new_stage_button.png b/doc/serenity_docs/images/new_stage_button.png new file mode 100644 index 0000000..b5f9eaf Binary files /dev/null and b/doc/serenity_docs/images/new_stage_button.png differ diff --git a/doc/serenity_docs/images/serenity_material_properties.png b/doc/serenity_docs/images/serenity_material_properties.png new file mode 100644 index 0000000..aa1bf7a Binary files /dev/null and b/doc/serenity_docs/images/serenity_material_properties.png differ diff --git a/doc/serenity_docs/images/serenity_material_texture_panel.png b/doc/serenity_docs/images/serenity_material_texture_panel.png new file mode 100644 index 0000000..5c6c59a Binary files /dev/null and b/doc/serenity_docs/images/serenity_material_texture_panel.png differ diff --git a/doc/serenity_docs/images/serenity_mesh_editor.png b/doc/serenity_docs/images/serenity_mesh_editor.png new file mode 100644 index 0000000..99a14dd Binary files /dev/null and b/doc/serenity_docs/images/serenity_mesh_editor.png differ diff --git a/doc/serenity_docs/images/serenity_scene_editor.png b/doc/serenity_docs/images/serenity_scene_editor.png new file mode 100644 index 0000000..d4e31e1 Binary files /dev/null and b/doc/serenity_docs/images/serenity_scene_editor.png differ diff --git a/doc/serenity_docs/images/serenity_texture_view.png b/doc/serenity_docs/images/serenity_texture_view.png new file mode 100644 index 0000000..5a853e9 Binary files /dev/null and b/doc/serenity_docs/images/serenity_texture_view.png differ diff --git a/doc/serenity_docs/images/yeet_stage_button.png b/doc/serenity_docs/images/yeet_stage_button.png new file mode 100644 index 0000000..c097fae Binary files /dev/null and b/doc/serenity_docs/images/yeet_stage_button.png differ diff --git a/doc/serenity_docs/nirvana_api.html b/doc/serenity_docs/nirvana_api.html new file mode 100644 index 0000000..93e8b9a --- /dev/null +++ b/doc/serenity_docs/nirvana_api.html @@ -0,0 +1,673 @@ + + +
+ + ++ This API is what allows developers to access objects created in the Nirvana2D editor inside RCBasic. +
++
+ Type Nirvana_Vector2D +
+
+
+
+ Type Nirvana_Size2D +
+
+
+
+ Type Nirvana_Sprite +
+
+
+
+ Type Nirvana_TileMap +
+
+
+
+ Type Nirvana_Background +
+
+
+
+ Type Nirvana_Shape +
+
+
+
+ Type Nirvana_Layer +
+
+
+
+ Type Nirvana_Stage +
+
+
+
+ Function Nirvana_CreateVector2D(x, y) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_CreateSize2D(w, h) As Nirvana_Size2D +
+
+
+
+ Function Nirvana_CreateSprite(spriteDefinition_name$, sprite_name$) As Nirvana_Sprite +
+
+
+
+ Function Nirvana_CreateTileMap(tset_name$, tmap_width, tmap_height) As Nirvana_TileMap +
+
+
+
+
+ Function Nirvana_LoadStage(stage_name$, viewport_x, viewport_y, viewport_w, viewport_h) +
+
+
+
+ Sub Nirvana_Update() +
+
+
+
+
+ Function Nirvana_GetLayerIndex(layer_name$) +
+
+
+
+ Function Nirvana_GetLayerCanvasID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerType(layer_index) +
+
+
+
+ Function Nirvana_GetLayerName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerAlpha(layer_index) +
+
+
+
+ Function Nirvana_GetLayerScrollSpeed(layer_index) As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetLayerTileSetName$(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileSetID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMapID(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerTileMaskIndex(layer_index, mask_num) +
+
+
+
+ Function Nirvana_GetLayerSpriteCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerSpriteIndex(layer_index, sprite_name$) +
+
+
+
+ Function Nirvana_GetLayerShapeCount(layer_index) +
+
+
+
+ Function Nirvana_GetLayerBackgroundImageID(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundImage(layer_index, image_id) +
+
+
+
+ Function Nirvana_GetLayerBackgroundRenderType(layer_index) +
+
+
+
+ Function Nirvana_SetLayerBackgroundRenderType(layer_index, render_type) +
+
+
+
+
+ Function Nirvana_GetTileMaskName$(mask_index) +
+
+
+
+ Function Nirvana_GetTileMaskMatrix(mask_index) +
+
+
+
+ Function Nirvana_GetLayerMaskHit(layer_index, mask_index, x, y) +
+
+
+
+
+ Function Nirvana_GetSpriteID(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteDefinitionName$(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationCount(sprite_index) +
+
+
+
+ Function Nirvana_GetSpriteAnimationName$(sprite_index, animation_num) +
+
+
+
+
+
+
+ Function Nirvana_GetStageOffset() As Nirvana_Vector2D +
+
+
+
+
+
+
+ Function Nirvana_GetViewportPosition() As Nirvana_Vector2D +
+
+
+
+ Function Nirvana_GetViewportSize() As Nirvana_Size2D +
++ + + \ No newline at end of file diff --git a/doc/serenity_docs/serenity_api.html b/doc/serenity_docs/serenity_api.html new file mode 100644 index 0000000..3db877f --- /dev/null +++ b/doc/serenity_docs/serenity_api.html @@ -0,0 +1,56 @@ + + +
+ + ++ This API is what allows developers to access objects created in the Serenity3D editor inside RCBasic. +
++ '-------SKY------- Function Serenity_GetSkyShape() +
++ Function Serenity_GetSkyBox() As Serenity_Sky_Box +
++ Function Serenity_GetSkyDome() As Serenity_Sky_Dome +
++ Function Serenity_StageHasSky() +
++ '-------STAGES------- Function Serenity_GetStageIndex(stage_name$) +
++ Function Serenity_GetStageName$(stage_index) +
++ Function Serenity_GetStageCount() +
++ Sub Serenity_ClearStage() +
++ Sub Serenity_LoadStage(stage_name$) +
++ Function Serenity_GetCurrentStageIndex() +
++ '-------GROUPS------- Function Serenity_GetGroupCount() +
++ Function Serenity_GetGroupIndex(group_name$) +
++ Function Serenity_GetGroupName$(group_index) +
++ + + \ No newline at end of file diff --git a/doc/serenity_docs/serenity_api.txt b/doc/serenity_docs/serenity_api.txt new file mode 100644 index 0000000..e72a9b3 --- /dev/null +++ b/doc/serenity_docs/serenity_api.txt @@ -0,0 +1,36 @@ +#title Serenity3D [RCBasic Doc] +#header Serenity3D API + +This API is what allows developers to access objects created in the Serenity3D editor inside RCBasic. + + +'-------SKY------- +Function Serenity_GetSkyShape() + +Function Serenity_GetSkyBox() As Serenity_Sky_Box + +Function Serenity_GetSkyDome() As Serenity_Sky_Dome + +Function Serenity_StageHasSky() + + + +'-------STAGES------- +Function Serenity_GetStageIndex(stage_name$) + +Function Serenity_GetStageName$(stage_index) + +Function Serenity_GetStageCount() + +Sub Serenity_ClearStage() + +Sub Serenity_LoadStage(stage_name$) + +Function Serenity_GetCurrentStageIndex() + +'-------GROUPS------- +Function Serenity_GetGroupCount() + +Function Serenity_GetGroupIndex(group_name$) + +Function Serenity_GetGroupName$(group_index) diff --git a/doc/serenity_docs/serenity_api_actors.html b/doc/serenity_docs/serenity_api_actors.html new file mode 100644 index 0000000..579959c --- /dev/null +++ b/doc/serenity_docs/serenity_api_actors.html @@ -0,0 +1,175 @@ + + +
+ + ++ Function Serenity_GetActorIndex(actor_name$) +
+
+
+
+ Function Serenity_GetActorCount() +
+
+
+
+ Function Serenity_GetActorID(actor_index) +
+
+
+
+ Function Serenity_GetActorName$(actor_index) +
+
+
+
+ Function Serenity_GetActorType(actor_index) +
+
+
+
+ Function Serenity_GetActorMeshIndex(actor_index) +
+
+
+
+ Function Serenity_GetActorOverrideMaterialIndex(actor_index) +
+
+
+
+ Function Serenity_GetActorTerrainHeightMap$(actor_index) +
+
+
+
+ Function Serenity_GetActorCubeSize(actor_index) +
+
+
+
+ Function Serenity_GetActorSphereRadius(actor_index) +
+
+
+
+ Function Serenity_GetActorGroupIndex(actor_index) +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_api_actors.txt b/doc/serenity_docs/serenity_api_actors.txt
new file mode 100644
index 0000000..78a4d35
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_actors.txt
@@ -0,0 +1,86 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Actors API
+
+
+Function Serenity_GetActorIndex(actor_name$)
+#list ul
+#li Returns the Serenity Actor Index which is used to access actor data in the API
+#/list
+
+
+Function Serenity_GetActorCount()
+#list ul
+#li Returns the number of actors in the current stage
+#list ul
+#li NOTE: This count only includes actors that were created in Serenity3D
+#/list
+#/list
+
+
+Function Serenity_GetActorID(actor_index)
+#list ul
+#li Returns the RCBasic Actor ID
+#/list
+
+
+Function Serenity_GetActorName$(actor_index)
+#list ul
+#li Returns the name of the actor from the given Serenity Actor Index
+#/list
+
+
+Function Serenity_GetActorType(actor_index)
+#list ul
+#li Returns the actor type
+#li Possible values are
+#list ul
+#li SN_ACTOR_TYPE_ANIMATED
+#li SN_ACTOR_TYPE_OCTREE
+#li SN_ACTOR_TYPE_LIGHT
+#li SN_ACTOR_TYPE_BILLBOARD
+#li SN_ACTOR_TYPE_TERRAIN
+#li SN_ACTOR_TYPE_WATER
+#li SN_ACTOR_TYPE_PARTICLE
+#li SN_ACTOR_TYPE_CUBE
+#li SN_ACTOR_TYPE_SPHERE
+#li SN_ACTOR_TYPE_PLANE
+#/list
+#/list
+
+
+Function Serenity_GetActorMeshIndex(actor_index)
+#list ul
+#li Returns the Serenity Mesh index the actor was created from
+#/list
+
+
+Function Serenity_GetActorOverrideMaterialIndex(actor_index)
+#list ul
+#li Returns the material index set in an actors properties on the Stage Editor tab
+#/list
+
+
+Function Serenity_GetActorTerrainHeightMap$(actor_index)
+#list ul
+#li Returns the height map file for a terrain actor
+#/list
+
+
+Function Serenity_GetActorCubeSize(actor_index)
+#list ul
+#li Returns the cube size for a cube actor
+#/list
+
+
+Function Serenity_GetActorSphereRadius(actor_index)
+#list ul
+#li Returns the sphere radius for a sphere actor
+#/list
+
+
+Function Serenity_GetActorGroupIndex(actor_index)
+#list ul
+#li Returns the Serenity Group Index the actor is grouped in or -1 if the actor is not part of a group
+#/list
+
+
diff --git a/doc/serenity_docs/serenity_api_groups.html b/doc/serenity_docs/serenity_api_groups.html
new file mode 100644
index 0000000..13e7169
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_groups.html
@@ -0,0 +1,47 @@
+
+
+
+ Function Serenity_GetGroupCount() +
+
+
+
+ Function Serenity_GetGroupIndex(group_name$) +
+
+
+
+ Function Serenity_GetGroupName$(group_index) +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_api_groups.txt b/doc/serenity_docs/serenity_api_groups.txt
new file mode 100644
index 0000000..d6a0e75
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_groups.txt
@@ -0,0 +1,21 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Groups API
+
+
+Function Serenity_GetGroupCount()
+#list ul
+#li Returns the number of groups in the current stage
+#/list
+
+
+Function Serenity_GetGroupIndex(group_name$)
+#list ul
+#li Returns the Serenity Group index from the group name or -1 if group does not exists in current stage
+#/list
+
+
+Function Serenity_GetGroupName$(group_index)
+#list ul
+#li Returns the group name
+#/list
+
diff --git a/doc/serenity_docs/serenity_api_materials.html b/doc/serenity_docs/serenity_api_materials.html
new file mode 100644
index 0000000..4e6cf74
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_materials.html
@@ -0,0 +1,47 @@
+
+
+
+
+
+ Function Serenity_GetMaterialIndex(material_name$) +
+
+
+
+ Function Serenity_GetMaterialID(material_index) +
+
+
+
+ Function Serenity_GetMaterialTextureIndex(material_index, texture_level) +
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_api_materials.txt b/doc/serenity_docs/serenity_api_materials.txt
new file mode 100644
index 0000000..47afdba
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_materials.txt
@@ -0,0 +1,21 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Materials API
+
+
+
+Function Serenity_GetMaterialIndex(material_name$)
+#list ul
+#li Returns the Serenity Material Index which is used to access material data in the API
+#/list
+
+
+Function Serenity_GetMaterialID(material_index)
+#list ul
+#li Returns the RCBasic material ID or -1 if material_index is not valid
+#/list
+
+
+Function Serenity_GetMaterialTextureIndex(material_index, texture_level)
+#list ul
+#li Returns the Serenity Texture Index which is used to access texture data in the API
+#/list
diff --git a/doc/serenity_docs/serenity_api_meshes.html b/doc/serenity_docs/serenity_api_meshes.html
new file mode 100644
index 0000000..e3a2862
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_meshes.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+ Function Serenity_GetAN8Count() +
+
+
+
+ Function Serenity_GetAN8ID(an8_index) +
+
+
+
+ Function Serenity_GetMeshIndex(mesh_name$) +
+
+
+
+ Function Serenity_GetMeshID(mesh_index) +
+
+
+
+ Function Serenity_GetMeshName$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshType(mesh_index) +
+
+
+
+ Function Serenity_GetMeshAN8Index(mesh_index) +
+
+
+
+ Function Serenity_GetMeshAN8Scene$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshArchiveName$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshFile$(mesh_index) +
+
+
+
+ Function Serenity_GetMeshMaterialCount(mesh_index) +
+
+
+
+ Function Serenity_GetMeshMaterialIndex(mesh_index, material_num) +
+
+
+
+ Function Serenity_GetMeshAnimationCount(mesh_index) +
+
+
+
+ Function Serenity_GetMeshAnimationID(mesh_index, animation_num) +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_api_meshes.txt b/doc/serenity_docs/serenity_api_meshes.txt
new file mode 100644
index 0000000..4e07024
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_meshes.txt
@@ -0,0 +1,97 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Mesh API
+
+
+
+Function Serenity_GetAN8Count()
+#list ul
+#li Returns the number of Anim8or objects loaded with the current stage
+#/list
+
+
+Function Serenity_GetAN8ID(an8_index)
+#list ul
+#li Returns the RCBasic Anim8or ID
+#list ul
+#li NOTE: an8_index should be from 0 to Serenity_GetAN8Count()-1
+#/list
+#/list
+
+
+Function Serenity_GetMeshIndex(mesh_name$)
+#list ul
+#li Returns the Serenity Mesh Index which is used to access mesh data in the API
+#/list
+
+
+Function Serenity_GetMeshID(mesh_index)
+#list ul
+#li Returns the RCBasic Mesh ID of the given mesh index or -1 if mesh_index is not valid
+#/list
+
+
+Function Serenity_GetMeshName$(mesh_index)
+#list ul
+#li Returns the mesh name fron the given mesh index
+#/list
+
+
+Function Serenity_GetMeshType(mesh_index)
+#list ul
+#li Returns the mesh type
+#li Possible values are:
+#list ul
+#li SN_MESH_TYPE_NORMAL - Unless the mesh is loaded from an Anim8or project or a zip its going to be this
+#li SN_MESH_TYPE_ZIPPED - A mesh loaded from an archive like a *.pak file
+#li SN_MESH_TYPE_AN8_SCENE - Anim8or mesh
+#/list
+#/list
+
+
+Function Serenity_GetMeshAN8Index(mesh_index)
+#list ul
+#li Returns the Serenity Anim8or object index
+#/list
+
+
+Function Serenity_GetMeshAN8Scene$(mesh_index)
+#list ul
+#li Returns the scene name$ in Anim8or that this mesh is loaded from
+#/list
+
+
+Function Serenity_GetMeshArchiveName$(mesh_index)
+#list ul
+#li Returns the name of the archive that the mesh is loaded from
+#/list
+
+
+Function Serenity_GetMeshFile$(mesh_index)
+#list ul
+#li Returns the name of the mesh file that the mesh is loaded from
+#/list
+
+
+Function Serenity_GetMeshMaterialCount(mesh_index)
+#list ul
+#li Returns the number of materials on given mesh
+#/list
+
+
+Function Serenity_GetMeshMaterialIndex(mesh_index, material_num)
+#list ul
+#li Returns the Serenity Material Index from the material number on the given mesh
+#/list
+
+
+Function Serenity_GetMeshAnimationCount(mesh_index)
+#list ul
+#li Returns the number of animations on the given mesh
+#/list
+
+
+Function Serenity_GetMeshAnimationID(mesh_index, animation_num)
+#list ul
+#li Returns the RCBasic mesh animation id
+#/list
+
diff --git a/doc/serenity_docs/serenity_api_stages.html b/doc/serenity_docs/serenity_api_stages.html
new file mode 100644
index 0000000..148d5dc
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_stages.html
@@ -0,0 +1,143 @@
+
+
+
+ Function Serenity_GetSkyShape() +
+
+
+
+ Function Serenity_GetSkyBox() As Serenity_Sky_Box +
+
+
+
+ Function Serenity_GetSkyDome() As Serenity_Sky_Dome +
+
+
+
+ Function Serenity_StageHasSky() +
+
+
+
+ Function Serenity_GetStageIndex(stage_name$) +
+
+
+
+ Function Serenity_GetStageName$(stage_index) +
+
+
+
+ Function Serenity_GetStageCount() +
+
+
+
+ Sub Serenity_ClearStage() +
+
+
+
+ Sub Serenity_LoadStage(stage_name$) +
+
+
+
+ Function Serenity_GetCurrentStageIndex() +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_api_stages.txt b/doc/serenity_docs/serenity_api_stages.txt
new file mode 100644
index 0000000..ddedd55
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_stages.txt
@@ -0,0 +1,75 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Stages API
+
+
+Function Serenity_GetSkyShape()
+#list ul
+#li Returns the Serenity Actor Index which is used to access actor data in the API
+#li Possible values are:
+#list ul
+#li SN_SKY_TYPE_NONE
+#li SN_SKY_TYPE_BOX
+#li SN_SKY_TYPE_DOME
+#/list
+#/list
+
+
+Function Serenity_GetSkyBox() As Serenity_Sky_Box
+#list ul
+#li Returns the sky box for the current stage
+#/list
+
+
+Function Serenity_GetSkyDome() As Serenity_Sky_Dome
+#list ul
+#li Returns the sky dome for the current stage
+#/list
+
+
+Function Serenity_StageHasSky()
+#list ul
+#li Returns TRUE if the stage has a sky object and FALSE otherwise
+#/list
+
+
+
+Function Serenity_GetStageIndex(stage_name$)
+#list ul
+#li Returns the Serenity Stage Index or -1 if the stage name was not found in the project
+#/list
+
+
+
+Function Serenity_GetStageName$(stage_index)
+#list ul
+#li Returns the name of the stage from the index
+#/list
+
+
+Function Serenity_GetStageCount()
+#list ul
+#li Returns the number of stages in the project
+#/list
+
+
+Sub Serenity_ClearStage()
+#list ul
+#li Clears the currently loaded stage
+#/list
+
+
+Sub Serenity_LoadStage(stage_name$)
+#list ul
+#li Loads a stage
+#list ul
+#li NOTE: Its a good idea to get the stage index first to make sure the stage exists
+#/list
+#/list
+
+
+Function Serenity_GetCurrentStageIndex()
+#list ul
+#li Returns the index of the currently loaded stage
+#/list
+
+
diff --git a/doc/serenity_docs/serenity_api_textures.html b/doc/serenity_docs/serenity_api_textures.html
new file mode 100644
index 0000000..5ee9365
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_textures.html
@@ -0,0 +1,69 @@
+
+
+
+
+
+ Function Serenity_GetTextureIndex(texture_name$) +
+
+
+
+ Function Serenity_GetTextureID(texture_index) +
+
+
+
+ Function Serenity_GetTextureFile$(texture_index) +
+
+
+
+ Function Serenity_GetTextureColorKey(texture_index) +
+
+
+
+ Function Serenity_GetTextureIsColorKey(texture_index) +
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_api_textures.txt b/doc/serenity_docs/serenity_api_textures.txt
new file mode 100644
index 0000000..19ae110
--- /dev/null
+++ b/doc/serenity_docs/serenity_api_textures.txt
@@ -0,0 +1,34 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Texture API
+
+
+
+Function Serenity_GetTextureIndex(texture_name$)
+#list ul
+#li Returns the Serenity Texture Index which is used to access texture data in the API
+#/list
+
+
+Function Serenity_GetTextureID(texture_index)
+#list ul
+#li Returns the RCBasic texture ID or -1 if texture_index is not valid
+#/list
+
+
+Function Serenity_GetTextureFile$(texture_index)
+#list ul
+#li Returns the name of the texture file
+#/list
+
+
+Function Serenity_GetTextureColorKey(texture_index)
+#list ul
+#li Returns the color key of the texture
+#/list
+
+
+Function Serenity_GetTextureIsColorKey(texture_index)
+#list ul
+#li Returns TRUE if texture colorkey flag was set in Serenity3D
+#/list
+
diff --git a/doc/serenity_docs/serenity_material_editor.html b/doc/serenity_docs/serenity_material_editor.html
new file mode 100644
index 0000000..3a890c6
--- /dev/null
+++ b/doc/serenity_docs/serenity_material_editor.html
@@ -0,0 +1,67 @@
+
+
+
+ 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. +
++ The main properties panel is where a majority of settings for the material is set. +
+
+
+
+ The texture panel is where you set textures for the material. Each material can have multiple texture levels which you can set here. +
+
+
+
+ The material preview allows you to view the current material on a mesh. +
+
+
+
+
#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.
#2 -The last option allows you to edit the camera actions on the material view.
+ +
+
+
+ If lighting is checked, then you will need to enable a light on the preview window to view it. +
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_material_editor.txt b/doc/serenity_docs/serenity_material_editor.txt
new file mode 100644
index 0000000..767849b
--- /dev/null
+++ b/doc/serenity_docs/serenity_material_editor.txt
@@ -0,0 +1,36 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Material Editor
+
+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.
+
+
+The main properties panel is where a majority of settings for the material is set.
+#image "images/serenity_material_properties.png"
+
+
+
+The texture panel is where you set textures for the material. Each material can have multiple texture levels which you can set here.
+#image "images/serenity_material_texture_panel.png"
+
+
+
+The material preview allows you to view the current material on a mesh.
+#list ul
+#li Preview Controls - Hold the Middle Mouse button and move left/right to rotate the camera around the object
+#/list
+
+
+
#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.
+#2 -The last option allows you to edit the camera actions on the material view.
+#image "images/material_preview_settings.png" ++ The mesh editor performs the following functions +
+
+
+
+ The mesh preview window has the same controls as the material preview. +
++ Hold the middle mouse button down and move the mouse left/right to rotate around the mesh. +
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_mesh_editor.txt b/doc/serenity_docs/serenity_mesh_editor.txt
new file mode 100644
index 0000000..2118fd3
--- /dev/null
+++ b/doc/serenity_docs/serenity_mesh_editor.txt
@@ -0,0 +1,26 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Mesh Editor
+
+The mesh editor performs the following functions
+#list ol
+#li Load Mesh from file
+#li Create Mesh from a mesh primitive shape
+#li Remove mesh from project
+#/list
+
+
+The mesh preview window has the same controls as the material preview.
+
+Hold the middle mouse button down and move the mouse left/right to rotate around the mesh.
+
+#image "images/serenity_mesh_editor.png", w=640, h=400
+#list ol
+#li ID - Must be a valid RCBasic variable
+#li File - The file the mesh was loaded from
+#li Materials - Add materials and set them
+#li Animations - Add and remove animations from mesh
+#list ul
+#li NOTE: MD2 meshes will load default animations
+#/list
+#/list
+
diff --git a/doc/serenity_docs/serenity_scene_editor.html b/doc/serenity_docs/serenity_scene_editor.html
new file mode 100644
index 0000000..219daf5
--- /dev/null
+++ b/doc/serenity_docs/serenity_scene_editor.html
@@ -0,0 +1,49 @@
+
+
+
+ The scene editor performs the following functions +
+
+
+
+ The scene view is where most of the work is done. +
+
+ These are the main controls for navigating through the scene: +
+
+
+
+
\ No newline at end of file
diff --git a/doc/serenity_docs/serenity_scene_editor.txt b/doc/serenity_docs/serenity_scene_editor.txt
new file mode 100644
index 0000000..1489305
--- /dev/null
+++ b/doc/serenity_docs/serenity_scene_editor.txt
@@ -0,0 +1,20 @@
+#title Serenity3D [RCBasic Doc]
+#header Serenity3D Scene Editor
+
+The scene editor performs the following functions
+#list ol
+#li Create Stages
+#li Create Actors and Place them in a stage
+#li Set Actor Properties
+#/list
+
+
+The scene view is where most of the work is done.
+#image "images/serenity_scene_editor.png", w=640, h=400
+
+These are the main controls for navigating through the scene:
+#list ul
+#li Hold the middle mouse button in the viewport to go into navigate mode
+#li While the middle mouse is down, you can around with W/A/S/D and move vertically with R/F
+#li Moving the mouse will rotate the camera
+#/list
diff --git a/doc/serenity_docs/serenity_texture_view.html b/doc/serenity_docs/serenity_texture_view.html
new file mode 100644
index 0000000..35f163a
--- /dev/null
+++ b/doc/serenity_docs/serenity_texture_view.html
@@ -0,0 +1,33 @@
+
+
+
+ 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. +
++ You have these properties you can edit. +
+
+ Texture ID - Must be a valid RCBasic variable name. It is the name your texture can be looked up by. +
++ File - This field will show the file name associated with this ID. +
++ Use Colorkey - This is a flag to tell the editor to use the provided color key. +
++ Colorkey - This is the color key value used. +
++ + + \ No newline at end of file diff --git a/doc/serenity_docs/serenity_texture_view.txt b/doc/serenity_docs/serenity_texture_view.txt new file mode 100644 index 0000000..966d626 --- /dev/null +++ b/doc/serenity_docs/serenity_texture_view.txt @@ -0,0 +1,15 @@ +#title Serenity3D [RCBasic Doc] +#header Serenity3D Texture Manager + +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. + +You have these properties you can edit. +#image "images/serenity_texture_view.png" + +Texture ID - Must be a valid RCBasic variable name. It is the name your texture can be looked up by. + +File - This field will show the file name associated with this ID. + +Use Colorkey - This is a flag to tell the editor to use the provided color key. + +Colorkey - This is the color key value used. diff --git a/doc/serenity_docs/update_doc.sh b/doc/serenity_docs/update_doc.sh new file mode 100644 index 0000000..9b47955 --- /dev/null +++ b/doc/serenity_docs/update_doc.sh @@ -0,0 +1,6 @@ +#!/bin/bash +export PATH=~/Programs/rcbasic3 +export RC_DOC_HOME=/home/n00b/Projects/rc_docs/RCDocs +rcbasic_run --version +cd /home/n00b/Projects/rc_docs/RCDocs/rc_doc_run +rcbasic_run /home/n00b/Projects/rc_docs/RCDocs/rc_doc_run . .