Added new functions to documentation

This commit is contained in:
n00b87
2025-08-13 19:20:25 -05:00
parent 6ad655f40d
commit 4b2f517de4
152 changed files with 8947 additions and 0 deletions

View File

@@ -0,0 +1,18 @@
#title GetActorShape [RCBasic Doc]
#header function GetActorShape(actor)
Returns the shape of an actor
Possible Actor Shapes
#list ul
#li ACTOR_SHAPE_NONE
#li ACTOR_SHAPE_BOX
#li ACTOR_SHAPE_SPHERE
#li ACTOR_SHAPE_CYLINDER
#li ACTOR_SHAPE_CAPSULE
#li ACTOR_SHAPE_CONE
#li ACTOR_SHAPE_CONVEXHULL
#li ACTOR_SHAPE_TRIMESH
#/list
#ref SetActorShape

View File

@@ -0,0 +1,6 @@
#title GetMeshBoundingBox [RCBasic Doc]
#header Sub GetMeshBoundingBox( mesh, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z )
Gets the min and max corners of a mesh's bounding box
#ref SetMeshBoundingBox ReCalculateMeshBoundingBox

View File

@@ -0,0 +1,18 @@
#title GetSpriteShape [RCBasic Doc]
#header Function GetSpriteShape(spr_id)
Returns the shape of a sprite.
Possible Shapes
#list ul
#li SPRITE_SHAPE_NONE
#li SPRITE_SHAPE_BOX - A rectangular shape
#li SPRITE_SHAPE_POLYGON - A polygon (any shape with 3 or more sides)
#li SPRITE_SHAPE_CIRCLE - A circle
#li SPRITE_SHAPE_CHAIN - A open polygon shape
#list ul
#li NOTE: Mainly used for terrain
#/list
#/list
#ref SetSpriteShape

View File

@@ -0,0 +1,6 @@
#title GetSpriteShapeOffset [RCBasic Doc]
#header Sub GetSpriteShapeOffset( spr_id, ByRef x, ByRef y )
Gets the relative location the sprite shape is from where it is rendered
#ref SetSpriteShapeOffset

View File

@@ -0,0 +1,6 @@
#title ReCalculateMeshBoundingBox [RCBasic Doc]
#header Sub ReCalculateMeshBoundingBox( mesh )
Sets the bounding box for a mesh based of its current data
#ref GetMeshBoundingBox SetMeshBoundingBox

View File

@@ -0,0 +1,18 @@
#title SetActorShape [RCBasic Doc]
#header sub SetActorShape( actor, shape_type, mass)
Sets the shape of an actor
Possible Actor Shapes
#list ul
#li ACTOR_SHAPE_NONE
#li ACTOR_SHAPE_BOX
#li ACTOR_SHAPE_SPHERE
#li ACTOR_SHAPE_CYLINDER
#li ACTOR_SHAPE_CAPSULE
#li ACTOR_SHAPE_CONE
#li ACTOR_SHAPE_CONVEXHULL
#li ACTOR_SHAPE_TRIMESH
#/list
#ref GetActorShape

View File

@@ -0,0 +1,8 @@
#title SetMeshBoundingBox [RCBasic Doc]
#header Sub SetMeshBoundingBox( mesh, min_x, min_y, min_z, max_x, max_y, max_z )
Sets the min and max corners of a meshes bounding box.
NOTE: Physics shapes are determined from the bounding box data so you should adjust this before setting the shape.
#ref GetMeshBoundingBox ReCalculateMeshBoundingBox

View File

@@ -0,0 +1,19 @@
#title SetSpriteShape [RCBasic Doc]
#header Sub SetSpriteShape(spr_id, shape)
Sets the shape of a sprite.
Possible Shapes
#list ul
#li SPRITE_SHAPE_NONE
#li SPRITE_SHAPE_BOX - A rectangular shape
#li SPRITE_SHAPE_POLYGON - A polygon (any shape with 3 or more sides)
#li SPRITE_SHAPE_CIRCLE - A circle
#li SPRITE_SHAPE_CHAIN - A open polygon shape
#list ul
#li NOTE: Mainly used for terrain
#/list
#/list
#ref GetSpriteShape

View File

@@ -0,0 +1,7 @@
#title SetSpriteShapeOffset [RCBasic Doc]
#header Sub SetSpriteShapeOffset( spr_id, x, y )
Sets the relative location the sprite shape is from where it is rendered
#ref GetSpriteShapeOffset

View File

@@ -0,0 +1,8 @@
#title Steam_AddAchievement [RCBasic Doc]
#header sub Steam_AddAchievement( ach_id$, ach_name$ )
Add a steam achievement to the current program
NOTE: This only works for desktop applications
#ref Steam_ClearAchievements Steam_FinalizeAchievements Steam_GetID Steam_TriggerAchievement

View File

@@ -0,0 +1,6 @@
#title Steam_ClearAchievements [RCBasic Doc]
#header sub Steam_ClearAchievements()
Clear all steam achievements from the application
#ref Steam_AddAchievement Steam_FinalizeAchievements Steam_GetID Steam_TriggerAchievement

View File

@@ -0,0 +1,6 @@
#title Steam_FinalizeAchievements [RCBasic Doc]
#header sub Steam_FinalizeAchievements()
This function must be called once all steam achievements have been added
#ref Steam_AddAchievement Steam_ClearAchievements Steam_GetID Steam_TriggerAchievement

View File

@@ -0,0 +1,6 @@
#title Steam_GetID$ [RCBasic Doc]
#header function Steam_GetID$()
Returns the steam ID of the application which is needed to use the Steamworks API
#ref Steam_AddAchievement Steam_ClearAchievements Steam_FinalizeAchievements Steam_TriggerAchievement

View File

@@ -0,0 +1,9 @@
#title Steam_TriggerAchievement [RCBasic Doc]
#header function Steam_TriggerAchievement( ach_name$ )
Unlocks a steam achievement in the current application.
Returns True if the achievement was triggered and false if not.
#ref Steam_AddAchievement Steam_ClearAchievements Steam_FinalizeAchievements Steam_GetID

View File

@@ -0,0 +1,6 @@
#title TileMapExists [RCBasic Doc]
#header Function TileMapExists(tilemap)
Returns true if the given tilemap is an active tilemap in the program
#ref TileSetExists

View File

@@ -0,0 +1,6 @@
#title TileSetExists [RCBasic Doc]
#header Function TileSetExists(tileset)
Returns true if the given tileset is an active tileset in the program
#ref TileMapExists

6
doc/files/touchx.txt Normal file
View File

@@ -0,0 +1,6 @@
#title TouchX [RCBasic Doc]
#header function TouchX()
Return the X Position of a touch event
#ref TouchY GetTouch GetTouchFinger

7
doc/files/touchy.txt Normal file
View File

@@ -0,0 +1,7 @@
#title TouchY [RCBasic Doc]
#header function TouchY()
Return the Y Position of a touch event
#ref TouchX GetTouch GetTouchFinger