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

Updated docs

Browse Source
This commit is contained in:
n00b87
2026-03-03 19:29:04 -06:00
parent 9dbb4b6b5f
commit ea986a826b
135 changed files with 3466 additions and 318 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/doc_files/activefont.html Normal file
View File

@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>ActiveFont [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function ActiveFont() </h2></p>
<p>
Returns the current font that will be used with DrawText
</p>
<p id="rc_code"><code>
test_font&nbsp;=&nbsp;LoadFont<b>(</b><span class="rc_string">"test_font.ttf"</span>,&nbsp;<span class="rc_number">12</span><b>)</b>&nbsp;<br>
SetFont<b>(</b>test_font<b>)</b>&nbsp;<br>
<span class="rc_keyword">If</span>&nbsp;ActiveFont<b>(</b><b>)</b>&nbsp;=&nbsp;test_font&nbsp;<span class="rc_keyword">Then</span>&nbsp;<br>
<span class="rc_keyword">Print</span>&nbsp;<span class="rc_string">"Test Font is active"</span>&nbsp;<br>
<span class="rc_keyword">End</span>&nbsp;<span class="rc_keyword">If</span>&nbsp;<br>
</code></p>
<br><p>Related:
<a href="loadfont.html">LoadFont</a>
<a href="setfont.html">SetFont</a>
<a href="drawtext.html">DrawText</a>
</p>
<p>
</p>
</body>
</html>

27
doc/doc_files/addcompositechild.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>AddCompositeChild [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function AddCompositeChild(actor, child_actor, t_matrix) </h2></p>
<p>
Adds a child Actor to a composite actor.
</p>
<p>
Returns the child index in the composite actor.
</p>
<p>
NOTE: Reference the included Composite Demo for an example
</p>
<br><p>Related:
<a href="createcompositeactor.html">CreateCompositeActor</a>
</p>
<p>
</p>
</body>
</html>

27
doc/doc_files/addprojectoreffectactor.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>AddProjectorEffectActor [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function AddProjectorEffectActor(actor, tgt_actor) </h2></p>
<p>
Add an effect actor from a projector.
</p>
<p>
Returns the index of the effect actor in the projector.
</p>
<p>
Refer to the included Projector Demo for an example
</p>
<br><p>Related:
<a href="removeprojectoreffectactor.html">RemoveProjectorEffectActor</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/addspritechild.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>AddSpriteChild [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function AddSpriteChild(sprite, child_sprite, x, y) </h2></p>
<p>
Adds a sprite as a child to another sprite. Child sprite is offset by given position.
</p>
<br><p>Related:
<a href="removespritechild.html">RemoveSpriteChild</a>
</p>
<p>
</p>
</body>
</html>

27
doc/doc_files/addvehiclewheel.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>AddVehicleWheel [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function AddVehicleWheel( actor, wheel_actor, is_front_wheel ) </h2></p>
<p>
Add a wheel to a vehicle actor
</p>
<p>
is_front_wheel sets whether it should be considered a front wheel for physics and control
</p>
<p>
NOTE: Once an actor is set as a wheel, the vehicle controls all transforms for the actor
</p>
<br><p>Related:
<a href="createvehicleactor.html">CreateVehicleActor</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/applywheelengineforce.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>ApplyWheelEngineForce [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub ApplyWheelEngineForce( actor, wheel, force ) </h2></p>
<p>
Apply force to a wheel.
</p>
<p>
NOTE: For movement, you can apply force to a vehicle the same way you apply it to any actor. Refer to the actor physics section for documentation on that.
</p>
<p>
</p>
</body>
</html>

35
doc/doc_files/calculatecompositeprincipaltransform.html Normal file
View File

@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>CalculateCompositePrincipalTransform [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub CalculateCompositePrincipalTransform(actor, ByRef masses, principal_matrix, ByRef x, ByRef y, ByRef z) </h2></p>
<p>
Calculates the center of mass and principal intertia axes for a composite actor.
</p>
<p>
Parameters:
</p>
<ul>
<li>
masses - An array with masses for each child in the compound shape
</li>
<li>
principal_matrix - This will be set to principal axis transform
</li>
<li>
(x, y, z) - Inertia
</li>
</ul>
<br><p>Related:
<a href="createcompositeactor.html">CreateCompositeActor</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/clearposteffect.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>ClearPostEffect [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub ClearPostEffect( c_num ) </h2></p>
<p>
Removes the current post effect from the canvas.
</p>
<p>
</p>
</body>
</html>

24
doc/doc_files/createcompositeactor.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>CreateCompositeActor [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function CreateCompositeActor() </h2></p>
<p>
Creates a composite actor
</p>
<p>
Refer to the included Composite Demo for an example
</p>
<br><p>Related:
<a href="addcompositechild.html">AddCompositeChild</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/createvehicleactor.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>CreateVehicleActor [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function CreateVehicleActor( chassis_actor ) </h2></p>
<p>
Creates a vehicle actor. The chassis_actor is another actor that will be attached as the main body of the vehicle.
</p>
<br><p>Related:
<a href="addvehiclewheel.html">AddVehicleWheel</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/dotproduct.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>DotProduct [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function DotProduct(x1, y1, z1, x2, y2, z2) </h2></p>
<p>
Returns the dot product from 2 vectors
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/flipmeshsurfaces.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>FlipMeshSurfaces [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub FlipMeshSurfaces( mesh ) </h2></p>
<p>
Changes the facing direction of triangles in a mesh
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/generatecompositeaabbfromchildren.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GenerateCompositeAABBFromChildren [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GenerateCompositeAABBFromChildren(actor) </h2></p>
<p>
Generates a bounding box based on the child actors
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorboneabsolutetranform.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBoneAbsoluteTranform [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBoneAbsoluteTranform( actor, bone_index, t_matrix ) </h2></p>
<p>
Stores the absolute transform of a bone in t_matrix
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorbonecount.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBoneCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBoneCount( actor ) </h2></p>
<p>
Returns the number of bones in an actor
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorboneindex.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBoneIndex [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBoneIndex( actor, bone_name$ ) </h2></p>
<p>
Returns a bone index based on its name
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorbonename.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBoneName$ [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBoneName$( actor, bone_index ) </h2></p>
<p>
Returns an actor's bone name
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorboneposition.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBonePosition [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBonePosition( actor, bone_index, ByRef x, ByRef y, ByRef z ) </h2></p>
<p>
Gets an actor's bone position
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorbonerelativetranform.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBoneRelativeTranform [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBoneRelativeTranform( actor, bone_index, t_matrix ) </h2></p>
<p>
Stores the local transform of a bone in t_matrix
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorbonerotation.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBoneRotation [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBoneRotation( actor, bone_index, ByRef x, ByRef y, ByRef z ) </h2></p>
<p>
Gets an actor's bone rotation
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getactorbonescale.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorBoneScale [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorBoneScale( actor, bone_index, ByRef x, ByRef y, ByRef z ) </h2></p>
<p>
Returns the scale transform for an actor's bone
</p>
<p>
NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files)
</p>
<p>
</p>
</body>
</html>

62
doc/doc_files/getactortype.html Normal file
View File

@@ -0,0 +1,62 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetActorType [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetActorType( actor ) </h2></p>
<p>
Returns an actor's type
</p>
<p>
Actor Types
</p>
<ul>
<li>
ACTOR_TYPE_NONE
</li>
<li>
ACTOR_TYPE_MESH
</li>
<li>
ACTOR_TYPE_OTMESH
</li>
<li>
ACTOR_TYPE_LIGHT
</li>
<li>
ACTOR_TYPE_TERRAIN
</li>
<li>
ACTOR_TYPE_WATER
</li>
<li>
ACTOR_TYPE_BILLBOARD
</li>
<li>
ACTOR_TYPE_PARTICLE
</li>
<li>
ACTOR_TYPE_PRIMITIVE
</li>
<li>
ACTOR_TYPE_PROJECTOR
</li>
<li>
ACTOR_TYPE_COMPOSITE
</li>
<li>
ACTOR_TYPE_VEHICLE
</li>
</ul>
<p>
NOTE: Cube and Sphere actors both return ACTOR_TYPE_PRIMITIVE
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getbillboardsize.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetBillboardSize [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetBillboardSize(actor, ByRef w, ByRef h) </h2></p>
<p>
Gets the width and height of a billboard.
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getcompositeaabb.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetCompositeAABB [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetCompositeAABB(actor, t_matrix, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z) </h2></p>
<p>
Returns the bounding box of a composite actor
</p>
<p>
t_matrix will store the transform for the bounding box
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getcompositechild.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetCompositeChild [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetCompositeChild(actor, child_index) </h2></p>
<p>
Returns the actor stored as the child actor at a given index in a composite actor
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getcompositechildcount.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetCompositeChildCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetCompositeChildCount(actor) </h2></p>
<p>
Returns the number of child actors in a composite actor
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getcompositechildindex.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetCompositeChildIndex [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetCompositeChildIndex(actor, child_actor) </h2></p>
<p>
Returns the index an actor is stored at in a composite actor
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getcompositechildtransform.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetCompositeChildTransform [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetCompositeChildTransform(actor, child_index, t_matrix) </h2></p>
<p>
Stores the transform from composite actor to the child index shape in t_matrix
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getcompositeupdaterevision.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetCompositeUpdateRevision [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetCompositeUpdateRevision(actor) </h2></p>
<p>
Returns a counter that increments when the composite actor shape is modifed
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/gethorizontalangle.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetHorizontalAngle [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetHorizontalAngle(x, y, z, ByRef hx, ByRef hy, ByRef hz) </h2></p>
<p>
Get the rotation vector that would make a (0,0,1) direction vector point in the same direction as the given direction vector
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getlineangle.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetLineAngle [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetLineAngle(x1, y1, x2, y2) </h2></p>
<p>
Gets an angle between 2 points
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getmeshbuffer.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetMeshBuffer [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetMeshBuffer( mesh_id, buffer_index, ByRef vertex_data, ByRef normal_data, ByRef uv_data, ByRef index_data ) </h2></p>
<p>
Gets the data in a mesh buffer.
</p>
<p>
Returns TRUE if successful and FALSE if not.
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getmeshbuffercount.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetMeshBufferCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetMeshBufferCount( mesh_id ) </h2></p>
<p>
Returns the number of mesh buffers in a mesh.
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getmeshbufferindexcount.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetMeshBufferIndexCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetMeshBufferIndexCount( mesh_id, buffer_index ) </h2></p>
<p>
Returns the number of indices in a mesh buffer
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getmeshbuffervertexcount.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetMeshBufferVertexCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetMeshBufferVertexCount( mesh_id, buffer_index ) </h2></p>
<p>
Returns the number of vertices in a mesh buffer.
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getmeshpolygoncount.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetMeshPolygonCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetMeshPolygonCount( mesh ) </h2></p>
<p>
Returns the number of polygons in a mesh
</p>
<p>
</p>
</body>
</html>

24
doc/doc_files/getphysics3d.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetPhysics3D [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetPhysics3D( ) </h2></p>
<p>
Return if the physics engine is enabled
</p>
<p>
NOTE: While the physics engine is disabled, actor collisions won't be able to be checked.
</p>
<br><p>Related:
<a href="setphysics3d.html">SetPhysics3D</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getposteffectproperty.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetPostEffectProperty [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetPostEffectProperty( c_num, property) </h2></p>
<p>
Returns the value of the property on the current canvas post effect.
</p>
<p>
</p>
</body>
</html>

44
doc/doc_files/getposteffecttype.html Normal file
View File

@@ -0,0 +1,44 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetPostEffectType [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetPostEffectType( c_num ) </h2></p>
<p>
Returns the type of post effect set on the given canvas.
</p>
<p>
Possible Effect Types
</p>
<ul>
<li>
POST_EFFECT_TYPE_BLOOM
</li>
<li>
POST_EFFECT_TYPE_BLUR
</li>
<li>
POST_EFFECT_TYPE_MOTION_BLUR
</li>
<li>
POST_EFFECT_TYPE_RADIAL_BLUR
</li>
<li>
POST_EFFECT_TYPE_COLORIZE
</li>
<li>
POST_EFFECT_TYPE_INVERT
</li>
<li>
POST_EFFECT_TYPE_MINERAL
</li>
</ul>
<p>
</p>
</body>
</html>

24
doc/doc_files/getprojectoreffectactor.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetProjectorEffectActor [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetProjectorEffectActor(actor, tgt_index) </h2></p>
<p>
Returns the effect actor at tgt_index in a projector
</p>
<p>
Refer to the included Projector Demo for an example
</p>
<br><p>Related:
<a href="addprojectoreffectactor.html">AddProjectorEffectActor</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getprojectoreffectactorcount.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetProjectorEffectActorCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetProjectorEffectActorCount(actor) </h2></p>
<p>
Returns the number of effect actors on a projector
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getprojectortexture.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetProjectorTexture [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetProjectorTexture(actor) </h2></p>
<p>
Returns the image currently being projected by the projector
</p>
<br><p>Related:
<a href="setprojectortexture.html">SetProjectorTexture</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getrotationtotarget.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetRotationToTarget [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetRotationToTarget(x, y, z, tgt_x, tgt_y, tgt_z, ByRef rx, ByRef ry, ByRef rz) </h2></p>
<p>
Gets a rotation vector to a target from an origin point
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getspriteanimationsource.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetSpriteAnimationSource [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetSpriteAnimationSource(sprite, animation) </h2></p>
<p>
Returns the image associated with the given sprite animation.
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getspritechildindex.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetSpriteChildIndex [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetSpriteChildIndex(sprite, child_sprite) </h2></p>
<p>
Returns the index a child_sprite is stored at in a parent sprite
</p>
<p>
Returns -1 if child_sprite is not a child of sprite
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getspriteworldcenter.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetSpriteWorldCenter [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetSpriteWorldCenter( spr_id, ByRef x, ByRef y ) </h2></p>
<p>
Gets the center of a sprite's shape as world coordinates.
</p>
<p>
</p>
</body>
</html>

29
doc/doc_files/getvehicleaxis.html Normal file
View File

@@ -0,0 +1,29 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetVehicleAxis [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetVehicleAxis( actor, ByRef x, ByRef y, ByRef z ) </h2></p>
<p>
Gets the axis used to define a vehicles orientation.
</p>
<table>
<tr><th>Direction</th><th>Axis</th><th>Meaning</th></tr>
<tr><th>X</th><th>Right Axis</th><th>Wheel axle direction</th></tr>
<tr><th>Y</th><th>Up Axis</th><th>Suspension direction</th></tr>
<tr><th>Z</th><th>Forward Axis</th><th>Driving direction</th></tr>
</table>
<br><p>Related:
<a href="setwheelaxel.html">SetWheelAxel</a>
<a href="setsuspensionlength.html">SetSuspensionLength</a>
<a href="setwheeldirection.html">SetWheelDirection</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getvehiclechassisworldtransform.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetVehicleChassisWorldTransform [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetVehicleChassisWorldTransform( actor, t_matrix ) </h2></p>
<p>
Stores the world transform of the chassis actor in a vehicle
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getvehiclecurrentspeed.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetVehicleCurrentSpeed [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetVehicleCurrentSpeed( actor ) </h2></p>
<p>
Returns the current speed set on the vehicle
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getvehicleforwardvector.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetVehicleForwardVector [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetVehicleForwardVector( actor, ByRef x, ByRef y, ByRef z ) </h2></p>
<p>
Gets the forward vector of a vehicle
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getvehiclepitchcontrol.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetVehiclePitchControl [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetVehiclePitchControl( actor ) </h2></p>
<p>
Returns the pitch control for a vehicle
</p>
<br><p>Related:
<a href="setvehiclepitchcontrol.html">SetVehiclePitchControl</a>
</p>
<p>
</p>
</body>
</html>

27
doc/doc_files/getwheelactoroffsettransform.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelActorOffsetTransform [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetWheelActorOffsetTransform( actor, wheel, t_matrix ) </h2></p>
<p>
Stores the local offset transform for the wheel actor in t_matrix.
</p>
<p>
This is mainly for when the actors local transform does not line up with the axis for the vehicle.
</p>
<p>
Refer to the Vehicle demo to see an example of this.
</p>
<br><p>Related:
<a href="setwheelactoroffsettransform.html">SetWheelActorOffsetTransform</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelaxel.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelAxel [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetWheelAxel( actor, wheel, ByRef x, ByRef y, ByRef z ) </h2></p>
<p>
Get the axel direction of a wheel on a vehicle
</p>
<br><p>Related:
<a href="setwheelaxel.html">SetWheelAxel</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelbrake.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelBrake [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelBrake( actor, wheel ) </h2></p>
<p>
Returns the brake value of a wheel on a vehicle
</p>
<br><p>Related:
<a href="setwheelbrake.html">SetWheelBrake</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelconnectionpoint.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelConnectionPoint [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetWheelConnectionPoint( actor, wheel, ByRef x, ByRef y, ByRef z) </h2></p>
<p>
Gets the point in local space that a wheel is connected to a vehicle at
</p>
<br><p>Related:
<a href="setwheelconnectionpoint.html">SetWheelConnectionPoint</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelcount.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelCount [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelCount( actor ) </h2></p>
<p>
Returns the number of wheels on a vehicle
</p>
<br><p>Related:
<a href="addvehiclewheel.html">AddVehicleWheel</a>
</p>
<p>
</p>
</body>
</html>

22
doc/doc_files/getwheeldampingcompression.html Normal file
View File

@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelDampingCompression [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelDampingCompression( actor, wheel ) </h2></p>
<p>
Returns the damping compression of a wheel
</p>
<br><p>Related:
<a href="getwheeldampingrelaxation.html">GetWheelDampingRelaxation</a>
<a href="setwheeldampingcompression.html">SetWheelDampingCompression</a>
</p>
<p>
</p>
</body>
</html>

22
doc/doc_files/getwheeldampingrelaxation.html Normal file
View File

@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelDampingRelaxation [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelDampingRelaxation( actor, wheel ) </h2></p>
<p>
Returns the damping relaxation of a wheel
</p>
<br><p>Related:
<a href="getwheeldampingcompression.html">GetWheelDampingCompression</a>
<a href="setwheeldampingrelaxation.html">SetWheelDampingRelaxation</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/getwheeldirection.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelDirection [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetWheelDirection( actor, wheel, ByRef x, ByRef y, ByRef z ) </h2></p>
<p>
Gets the direction of a wheel on a vehicle
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelengineforce.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelEngineForce [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelEngineForce( actor, wheel ) </h2></p>
<p>
Returns the engine force currently applied to a wheel
</p>
<br><p>Related:
<a href="setwheelengineforce.html">SetWheelEngineForce</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelfrictionslip.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelFrictionSlip [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelFrictionSlip( actor, wheel ) </h2></p>
<p>
Returns the friction slip of a wheel
</p>
<br><p>Related:
<a href="setwheelfrictionslip.html">SetWheelFrictionSlip</a>
</p>
<p>
</p>
</body>
</html>

27
doc/doc_files/getwheelinversecontactsuspension.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelInverseContactSuspension [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelInverseContactSuspension( actor, wheel ) </h2></p>
<p>
Returns the clipped inverse contact dot suspension.
</p>
<p>
This value is a stability factor used to adjust suspension force when the ground contact surface is tilted.
</p>
<p>
It prevents suspension forces from exploding when the wheel contacts steep surfaces.
</p>
<br><p>Related:
<a href="setwheelinversecontactsuspension.html">SetWheelInverseContactSuspension</a>
</p>
<p>
</p>
</body>
</html>

24
doc/doc_files/getwheelmaxsuspensiontravel.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelMaxSuspensionTravel [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelMaxSuspensionTravel( actor, wheel ) </h2></p>
<p>
Returns the max suspension travel distance.
</p>
<p>
This value is the maximum distance the suspension is allowed to extend or compress from its rest length set with SetSuspensionLength().
</p>
<br><p>Related:
<a href="setwheelmaxsuspension.html">SetWheelMaxSuspension</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelradius.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelRadius [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelRadius( actor, wheel ) </h2></p>
<p>
You will never guess what this returns
</p>
<br><p>Related:
<a href="setwheelradius.html">SetWheelRadius</a>
</p>
<p>
</p>
</body>
</html>

27
doc/doc_files/getwheelrollinfluence.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelRollInfluence [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelRollInfluence( actor, wheel ) </h2></p>
<p>
Returns the roll_influence for a wheel.
</p>
<p>
Roll influence controls how much a wheel’s suspension force contributes to the vehicle’s body roll (sideways tipping).
</p>
<p>
It’s essentially a stability scaling factor.
</p>
<br><p>Related:
<a href="setwheelrollinfluence.html">SetWheelRollInfluence</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelrotation.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelRotation [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelRotation( actor, wheel ) </h2></p>
<p>
Returns a wheel's spin rotation.
</p>
<br><p>Related:
<a href="setwheelrotation.html">SetWheelRotation</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelrotationdelta.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelRotationDelta [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelRotationDelta( actor, wheel ) </h2></p>
<p>
Returns how much the wheels spin angle changed since the last frame.
</p>
<br><p>Related:
<a href="setwheelrotationdelta.html">SetWheelRotationDelta</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelsteeringvalue.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelSteeringValue [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelSteeringValue( actor, wheel ) </h2></p>
<p>
Returns the steering value for a wheel
</p>
<br><p>Related:
<a href="setwheelsteeringvalue.html">SetWheelSteeringValue</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/getwheelsuspensionlength.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelSuspensionLength [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelSuspensionLength( actor, wheel ) </h2></p>
<p>
Returns the suspsension rest length of a wheel
</p>
<br><p>Related:
<a href="setwheelsuspensionlength.html">SetWheelSuspensionLength</a>
</p>
<p>
</p>
</body>
</html>

29
doc/doc_files/getwheelsuspensionstiffness.html Normal file
View File

@@ -0,0 +1,29 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelSuspensionStiffness [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelSuspensionStiffness( actor, wheel ) </h2></p>
<p>
Returns the suspension stiffness of a wheel.
</p>
<ul>
<li>
Higher stiffness - stronger upward force for the same compression
</li>
<li>
Lower stiffness - softer suspension
</li>
</ul>
<br><p>Related:
<a href="setwheelsuspensionstiffness.html">SetWheelSuspensionStiffness</a>
</p>
<p>
</p>
</body>
</html>

24
doc/doc_files/getwheelsuspensionvelocity.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelSuspensionVelocity [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function GetWheelSuspensionVelocity( actor, wheel ) </h2></p>
<p>
Returns the suspension velocity.
</p>
<p>
This value is the speed that the suspension compresses or extends at.
</p>
<br><p>Related:
<a href="setwheelsuspensionvelocity.html">SetWheelSuspensionVelocity</a>
</p>
<p>
</p>
</body>
</html>

24
doc/doc_files/getwheelworldtransform.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetWheelWorldTransform [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub GetWheelWorldTransform( actor, wheel, t_matrix ) </h2></p>
<p>
Returns the world transform of a wheel on a vehicle.
</p>
<p>
NOTE: This will not be the world tranform of the actor if an offset transform has been set. In that case you will need to multiply the offset by the world transform.
</p>
<br><p>Related:
<a href="setwheelworldtransform.html">SetWheelWorldTransform</a>
</p>
<p>
</p>
</body>
</html>

170
doc/doc_files/graphics2.html Normal file
View File

@@ -0,0 +1,170 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>RCBasic Sprites [RCBasic Doc] </title>
</head>
<body>
<p><h2>SPRITES </h2></p>
<p>
The last section was a basic overview of graphics so in this section, I am going to go more indepth on sprites. In RCBasic, sprites are 2D objects with animation and physics properties. Sprite physics and animations are updated each time Update() is called.
</p>
<p>
To create a sprite, you must have a sprite canvas as your active canvas. Here is a quick explanation of how to open a new sprite canvas.
</p>
<p id="rc_code"><code>
pos_x&nbsp;=&nbsp;<span class="rc_number">0</span>&nbsp;<br>
pos_y&nbsp;=&nbsp;<span class="rc_number">0</span>&nbsp;<br>
viewport_width&nbsp;=&nbsp;<span class="rc_number">640</span>&nbsp;<br>
viewport_height&nbsp;=&nbsp;<span class="rc_number">480</span>&nbsp;<br>
&nbsp;&nbsp;<br>
sprite_canvas&nbsp;=&nbsp;OpenCanvasSpriteLayer<b>(</b>pos_x,&nbsp;pos_y,&nbsp;viewport_width,&nbsp;viewport_height<b>)</b>&nbsp;<br>
</code></p>
<p>
Sprite canvases are opened with <a href="opencanvasspritelayer.html">OpenCanvasSpriteLayer()</a>. You only need to pass the position in the window where the viewport starts at and the size of the viewport. Sprite canvases don't have a fixed size since it only renders the part of the canvas that is visible.
</p>
<p>
Once you have opened a sprite canvas, use the <a href="canvas.html">Canvas()</a> function to set the sprite canvas as active.
</p>
<p id="rc_code"><code>
Canvas<b>(</b>sprite_canvas<b>)</b>&nbsp;<br>
</code></p>
<p>
Now you are ready to create a sprite. To create a sprite, normally you would need a sprite sheet. The sprite sheet is a image file that contains all the animations for your sprite.
</p>
<p id="rc_code"><code>
spriteSheet&nbsp;=&nbsp;LoadImage<b>(</b><span class="rc_string">"graizor.png"</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
frame_width&nbsp;=&nbsp;<span class="rc_number">32</span>&nbsp;<br>
frame_height&nbsp;=&nbsp;<span class="rc_number">32</span>&nbsp;<br>
&nbsp;&nbsp;<br>
mySprite&nbsp;=&nbsp;CreateSprite<b>(</b>spriteSheet,&nbsp;frame_width,&nbsp;frame_height<b>)</b>&nbsp;<br>
</code></p>
<p>
Sprites are created with the <a href="createsprite.html">CreateSprite()</a> function. Sprites have a default animation that is 1 frame in length and set as the first frame in the sprite sheet. The frames in a sprite sheet start at 0 and increase going from left to right and continue incrementing down each row. So if each row as 4 frames then the first row would have frames 0 to 3 and the second row would start at 4 and continue until the end of the last row.
</p>
<p><img src="images/sprite_frames.png" ></p>
<p>
To animate our sprite, we have to create an animation for it. You can create an animation with the <a href="createspriteanimation.html">CreateSpriteAnimation()</a> function.
</p>
<p id="rc_code"><code>
walk_left_animation&nbsp;=&nbsp;CreateSpriteAnimation<b>(</b>mySprite,&nbsp;<span class="rc_number">4</span>,&nbsp;<span class="rc_number">12</span><b>)</b>&nbsp;<br>
SetSpriteAnimationFrame<b>(</b>mySprite,&nbsp;walk_left_animation,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">28</span><b>)</b>&nbsp;<br>
SetSpriteAnimationFrame<b>(</b>mySprite,&nbsp;walk_left_animation,&nbsp;<span class="rc_number">1</span>,&nbsp;<span class="rc_number">29</span><b>)</b>&nbsp;<br>
SetSpriteAnimationFrame<b>(</b>mySprite,&nbsp;walk_left_animation,&nbsp;<span class="rc_number">2</span>,&nbsp;<span class="rc_number">30</span><b>)</b>&nbsp;<br>
SetSpriteAnimationFrame<b>(</b>mySprite,&nbsp;walk_left_animation,&nbsp;<span class="rc_number">3</span>,&nbsp;<span class="rc_number">31</span><b>)</b>&nbsp;<br>
</code></p>
<p>
CreateSpriteAnimation() takes 3 parameters
</p>
<ul>
<li>
sprite - A sprite created with CreateSprite()
</li>
<li>
animation length - number of frames in the animation
</li>
<li>
animation speed - frames per second for the animation
</li>
</ul>
<p>
<a href="setspriteanimationframe.html">SetSpriteAnimationFrame()</a> takes 4 parameters
</p>
<ul>
<li>
sprite - the sprite the animation is on
</li>
<li>
animation - the animation created with CreateSpriteAnimation()
</li>
<li>
animation frame - the animation frame number NOTE: first frame is 0
</li>
<li>
sheet index - the index of the frame on the sprite sheet NOTE: This will match one of the numbers in the top corner of each frame in the picture above
</li>
</ul>
<p>
Now to play the animation, we just set the animation on the sprite.
</p>
<p id="rc_code"><code>
SetSpriteAnimation<b>(</b>mySprite,&nbsp;walk_left_animation,&nbsp;-<span class="rc_number">1</span><b>)</b>&nbsp;<br>
</code></p>
<p>
<a href="setspriteanimation.html">SetSpriteAnimation()</a> takes the sprite, the animation, and the last parameter is the number of times to loop the animation. Setting it to a value less than 0 will cause it to loop infinitely.
</p>
<p>
Thats the basics of sprite animation. Next lets go over sprite physics. By default, a sprite is non-solid which means it won't collide with anything. To change our sprite to solid, we just call the <a href="setspritesolid.html">SetSpriteSolid()</a> function.
</p>
<p id="rc_code"><code>
SetSpriteSolid<b>(</b>mySprite,&nbsp;<span class="rc_keyword">TRUE</span><b>)</b>&nbsp;<br>
</code></p>
<p>
To have the sprite fall, we need to set gravity for our sprite canvas. We do that with <a href="setgravity2d.html">SetGravity2D()</a>.
</p>
<p id="rc_code"><code>
SetGravity2D<b>(</b><span class="rc_number">0</span>,&nbsp;<span class="rc_number">30</span><b>)</b>&nbsp;<br>
</code></p>
<p>
SetGravity2D() takes an x and y value for the direction gravity pulls in. We just want gravity pulling down on our sprite. This would have our sprite falling forever since there is no ground for the sprite to collide with. So we need to create another sprite for the ground.
</p>
<p id="rc_code"><code>
ground&nbsp;=&nbsp;CreateSprite<b>(</b>-<span class="rc_number">1</span>,&nbsp;<span class="rc_number">640</span>,&nbsp;<span class="rc_number">100</span><b>)</b>&nbsp;<br>
SetSpriteSolid<b>(</b>ground,&nbsp;<span class="rc_keyword">TRUE</span><b>)</b>&nbsp;<br>
SetSpritePosition<b>(</b>ground,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">380</span><b>)</b>&nbsp;<br>
SetSpriteType<b>(</b>ground,&nbsp;SPRITE_TYPE_STATIC<b>)</b>&nbsp;<br>
</code></p>
<p>
There is a few things to go over with how the ground was created. First, we use -1 instead of an image for the ground. If you use a value less than 0 when creating a sprite, it will just create a physics object without any animation. This works well for a ground since we can draw an image on a paint canvas or draw a tile map.
</p>
<p>
On the next 2 lines we are setting the ground as solid and setting the grounds position to the bottom of our screen.
</p>
<p>
The last line is setting the ground sprite as static. This sets the ground as an unmovable object.
</p>
<p>
Since the ground does not have an image associated with it, we can just open a paint canvas over the sprite layer and draw a rectangle covering the area where our ground physics object is.
</p>
<p id="rc_code"><code>
paint_canvas&nbsp;=&nbsp;OpenCanvas<b>(</b><span class="rc_number">640</span>,&nbsp;<span class="rc_number">480</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">640</span>,&nbsp;<span class="rc_number">480</span>,&nbsp;<span class="rc_number">1</span><b>)</b>&nbsp;<br>
SetCanvasZ<b>(</b>paint_canvas,&nbsp;<span class="rc_number">1</span><b>)</b>&nbsp;<br>
</code></p>
<p>
We use OpenCanvas() from the last section to open a paint canvas here. Setting the last parameter in OpenCanvas() to 1 will make the canvas background clear so we can see the sprite canvas behind it.
</p>
<p>
<a href="setcanvasz.html">SetCanvasZ()</a> changes the render order for the canvas. Canvases with a higher Z order are drawn on top of canvases with lower Z order. Now we can switch to the paint canvas to draw a rectangle using the functions from the last section.
</p>
<p id="rc_code"><code>
SetColor<b>(</b>&nbsp;RGB<b>(</b><span class="rc_number">200</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span><b>)</b>&nbsp;<b>)</b>&nbsp;&nbsp;<span class="rc_comment">'Sets the drawing color to red </span><br>
RectFill<b>(</b><span class="rc_number">0</span>,&nbsp;<span class="rc_number">380</span>,&nbsp;<span class="rc_number">640</span>,&nbsp;<span class="rc_number">100</span><b>)</b>&nbsp;&nbsp;&nbsp;&nbsp;<span class="rc_comment">'Draws a filled rectangle with the current draw color </span><br>
</code></p>
<p>
We are drawing our rectangle at the location where we positioned our ground sprite above with the size that we made our ground sprite object. That will make our sprite ground visible for us to land on.
</p>
<p>
The last thing we will do is make our sprite move when we press a key.
</p>
<p id="rc_code"><code>
<span class="rc_keyword">If</span>&nbsp;Key<b>(</b>K_RIGHT<b>)</b>&nbsp;<span class="rc_keyword">Then</span>&nbsp;<br>
SetSpriteLinearVelocity<b>(</b>mySprite,&nbsp;<span class="rc_number">30</span>,&nbsp;<span class="rc_number">0</span><b>)</b>&nbsp;<br>
<span class="rc_keyword">End</span>&nbsp;<span class="rc_keyword">If</span>&nbsp;<br>
</code></p>
<p>
<a href="key.html">Key()</a> returns true if the key code parameter is pressed. You can see a list of all the key codes in the <a href="key_codes.html">Key Codes</a> section in the Appendix.
</p>
<p>
We use <a href="setspritelinearvelocity.html">SetSpriteLinearVelocity()</a> to move the sprite instead of SetSpritePosition() because we don't want to directly move a sprite that we want physics to be applied to. There are a few functions for applying forces to a sprite that you can find under the Sprite Physics section in the manual.
</p>
<p>
And that is it for our simple overview of sprites. To see a full working example of the concepts covered here, try out the Sprite Test example in the examples folder.
</p>
<p>
</p>
</body>
</html>

180
doc/doc_files/graphics3.html Normal file
View File

@@ -0,0 +1,180 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>RCBasic Sprites [RCBasic Doc] </title>
</head>
<body>
<p><h2>3D Graphics </h2></p>
<p>
This last section will cover how 3D graphics work in RCBasic. We can render the scene with a 3D canvas which is opened with <a href="opencanvas3d.html">OpenCanvas3D()</a>
</p>
<p id="rc_code"><code>
viewport_width&nbsp;=&nbsp;<span class="rc_number">640</span>&nbsp;<br>
viewport_height&nbsp;=&nbsp;<span class="rc_number">480</span>&nbsp;<br>
scene_canvas&nbsp;=&nbsp;OpenCanvas3D<b>(</b><span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;viewport_width,&nbsp;viewport_height,&nbsp;<span class="rc_number">1</span><b>)</b>&nbsp;<br>
</code></p>
<p>
OpenCanvas3D takes some of the same parameters as OpenCanvas. It will open a canvas to view the 3D scene. You can open multiple 3D canvases to view the 3D scene from different camera angles but there is only one 3D scene.
</p>
<p>
Next, lets go over actors. Actors are objects in our 3D scene and similiar to what sprites are on a sprite canvas. There are different types of actors that we can create and each one serves a different purpose. For now lets just create an animated actor.
</p>
<p id="rc_code"><code>
hero_mesh&nbsp;=&nbsp;LoadMesh<b>(</b><span class="rc_string">"char.ms3d"</span><b>)</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="rc_comment">' Load a 3D model from a file </span><br>
hero&nbsp;=&nbsp;CreateAnimatedActor<b>(</b>hero_mesh<b>)</b>&nbsp;&nbsp;&nbsp;<span class="rc_comment">' Create an animated object in our scene from the 3D model </span><br>
</code></p>
<p>
We use <a href="loadmesh.html">LoadMesh()</a> to load a 3D model into our program. If we want to make multiple actors in our scene from this 3D model, we only need to load the model once.
</p>
<p>
After we load the model, we use <a href="createanimatedactor.html">CreateAnimatedActor()</a> to create an object in our scene using the 3D model. Animated actors function like 3D version of sprites since they have animation and physics. Adding animation to our animated actor is a similiar process to adding animation to our sprite from the last section.
</p>
<p id="rc_code"><code>
RUN_ANIMATION&nbsp;=&nbsp;CreateActorAnimation<b>(</b>hero,&nbsp;<span class="rc_number">13</span>,&nbsp;<span class="rc_number">36</span>,&nbsp;<span class="rc_number">30</span><b>)</b>&nbsp;<br>
</code></p>
<p>
<a href="createactoranimation.html">CreateActorAnimation()</a> takes 4 parameters.
</p>
<ul>
<li>
actor - the actor we created with CreateAnimatedActor()
<ul>
<li>
NOTE: We can only create animations for animated actors
</li>
</ul>
</li>
<li>
start frame - The first frame of the animation
</li>
<li>
end frame - The last frame of the animation
</li>
<li>
speed - The frames per second of the animtion
</li>
</ul>
<p>
Now that we have an animation, we can set the actor's animation in the same way we set the sprite's animation in the last section.
</p>
<p id="rc_code"><code>
SetActorAnimation<b>(</b>hero,&nbsp;RUN_ANIMATION,&nbsp;-<span class="rc_number">1</span><b>)</b>&nbsp;<br>
</code></p>
<p>
<a href="setactoranimation.html">SetActorAnimation()</a> works the same way that SetSpriteAnimation() does. It takes the actor, the animation, and number of animation loops. We can set it to a value less than 0 to loop infinitely just like we did with our sprite in the last section.
</p>
<p>
Currently, the actor will not have any color. We need to add a texture to the actor. We will also disable lighting for the actor for now so that it just renders with the texture applied.
</p>
<p id="rc_code"><code>
hero_material&nbsp;=&nbsp;GetActorMaterial<b>(</b>hero,&nbsp;<span class="rc_number">0</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
SetMaterialLighting<b>(</b>hero_material,&nbsp;<span class="rc_keyword">FALSE</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
hero_texture&nbsp;=&nbsp;LoadImage<b>(</b><span class="rc_string">"hero.png"</span><b>)</b>&nbsp;<br>
SetMaterialTexture<b>(</b>hero_material,&nbsp;<span class="rc_number">0</span>,&nbsp;hero_texture<b>)</b>&nbsp;<br>
</code></p>
<p>
First, we get a reference to our actors material with <a href="getactormaterial.html">GetActorMaterial()</a>. We use this reference to set properties for the actor's material. The material determines how the actor is rendered.
</p>
<p>
Next, we disable lighting for the material. This means that lighting will not determine how light or dark the texture will be rendered at.
</p>
<p>
Finally, we load an image and set it to the first texture slot on the material with <a href="setmaterialtexture.html">SetMaterialTexture()</a>.
</p>
<p>
This now puts our actor in our scene with our texture applied. But just like in the sprite section, our actor needs to have physics applied to it. So lets make the actor solid and set our scene gravity.
</p>
<p id="rc_code"><code>
SetActorSolid<b>(</b>cube,&nbsp;<span class="rc_keyword">TRUE</span><b>)</b>&nbsp;<br>
SetGravity3D<b>(</b><span class="rc_number">0</span>,&nbsp;-<span class="rc_number">10</span>,&nbsp;<span class="rc_number">0</span><b>)</b>&nbsp;<br>
</code></p>
<p>
<a href="setactorsolid.html">SetActorSolid()</a> functions just like SetSpriteSolid() does. <a href="setgravity3d.html">SetGravity3D()</a> is like SetGravity2D() but it adds a 3rd dimension to it.
</p>
<p>
Now we need a ground plane. Lets create a plane mesh and then create an octree actor from it to serve as our ground. Octree actors are actors with meshes that have optimizations for large scenes.
</p>
<p id="rc_code"><code>
plane_mesh&nbsp;=&nbsp;CreatePlaneMesh<b>(</b><span class="rc_number">1000</span>,&nbsp;<span class="rc_number">1000</span>,&nbsp;<span class="rc_number">100</span>,&nbsp;<span class="rc_number">100</span>,&nbsp;<span class="rc_number">100</span>,&nbsp;<span class="rc_number">100</span><b>)</b>&nbsp;<br>
plane&nbsp;=&nbsp;CreateOctreeActor<b>(</b>plane_mesh<b>)</b>&nbsp;<br>
</code></p>
<p>
<a href="createplanemesh.html">CreatePlaneMesh()</a> is used to create a plane mesh rather than use LoadMesh() to load it from an external file like we did earlier.
</p>
<p>
<a href="createoctreeactor.html">CreateOctreeActor()</a> will create an octree actor rather than an animated actor.
</p>
<p>
Next we will set a solid color material for our plane rather than load another texture.
</p>
<p id="rc_code"><code>
plane_material&nbsp;=&nbsp;CreateMaterial<b>(</b><b>)</b>&nbsp;<br>
SetMaterialType<b>(</b>plane_material,&nbsp;FX_MATERIAL_TYPE_PLASTIC<b>)</b>&nbsp;<br>
SetActorMaterial<b>(</b>plane,&nbsp;<span class="rc_number">0</span>,&nbsp;plane_material<b>)</b>&nbsp;<br>
</code></p>
<p>
We are using an FX material here which is a special type of material with separate properties from a normal material. This time we had to use <a href="creatematerial.html">CreateMaterial()</a> to make a new material. To make FX materials, you must create a new material since you can not set any of the FX material types on a material attached to an actor.
</p>
<p>
Then we just set our material type with <a href="setmaterialtype.html">SetMaterialType()</a> and set the material on the actor with <a href="setactormaterial.html">SetActorMaterial()</a>.
</p>
<p>
Now lets set our physics properties for our plane.
</p>
<p id="rc_code"><code>
SetActorSolid<b>(</b>plane,&nbsp;<span class="rc_keyword">TRUE</span><b>)</b>&nbsp;<br>
SetActorShape<b>(</b>plane,&nbsp;ACTOR_SHAPE_TRIMESH,&nbsp;<span class="rc_number">0</span><b>)</b>&nbsp;<br>
</code></p>
<p>
Yet again, we are using SetActorSolid() to set our actor solid. We use <a href="setactorshape.html">SetActorShape()</a> to change the shape of the plane to ACTOR_SHAPE_TRIMESH. By default, actors shapes are ACTOR_SHAPE_BOX. Boxes are fine for our actor's hit box but we want a shape with more geometry for our ground usually.
</p>
<p>
Just like what we did with our sprites in the last lesson, lets have the actor move when a key is pressed.
</p>
<p id="rc_code"><code>
<span class="rc_keyword">If</span>&nbsp;Key<b>(</b>K_RIGHT<b>)</b>&nbsp;<span class="rc_keyword">Then</span>&nbsp;<br>
SetActorLinearVelocityLocal<b>(</b>hero,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">20</span><b>)</b>&nbsp;<br>
<span class="rc_keyword">End</span>&nbsp;<span class="rc_keyword">If</span>&nbsp;<br>
</code></p>
<p>
This looks very similiar to our code for moving the sprite in the last lesson. <a href="setactorlinearvelocitylocal.html">SetActorLinearVelocityLocal()</a> has a little bit longer name. It has a companion function called <a href="setactorlinearvelocityworld.html">SetActorLinearVelocityWorld()</a> which applies a transform based on world instead of local space.
</p>
<p>
Before moving on, I want to quickly explain the difference between local transforms and world transforms.
</p>
<ul>
<li>
Local Transforms - These transforms apply to the direction you are facing. Basically if you increase your Z position, you will move forward in the direction you are facing.
</li>
<li>
World Transforms - These transforms apply to the absolute direction in the world. Basically, if you increase your Z position, you will move in the direction of the Z axis regardless of the direction you are facing.
</li>
</ul>
<p>
Before ending this lesson, lets do a quick overview of how to set the camera. Each 3D canvas has its own camera. To set the camera for a 3D canvas you must make sure you set the 3D canvas active with Canvas().
</p>
<p id="rc_code"><code>
Canvas<b>(</b>scene_canvas<b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
SetCameraPosition<b>(</b><span class="rc_number">0</span>,&nbsp;<span class="rc_number">30</span>,&nbsp;-<span class="rc_number">100</span><b>)</b>&nbsp;&nbsp;<span class="rc_comment">'Set the camera position </span><br>
SetCameraRotation<b>(</b><span class="rc_number">20</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span><b>)</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="rc_comment">'Set the camera rotation </span><br>
</code></p>
<p>
<a href="setcameraposition.html">SetCameraPosition()</a> and <a href="setcamerarotation.html">SetCameraRotation()</a> do exactly what you think they do. There are also other functions to set camera FOV(field of view), aspect ratio, etc. Look in the camera section for more info.
</p>
<p>
Refer to the Intro to 3D demo for the complete code for this lesson.
</p>
<p>
RCBasic has several functions for graphics, physics, etc., so if you can't find it in the manual then feel free to ask a question on the <a href="http://rcbasic.freeforums.net">forum</a>.
</p>
<p>
</p>
</body>
</html>

BIN
doc/doc_files/images/banner.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
doc/doc_files/images/sprite_frames.aseprite Normal file
View File

Binary file not shown.

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

18
doc/doc_files/interpolatevector.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>InterpolateVector [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub InterpolateVector(x1, y1, z1, x2, y2, z2, distance, ByRef ix, ByRef iy, ByRef iz) </h2></p>
<p>
Gets an interpolated vector a given distance along a line starting at (x1, y1, z1) and ending at (x2, y2, z2)
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/interpolatevectorq.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>InterpolateVectorQ [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub InterpolateVectorQ(x1, y1, z1, x2, y2, z2, x3, y3, z3, distance, ByRef ix, ByRef iy, ByRef iz) </h2></p>
<p>
Gets a quadratic interpolated vector based on a distance between 3 vectors
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/makeplanartexturemap.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>MakePlanarTextureMap [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub MakePlanarTextureMap( mesh, resolution ) </h2></p>
<p>
Makes a planar texture map for the mesh.
</p>
<p>
Resolution is a ratio of the world space to texture space NOTE: Value should be between 0 and 1, a recommended value to start with is 0.001
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/matrixexists.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>MatrixExists [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function MatrixExists( mA ) </h2></p>
<p>
Returns TRUE if a matrix exists and FALSE if not.
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/normalizevector.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>NormalizeVector [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub NormalizeVector(x, y, z, ByRef nx, ByRef ny, ByRef nz) </h2></p>
<p>
Returns a normalized vector from (x,y,z)
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/pipeline_begin.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Pipeline_Begin [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub Pipeline_Begin() </h2></p>
<p>
Begins a custom rendering process.
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/pipeline_end.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Pipeline_End [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub Pipeline_End() </h2></p>
<p>
Ends a custom rendering process.
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/pipeline_render.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Pipeline_Render [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub Pipeline_Render() </h2></p>
<p>
Render the active canvas.
</p>
<p>
NOTE: Must be used between Pipeline_Begin() and Pipeline_End().
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/posteffectisactive.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>PostEffectIsActive [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function PostEffectIsActive( c_num ) </h2></p>
<p>
Returns TRUE if an effect is active on the canvas and FALSE if not.
</p>
<br><p>Related:
<a href="setposteffectactive.html">SetPostEffectActive</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/recalculatecompositeaabb.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>RecalculateCompositeAABB [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub RecalculateCompositeAABB(actor) </h2></p>
<p>
Recalculates the bounding box for a composite actor
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/recalculatemeshnormals.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>ReCalculateMeshNormals [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub ReCalculateMeshNormals( mesh ) </h2></p>
<p>
Calculates the facing direction of the normals in a mesh
</p>
<p>
</p>
</body>
</html>

24
doc/doc_files/removecompositechild.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>RemoveCompositeChild [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub RemoveCompositeChild(actor, child_index) </h2></p>
<p>
Removes the actor stored as a child at the given index in a composite actor
</p>
<p>
NOTE: This will change the index of all the remaining child actors
</p>
<br><p>Related:
<a href="addcompositechild.html">AddCompositeChild</a>
</p>
<p>
</p>
</body>
</html>

27
doc/doc_files/removeprojectoreffectactor.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>RemoveProjectorEffectActor [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub RemoveProjectorEffectActor(actor, tgt_index) </h2></p>
<p>
Removes an effect actor from a projector.
</p>
<p>
NOTE: Removing an effect actor will change the order of other effect actors so you will need to get the new index for other effect actors.
</p>
<p>
Refer to the included Projector Demo for an example
</p>
<br><p>Related:
<a href="addprojectoreffectactor.html">AddProjectorEffectActor</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/removespritechild.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>RemoveSpriteChild [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub RemoveSpriteChild(sprite, child_index) </h2></p>
<p>
Removes the child at the given index from the parent sprite
</p>
<br><p>Related:
<a href="addspritechild.html">AddSpriteChild</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/resetvehiclesuspension.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>ResetVehicleSuspension [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub ResetVehicleSuspension( actor ) </h2></p>
<p>
Sets the suspension of a vehicle back to its base length.
</p>
<p>
</p>
</body>
</html>

46
doc/doc_files/savebmp.html Normal file
View File

@@ -0,0 +1,46 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SaveBMP [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function SaveBMP(img, file$) </h2></p>
<p>
Save an image to a *.bmp file
</p>
<p id="rc_code"><code>
title$&nbsp;=&nbsp;<span class="rc_string">"Sprite Test"</span>&nbsp;<br>
w&nbsp;=&nbsp;<span class="rc_number">640</span>&nbsp;<br>
h&nbsp;=&nbsp;<span class="rc_number">480</span>&nbsp;<br>
fullscreen&nbsp;=&nbsp;<span class="rc_keyword">FALSE</span>&nbsp;<br>
vsync&nbsp;=&nbsp;<span class="rc_keyword">FALSE</span>&nbsp;<br>
&nbsp;&nbsp;<br>
OpenWindow<b>(</b>&nbsp;title$,&nbsp;w,&nbsp;h,&nbsp;fullscreen,&nbsp;vsync&nbsp;<b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
my_canvas&nbsp;=&nbsp;OpenCanvas<b>(</b>w,&nbsp;h,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;w,&nbsp;h,&nbsp;<span class="rc_number">1</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
Canvas<b>(</b>my_canvas<b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
SetColor<b>(</b>RGB<b>(</b><span class="rc_number">255</span>,0,&nbsp;<span class="rc_number">0</span><b>)</b><b>)</b>&nbsp;<br>
CircleFill<b>(</b><span class="rc_number">50</span>,&nbsp;<span class="rc_number">50</span>,&nbsp;<span class="rc_number">25</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
SetColor<b>(</b>RGB<b>(</b><span class="rc_number">0</span>,&nbsp;<span class="rc_number">255</span>,&nbsp;<span class="rc_number">0</span><b>)</b><b>)</b>&nbsp;<br>
CircleFill<b>(</b><span class="rc_number">590</span>,&nbsp;<span class="rc_number">50</span>,&nbsp;<span class="rc_number">25</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
SetColor<b>(</b>RGB<b>(</b><span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">255</span><b>)</b><b>)</b>&nbsp;<br>
CircleFill<b>(</b><span class="rc_number">590</span>,&nbsp;<span class="rc_number">430</span>,&nbsp;<span class="rc_number">25</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
img&nbsp;=&nbsp;CanvasClip<b>(</b><span class="rc_number">0</span>,&nbsp;<span class="rc_number">0</span>,&nbsp;<span class="rc_number">640</span>,&nbsp;<span class="rc_number">480</span><b>)</b>&nbsp;<br>
SaveBMP<b>(</b>img,&nbsp;<span class="rc_string">"test.bmp"</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
Update<b>(</b><b>)</b>&nbsp;<br>
WaitKey<b>(</b><b>)</b>&nbsp;<br>
</code></p>
<p>
</p>
</body>
</html>

21
doc/doc_files/setactorimpactmesh.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SetActorImpactMesh [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub SetActorImpactMesh( actor, mesh, mass ) </h2></p>
<p>
Sets the collision mesh for an actor with a shape type of ACTOR_SHAPE_IMPACT_MESH
</p>
<br><p>Related:
<a href="setactorshape.html">SetActorShape</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/setactorshapeex.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SetActorShapeEx [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub SetActorShapeEx( actor, shape_type, mass, radius) </h2></p>
<p>
Sets actor shape and radius for capsule, cone, and sphere shapes
</p>
<br><p>Related:
<a href="setactorshape.html">SetActorShape</a>
</p>
<p>
</p>
</body>
</html>

18
doc/doc_files/setbillboardsize.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SetBillboardSize [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub SetBillboardSize(actor, w, h) </h2></p>
<p>
Sets the size of a billboard.
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/setmeshbuffer.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SetMeshBuffer [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function SetMeshBuffer( mesh_id, buffer_num, vertex_count, ByRef vertex_data, ByRef normal_data, ByRef uv_data, index_count, ByRef index_data ) </h2></p>
<p>
Sets the contents of a mesh buffer. Buffer_num must already exists in mesh.
</p>
<p>
Returns TRUE if successful and FALSE if not
</p>
<p>
</p>
</body>
</html>

24
doc/doc_files/setphysics3d.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SetPhysics3D [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub SetPhysics3D( flag ) </h2></p>
<p>
Enables or disables the physics engine.
</p>
<p>
NOTE: While the physics engine is disabled, actor collisions won't be able to be checked.
</p>
<br><p>Related:
<a href="getphysics3d.html">GetPhysics3D</a>
</p>
<p>
</p>
</body>
</html>

103
doc/doc_files/setposteffect.html Normal file
View File

@@ -0,0 +1,103 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SetPostEffect [RCBasic Doc] </title>
</head>
<body>
<p><h2>Function SetPostEffect( c_num, effect_type ) </h2></p>
<p>
Sets a post effect on an canvas.
</p>
<p>
Returns TRUE if successful and FALSE if not.
</p>
<p>
NOTE: Post Effects only apply to 3D canvases.
</p>
<p>
Possible Effects and there properties:
</p>
<ul>
<li>
POST_EFFECT_TYPE_BLOOM
<ul>
<li>
POST_EFFECT_PROPERTY_STRENGTH
</li>
<li>
POST_EFFECT_PROPERTY_DISTANCE
</li>
<li>
POST_EFFECT_PROPERTY_MULTIPLIER
</li>
</ul>
</li>
<li>
POST_EFFECT_TYPE_BLUR
<ul>
<li>
POST_EFFECT_PROPERTY_DISTANCE
</li>
</ul>
</li>
<li>
POST_EFFECT_TYPE_MOTION_BLUR
<ul>
<li>
POST_EFFECT_PROPERTY_STRENGTH
</li>
</ul>
</li>
<li>
POST_EFFECT_TYPE_RADIAL_BLUR
<ul>
<li>
POST_EFFECT_PROPERTY_STRENGTH
</li>
<li>
POST_EFFECT_PROPERTY_DISTANCE
</li>
</ul>
</li>
<li>
POST_EFFECT_TYPE_COLORIZE
<ul>
<li>
POST_EFFECT_PROPERTY_STRENGTH
</li>
<li>
POST_EFFECT_PROPERTY_SATURATION
</li>
<li>
POST_EFFECT_PROPERTY_COLOR
</li>
</ul>
</li>
<li>
POST_EFFECT_TYPE_INVERT
<ul>
<li>
NONE
</li>
</ul>
</li>
<li>
POST_EFFECT_TYPE_MINERAL
<ul>
<li>
POST_EFFECT_PROPERTY_STRENGTH
</li>
</ul>
</li>
</ul>
<br><p>Related:
<a href="clearposteffect.html">ClearPostEffect</a>
</p>
<p>
</p>
</body>
</html>

21
doc/doc_files/setposteffectactive.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>SetPostEffectActive [RCBasic Doc] </title>
</head>
<body>
<p><h2>Sub SetPostEffectActive( c_num, flag ) </h2></p>
<p>
Enables or Disables currently set effect
</p>
<br><p>Related:
<a href="posteffectisactive.html">PostEffectIsActive</a>
</p>
<p>
</p>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More