diff --git a/doc/doc_files/abs.html b/doc/doc_files/abs.html index d594b25..d9708c6 100644 --- a/doc/doc_files/abs.html +++ b/doc/doc_files/abs.html @@ -12,6 +12,7 @@ Returns the absolute value of n

+

- + \ No newline at end of file diff --git a/doc/doc_files/accelname.html b/doc/doc_files/accelname.html index c3fadcd..5dedae9 100644 --- a/doc/doc_files/accelname.html +++ b/doc/doc_files/accelname.html @@ -7,11 +7,12 @@ -

function AccelName$(accel_num)

+

Function AccelName$(accel_num)

Returns the name of an accelerometer

+

\ No newline at end of file diff --git a/doc/doc_files/acos.html b/doc/doc_files/acos.html index 35de12c..7578e26 100644 --- a/doc/doc_files/acos.html +++ b/doc/doc_files/acos.html @@ -7,11 +7,12 @@ -

function Acos(n)

+

Function Acos(n)

Returns the Arcosine of n

+

\ No newline at end of file diff --git a/doc/doc_files/activecanvas.html b/doc/doc_files/activecanvas.html index efa7f07..d0d90b3 100644 --- a/doc/doc_files/activecanvas.html +++ b/doc/doc_files/activecanvas.html @@ -7,7 +7,7 @@ -

function ActiveCanvas()

+

Function ActiveCanvas()

Returns the canvas that drawing commands are currently applied to

@@ -28,6 +28,7 @@ End If 

+

\ No newline at end of file diff --git a/doc/doc_files/actoranimationisplaying.html b/doc/doc_files/actoranimationisplaying.html index 7c5fb03..1ae58b0 100644 --- a/doc/doc_files/actoranimationisplaying.html +++ b/doc/doc_files/actoranimationisplaying.html @@ -7,7 +7,7 @@ -

function ActorAnimationIsPlaying(actor)

+

Function ActorAnimationIsPlaying(actor)

Returns true if an actor is currently playing an animation

@@ -15,6 +15,7 @@ Note: If the number of loops in the animation is set to -1 then this will always be true since it does not return false until it plays the last frame in the last loop

+

\ No newline at end of file diff --git a/doc/doc_files/actorexists.html b/doc/doc_files/actorexists.html index 63778ab..a83b150 100644 --- a/doc/doc_files/actorexists.html +++ b/doc/doc_files/actorexists.html @@ -7,11 +7,12 @@ -

function ActorExists( actor )

+

Function ActorExists( actor )

Returns true if the id passed is a valid actor

+

\ No newline at end of file diff --git a/doc/doc_files/actorissolid.html b/doc/doc_files/actorissolid.html index 71c2baa..fe6f0d0 100644 --- a/doc/doc_files/actorissolid.html +++ b/doc/doc_files/actorissolid.html @@ -7,7 +7,7 @@ -

function ActorIsSolid(actor)

+

Function ActorIsSolid(actor)

Returns true or false depending on if physics and collision response applies to an actor.

@@ -23,6 +23,7 @@   
#ref SetActorSolid 
  
+   
\ No newline at end of file diff --git a/doc/doc_files/actorisvisible.html b/doc/doc_files/actorisvisible.html index e8c734f..86b8272 100644 --- a/doc/doc_files/actorisvisible.html +++ b/doc/doc_files/actorisvisible.html @@ -7,7 +7,7 @@ -

function ActorIsVisible( actor )

+

Function ActorIsVisible( actor )

Returns true if an actor is visible

@@ -21,6 +21,7 @@ SetActorVisible

+

\ No newline at end of file diff --git a/doc/doc_files/addactorshadow.html b/doc/doc_files/addactorshadow.html index d6b37af..81c17f2 100644 --- a/doc/doc_files/addactorshadow.html +++ b/doc/doc_files/addactorshadow.html @@ -7,7 +7,7 @@ -

sub AddActorShadow( actor )

+

Sub AddActorShadow( actor )

Cast a shadow on an actor during lighting calculations

@@ -18,6 +18,7 @@ RemoveActorShadow

+

\ No newline at end of file diff --git a/doc/doc_files/addmatrix.html b/doc/doc_files/addmatrix.html index 5360855..596b0e8 100644 --- a/doc/doc_files/addmatrix.html +++ b/doc/doc_files/addmatrix.html @@ -7,11 +7,12 @@ -

function AddMatrix(mA, mB, mC)

+

Function AddMatrix(mA, mB, mC)

Adds matrix mA to matrix mB and stores the results in mC

+

\ No newline at end of file diff --git a/doc/doc_files/addmeshbuffer.html b/doc/doc_files/addmeshbuffer.html index af6b31e..622a311 100644 --- a/doc/doc_files/addmeshbuffer.html +++ b/doc/doc_files/addmeshbuffer.html @@ -7,7 +7,7 @@ -

sub AddMeshBuffer( mesh, vertex_count, ByRef vertex_data, ByRef normal_data, ByRef uv_data, index_count, ByRef index_data )

+

Sub AddMeshBuffer( mesh, vertex_count, ByRef vertex_data, ByRef normal_data, ByRef uv_data, index_count, ByRef index_data )

Sets the vertices, normals, and texture coordinates for a mesh

@@ -15,6 +15,7 @@ CreateMesh

+

\ No newline at end of file diff --git a/doc/doc_files/addsceneskybox.html b/doc/doc_files/addsceneskybox.html index fc179b2..763f6cb 100644 --- a/doc/doc_files/addsceneskybox.html +++ b/doc/doc_files/addsceneskybox.html @@ -7,7 +7,7 @@ -

sub AddSceneSkyBox( img_top, img_bottom, img_left, img_right, img_front, img_back)

+

Sub AddSceneSkyBox( img_top, img_bottom, img_left, img_right, img_front, img_back)

Generates a skybox based on the provided images.

@@ -16,6 +16,7 @@ AddSceneSkyDomeEx

+

\ No newline at end of file diff --git a/doc/doc_files/addsceneskydome.html b/doc/doc_files/addsceneskydome.html index 5b56126..941db67 100644 --- a/doc/doc_files/addsceneskydome.html +++ b/doc/doc_files/addsceneskydome.html @@ -7,7 +7,7 @@ -

sub AddSceneSkyDome( img )

+

Sub AddSceneSkyDome( img )

Adds a sky dome to the scene

@@ -15,6 +15,7 @@ AddSceneSkyDomeEx

+

\ No newline at end of file diff --git a/doc/doc_files/addsceneskydomeex.html b/doc/doc_files/addsceneskydomeex.html index fa4fa68..4191392 100644 --- a/doc/doc_files/addsceneskydomeex.html +++ b/doc/doc_files/addsceneskydomeex.html @@ -7,7 +7,7 @@ -

sub AddSceneSkyDomeEx( img, horiRes, vertRes, txPercentage, spherePercentage, radius)

+

Sub AddSceneSkyDomeEx( img, horiRes, vertRes, txPercentage, spherePercentage, radius)

Adds a sky dome to the scene

@@ -36,6 +36,7 @@ AddSceneSkyDome

+

\ No newline at end of file diff --git a/doc/doc_files/adjointmatrix.html b/doc/doc_files/adjointmatrix.html index 708eda7..d6366e0 100644 --- a/doc/doc_files/adjointmatrix.html +++ b/doc/doc_files/adjointmatrix.html @@ -7,11 +7,12 @@ -

function AdjointMatrix(mA, mB)

+

Function AdjointMatrix(mA, mB)

Stores the adjoint matrix of mA in mB

+

\ No newline at end of file diff --git a/doc/doc_files/andbit.html b/doc/doc_files/andbit.html index 34287ba..7b49b8f 100644 --- a/doc/doc_files/andbit.html +++ b/doc/doc_files/andbit.html @@ -7,11 +7,12 @@ -

function AndBit(a,b)

+

Function AndBit(a,b)

Returns the bitwise AND operation of 2 numbers

+

\ No newline at end of file diff --git a/doc/doc_files/android_getexternalstoragepath.html b/doc/doc_files/android_getexternalstoragepath.html index cac6134..640e23b 100644 --- a/doc/doc_files/android_getexternalstoragepath.html +++ b/doc/doc_files/android_getexternalstoragepath.html @@ -7,7 +7,7 @@ -

function Android_GetExternalStoragePath$()

+

Function Android_GetExternalStoragePath$()

Returns the designated external storage path

@@ -16,6 +16,7 @@ Android_GetInternalStoragePath$

+

\ No newline at end of file diff --git a/doc/doc_files/android_getexternalstoragestate.html b/doc/doc_files/android_getexternalstoragestate.html index 7f60b6a..5be859d 100644 --- a/doc/doc_files/android_getexternalstoragestate.html +++ b/doc/doc_files/android_getexternalstoragestate.html @@ -7,7 +7,7 @@ -

function Android_GetExternalStorageState()

+

Function Android_GetExternalStorageState()

Returns a bitmask of these values:

@@ -29,6 +29,7 @@ Android_GetInternalStoragePath$

+

\ No newline at end of file diff --git a/doc/doc_files/android_getinternalstoragepath.html b/doc/doc_files/android_getinternalstoragepath.html index 1c6c85e..ac3fc42 100644 --- a/doc/doc_files/android_getinternalstoragepath.html +++ b/doc/doc_files/android_getinternalstoragepath.html @@ -7,7 +7,7 @@ -

function Android_GetInternalStoragePath$()

+

Function Android_GetInternalStoragePath$()

Returns the internal storage path

@@ -16,6 +16,7 @@ Android_GetExternalStoragePath$

+

\ No newline at end of file diff --git a/doc/doc_files/android_jni_message.html b/doc/doc_files/android_jni_message.html index ae39c49..02f7fc7 100644 --- a/doc/doc_files/android_jni_message.html +++ b/doc/doc_files/android_jni_message.html @@ -7,7 +7,7 @@ -

function Android_JNI_Message$(arg$)

+

Function Android_JNI_Message$(arg$)

Passes arg$ to the rcbasic_android_interface() method in the java code for your android app. The java method returns a string.

@@ -15,6 +15,7 @@ Runtime_Utility_Message$

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorcentralforcelocal.html b/doc/doc_files/applyactorcentralforcelocal.html index 7822d13..764326f 100644 --- a/doc/doc_files/applyactorcentralforcelocal.html +++ b/doc/doc_files/applyactorcentralforcelocal.html @@ -7,7 +7,7 @@ -

sub ApplyActorCentralForceLocal( actor, x, y, z)

+

Sub ApplyActorCentralForceLocal( actor, x, y, z)

Applies a force to the center of mass of an actor in local coordinate space. This force impacts the linear velocity of the object without affecting its rotation.

@@ -22,6 +22,7 @@ ApplyActorCentralImpulseWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorcentralforceworld.html b/doc/doc_files/applyactorcentralforceworld.html index 9691595..91fa14e 100644 --- a/doc/doc_files/applyactorcentralforceworld.html +++ b/doc/doc_files/applyactorcentralforceworld.html @@ -7,7 +7,7 @@ -

sub ApplyActorCentralForceWorld( actor, x, y, z)

+

Sub ApplyActorCentralForceWorld( actor, x, y, z)

Applies a force to the center of mass of an actor in world coordinate space. This force impacts the linear velocity of the object without affecting its rotation.

@@ -22,6 +22,7 @@ ApplyActorCentralImpulseWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorcentralimpulselocal.html b/doc/doc_files/applyactorcentralimpulselocal.html index 8a6eb1e..97af6a4 100644 --- a/doc/doc_files/applyactorcentralimpulselocal.html +++ b/doc/doc_files/applyactorcentralimpulselocal.html @@ -7,7 +7,7 @@ -

sub ApplyActorCentralImpulseLocal( actor, x, y, z)

+

Sub ApplyActorCentralImpulseLocal( actor, x, y, z)

Applies an impulse directly to the center of mass of an actor. An impulse differs from a continuous force in that it applies an immediate, short-duration change to the velocity of the actor. It affects the linear velocity but does not generate rotational effects (since it's applied to the center of mass).

@@ -22,6 +22,7 @@ ApplyActorCentralImpulseWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorcentralimpulseworld.html b/doc/doc_files/applyactorcentralimpulseworld.html index 2bda8cb..96a8ca6 100644 --- a/doc/doc_files/applyactorcentralimpulseworld.html +++ b/doc/doc_files/applyactorcentralimpulseworld.html @@ -7,7 +7,7 @@ -

sub ApplyActorCentralImpulseWorld( actor, x, y, z)

+

Sub ApplyActorCentralImpulseWorld( actor, x, y, z)

Applies an impulse directly to the center of mass of an actor. An impulse differs from a continuous force in that it applies an immediate, short-duration change to the velocity of the actor. It affects the linear velocity but does not generate rotational effects (since it's applied to the center of mass).

@@ -22,6 +22,7 @@ ApplyActorCentralImpulseLocal

+

\ No newline at end of file diff --git a/doc/doc_files/applyactordamping.html b/doc/doc_files/applyactordamping.html index eea318b..b9fb862 100644 --- a/doc/doc_files/applyactordamping.html +++ b/doc/doc_files/applyactordamping.html @@ -7,7 +7,7 @@ -

sub ApplyActorDamping( actor, timeStep)

+

Sub ApplyActorDamping( actor, timeStep)

Reduces the velocity of an actor over time, simulating the effect of friction or air resistance.

@@ -33,6 +33,7 @@ getActorAngularDamping

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorforcelocal.html b/doc/doc_files/applyactorforcelocal.html index c6b4f27..fa6a99b 100644 --- a/doc/doc_files/applyactorforcelocal.html +++ b/doc/doc_files/applyactorforcelocal.html @@ -7,7 +7,7 @@ -

sub ApplyActorForceLocal( actor, x, y, z, rel_x, rel_y, rel_z)

+

Sub ApplyActorForceLocal( actor, x, y, z, rel_x, rel_y, rel_z)

Applies a force to an actor at a specific point. Unlike ApplyActorCentralForce(local/world), which applies force only at the center of mass (affecting linear velocity), this can generate both linear motion and rotation (torque), depending on where the force is applied relative to the center of mass.

@@ -25,6 +25,7 @@ ApplyActorCentralForceWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorforceworld.html b/doc/doc_files/applyactorforceworld.html index 13e7bb0..312e247 100644 --- a/doc/doc_files/applyactorforceworld.html +++ b/doc/doc_files/applyactorforceworld.html @@ -7,7 +7,7 @@ -

sub ApplyActorForceWorld( actor, x, y, z, rel_x, rel_y, rel_z)

+

Sub ApplyActorForceWorld( actor, x, y, z, rel_x, rel_y, rel_z)

Applies a force to an actor at a specific point. Unlike ApplyActorCentralForce(local/world), which applies force only at the center of mass (affecting linear velocity), this can generate both linear motion and rotation (torque), depending on where the force is applied relative to the center of mass.

@@ -25,6 +25,7 @@ ApplyActorCentralForceWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorimpulselocal.html b/doc/doc_files/applyactorimpulselocal.html index a1a8754..b018b41 100644 --- a/doc/doc_files/applyactorimpulselocal.html +++ b/doc/doc_files/applyactorimpulselocal.html @@ -7,7 +7,7 @@ -

sub ApplyActorImpulseLocal( actor, x, y, z, rel_x, rel_y, rel_z)

+

Sub ApplyActorImpulseLocal( actor, x, y, z, rel_x, rel_y, rel_z)

Applies an impulse to an actor at a specific point. Unlike ApplyActorCentralImpulse(local/world), which applies impulse only at the center of mass (affecting linear velocity), this can generate both linear motion and rotation (torque), depending on where the force is applied relative to the center of mass.

@@ -25,6 +25,7 @@ ApplyActorForceWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactorimpulseworld.html b/doc/doc_files/applyactorimpulseworld.html index b2a8d08..db62c6f 100644 --- a/doc/doc_files/applyactorimpulseworld.html +++ b/doc/doc_files/applyactorimpulseworld.html @@ -25,6 +25,7 @@ ApplyActorForceWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactortorqueimpulselocal.html b/doc/doc_files/applyactortorqueimpulselocal.html index 9c4ef56..0349291 100644 --- a/doc/doc_files/applyactortorqueimpulselocal.html +++ b/doc/doc_files/applyactortorqueimpulselocal.html @@ -21,6 +21,7 @@ ApplyActorTorqueImpulseWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactortorqueimpulseworld.html b/doc/doc_files/applyactortorqueimpulseworld.html index ff2c529..ceb6ba7 100644 --- a/doc/doc_files/applyactortorqueimpulseworld.html +++ b/doc/doc_files/applyactortorqueimpulseworld.html @@ -21,6 +21,7 @@ ApplyActorTorqueImpulseLocal

+

\ No newline at end of file diff --git a/doc/doc_files/applyactortorquelocal.html b/doc/doc_files/applyactortorquelocal.html index 04a2a1d..3312f85 100644 --- a/doc/doc_files/applyactortorquelocal.html +++ b/doc/doc_files/applyactortorquelocal.html @@ -22,6 +22,7 @@ ApplyActorTorqueImpulseWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyactortorqueworld.html b/doc/doc_files/applyactortorqueworld.html index 70fc39e..2851888 100644 --- a/doc/doc_files/applyactortorqueworld.html +++ b/doc/doc_files/applyactortorqueworld.html @@ -22,6 +22,7 @@ ApplyActorTorqueImpulseWorld

+

\ No newline at end of file diff --git a/doc/doc_files/applyspriteangularimpulse.html b/doc/doc_files/applyspriteangularimpulse.html index 8652365..94afea3 100644 --- a/doc/doc_files/applyspriteangularimpulse.html +++ b/doc/doc_files/applyspriteangularimpulse.html @@ -3,11 +3,11 @@ - applySpriteAngularImpulse [RCBasic Doc] + ApplySpriteAngularImpulse [RCBasic Doc] -

sub applySpriteAngularImpulse( spr_id, impulse)

+

Sub ApplySpriteAngularImpulse( spr_id, impulse)

Apply an angular impulse to a body. This method affects the body’s rotational motion, changing its angular velocity based on the impulse applied.

@@ -15,6 +15,7 @@ ApplySpriteLinearImpulse

+

\ No newline at end of file diff --git a/doc/doc_files/applyspritecentralforce.html b/doc/doc_files/applyspritecentralforce.html index eb93348..ac538d4 100644 --- a/doc/doc_files/applyspritecentralforce.html +++ b/doc/doc_files/applyspritecentralforce.html @@ -3,15 +3,16 @@ - applySpriteCentralForce [RCBasic Doc] + ApplySpriteCentralForce [RCBasic Doc] -

sub applySpriteCentralForce( spr_id, x, y)

+

Sub ApplySpriteCentralForce( spr_id, x, y)

Apply a continuous force to a body at its center of mass, regardless of the body's current orientation. This method affects the body's linear motion and is useful for simulating forces like gravity, wind, or any other directional force.

+

\ No newline at end of file diff --git a/doc/doc_files/applyspriteforce.html b/doc/doc_files/applyspriteforce.html index 86ec72c..6109ea2 100644 --- a/doc/doc_files/applyspriteforce.html +++ b/doc/doc_files/applyspriteforce.html @@ -3,15 +3,16 @@ - applySpriteForce [RCBasic Doc] + ApplySpriteForce [RCBasic Doc] -

sub applySpriteForce( spr_id, fX, fY, pX, pY)

+

Sub ApplySpriteForce( spr_id, fX, fY, pX, pY)

Apply a force at a world point. If the force is not applied at the center of mass, it will generate a torque and affect the angular velocity. This wakes up the body.

+

\ No newline at end of file diff --git a/doc/doc_files/applyspritelinearimpulse.html b/doc/doc_files/applyspritelinearimpulse.html index 9a24e77..7131ded 100644 --- a/doc/doc_files/applyspritelinearimpulse.html +++ b/doc/doc_files/applyspritelinearimpulse.html @@ -3,11 +3,11 @@ - applySpriteLinearImpulse [RCBasic Doc] + ApplySpriteLinearImpulse [RCBasic Doc] -

sub applySpriteLinearImpulse( spr_id, iX, iY, pX, pY)

+

Sub ApplySpriteLinearImpulse( spr_id, iX, iY, pX, pY)

Apply an instantaneous linear impulse to a body. This method directly affects the body’s linear motion by changing its velocity based on the impulse applied.

@@ -15,6 +15,7 @@ ApplySpriteAngularImpulse

+

\ No newline at end of file diff --git a/doc/doc_files/applyspritetorque.html b/doc/doc_files/applyspritetorque.html index c0aa765..0fe585a 100644 --- a/doc/doc_files/applyspritetorque.html +++ b/doc/doc_files/applyspritetorque.html @@ -3,15 +3,16 @@ - applySpriteTorque [RCBasic Doc] + ApplySpriteTorque [RCBasic Doc] -

sub applySpriteTorque( spr_id, torque)

+

Sub ApplySpriteTorque( spr_id, torque)

Apply a torque. This affects the angular velocity without affecting the linear velocity of the center of mass.

+

\ No newline at end of file diff --git a/doc/doc_files/arraycopy.html b/doc/doc_files/arraycopy.html index 01a2788..e64d9ff 100644 --- a/doc/doc_files/arraycopy.html +++ b/doc/doc_files/arraycopy.html @@ -7,7 +7,7 @@ -

sub ArrayCopy(ByRef src, ByRef dst)

+

Sub ArrayCopy(ByRef src, ByRef dst)

Copies the contents of src array to dst array

@@ -20,6 +20,7 @@ ArrayFill

+

\ No newline at end of file diff --git a/doc/doc_files/arraydim.html b/doc/doc_files/arraydim.html index c2b0268..76fb6de 100644 --- a/doc/doc_files/arraydim.html +++ b/doc/doc_files/arraydim.html @@ -7,7 +7,7 @@ -

function ArrayDim(Byref id)

+

Function ArrayDim(ByRef id)

Returns the number of dimensions in an array

@@ -17,6 +17,7 @@ ArraySize

+

\ No newline at end of file diff --git a/doc/doc_files/arrayfill.html b/doc/doc_files/arrayfill.html index 3a86c70..f71459f 100644 --- a/doc/doc_files/arrayfill.html +++ b/doc/doc_files/arrayfill.html @@ -17,6 +17,7 @@ ArraySize

+

\ No newline at end of file diff --git a/doc/doc_files/arrays.html b/doc/doc_files/arrays.html index add3644..7dcc576 100644 --- a/doc/doc_files/arrays.html +++ b/doc/doc_files/arrays.html @@ -56,6 +56,7 @@ Y[1, 2, 3] = 6   '(This line sets the 4th value of the 3rd index in the 2nd index in the array to 6. That was a mouth full. )

+

\ No newline at end of file diff --git a/doc/doc_files/arraysize.html b/doc/doc_files/arraysize.html index 704c5a3..0f220ec 100644 --- a/doc/doc_files/arraysize.html +++ b/doc/doc_files/arraysize.html @@ -7,7 +7,7 @@ -

Function ArraySize(Byref id, array_dim)

+

Function ArraySize(ByRef id, array_dim)

Returns the number of elements in the given dimension of an array

@@ -17,6 +17,7 @@ ArrayFill

+

\ No newline at end of file diff --git a/doc/doc_files/asc.html b/doc/doc_files/asc.html index 14aa178..63d0295 100644 --- a/doc/doc_files/asc.html +++ b/doc/doc_files/asc.html @@ -12,6 +12,7 @@ Returns the ASCII value of a character.

+

\ No newline at end of file diff --git a/doc/doc_files/asin.html b/doc/doc_files/asin.html index 53ff2c3..0fea1d4 100644 --- a/doc/doc_files/asin.html +++ b/doc/doc_files/asin.html @@ -12,6 +12,7 @@ Returns the ArcSine of a number.

+

\ No newline at end of file diff --git a/doc/doc_files/atan.html b/doc/doc_files/atan.html index 06fe174..3f8f70e 100644 --- a/doc/doc_files/atan.html +++ b/doc/doc_files/atan.html @@ -12,6 +12,7 @@ Returns the ArcTangent of a number.

+

\ No newline at end of file diff --git a/doc/doc_files/atan2.html b/doc/doc_files/atan2.html index 579e4d7..637de3f 100644 --- a/doc/doc_files/atan2.html +++ b/doc/doc_files/atan2.html @@ -12,6 +12,7 @@ Returns the ArcTangent of x and y

+

\ No newline at end of file diff --git a/doc/doc_files/augmentmatrix.html b/doc/doc_files/augmentmatrix.html index a7005d5..48bca2f 100644 --- a/doc/doc_files/augmentmatrix.html +++ b/doc/doc_files/augmentmatrix.html @@ -7,7 +7,7 @@ -

function AugmentMatrix(mA, mB, mC)

+

Function AugmentMatrix(mA, mB, mC)

Appends the columns of matrix mB onto matrix mA and stores the result in mC.

@@ -15,6 +15,7 @@ NOTE: Must mA and mB must be the same number of rows.

+

\ No newline at end of file diff --git a/doc/doc_files/bin.html b/doc/doc_files/bin.html index a3ebf49..e990d8b 100644 --- a/doc/doc_files/bin.html +++ b/doc/doc_files/bin.html @@ -7,11 +7,12 @@ -

function Bin$(n)

+

Function Bin$(n)

Returns the binary representation of a number.

+

\ No newline at end of file diff --git a/doc/doc_files/box3d.html b/doc/doc_files/box3d.html index d8dd34b..8b9f3bc 100644 --- a/doc/doc_files/box3d.html +++ b/doc/doc_files/box3d.html @@ -7,11 +7,12 @@ -

sub Box3D(min_x, min_y, min_z, max_x, max_y, max_z)

+

Sub Box3D(min_x, min_y, min_z, max_x, max_y, max_z)

Draws a box in 3D space

+

\ No newline at end of file diff --git a/doc/doc_files/bufferfromimage.html b/doc/doc_files/bufferfromimage.html index 425788e..c0dcb79 100644 --- a/doc/doc_files/bufferfromimage.html +++ b/doc/doc_files/bufferfromimage.html @@ -7,8 +7,9 @@ -

sub BufferFromImage(slot, byref buffer)

+

Sub BufferFromImage(slot, ByRef buffer)

+

\ No newline at end of file diff --git a/doc/doc_files/bufferfrommatrix.html b/doc/doc_files/bufferfrommatrix.html index 4e99e2d..6b62839 100644 --- a/doc/doc_files/bufferfrommatrix.html +++ b/doc/doc_files/bufferfrommatrix.html @@ -7,7 +7,7 @@ -

sub BufferFromMatrix(ByRef buffer, mA)

+

Sub BufferFromMatrix(ByRef buffer, mA)

Saves the matrix mA in an array

@@ -18,6 +18,7 @@ MatrixFromBuffer

+

\ No newline at end of file diff --git a/doc/doc_files/bufferfromstring.html b/doc/doc_files/bufferfromstring.html index cf85941..ec31b45 100644 --- a/doc/doc_files/bufferfromstring.html +++ b/doc/doc_files/bufferfromstring.html @@ -7,7 +7,7 @@ -

function BufferFromString(s$, ByRef buffer)

+

Function BufferFromString(s$, ByRef buffer)

Stores the byte value of a string into a number buffer

@@ -15,6 +15,7 @@ StringFromBuffer$

+

\ No newline at end of file diff --git a/doc/doc_files/canvas.html b/doc/doc_files/canvas.html index 5ada771..ef23f9a 100644 --- a/doc/doc_files/canvas.html +++ b/doc/doc_files/canvas.html @@ -7,7 +7,7 @@ -

sub Canvas(c_num)

+

Sub Canvas(c_num)

Sets the active canvas for drawing commands to use

@@ -15,6 +15,7 @@ ActiveCanvas

+

\ No newline at end of file diff --git a/doc/doc_files/canvasclip.html b/doc/doc_files/canvasclip.html index 0913f2c..b3c69ef 100644 --- a/doc/doc_files/canvasclip.html +++ b/doc/doc_files/canvasclip.html @@ -7,7 +7,7 @@ -

function CanvasClip(x, y, w, h)

+

Function CanvasClip(x, y, w, h)

Returns an image id with a selected portion of the active drawing canvas saved

@@ -15,6 +15,7 @@ WindowClip

+

\ No newline at end of file diff --git a/doc/doc_files/canvasisvisible.html b/doc/doc_files/canvasisvisible.html index e4d4fe8..14ec93b 100644 --- a/doc/doc_files/canvasisvisible.html +++ b/doc/doc_files/canvasisvisible.html @@ -7,7 +7,7 @@ -

function CanvasIsVisible(c_num)

+

Function CanvasIsVisible(c_num)

Returns true if a canvas is shown in the Window

@@ -15,6 +15,7 @@ SetCanvasVisible

+

\ No newline at end of file diff --git a/doc/doc_files/canvasz.html b/doc/doc_files/canvasz.html index b37887e..901c0f6 100644 --- a/doc/doc_files/canvasz.html +++ b/doc/doc_files/canvasz.html @@ -7,7 +7,7 @@ -

function CanvasZ(c_num)

+

Function CanvasZ(c_num)

Returns the Canvas Z Order.

@@ -18,6 +18,7 @@ SetCanvasZ

+

\ No newline at end of file diff --git a/doc/doc_files/castray2d.html b/doc/doc_files/castray2d.html index c460985..b9e5701 100644 --- a/doc/doc_files/castray2d.html +++ b/doc/doc_files/castray2d.html @@ -7,7 +7,7 @@ -

function CastRay2D( from_x, from_y, to_x, to_y )

+

Function CastRay2D( from_x, from_y, to_x, to_y )

Cast a ray and get the closest hit on the ray

@@ -25,6 +25,7 @@ GetRayHit2D

+

\ No newline at end of file diff --git a/doc/doc_files/castray2d_all.html b/doc/doc_files/castray2d_all.html index 2b2f9bb..4987221 100644 --- a/doc/doc_files/castray2d_all.html +++ b/doc/doc_files/castray2d_all.html @@ -7,7 +7,7 @@ -

function CastRay2D_All( from_x, from_y, to_x, to_y )

+

Function CastRay2D_All( from_x, from_y, to_x, to_y )

Cast a ray and gets all hits on the ray

@@ -25,6 +25,7 @@ GetRayHit2D

+

\ No newline at end of file diff --git a/doc/doc_files/castray3d.html b/doc/doc_files/castray3d.html index 0847b09..fc838fe 100644 --- a/doc/doc_files/castray3d.html +++ b/doc/doc_files/castray3d.html @@ -7,7 +7,7 @@ -

function CastRay3D( from_x, from_y, from_z, to_x, to_y, to_z )

+

Function CastRay3D( from_x, from_y, from_z, to_x, to_y, to_z )

Cast a ray and get the closest hit on the ray

@@ -25,6 +25,7 @@ GetRayHit2D

+

\ No newline at end of file diff --git a/doc/doc_files/castray3d_all.html b/doc/doc_files/castray3d_all.html index 38fdbfa..b9bfaa8 100644 --- a/doc/doc_files/castray3d_all.html +++ b/doc/doc_files/castray3d_all.html @@ -7,7 +7,7 @@ -

function CastRay3D_All( from_x, from_y, from_z, to_x, to_y, to_z )

+

Function CastRay3D_All( from_x, from_y, from_z, to_x, to_y, to_z )

Cast a ray and gets all hits on the ray

@@ -25,6 +25,7 @@ GetRayHit2D

+

\ No newline at end of file diff --git a/doc/doc_files/changedir.html b/doc/doc_files/changedir.html index ea7d13d..43af375 100644 --- a/doc/doc_files/changedir.html +++ b/doc/doc_files/changedir.html @@ -7,11 +7,12 @@ -

sub ChangeDir(p$)

+

Sub ChangeDir(p$)

Sets the working directory that the directory commands use

+

\ No newline at end of file diff --git a/doc/doc_files/channelispaused.html b/doc/doc_files/channelispaused.html index b8c14df..5ad2a75 100644 --- a/doc/doc_files/channelispaused.html +++ b/doc/doc_files/channelispaused.html @@ -7,7 +7,7 @@ -

function ChannelIsPaused(channel)

+

Function ChannelIsPaused(channel)

Returns true if an audio channel is currently paused

@@ -15,6 +15,7 @@ PauseSound

+

\ No newline at end of file diff --git a/doc/doc_files/channelisplaying.html b/doc/doc_files/channelisplaying.html index 4f233de..448c5db 100644 --- a/doc/doc_files/channelisplaying.html +++ b/doc/doc_files/channelisplaying.html @@ -7,7 +7,7 @@ -

function ChannelIsPlaying(channel)

+

Function ChannelIsPlaying(channel)

Returns true if an audio channel is playing

@@ -17,6 +17,7 @@ PlaySoundTimed

+

\ No newline at end of file diff --git a/doc/doc_files/checksockets.html b/doc/doc_files/checksockets.html index 46db155..d90f3ad 100644 --- a/doc/doc_files/checksockets.html +++ b/doc/doc_files/checksockets.html @@ -7,7 +7,7 @@ -

function CheckSockets(timeout_ms)

+

Function CheckSockets(timeout_ms)

Checks all connected sockets for activity. If timeout_ms is greater than 0 than it will wait that many milliseconds. If less than 0 it will wait for over 49 days (hint: there is no reason what so ever to set this less than 0).

@@ -15,6 +15,7 @@ Returns the number of sockets that have activity (ie. a connection was made or data was sent)

+

\ No newline at end of file diff --git a/doc/doc_files/chr.html b/doc/doc_files/chr.html index b449c24..4b2c0af 100644 --- a/doc/doc_files/chr.html +++ b/doc/doc_files/chr.html @@ -7,11 +7,12 @@ -

function Chr$(n)

+

Function Chr$(n)

Returns the character with the matching ASCII value n.

+

\ No newline at end of file diff --git a/doc/doc_files/cint32.html b/doc/doc_files/cint32.html index 8dea700..b36161f 100644 --- a/doc/doc_files/cint32.html +++ b/doc/doc_files/cint32.html @@ -7,11 +7,12 @@ -

function CInt32(i)

+

Function CInt32(i)

Returns a 32-bit signed integer.

+

\ No newline at end of file diff --git a/doc/doc_files/cint64.html b/doc/doc_files/cint64.html index 8ecb94d..4322bf7 100644 --- a/doc/doc_files/cint64.html +++ b/doc/doc_files/cint64.html @@ -7,11 +7,12 @@ -

function CInt64(i)

+

Function CInt64(i)

Returns a 64-bit signed integer.

+

\ No newline at end of file diff --git a/doc/doc_files/circle.html b/doc/doc_files/circle.html index 1af0f09..80d7ddb 100644 --- a/doc/doc_files/circle.html +++ b/doc/doc_files/circle.html @@ -7,11 +7,12 @@ -

sub Circle(x,y,radius)

+

Sub Circle(x,y,radius)

Draws a circle on the current canvas.

+

\ No newline at end of file diff --git a/doc/doc_files/circlefill.html b/doc/doc_files/circlefill.html index 554064a..710dd59 100644 --- a/doc/doc_files/circlefill.html +++ b/doc/doc_files/circlefill.html @@ -7,11 +7,12 @@ -

sub CircleFill(x,y,radius)

+

Sub CircleFill(x,y,radius)

Draws a filled circle on the current canvas.

+

\ No newline at end of file diff --git a/doc/doc_files/clearactorforces.html b/doc/doc_files/clearactorforces.html index 43c251a..32e5cc1 100644 --- a/doc/doc_files/clearactorforces.html +++ b/doc/doc_files/clearactorforces.html @@ -3,11 +3,11 @@ - clearActorForces [RCBasic Doc] + ClearActorForces [RCBasic Doc] -

sub clearActorForces( actor)

+

Sub ClearActorForces( actor)

Resets or clears all the forces and torques that have been applied to a rigid body in the current simulation step. This ensures that any forces, including linear forces and torques, do not accumulate from one simulation step to the next.

@@ -26,6 +26,7 @@

+

\ No newline at end of file diff --git a/doc/doc_files/clearcanvas.html b/doc/doc_files/clearcanvas.html index 338383d..e6fb735 100644 --- a/doc/doc_files/clearcanvas.html +++ b/doc/doc_files/clearcanvas.html @@ -7,7 +7,7 @@ -

sub ClearCanvas()

+

Sub ClearCanvas()

Clears the active drawing canvas

@@ -15,6 +15,7 @@ NOTE: This is only for drawing canvases (ie. Those opened with OpenCanvas())

+

\ No newline at end of file diff --git a/doc/doc_files/clearmatrix.html b/doc/doc_files/clearmatrix.html index 82c2b5e..8404112 100644 --- a/doc/doc_files/clearmatrix.html +++ b/doc/doc_files/clearmatrix.html @@ -7,11 +7,12 @@ -

sub ClearMatrix(mA)

+

Sub ClearMatrix(mA)

Sets all elements in a matrix to zero

+

\ No newline at end of file diff --git a/doc/doc_files/clearmatrixcolumns.html b/doc/doc_files/clearmatrixcolumns.html index 188769f..0812c28 100644 --- a/doc/doc_files/clearmatrixcolumns.html +++ b/doc/doc_files/clearmatrixcolumns.html @@ -7,7 +7,7 @@ -

function ClearMatrixColumns(mA, c, num_cols)

+

Function ClearMatrixColumns(mA, c, num_cols)

Sets all elements in the matrix columns specified to zero.

@@ -16,6 +16,7 @@ ClearMatrixRows

+

\ No newline at end of file diff --git a/doc/doc_files/clearmatrixrows.html b/doc/doc_files/clearmatrixrows.html index 7ea08e7..dc49370 100644 --- a/doc/doc_files/clearmatrixrows.html +++ b/doc/doc_files/clearmatrixrows.html @@ -7,7 +7,7 @@ -

function ClearMatrixRows(mA, r, num_rows)

+

Function ClearMatrixRows(mA, r, num_rows)

Sets all elements in the matrix rows specified to zero.

@@ -16,6 +16,7 @@ ClearMatrixColumns

+

\ No newline at end of file diff --git a/doc/doc_files/clearmousezone.html b/doc/doc_files/clearmousezone.html index e1ee81f..b1e6f65 100644 --- a/doc/doc_files/clearmousezone.html +++ b/doc/doc_files/clearmousezone.html @@ -7,11 +7,12 @@ -

sub ClearMouseZone()

+

Sub ClearMouseZone()

Removes the previously set mouse zone from the window

+

\ No newline at end of file diff --git a/doc/doc_files/clearscene.html b/doc/doc_files/clearscene.html index 4f4882f..b2b6835 100644 --- a/doc/doc_files/clearscene.html +++ b/doc/doc_files/clearscene.html @@ -9,6 +9,7 @@

Sub ClearScene()

+

\ No newline at end of file diff --git a/doc/doc_files/clearstack_n.html b/doc/doc_files/clearstack_n.html index 6135148..adf0fde 100644 --- a/doc/doc_files/clearstack_n.html +++ b/doc/doc_files/clearstack_n.html @@ -7,7 +7,7 @@ -

sub ClearStack_N( num_stack )

+

Sub ClearStack_N( num_stack )

Removes all elements from the stack

@@ -15,6 +15,7 @@ ClearStack_S

+

\ No newline at end of file diff --git a/doc/doc_files/clearstack_s.html b/doc/doc_files/clearstack_s.html index 8587936..89ebccc 100644 --- a/doc/doc_files/clearstack_s.html +++ b/doc/doc_files/clearstack_s.html @@ -7,7 +7,7 @@ -

sub ClearStack_S( str_stack )

+

Sub ClearStack_S( str_stack )

Removes all elements from the stack

@@ -15,6 +15,7 @@ ClearStack_N

+

\ No newline at end of file diff --git a/doc/doc_files/clipmatrix.html b/doc/doc_files/clipmatrix.html index b06e42b..2056fa8 100644 --- a/doc/doc_files/clipmatrix.html +++ b/doc/doc_files/clipmatrix.html @@ -7,11 +7,12 @@ -

sub ClipMatrix(mA, r, c, num_rows, num_cols, mB)

+

Sub ClipMatrix(mA, r, c, num_rows, num_cols, mB)

Copies the specified portion of matrix mA into matrix mB

+

\ No newline at end of file diff --git a/doc/doc_files/clonecanvas.html b/doc/doc_files/clonecanvas.html index 5e228ab..89ef281 100644 --- a/doc/doc_files/clonecanvas.html +++ b/doc/doc_files/clonecanvas.html @@ -7,7 +7,7 @@ -

function CloneCanvas(c_num, mode)

+

Function CloneCanvas(c_num, mode)

Returns a clone of a canvas. Clone canvases are mirrors of the original canvas so when you draw to one it will also be on the other. This is useful for a splitscreen 2d game.

@@ -18,6 +18,7 @@ OpenCanvas

+

\ No newline at end of file diff --git a/doc/doc_files/closecanvas.html b/doc/doc_files/closecanvas.html index 26ed1e9..57adffc 100644 --- a/doc/doc_files/closecanvas.html +++ b/doc/doc_files/closecanvas.html @@ -15,6 +15,7 @@ OpenCanvas

+

\ No newline at end of file diff --git a/doc/doc_files/closefile.html b/doc/doc_files/closefile.html index 81566ea..b143bc7 100644 --- a/doc/doc_files/closefile.html +++ b/doc/doc_files/closefile.html @@ -7,7 +7,7 @@ -

sub CloseFile( stream )

+

Sub CloseFile( stream )

Closes a file

@@ -15,6 +15,7 @@ OpenFile

+

\ No newline at end of file diff --git a/doc/doc_files/closewindow.html b/doc/doc_files/closewindow.html index 24efc2d..0df0a09 100644 --- a/doc/doc_files/closewindow.html +++ b/doc/doc_files/closewindow.html @@ -7,7 +7,7 @@ -

sub CloseWindow( )

+

Sub CloseWindow( )

Closes the graphics window

@@ -15,6 +15,7 @@ OpenWindow

+

\ No newline at end of file diff --git a/doc/doc_files/cls.html b/doc/doc_files/cls.html index 2ab7692..e7b05a1 100644 --- a/doc/doc_files/cls.html +++ b/doc/doc_files/cls.html @@ -7,11 +7,12 @@ -

sub Cls()

+

Sub Cls()

Clears the back buffer on the window

+

\ No newline at end of file diff --git a/doc/doc_files/cofactormatrix.html b/doc/doc_files/cofactormatrix.html index f3ad1b5..ebd5e76 100644 --- a/doc/doc_files/cofactormatrix.html +++ b/doc/doc_files/cofactormatrix.html @@ -7,7 +7,7 @@ -

sub CofactorMatrix(mA, r, c)

+

Sub CofactorMatrix(mA, r, c)

Sets matrix mA to a cofactor. This will change the original matrix so it is recommended to copy the matrix if you still need the original matrix.

@@ -15,6 +15,7 @@ CopyMatrix

+

\ No newline at end of file diff --git a/doc/doc_files/colorkey.html b/doc/doc_files/colorkey.html index ef6bf75..d4a1282 100644 --- a/doc/doc_files/colorkey.html +++ b/doc/doc_files/colorkey.html @@ -7,11 +7,12 @@ -

sub ColorKey(img_id, c)

+

Sub ColorKey(img_id, c)

Sets the color key for an image

+

\ No newline at end of file diff --git a/doc/doc_files/command.html b/doc/doc_files/command.html index 558c114..be05523 100644 --- a/doc/doc_files/command.html +++ b/doc/doc_files/command.html @@ -7,7 +7,7 @@ -

function Command$(arg)

+

Function Command$(arg)

Returns command line arguments passed to a program.

@@ -18,6 +18,7 @@ NumCommands

+

\ No newline at end of file diff --git a/doc/doc_files/comments.html b/doc/doc_files/comments.html index 65f835d..c9a15a7 100644 --- a/doc/doc_files/comments.html +++ b/doc/doc_files/comments.html @@ -27,6 +27,7 @@ MULTI-LINE COMMENT '/

+

\ No newline at end of file diff --git a/doc/doc_files/computeactorangularimpulsedenominator.html b/doc/doc_files/computeactorangularimpulsedenominator.html index c65a4ff..4b25ad1 100644 --- a/doc/doc_files/computeactorangularimpulsedenominator.html +++ b/doc/doc_files/computeactorangularimpulsedenominator.html @@ -7,7 +7,7 @@ -

function ComputeActorAngularImpulseDenominator( actor, x, y, z)

+

Function ComputeActorAngularImpulseDenominator( actor, x, y, z)

Computes a scalar value that represents how an actor will respond to an angular impulse at a given point, taking into account the actor's inertia tensor (which governs how the object resists rotation). This function is particularly useful in calculating the actor's rotational response to an impulse, typically during collision resolution or constraints involving rotation.

@@ -15,6 +15,7 @@ ComputeActorImpulseDenominator

+

\ No newline at end of file diff --git a/doc/doc_files/computeactorgyroimpulselocal.html b/doc/doc_files/computeactorgyroimpulselocal.html index 265ce83..5e8b470 100644 --- a/doc/doc_files/computeactorgyroimpulselocal.html +++ b/doc/doc_files/computeactorgyroimpulselocal.html @@ -7,7 +7,7 @@ -

sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z)

+

Sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z)

Computes the gyroscopic impulse for an actor in an implicit manner, based on the actor's current angular velocity and inertia. This function is used to simulate the gyroscopic effect—also known as gyroscopic precession—which occurs when a rotating object experiences a torque that causes its axis of rotation to change.

@@ -15,6 +15,7 @@ ComputeActorGyroImpulseWorld

+

\ No newline at end of file diff --git a/doc/doc_files/computeactorgyroimpulseworld.html b/doc/doc_files/computeactorgyroimpulseworld.html index 431aebd..5bc684b 100644 --- a/doc/doc_files/computeactorgyroimpulseworld.html +++ b/doc/doc_files/computeactorgyroimpulseworld.html @@ -7,7 +7,7 @@ -

sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z)

+

Sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z)

Computes the gyroscopic impulse for an actor in an implicit manner, but in this case, it performs the calculation relative to the world frame of reference, rather than the actor’s local frame. This function is used to handle the gyroscopic effects (i.e., gyroscopic precession) of a rotating object when a torque is applied, affecting its axis of rotation.

@@ -15,6 +15,7 @@ ComputeActorGyroImpulseLocal

+

\ No newline at end of file diff --git a/doc/doc_files/computeactorimpulsedenominator.html b/doc/doc_files/computeactorimpulsedenominator.html index 7082ceb..d27b555 100644 --- a/doc/doc_files/computeactorimpulsedenominator.html +++ b/doc/doc_files/computeactorimpulsedenominator.html @@ -7,7 +7,7 @@ -

function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z)

+

Function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z)

Computes a scalar value related to how a rigid body will respond to an applied impulse at a given point. It’s primarily used internally in the physics engine to calculate how an object’s mass, inertia, and shape will affect the outcome of impulses, particularly in collisions or constraints like contact points between objects.

@@ -15,6 +15,7 @@ ComputeActorAngularImpulseDenominator

+

\ No newline at end of file diff --git a/doc/doc_files/conditions.html b/doc/doc_files/conditions.html index 13f3c18..77f40f9 100644 --- a/doc/doc_files/conditions.html +++ b/doc/doc_files/conditions.html @@ -55,6 +55,7 @@ The above example is mostly the same as the previous example. The difference is that in our second CASE we are comparing both 4 and 5. If either of them are equal to our SELECT argument then the code inside the CASE block will execute.

+

\ No newline at end of file diff --git a/doc/doc_files/constants.html b/doc/doc_files/constants.html index 4696681..4e153fe 100644 --- a/doc/doc_files/constants.html +++ b/doc/doc_files/constants.html @@ -16,6 +16,7 @@ const  MY_PRINT = print "hello world" 

+

\ No newline at end of file diff --git a/doc/doc_files/constraintexists.html b/doc/doc_files/constraintexists.html index 42300e5..f63be2e 100644 --- a/doc/doc_files/constraintexists.html +++ b/doc/doc_files/constraintexists.html @@ -7,11 +7,12 @@ -

function ConstraintExists( constraint_id )

+

Function ConstraintExists( constraint_id )

Returns true if the id passed is a valid constraint

+

\ No newline at end of file diff --git a/doc/doc_files/converttonormalmap.html b/doc/doc_files/converttonormalmap.html index d13bbf3..32b7e3b 100644 --- a/doc/doc_files/converttonormalmap.html +++ b/doc/doc_files/converttonormalmap.html @@ -7,11 +7,12 @@ -

sub ConvertToNormalMap(img_id, amp)

+

Sub ConvertToNormalMap(img_id, amp)

Converts an image to a format for normal maps

+

\ No newline at end of file diff --git a/doc/doc_files/copyactormaterial.html b/doc/doc_files/copyactormaterial.html index 1e3aac6..b6f7977 100644 --- a/doc/doc_files/copyactormaterial.html +++ b/doc/doc_files/copyactormaterial.html @@ -7,11 +7,12 @@ -

function CopyActorMaterial( actor, material_num)

+

Function CopyActorMaterial( actor, material_num)

Returns a material id for a copy of an actor's material

+

\ No newline at end of file diff --git a/doc/doc_files/copyfile.html b/doc/doc_files/copyfile.html index 50b1ca9..50652a0 100644 --- a/doc/doc_files/copyfile.html +++ b/doc/doc_files/copyfile.html @@ -7,11 +7,12 @@ -

sub CopyFile(src$, dst$)

+

Sub CopyFile(src$, dst$)

Copies the contents of src$ file to a new dst$ file

+

\ No newline at end of file diff --git a/doc/doc_files/copyimage.html b/doc/doc_files/copyimage.html index be775b7..93d5f70 100644 --- a/doc/doc_files/copyimage.html +++ b/doc/doc_files/copyimage.html @@ -7,11 +7,12 @@ -

function CopyImage( img_id )

+

Function CopyImage( img_id )

Returns a copy of an image

+

\ No newline at end of file diff --git a/doc/doc_files/copymaterial.html b/doc/doc_files/copymaterial.html index 7140ec2..15b3d58 100644 --- a/doc/doc_files/copymaterial.html +++ b/doc/doc_files/copymaterial.html @@ -7,11 +7,12 @@ -

function CopyMaterial( smaterial_id)

+

Function CopyMaterial( smaterial_id)

Returns a copy of a material

+

\ No newline at end of file diff --git a/doc/doc_files/copymatrix.html b/doc/doc_files/copymatrix.html index 36f7ff1..e5ed2ad 100644 --- a/doc/doc_files/copymatrix.html +++ b/doc/doc_files/copymatrix.html @@ -7,11 +7,12 @@ -

sub CopyMatrix(mA, mB)

+

Sub CopyMatrix(mA, mB)

Copies matrix mA to matrix mB

+

\ No newline at end of file diff --git a/doc/doc_files/copymatrixcolumns.html b/doc/doc_files/copymatrixcolumns.html index 6d4898d..053d59d 100644 --- a/doc/doc_files/copymatrixcolumns.html +++ b/doc/doc_files/copymatrixcolumns.html @@ -7,7 +7,7 @@ -

function CopyMatrixColumns(mA, mB, c, num_cols)

+

Function CopyMatrixColumns(mA, mB, c, num_cols)

Copies the specified matrix columns from matrix mA to matrix mB.

@@ -15,6 +15,7 @@ Note: Matrix mB will be redimensioned to the size of the copied columns.

+

\ No newline at end of file diff --git a/doc/doc_files/copymatrixrows.html b/doc/doc_files/copymatrixrows.html index 482687d..ed32e20 100644 --- a/doc/doc_files/copymatrixrows.html +++ b/doc/doc_files/copymatrixrows.html @@ -7,7 +7,7 @@ -

function CopyMatrixRows(mA, mB, r, num_rows)

+

Function CopyMatrixRows(mA, mB, r, num_rows)

Copies the specified matrix rows from matrix mA to matrix mB.

@@ -15,6 +15,7 @@ Note: Matrix mB will be redimensioned to the size of the copied rows.

+

\ No newline at end of file diff --git a/doc/doc_files/cos.html b/doc/doc_files/cos.html index 7d67e00..bff67c4 100644 --- a/doc/doc_files/cos.html +++ b/doc/doc_files/cos.html @@ -7,11 +7,12 @@ -

function Cos(n)

+

Function Cos(n)

Returns the Cosine of an angle

+

\ No newline at end of file diff --git a/doc/doc_files/createactoranimation.html b/doc/doc_files/createactoranimation.html index db707e9..9f5383c 100644 --- a/doc/doc_files/createactoranimation.html +++ b/doc/doc_files/createactoranimation.html @@ -9,6 +9,7 @@

Function CreateActorAnimation(actor, start_frame, end_frame, speed)

+

\ No newline at end of file diff --git a/doc/doc_files/createanimatedactor.html b/doc/doc_files/createanimatedactor.html index 1146adc..00be22b 100644 --- a/doc/doc_files/createanimatedactor.html +++ b/doc/doc_files/createanimatedactor.html @@ -7,7 +7,7 @@ -

function CreateAnimatedActor( mesh )

+

Function CreateAnimatedActor( mesh )

Returns a new animated actor composed of a mesh

@@ -32,6 +32,7 @@ CreateTerrainActor

+

\ No newline at end of file diff --git a/doc/doc_files/createbillboardactor.html b/doc/doc_files/createbillboardactor.html index 960d051..cc6bf48 100644 --- a/doc/doc_files/createbillboardactor.html +++ b/doc/doc_files/createbillboardactor.html @@ -7,7 +7,7 @@ -

function CreateBillboardActor( )

+

Function CreateBillboardActor( )

Returns a billboard actor

@@ -24,6 +24,7 @@ CreateTerrainActor

+

\ No newline at end of file diff --git a/doc/doc_files/createconeconstraint.html b/doc/doc_files/createconeconstraint.html index 4bc8256..3cd0732 100644 --- a/doc/doc_files/createconeconstraint.html +++ b/doc/doc_files/createconeconstraint.html @@ -7,7 +7,7 @@ -

function CreateConeConstraint( actorA, rbAFrame_matrix)

+

Function CreateConeConstraint( actorA, rbAFrame_matrix)

The Cone Constraint is a type of joint constraint used to simulate realistic rotational movement between two actors (or between an actor and the world) with specific angular limits. This constraint is especially useful for simulating ball-and-socket joints with some twisting freedom but restricted cone-like movement, such as human shoulders or robotic arms.

@@ -31,6 +31,7 @@ SetMatrixRotation

+

\ No newline at end of file diff --git a/doc/doc_files/createconeconstraintex.html b/doc/doc_files/createconeconstraintex.html index bfe5bc3..60a1ce6 100644 --- a/doc/doc_files/createconeconstraintex.html +++ b/doc/doc_files/createconeconstraintex.html @@ -3,11 +3,11 @@ - createConeConstraintEx [RCBasic Doc] + CreateConeConstraintEx [RCBasic Doc] -

function createConeConstraintEx( actorA, actorB, rbAFrame_matrix, rbBFrame_matrix)

+

Function CreateConeConstraintEx( actorA, actorB, rbAFrame_matrix, rbBFrame_matrix)

The Cone Constraint is a type of joint constraint used to simulate realistic rotational movement between two actors (or between an actor and the world) with specific angular limits. This constraint is especially useful for simulating ball-and-socket joints with some twisting freedom but restricted cone-like movement, such as human shoulders or robotic arms.

@@ -34,6 +34,7 @@ SetMatrixRotation

+

\ No newline at end of file diff --git a/doc/doc_files/createconemesh.html b/doc/doc_files/createconemesh.html index 4c829fc..cbb9181 100644 --- a/doc/doc_files/createconemesh.html +++ b/doc/doc_files/createconemesh.html @@ -12,6 +12,7 @@ Create a cone mesh

+

\ No newline at end of file diff --git a/doc/doc_files/createcubeactor.html b/doc/doc_files/createcubeactor.html index b5bccbe..ac01e8c 100644 --- a/doc/doc_files/createcubeactor.html +++ b/doc/doc_files/createcubeactor.html @@ -7,7 +7,7 @@ -

function CreateCubeActor( cube_size )

+

Function CreateCubeActor( cube_size )

Returns an actor with a cube mesh of the specified size ( cube_size x cube_size x cube_size )

@@ -21,6 +21,7 @@ CreateTerrainActor

+

\ No newline at end of file diff --git a/doc/doc_files/createcylindermesh.html b/doc/doc_files/createcylindermesh.html index a084b04..32dc1eb 100644 --- a/doc/doc_files/createcylindermesh.html +++ b/doc/doc_files/createcylindermesh.html @@ -12,6 +12,7 @@ Create a cylinder mesh

+

\ No newline at end of file diff --git a/doc/doc_files/createdistancejoint.html b/doc/doc_files/createdistancejoint.html index 8399d24..b30f7cb 100644 --- a/doc/doc_files/createdistancejoint.html +++ b/doc/doc_files/createdistancejoint.html @@ -3,11 +3,11 @@ - createDistanceJoint [RCBasic Doc] + CreateDistanceJoint [RCBasic Doc] -

function createDistanceJoint( spriteA, spriteB, aX, aY, bX, bY, collide_connect)

+

Function CreateDistanceJoint( spriteA, spriteB, aX, aY, bX, bY, collide_connect)

Creates a distance joint

@@ -32,6 +32,7 @@

+

\ No newline at end of file diff --git a/doc/doc_files/createfrictionjoint.html b/doc/doc_files/createfrictionjoint.html index a8365fd..1b48930 100644 --- a/doc/doc_files/createfrictionjoint.html +++ b/doc/doc_files/createfrictionjoint.html @@ -3,11 +3,11 @@ - createFrictionJoint [RCBasic Doc] + CreateFrictionJoint [RCBasic Doc] -

function createFrictionJoint( spriteA, spriteB, x, y, collide_connect)

+

Function CreateFrictionJoint( spriteA, spriteB, x, y, collide_connect)

Creates a Friction Joint

@@ -29,6 +29,7 @@

+

\ No newline at end of file diff --git a/doc/doc_files/creategearjoint.html b/doc/doc_files/creategearjoint.html index d8917f5..b74eecd 100644 --- a/doc/doc_files/creategearjoint.html +++ b/doc/doc_files/creategearjoint.html @@ -3,11 +3,11 @@ - createGearJoint [RCBasic Doc] + CreateGearJoint [RCBasic Doc] -

function createGearJoint( jointA, jointB, g_ratio, collide_connect)

+

Function CreateGearJoint( jointA, jointB, g_ratio, collide_connect)

Creates a Gear Joint

@@ -29,6 +29,7 @@

+

\ No newline at end of file diff --git a/doc/doc_files/createhingeconstraint.html b/doc/doc_files/createhingeconstraint.html index 9c39af8..dc16205 100644 --- a/doc/doc_files/createhingeconstraint.html +++ b/doc/doc_files/createhingeconstraint.html @@ -7,7 +7,7 @@ -

function CreateHingeConstraint( actorA, frameA, useReferenceFrameA )

+

Function CreateHingeConstraint( actorA, frameA, useReferenceFrameA )

Simulates a hinge joint, which allows two actors (or an actor and the world) to rotate around a single axis while restricting movement along the other axes. This is similar to the way a door swings on its hinges or how an elbow joint functions in the human body.

@@ -28,6 +28,7 @@ SetMatrixRotation

+

\ No newline at end of file diff --git a/doc/doc_files/createhingeconstraintex.html b/doc/doc_files/createhingeconstraintex.html index 9e1e9bd..852154d 100644 --- a/doc/doc_files/createhingeconstraintex.html +++ b/doc/doc_files/createhingeconstraintex.html @@ -34,6 +34,7 @@ SetMatrixRotation

+

\ No newline at end of file diff --git a/doc/doc_files/createimage.html b/doc/doc_files/createimage.html index 1bb8d4f..5ed3061 100644 --- a/doc/doc_files/createimage.html +++ b/doc/doc_files/createimage.html @@ -7,7 +7,7 @@ -

function CreateImage(w, h, byref buffer)

+

Function CreateImage(w, h, ByRef buffer)

Returns an image created from the buffer provided

@@ -16,6 +16,7 @@ LoadImage

+

\ No newline at end of file diff --git a/doc/doc_files/createimageex.html b/doc/doc_files/createimageex.html index ca754eb..bf10d1d 100644 --- a/doc/doc_files/createimageex.html +++ b/doc/doc_files/createimageex.html @@ -3,11 +3,11 @@ - createImageEx [RCBasic Doc] + CreateImageEx [RCBasic Doc] -

function createImageEx(w, h, byref buffer, color)

+

Function CreateImageEx(w, h, ByRef buffer, color)

Returns an image created from the buffer provided

@@ -19,6 +19,7 @@ LoadImage

+

\ No newline at end of file diff --git a/doc/doc_files/createlightactor.html b/doc/doc_files/createlightactor.html index 46d9463..a621c2e 100644 --- a/doc/doc_files/createlightactor.html +++ b/doc/doc_files/createlightactor.html @@ -7,7 +7,7 @@ -

function CreateLightActor( )

+

Function CreateLightActor( )

Returns a new light in the scene

@@ -21,6 +21,7 @@ CreateTerrainActor

+

\ No newline at end of file diff --git a/doc/doc_files/creatematerial.html b/doc/doc_files/creatematerial.html index 262368d..bdae445 100644 --- a/doc/doc_files/creatematerial.html +++ b/doc/doc_files/creatematerial.html @@ -3,15 +3,16 @@ - createMaterial [RCBasic Doc] + CreateMaterial [RCBasic Doc] -

function createMaterial()

+

Function CreateMaterial()

Returns a new material

+

\ No newline at end of file diff --git a/doc/doc_files/createmesh.html b/doc/doc_files/createmesh.html index 023391d..6395fb6 100644 --- a/doc/doc_files/createmesh.html +++ b/doc/doc_files/createmesh.html @@ -7,11 +7,12 @@ -

function CreateMesh( )

+

Function CreateMesh( )

Returns a new mesh

+

\ No newline at end of file diff --git a/doc/doc_files/createmotorjoint.html b/doc/doc_files/createmotorjoint.html index 68fb28d..2552332 100644 --- a/doc/doc_files/createmotorjoint.html +++ b/doc/doc_files/createmotorjoint.html @@ -3,11 +3,11 @@ - createMotorJoint [RCBasic Doc] + CreateMotorJoint [RCBasic Doc] -

function createMotorJoint( spriteA, spriteB, collide_connect)

+

Function CreateMotorJoint( spriteA, spriteB, collide_connect)

Creates a Motor Joint

@@ -15,6 +15,7 @@ A motor joint is used to control the relative motion between two bodies. A typical usage is to control the movement of a dynamic body with respect to the ground.

+

\ No newline at end of file diff --git a/doc/doc_files/createoctreeactor.html b/doc/doc_files/createoctreeactor.html index f98ec0b..de63977 100644 --- a/doc/doc_files/createoctreeactor.html +++ b/doc/doc_files/createoctreeactor.html @@ -7,7 +7,7 @@ -

function CreateOctreeActor( mesh )

+

Function CreateOctreeActor( mesh )

Returns a mesh actor optimized for large objects (such as levels)

@@ -28,6 +28,7 @@ CreateTerrainActor

+

\ No newline at end of file diff --git a/doc/doc_files/createparticleactor.html b/doc/doc_files/createparticleactor.html index df45f38..8251e7d 100644 --- a/doc/doc_files/createparticleactor.html +++ b/doc/doc_files/createparticleactor.html @@ -7,7 +7,7 @@ -

function CreateParticleActor( particle_type )

+

Function CreateParticleActor( particle_type )

Returns a new particle actor

@@ -44,6 +44,7 @@ CreateTerrainActor

+

\ No newline at end of file diff --git a/doc/doc_files/createplanemesh.html b/doc/doc_files/createplanemesh.html index 3967e52..ed765bd 100644 --- a/doc/doc_files/createplanemesh.html +++ b/doc/doc_files/createplanemesh.html @@ -7,7 +7,7 @@ -

Function CreatePlaneMesh( w, h, tileCount_w, tileCount_h )

+

Function CreatePlaneMesh( w, h, tileCount_w, tileCount_h, txRepeat_x, txRepeat_y )

Creates a flat plane

@@ -18,8 +18,12 @@
  • tileCount_w, TileCount_h - The number of subdivisions across and down the plane
    • +
  • + txRepeat_x, txRepeat_y - The number of times to repeat the texture across and down the plane +

    • +

    \ No newline at end of file diff --git a/doc/doc_files/createpointconstraint.html b/doc/doc_files/createpointconstraint.html index a199c13..017a2b4 100644 --- a/doc/doc_files/createpointconstraint.html +++ b/doc/doc_files/createpointconstraint.html @@ -15,6 +15,7 @@ CreatePointConstraintEx

    +

    \ No newline at end of file diff --git a/doc/doc_files/createpointconstraintex.html b/doc/doc_files/createpointconstraintex.html index 1741ed2..6c1e38e 100644 --- a/doc/doc_files/createpointconstraintex.html +++ b/doc/doc_files/createpointconstraintex.html @@ -7,7 +7,7 @@ -

    function CreatePointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB)

    +

    Function CreatePointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB)

    A type of constraint that allows two actors (or an actor and the world) to move freely relative to each other while ensuring that one point on each body remains coincident. Essentially, it ensures that the two actors stay connected at a single point, but without restricting their relative rotations. This kind of constraint is useful when you need a connection that allows full rotation in all directions, such as a pendulum, ball joint, or even some suspension systems.

    @@ -15,6 +15,7 @@ CreatePointConstraint

    +

    \ No newline at end of file diff --git a/doc/doc_files/createprismaticjoint.html b/doc/doc_files/createprismaticjoint.html index ded3010..14ac75c 100644 --- a/doc/doc_files/createprismaticjoint.html +++ b/doc/doc_files/createprismaticjoint.html @@ -3,11 +3,11 @@ - createPrismaticJoint [RCBasic Doc] + CreatePrismaticJoint [RCBasic Doc] -

    function createPrismaticJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect)

    +

    Function CreatePrismaticJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect)

    Creates a Prismatic Joint

    @@ -32,6 +32,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/createprojectoractor.html b/doc/doc_files/createprojectoractor.html index d00b134..ad2c638 100644 --- a/doc/doc_files/createprojectoractor.html +++ b/doc/doc_files/createprojectoractor.html @@ -15,6 +15,7 @@ Projector actors can be used to project a texture over objects in its field of view.

    +

    \ No newline at end of file diff --git a/doc/doc_files/createpulleyjoint.html b/doc/doc_files/createpulleyjoint.html index 2132eac..755b4b5 100644 --- a/doc/doc_files/createpulleyjoint.html +++ b/doc/doc_files/createpulleyjoint.html @@ -3,11 +3,11 @@ - createPulleyJoint [RCBasic Doc] + CreatePulleyJoint [RCBasic Doc] -

    function createPulleyJoint( spriteA, spriteB, gaX, gaY, gbX, gbY, aX, aY, bX, bY, j_ratio, collide_connect)

    +

    Function CreatePulleyJoint( spriteA, spriteB, gaX, gaY, gbX, gbY, aX, aY, bX, bY, j_ratio, collide_connect)

    Creates a pulley joint

    @@ -15,6 +15,7 @@ The pulley joint is connected to two bodies and two fixed ground points. The pulley supports a ratio such that: length1 + ratio * length2 <= constant Yes, the force transmitted is scaled by the ratio. Warning: the pulley joint can get a bit squirrelly by itself. They often work better when combined with prismatic joints. You should also cover the the anchor points with static shapes to prevent one side from going to zero length.

    +

    \ No newline at end of file diff --git a/doc/doc_files/createrevolutejoint.html b/doc/doc_files/createrevolutejoint.html index 4dabc72..85c4ede 100644 --- a/doc/doc_files/createrevolutejoint.html +++ b/doc/doc_files/createrevolutejoint.html @@ -3,11 +3,11 @@ - createRevoluteJoint [RCBasic Doc] + CreateRevoluteJoint [RCBasic Doc] -

    function createRevoluteJoint( spriteA, spriteB, x, y, collide_connect)

    +

    Function CreateRevoluteJoint( spriteA, spriteB, x, y, collide_connect)

    Creates a revolute joint

    @@ -15,6 +15,7 @@ A revolute joint constrains two bodies to share a common point while they are free to rotate about the point. The relative rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is provided so that infinite forces are not generated.

    +

    \ No newline at end of file diff --git a/doc/doc_files/createslideconstraint.html b/doc/doc_files/createslideconstraint.html index 2db0edc..ecc1992 100644 --- a/doc/doc_files/createslideconstraint.html +++ b/doc/doc_files/createslideconstraint.html @@ -7,7 +7,7 @@ -

    function CreateSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA)

    +

    Function CreateSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA)

    A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems.

    @@ -29,6 +29,7 @@ SetMatrixRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/createslideconstraintex.html b/doc/doc_files/createslideconstraintex.html index b139388..d1cc65b 100644 --- a/doc/doc_files/createslideconstraintex.html +++ b/doc/doc_files/createslideconstraintex.html @@ -7,7 +7,7 @@ -

    function CreateSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA)

    +

    Function CreateSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA)

    A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems.

    @@ -35,6 +35,7 @@ SetMatrixRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/createsound.html b/doc/doc_files/createsound.html index f0e836a..a818fed 100644 --- a/doc/doc_files/createsound.html +++ b/doc/doc_files/createsound.html @@ -7,11 +7,12 @@ -

    function CreateSound(byref buffer, buffer_size, vol)

    +

    Function CreateSound(ByRef buffer, buffer_size, vol)

    Returns a new sound from a buffer of raw audio data

    +

    \ No newline at end of file diff --git a/doc/doc_files/createsphereactor.html b/doc/doc_files/createsphereactor.html index 78b54cd..1d1e250 100644 --- a/doc/doc_files/createsphereactor.html +++ b/doc/doc_files/createsphereactor.html @@ -7,7 +7,7 @@ -

    function CreateSphereActor( radius )

    +

    Function CreateSphereActor( radius )

    Returns an actor composed of a sphere mesh

    @@ -21,6 +21,7 @@ CreateTerrainActor

    +

    \ No newline at end of file diff --git a/doc/doc_files/createsprite.html b/doc/doc_files/createsprite.html index 03b9790..5ee5b2b 100644 --- a/doc/doc_files/createsprite.html +++ b/doc/doc_files/createsprite.html @@ -7,7 +7,7 @@ -

    function CreateSprite( img, frame_w, frame_h )

    +

    Function CreateSprite( img, frame_w, frame_h )

    This function returns a new sprite which you can place in a variable for use in your program.

    @@ -47,6 +47,7 @@ SetSpritePosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/createspriteanimation.html b/doc/doc_files/createspriteanimation.html index 86e6406..c85c53c 100644 --- a/doc/doc_files/createspriteanimation.html +++ b/doc/doc_files/createspriteanimation.html @@ -20,6 +20,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/createstack_n.html b/doc/doc_files/createstack_n.html index 0636ce1..17b661b 100644 --- a/doc/doc_files/createstack_n.html +++ b/doc/doc_files/createstack_n.html @@ -7,11 +7,12 @@ -

    function CreateStack_N( )

    +

    Function CreateStack_N( )

    Returns a new number stack

    +

    \ No newline at end of file diff --git a/doc/doc_files/createstack_s.html b/doc/doc_files/createstack_s.html index 5f954c2..44f1ce0 100644 --- a/doc/doc_files/createstack_s.html +++ b/doc/doc_files/createstack_s.html @@ -7,11 +7,12 @@ -

    function CreateStack_S()

    +

    Function CreateStack_S()

    Returns a new string stack

    +

    \ No newline at end of file diff --git a/doc/doc_files/createterrainactor.html b/doc/doc_files/createterrainactor.html index d100dea..e6180a9 100644 --- a/doc/doc_files/createterrainactor.html +++ b/doc/doc_files/createterrainactor.html @@ -7,7 +7,7 @@ -

    function CreateTerrainActor( hmap_file$ )

    +

    Function CreateTerrainActor( hmap_file$ )

    Returns terrain generated from a height map

    @@ -24,6 +24,7 @@ CreateBillboardActor

    +

    \ No newline at end of file diff --git a/doc/doc_files/createtilemap.html b/doc/doc_files/createtilemap.html index 5e0604a..cfb57da 100644 --- a/doc/doc_files/createtilemap.html +++ b/doc/doc_files/createtilemap.html @@ -29,6 +29,7 @@ CreateTileSet

    +

    \ No newline at end of file diff --git a/doc/doc_files/createtileset.html b/doc/doc_files/createtileset.html index df195b4..29a9e82 100644 --- a/doc/doc_files/createtileset.html +++ b/doc/doc_files/createtileset.html @@ -88,6 +88,7 @@ DrawTileMap

    +

    \ No newline at end of file diff --git a/doc/doc_files/createvolumelightmesh.html b/doc/doc_files/createvolumelightmesh.html index 9be4dbd..54a4d5d 100644 --- a/doc/doc_files/createvolumelightmesh.html +++ b/doc/doc_files/createvolumelightmesh.html @@ -12,6 +12,7 @@ Create a mesh to represent a light volume.

    +

    \ No newline at end of file diff --git a/doc/doc_files/createwateractor.html b/doc/doc_files/createwateractor.html index 2fbf096..f3d80c9 100644 --- a/doc/doc_files/createwateractor.html +++ b/doc/doc_files/createwateractor.html @@ -7,7 +7,7 @@ -

    function CreateWaterActor( mesh, waveHeight, waveSpeed, waveLength )

    +

    Function CreateWaterActor( mesh, waveHeight, waveSpeed, waveLength )

    Creates an actor with water properties set on a base mesh

    @@ -21,6 +21,7 @@ CreateTerrainActor

    +

    \ No newline at end of file diff --git a/doc/doc_files/createweldjoint.html b/doc/doc_files/createweldjoint.html index 96a885a..23f2367 100644 --- a/doc/doc_files/createweldjoint.html +++ b/doc/doc_files/createweldjoint.html @@ -3,11 +3,11 @@ - createWeldJoint [RCBasic Doc] + CreateWeldJoint [RCBasic Doc] -

    function createWeldJoint( spriteA, spriteB, x, y, collide_connect)

    +

    Function CreateWeldJoint( spriteA, spriteB, x, y, collide_connect)

    Creates a Weld Joint

    @@ -15,6 +15,7 @@ A weld joint essentially glues two bodies together. A weld joint may distort somewhat because the island constraint solver is approximate.

    +

    \ No newline at end of file diff --git a/doc/doc_files/createwheeljoint.html b/doc/doc_files/createwheeljoint.html index 0b74ef5..e3ec3a8 100644 --- a/doc/doc_files/createwheeljoint.html +++ b/doc/doc_files/createwheeljoint.html @@ -3,11 +3,11 @@ - createWheelJoint [RCBasic Doc] + CreateWheelJoint [RCBasic Doc] -

    function createWheelJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect)

    +

    Function CreateWheelJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect)

    Creates a wheel joint.

    @@ -15,6 +15,7 @@ A wheel joint. This joint provides two degrees of freedom: translation along an axis fixed in bodyA and rotation in the plane. In other words, it is a point to line constraint with a rotational motor and a linear spring/damper. The spring/damper is initialized upon creation. This joint is designed for vehicle suspensions.

    +

    \ No newline at end of file diff --git a/doc/doc_files/cubematrix.html b/doc/doc_files/cubematrix.html index fd8344c..ca31afb 100644 --- a/doc/doc_files/cubematrix.html +++ b/doc/doc_files/cubematrix.html @@ -7,11 +7,12 @@ -

    function CubeMatrix(mA, mB)

    +

    Function CubeMatrix(mA, mB)

    Returns matrix mA raised to the 3rd power

    +

    \ No newline at end of file diff --git a/doc/doc_files/date.html b/doc/doc_files/date.html index 4ce196c..254264f 100644 --- a/doc/doc_files/date.html +++ b/doc/doc_files/date.html @@ -7,11 +7,12 @@ -

    function Date$()

    +

    Function Date$()

    Returns the date in "MM-DD-YYYY" format

    +

    \ No newline at end of file diff --git a/doc/doc_files/degrees.html b/doc/doc_files/degrees.html index 8c331fc..4fd1a35 100644 --- a/doc/doc_files/degrees.html +++ b/doc/doc_files/degrees.html @@ -7,11 +7,12 @@ -

    function Degrees(r)

    +

    Function Degrees(r)

    Returns angle converted from radians to degrees

    +

    \ No newline at end of file diff --git a/doc/doc_files/deleteactor.html b/doc/doc_files/deleteactor.html index 7efb430..fc79e51 100644 --- a/doc/doc_files/deleteactor.html +++ b/doc/doc_files/deleteactor.html @@ -7,7 +7,7 @@ -

    sub DeleteActor( actor )

    +

    Sub DeleteActor( actor )

    Removes an actor from the scene and frees its memory

    @@ -15,6 +15,7 @@ NOTE: Actors are all removed on clearScene so make sure you don't continue using the id after that.

    +

    \ No newline at end of file diff --git a/doc/doc_files/deleteactoranimation.html b/doc/doc_files/deleteactoranimation.html index 89436d3..4bdc6c9 100644 --- a/doc/doc_files/deleteactoranimation.html +++ b/doc/doc_files/deleteactoranimation.html @@ -7,11 +7,12 @@ -

    sub DeleteActorAnimation(actor, animation)

    +

    Sub DeleteActorAnimation(actor, animation)

    Deletes an actor's animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletean8.html b/doc/doc_files/deletean8.html index 558a75f..3908440 100644 --- a/doc/doc_files/deletean8.html +++ b/doc/doc_files/deletean8.html @@ -12,6 +12,7 @@ Clears a anim8or project from program memory.

    +

    \ No newline at end of file diff --git a/doc/doc_files/deleteconstraint.html b/doc/doc_files/deleteconstraint.html index 2dca7ba..a90fd26 100644 --- a/doc/doc_files/deleteconstraint.html +++ b/doc/doc_files/deleteconstraint.html @@ -12,6 +12,7 @@ Removes a constraint

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletefont.html b/doc/doc_files/deletefont.html index 65a1bca..985e627 100644 --- a/doc/doc_files/deletefont.html +++ b/doc/doc_files/deletefont.html @@ -12,6 +12,7 @@ Frees a font from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deleteimage.html b/doc/doc_files/deleteimage.html index 507d13f..615dee8 100644 --- a/doc/doc_files/deleteimage.html +++ b/doc/doc_files/deleteimage.html @@ -12,6 +12,7 @@ Removes an image from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletejoint.html b/doc/doc_files/deletejoint.html index d2f63f4..224b08c 100644 --- a/doc/doc_files/deletejoint.html +++ b/doc/doc_files/deletejoint.html @@ -23,6 +23,7 @@ CreateWheelJoint

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletematerial.html b/doc/doc_files/deletematerial.html index 9a41461..00350f7 100644 --- a/doc/doc_files/deletematerial.html +++ b/doc/doc_files/deletematerial.html @@ -15,6 +15,7 @@ NOTE: In the case of actor materials, this will simple drop the reference to it but it will not remove the material from the actor.

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletematrix.html b/doc/doc_files/deletematrix.html index 3cd8f16..f78f803 100644 --- a/doc/doc_files/deletematrix.html +++ b/doc/doc_files/deletematrix.html @@ -12,6 +12,7 @@ Frees a matrix from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletematrixcolumns.html b/doc/doc_files/deletematrixcolumns.html index 1d62c02..89fc6c3 100644 --- a/doc/doc_files/deletematrixcolumns.html +++ b/doc/doc_files/deletematrixcolumns.html @@ -7,7 +7,7 @@ -

    function DeleteMatrixColumns(mA, c, num_cols)

    +

    Function DeleteMatrixColumns(mA, c, num_cols)

    Removes the specified columns from a matrix

    @@ -18,6 +18,7 @@ DeleteMatrixRows

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletematrixrows.html b/doc/doc_files/deletematrixrows.html index 9744bbd..e751f33 100644 --- a/doc/doc_files/deletematrixrows.html +++ b/doc/doc_files/deletematrixrows.html @@ -7,7 +7,7 @@ -

    function DeleteMatrixRows(mA, r, num_rows)

    +

    Function DeleteMatrixRows(mA, r, num_rows)

    Removes the specified rows from a matrix

    @@ -18,6 +18,7 @@ DeleteMatrixColumns

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletemesh.html b/doc/doc_files/deletemesh.html index 97df4d5..4235358 100644 --- a/doc/doc_files/deletemesh.html +++ b/doc/doc_files/deletemesh.html @@ -7,11 +7,12 @@ -

    sub DeleteMesh( mesh )

    +

    Sub DeleteMesh( mesh )

    Removes a mesh from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletemusic.html b/doc/doc_files/deletemusic.html index e4ce76d..c40d010 100644 --- a/doc/doc_files/deletemusic.html +++ b/doc/doc_files/deletemusic.html @@ -7,11 +7,12 @@ -

    sub DeleteMusic()

    +

    Sub DeleteMusic()

    Removes the current music track from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletesound.html b/doc/doc_files/deletesound.html index 030955e..17a3266 100644 --- a/doc/doc_files/deletesound.html +++ b/doc/doc_files/deletesound.html @@ -7,11 +7,12 @@ -

    sub DeleteSound(snd)

    +

    Sub DeleteSound(snd)

    Removes a sound from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletesprite.html b/doc/doc_files/deletesprite.html index f80ae44..bd568d6 100644 --- a/doc/doc_files/deletesprite.html +++ b/doc/doc_files/deletesprite.html @@ -58,6 +58,7 @@ CreateSprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletespriteanimation.html b/doc/doc_files/deletespriteanimation.html index b548c7b..9a16217 100644 --- a/doc/doc_files/deletespriteanimation.html +++ b/doc/doc_files/deletespriteanimation.html @@ -15,6 +15,7 @@ CreateSpriteAnimation

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletestack_n.html b/doc/doc_files/deletestack_n.html index 789e58c..aea8559 100644 --- a/doc/doc_files/deletestack_n.html +++ b/doc/doc_files/deletestack_n.html @@ -7,11 +7,12 @@ -

    sub DeleteStack_N( num_stack )

    +

    Sub DeleteStack_N( num_stack )

    Removes a number stack from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletestack_s.html b/doc/doc_files/deletestack_s.html index 2ae26e7..f88d2f4 100644 --- a/doc/doc_files/deletestack_s.html +++ b/doc/doc_files/deletestack_s.html @@ -7,11 +7,12 @@ -

    sub DeleteStack_S( str_stack )

    +

    Sub DeleteStack_S( str_stack )

    Removes a string stack from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletetilemap.html b/doc/doc_files/deletetilemap.html index fc1d742..2bbbca3 100644 --- a/doc/doc_files/deletetilemap.html +++ b/doc/doc_files/deletetilemap.html @@ -9,6 +9,7 @@

    Sub DeleteTileMap(tilemap)

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletetileset.html b/doc/doc_files/deletetileset.html index 926b1ea..6317faa 100644 --- a/doc/doc_files/deletetileset.html +++ b/doc/doc_files/deletetileset.html @@ -9,6 +9,7 @@

    Sub DeleteTileSet(tileset)

    +

    \ No newline at end of file diff --git a/doc/doc_files/deletevideo.html b/doc/doc_files/deletevideo.html index 7367586..7c756f4 100644 --- a/doc/doc_files/deletevideo.html +++ b/doc/doc_files/deletevideo.html @@ -7,11 +7,12 @@ -

    sub DeleteVideo()

    +

    Sub DeleteVideo()

    Removes the current video track from memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/determinant.html b/doc/doc_files/determinant.html index 8f746eb..8221d9c 100644 --- a/doc/doc_files/determinant.html +++ b/doc/doc_files/determinant.html @@ -7,11 +7,12 @@ -

    function Determinant(mA)

    +

    Function Determinant(mA)

    Returns the determinant of matrix mA

    +

    \ No newline at end of file diff --git a/doc/doc_files/dimmatrix.html b/doc/doc_files/dimmatrix.html index 3131ae5..9fd2e9e 100644 --- a/doc/doc_files/dimmatrix.html +++ b/doc/doc_files/dimmatrix.html @@ -7,11 +7,12 @@ -

    function DimMatrix(m_rows, m_cols)

    +

    Function DimMatrix(m_rows, m_cols)

    Returns a new matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/dir.html b/doc/doc_files/dir.html index bf59ec9..fa495ab 100644 --- a/doc/doc_files/dir.html +++ b/doc/doc_files/dir.html @@ -7,11 +7,12 @@ -

    function Dir$()

    +

    Function Dir$()

    Returns the current working directory

    +

    \ No newline at end of file diff --git a/doc/doc_files/direxists.html b/doc/doc_files/direxists.html index ec8a462..17b6679 100644 --- a/doc/doc_files/direxists.html +++ b/doc/doc_files/direxists.html @@ -7,11 +7,12 @@ -

    function DirExists(p$)

    +

    Function DirExists(p$)

    Returns true if a directory exists and false if not

    +

    \ No newline at end of file diff --git a/doc/doc_files/dirfirst.html b/doc/doc_files/dirfirst.html index a78ca29..1c476e3 100644 --- a/doc/doc_files/dirfirst.html +++ b/doc/doc_files/dirfirst.html @@ -7,11 +7,12 @@ -

    function DirFirst$()

    +

    Function DirFirst$()

    Resets the directory list poll and returns the first item in the current working directory

    +

    \ No newline at end of file diff --git a/doc/doc_files/dirnext.html b/doc/doc_files/dirnext.html index 7ed0d9a..2a7fbfb 100644 --- a/doc/doc_files/dirnext.html +++ b/doc/doc_files/dirnext.html @@ -7,7 +7,7 @@ -

    function DirNext$()

    +

    Function DirNext$()

    Returns the next item in the directory poll

    @@ -15,6 +15,7 @@ DirFirst$

    +

    \ No newline at end of file diff --git a/doc/doc_files/distance2d.html b/doc/doc_files/distance2d.html index 666e16a..1281e6c 100644 --- a/doc/doc_files/distance2d.html +++ b/doc/doc_files/distance2d.html @@ -12,6 +12,7 @@ Returns the distance between 2 points in 2d space

    +

    \ No newline at end of file diff --git a/doc/doc_files/distance3d.html b/doc/doc_files/distance3d.html index d306216..62980ba 100644 --- a/doc/doc_files/distance3d.html +++ b/doc/doc_files/distance3d.html @@ -12,6 +12,7 @@ Returns the distance between 2 points in 3d space

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage.html b/doc/doc_files/drawimage.html index 1225ee6..4b6d4e4 100644 --- a/doc/doc_files/drawimage.html +++ b/doc/doc_files/drawimage.html @@ -7,11 +7,12 @@ -

    sub DrawImage(img, x, y)

    +

    Sub DrawImage(img, x, y)

    Draws an image on the active canvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_blit.html b/doc/doc_files/drawimage_blit.html index 05937c5..a9b679c 100644 --- a/doc/doc_files/drawimage_blit.html +++ b/doc/doc_files/drawimage_blit.html @@ -7,11 +7,12 @@ -

    sub DrawImage_Blit(img, x, y, src_x, src_y, src_w, src_h)

    +

    Sub DrawImage_Blit(img, x, y, src_x, src_y, src_w, src_h)

    Draws a portion of an image to the current canvas.

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_blitex.html b/doc/doc_files/drawimage_blitex.html index 3827d66..eb1a905 100644 --- a/doc/doc_files/drawimage_blitex.html +++ b/doc/doc_files/drawimage_blitex.html @@ -7,7 +7,7 @@ -

    sub DrawImage_BlitEx(slot, x, y, w, h, src_x, src_y, src_w, src_h)

    +

    Sub DrawImage_BlitEx(slot, x, y, w, h, src_x, src_y, src_w, src_h)

    Draws a portion of an image to the current canvas scaled to a given width and height.

    @@ -15,6 +15,7 @@ DrawImage_Blit

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_flip.html b/doc/doc_files/drawimage_flip.html index b7ed61e..60e2347 100644 --- a/doc/doc_files/drawimage_flip.html +++ b/doc/doc_files/drawimage_flip.html @@ -7,7 +7,7 @@ -

    sub DrawImage_Flip(slot, x, y, h, v)

    +

    Sub DrawImage_Flip(slot, x, y, h, v)

    Draws an image flipped horizontally or vertically.

    @@ -18,6 +18,7 @@ DrawImage_FlipEx

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_flipex.html b/doc/doc_files/drawimage_flipex.html index dfa3595..741a97e 100644 --- a/doc/doc_files/drawimage_flipex.html +++ b/doc/doc_files/drawimage_flipex.html @@ -7,7 +7,7 @@ -

    sub DrawImage_FlipEx(slot, x, y, src_x, src_y, src_w, src_h, h, v)

    +

    Sub DrawImage_FlipEx(slot, x, y, src_x, src_y, src_w, src_h, h, v)

    Draws a portion of an image flipped horizontally or vertically.

    @@ -18,6 +18,7 @@ DrawImage_Flip

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_rotate.html b/doc/doc_files/drawimage_rotate.html index 363f5ef..e0e1183 100644 --- a/doc/doc_files/drawimage_rotate.html +++ b/doc/doc_files/drawimage_rotate.html @@ -7,11 +7,12 @@ -

    sub DrawImage_Rotate(slot, x, y, angle)

    +

    Sub DrawImage_Rotate(slot, x, y, angle)

    Draws an image to the current canvas rotated by a given angle.

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_rotateex.html b/doc/doc_files/drawimage_rotateex.html index ea696db..732526b 100644 --- a/doc/doc_files/drawimage_rotateex.html +++ b/doc/doc_files/drawimage_rotateex.html @@ -7,11 +7,12 @@ -

    sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle)

    +

    Sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle)

    Draws a portion of an image to the current canvas rotated by a given angle.

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_rotozoom.html b/doc/doc_files/drawimage_rotozoom.html index aa375ab..7933b3a 100644 --- a/doc/doc_files/drawimage_rotozoom.html +++ b/doc/doc_files/drawimage_rotozoom.html @@ -7,11 +7,12 @@ -

    sub DrawImage_Rotozoom(slot, x, y, angle, zx, zy)

    +

    Sub DrawImage_Rotozoom(slot, x, y, angle, zx, zy)

    Draws an image to the current canvas rotated and scaled

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_rotozoomex.html b/doc/doc_files/drawimage_rotozoomex.html index 9f3a9f7..21e1b90 100644 --- a/doc/doc_files/drawimage_rotozoomex.html +++ b/doc/doc_files/drawimage_rotozoomex.html @@ -7,11 +7,12 @@ -

    sub DrawImage_RotozoomEx(slot, x, y, src_x, src_y, src_w, src_h, angle, zx, zy)

    +

    Sub DrawImage_RotozoomEx(slot, x, y, src_x, src_y, src_w, src_h, angle, zx, zy)

    Draws a portion of an image to the current canvas rotated and scaled

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_zoom.html b/doc/doc_files/drawimage_zoom.html index 12bde10..77a7670 100644 --- a/doc/doc_files/drawimage_zoom.html +++ b/doc/doc_files/drawimage_zoom.html @@ -7,7 +7,7 @@ -

    sub DrawImage_Zoom(slot, x, y, zx, zy)

    +

    Sub DrawImage_Zoom(slot, x, y, zx, zy)

    Draws an image to the current canvas scaled by a given factor

    @@ -15,6 +15,7 @@ DrawImage_ZoomEx

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawimage_zoomex.html b/doc/doc_files/drawimage_zoomex.html index 49eb29b..ea493f5 100644 --- a/doc/doc_files/drawimage_zoomex.html +++ b/doc/doc_files/drawimage_zoomex.html @@ -7,7 +7,7 @@ -

    sub DrawImage_ZoomEx(slot, x, y, src_x, src_y, src_w, src_h, zx, zy)

    +

    Sub DrawImage_ZoomEx(slot, x, y, src_x, src_y, src_w, src_h, zx, zy)

    Draws a portion of an Image to the current canvas scaled by a given factor

    @@ -15,6 +15,7 @@ DrawImage_Zoom

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawtext.html b/doc/doc_files/drawtext.html index a9deca0..98e5999 100644 --- a/doc/doc_files/drawtext.html +++ b/doc/doc_files/drawtext.html @@ -7,11 +7,12 @@ -

    sub DrawText(txt$, x, y)

    +

    Sub DrawText(txt$, x, y)

    Draws text to the current canvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/drawtilemap.html b/doc/doc_files/drawtilemap.html index 460bc56..032103d 100644 --- a/doc/doc_files/drawtilemap.html +++ b/doc/doc_files/drawtilemap.html @@ -32,6 +32,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/easter.html b/doc/doc_files/easter.html index eea5013..dc6baa1 100644 --- a/doc/doc_files/easter.html +++ b/doc/doc_files/easter.html @@ -7,11 +7,12 @@ -

    function Easter$(year)

    +

    Function Easter$(year)

    Returns easter of the year passed to it.

    +

    \ No newline at end of file diff --git a/doc/doc_files/ellipse.html b/doc/doc_files/ellipse.html index a0ceccf..2cea409 100644 --- a/doc/doc_files/ellipse.html +++ b/doc/doc_files/ellipse.html @@ -7,11 +7,12 @@ -

    sub Ellipse(x,y,rx,ry)

    +

    Sub Ellipse(x,y,rx,ry)

    Draws an ellipse on the current canvas.

    +

    \ No newline at end of file diff --git a/doc/doc_files/ellipsefill.html b/doc/doc_files/ellipsefill.html index c1d01d5..ccb7e85 100644 --- a/doc/doc_files/ellipsefill.html +++ b/doc/doc_files/ellipsefill.html @@ -7,11 +7,12 @@ -

    sub EllipseFill(x,y,rx,ry)

    +

    Sub EllipseFill(x,y,rx,ry)

    Draws a filled ellipse on the current canvas.

    +

    \ No newline at end of file diff --git a/doc/doc_files/enablejointlimit.html b/doc/doc_files/enablejointlimit.html index 0fb2cf1..50bd72d 100644 --- a/doc/doc_files/enablejointlimit.html +++ b/doc/doc_files/enablejointlimit.html @@ -3,11 +3,11 @@ - enableJointLimit [RCBasic Doc] + EnableJointLimit [RCBasic Doc] -

    sub enableJointLimit( joint_id, flag)

    +

    Sub EnableJointLimit( joint_id, flag)

    Enables or disables joint limits

    @@ -30,6 +30,7 @@ SetJointLimits

    +

    \ No newline at end of file diff --git a/doc/doc_files/enablejointmotor.html b/doc/doc_files/enablejointmotor.html index 53ea4f5..228b025 100644 --- a/doc/doc_files/enablejointmotor.html +++ b/doc/doc_files/enablejointmotor.html @@ -3,11 +3,11 @@ - enableJointMotor [RCBasic Doc] + EnableJointMotor [RCBasic Doc] -

    sub enableJointMotor( joint_id, flag)

    +

    Sub EnableJointMotor( joint_id, flag)

    Enables or disables the joint motor

    @@ -29,6 +29,7 @@ JointMotorIsEnabled

    +

    \ No newline at end of file diff --git a/doc/doc_files/env.html b/doc/doc_files/env.html index f6c9178..12920a8 100644 --- a/doc/doc_files/env.html +++ b/doc/doc_files/env.html @@ -7,7 +7,7 @@ -

    function Env$(v$)

    +

    Function Env$(v$)

    Returns the value of the environment variable passed to it.

    @@ -15,6 +15,7 @@ SetEnv

    +

    \ No newline at end of file diff --git a/doc/doc_files/eof.html b/doc/doc_files/eof.html index 32196f9..2a47dc3 100644 --- a/doc/doc_files/eof.html +++ b/doc/doc_files/eof.html @@ -7,11 +7,12 @@ -

    function EOF(stream)

    +

    Function EOF(stream)

    Returns true when end of file is reached

    +

    \ No newline at end of file diff --git a/doc/doc_files/evaljs.html b/doc/doc_files/evaljs.html index 1aece3f..8a9dd7c 100644 --- a/doc/doc_files/evaljs.html +++ b/doc/doc_files/evaljs.html @@ -18,6 +18,7 @@ NOTE: ONLY WORKS IN WEB PORT

    +

    \ No newline at end of file diff --git a/doc/doc_files/exp.html b/doc/doc_files/exp.html index 2939f85..3df49b0 100644 --- a/doc/doc_files/exp.html +++ b/doc/doc_files/exp.html @@ -7,11 +7,12 @@ -

    function Exp(n)

    +

    Function Exp(n)

    Returns the exponential function of a number.

    +

    \ No newline at end of file diff --git a/doc/doc_files/fademusicin.html b/doc/doc_files/fademusicin.html index 75dd72d..9df9e5a 100644 --- a/doc/doc_files/fademusicin.html +++ b/doc/doc_files/fademusicin.html @@ -7,11 +7,12 @@ -

    sub FadeMusicIn(fade_time, loops)

    +

    Sub FadeMusicIn(fade_time, loops)

    Fades music in

    +

    \ No newline at end of file diff --git a/doc/doc_files/fademusicout.html b/doc/doc_files/fademusicout.html index 6caa49a..b86afb4 100644 --- a/doc/doc_files/fademusicout.html +++ b/doc/doc_files/fademusicout.html @@ -7,11 +7,12 @@ -

    sub FadeMusicOut(fade_time)

    +

    Sub FadeMusicOut(fade_time)

    Fades music out

    +

    \ No newline at end of file diff --git a/doc/doc_files/fileexists.html b/doc/doc_files/fileexists.html index 2e68cd1..ee16526 100644 --- a/doc/doc_files/fileexists.html +++ b/doc/doc_files/fileexists.html @@ -7,11 +7,12 @@ -

    function FileExists(fileName$)

    +

    Function FileExists(fileName$)

    Returns true if a file exists

    +

    \ No newline at end of file diff --git a/doc/doc_files/filelength.html b/doc/doc_files/filelength.html index ac5bff7..51e7f09 100644 --- a/doc/doc_files/filelength.html +++ b/doc/doc_files/filelength.html @@ -7,11 +7,12 @@ -

    function FileLength(fileName$)

    +

    Function FileLength(fileName$)

    Returns the size of a file in bytes.

    +

    \ No newline at end of file diff --git a/doc/doc_files/fillmatrix.html b/doc/doc_files/fillmatrix.html index 7cc1386..8e6868c 100644 --- a/doc/doc_files/fillmatrix.html +++ b/doc/doc_files/fillmatrix.html @@ -7,11 +7,12 @@ -

    sub FillMatrix(mA, v)

    +

    Sub FillMatrix(mA, v)

    Fills matrix with the given value

    +

    \ No newline at end of file diff --git a/doc/doc_files/fillmatrixcolumns.html b/doc/doc_files/fillmatrixcolumns.html index 2bc96d0..798c9f5 100644 --- a/doc/doc_files/fillmatrixcolumns.html +++ b/doc/doc_files/fillmatrixcolumns.html @@ -7,11 +7,12 @@ -

    function FillMatrixColumns(mA, c, num_cols, v)

    +

    Function FillMatrixColumns(mA, c, num_cols, v)

    Fills matrix columns with the given value starting at the given column

    +

    \ No newline at end of file diff --git a/doc/doc_files/fillmatrixrows.html b/doc/doc_files/fillmatrixrows.html index 861894f..8200b09 100644 --- a/doc/doc_files/fillmatrixrows.html +++ b/doc/doc_files/fillmatrixrows.html @@ -7,11 +7,12 @@ -

    function FillMatrixRows(mA, r, num_rows, v)

    +

    Function FillMatrixRows(mA, r, num_rows, v)

    Fills matrix rows with the given value starting at the given row

    +

    \ No newline at end of file diff --git a/doc/doc_files/filltile.html b/doc/doc_files/filltile.html index b42757e..36646ea 100644 --- a/doc/doc_files/filltile.html +++ b/doc/doc_files/filltile.html @@ -12,6 +12,7 @@ Fills an area of a tile map with a specified tile

    +

    \ No newline at end of file diff --git a/doc/doc_files/flashwindow.html b/doc/doc_files/flashwindow.html index a1df02e..cdc9e83 100644 --- a/doc/doc_files/flashwindow.html +++ b/doc/doc_files/flashwindow.html @@ -7,7 +7,7 @@ -

    function FlashWindow( flag )

    +

    Function FlashWindow( flag )

    Flashes a window to specify an alert

    @@ -29,6 +29,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/floodfill.html b/doc/doc_files/floodfill.html index afd743c..eec14a1 100644 --- a/doc/doc_files/floodfill.html +++ b/doc/doc_files/floodfill.html @@ -7,7 +7,7 @@ -

    sub FloodFill(x,y)

    +

    Sub FloodFill(x,y)

    Fills a closed shape in with the current draw color

    @@ -15,6 +15,7 @@ NOTE: It is not recommended to floodfill the full screen since its prone to stack overload

    +

    \ No newline at end of file diff --git a/doc/doc_files/fontexists.html b/doc/doc_files/fontexists.html index fa30d61..180a2cc 100644 --- a/doc/doc_files/fontexists.html +++ b/doc/doc_files/fontexists.html @@ -12,6 +12,7 @@ Returns True if the specified font id is associated with a loaded font

    +

    \ No newline at end of file diff --git a/doc/doc_files/fprint.html b/doc/doc_files/fprint.html index ef37dea..2b824ce 100644 --- a/doc/doc_files/fprint.html +++ b/doc/doc_files/fprint.html @@ -7,7 +7,7 @@ -

    sub Fprint(txt$)

    +

    Sub Fprint(txt$)

    Outputs text to the console

    @@ -15,6 +15,7 @@ NOTE: It does the exact same thing as Print. This is here for legacy reasons (ie. I am too lazy to remove it.)

    +

    \ No newline at end of file diff --git a/doc/doc_files/fps.html b/doc/doc_files/fps.html index 4636022..97edb60 100644 --- a/doc/doc_files/fps.html +++ b/doc/doc_files/fps.html @@ -7,11 +7,12 @@ -

    function FPS()

    +

    Function FPS()

    Returns the number of frames being rendered per second

    +

    \ No newline at end of file diff --git a/doc/doc_files/frac.html b/doc/doc_files/frac.html index 31297cd..863f38d 100644 --- a/doc/doc_files/frac.html +++ b/doc/doc_files/frac.html @@ -7,11 +7,12 @@ -

    function Frac(n)

    +

    Function Frac(n)

    Returns the decimal portion of a number.

    +

    \ No newline at end of file diff --git a/doc/doc_files/func_sub.html b/doc/doc_files/func_sub.html index 8037d17..9e2fa7b 100644 --- a/doc/doc_files/func_sub.html +++ b/doc/doc_files/func_sub.html @@ -156,6 +156,7 @@ The above code is the same as the previous example except that now we use the BYREF keyword to change a to a reference rather than a value. This means the when we pass the variable N to MYSUB, instead of the value stored in N being used as A, whatever we do to A will be done to N directly. This example will output 5 to the console.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getaccel.html b/doc/doc_files/getaccel.html index 8dc1245..c17a757 100644 --- a/doc/doc_files/getaccel.html +++ b/doc/doc_files/getaccel.html @@ -7,11 +7,12 @@ -

    sub GetAccel(accel_num, ByRef x, ByRef y, ByRef z)

    +

    Sub GetAccel(accel_num, ByRef x, ByRef y, ByRef z)

    Gets the axis values for an accelerometer.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactoraabb.html b/doc/doc_files/getactoraabb.html index 731d36b..91900a2 100644 --- a/doc/doc_files/getactoraabb.html +++ b/doc/doc_files/getactoraabb.html @@ -3,15 +3,16 @@ - getActorAABB [RCBasic Doc] + GetActorAABB [RCBasic Doc] -

    sub getActorAABB( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z)

    +

    Sub GetActorAABB( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z)

    Gets the bounding box for an actor.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorangulardamping.html b/doc/doc_files/getactorangulardamping.html index b3c9a36..5b2abca 100644 --- a/doc/doc_files/getactorangulardamping.html +++ b/doc/doc_files/getactorangulardamping.html @@ -7,7 +7,7 @@ -

    function GetActorAngularDamping( actor)

    +

    Function GetActorAngularDamping( actor)

    Returns the amount of angular damping set on the actor

    @@ -17,6 +17,7 @@ GetActorLinearDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorangularfactor.html b/doc/doc_files/getactorangularfactor.html index d8d307e..a6b922b 100644 --- a/doc/doc_files/getactorangularfactor.html +++ b/doc/doc_files/getactorangularfactor.html @@ -3,11 +3,11 @@ - getActorAngularFactor [RCBasic Doc] + GetActorAngularFactor [RCBasic Doc] -

    sub getActorAngularFactor( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorAngularFactor( actor, ByRef x, ByRef y, ByRef z)

    Returns the angular factor set on an actor

    @@ -17,6 +17,7 @@ SetActorLinearFactor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorangularsleepthreshold.html b/doc/doc_files/getactorangularsleepthreshold.html index 79b82a2..dacb229 100644 --- a/doc/doc_files/getactorangularsleepthreshold.html +++ b/doc/doc_files/getactorangularsleepthreshold.html @@ -7,7 +7,7 @@ -

    function GetActorAngularSleepThreshold( actor)

    +

    Function GetActorAngularSleepThreshold( actor)

    Returns the Angular deactivation threshold for the actor

    @@ -16,6 +16,7 @@ GetActorLinearSleepThreshold

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorangularvelocitylocal.html b/doc/doc_files/getactorangularvelocitylocal.html index 4983a8e..5428b32 100644 --- a/doc/doc_files/getactorangularvelocitylocal.html +++ b/doc/doc_files/getactorangularvelocitylocal.html @@ -3,11 +3,11 @@ - getActorAngularVelocityLocal [RCBasic Doc] + GetActorAngularVelocityLocal [RCBasic Doc] -

    sub getActorAngularVelocityLocal( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorAngularVelocityLocal( actor, ByRef x, ByRef y, ByRef z)

    Gets an actor's Angular Velocity

    @@ -17,6 +17,7 @@ SetActorAngularVelocityWorld

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorangularvelocityworld.html b/doc/doc_files/getactorangularvelocityworld.html index 897f6fd..0d2757e 100644 --- a/doc/doc_files/getactorangularvelocityworld.html +++ b/doc/doc_files/getactorangularvelocityworld.html @@ -3,11 +3,11 @@ - getActorAngularVelocityWorld [RCBasic Doc] + GetActorAngularVelocityWorld [RCBasic Doc] -

    sub getActorAngularVelocityWorld( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorAngularVelocityWorld( actor, ByRef x, ByRef y, ByRef z)

    Gets an actor's Angular Velocity

    @@ -17,6 +17,7 @@ SetActorAngularVelocityWorld

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactoranimationendframe.html b/doc/doc_files/getactoranimationendframe.html index 8f983c1..729320d 100644 --- a/doc/doc_files/getactoranimationendframe.html +++ b/doc/doc_files/getactoranimationendframe.html @@ -15,6 +15,7 @@ SetActorAnimationFrames

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactoranimationspeed.html b/doc/doc_files/getactoranimationspeed.html index 2356721..94a5292 100644 --- a/doc/doc_files/getactoranimationspeed.html +++ b/doc/doc_files/getactoranimationspeed.html @@ -7,7 +7,7 @@ -

    function GetActorAnimationSpeed( actor, animation )

    +

    Function GetActorAnimationSpeed( actor, animation )

    Returns actor's animation speed in frames per second

    @@ -15,6 +15,7 @@ SetActorAnimationSpeed

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactoranimationstartframe.html b/doc/doc_files/getactoranimationstartframe.html index cdde7d3..282ddf5 100644 --- a/doc/doc_files/getactoranimationstartframe.html +++ b/doc/doc_files/getactoranimationstartframe.html @@ -15,6 +15,7 @@ SetActorAnimationFrames

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorautoculling.html b/doc/doc_files/getactorautoculling.html index 98d2667..3a7159d 100644 --- a/doc/doc_files/getactorautoculling.html +++ b/doc/doc_files/getactorautoculling.html @@ -7,7 +7,7 @@ -

    function GetActorAutoCulling( actor )

    +

    Function GetActorAutoCulling( actor )

    Returns the automatic culling state for an actor

    @@ -35,6 +35,7 @@ SetActorAutoCulling

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorcenter.html b/doc/doc_files/getactorcenter.html index b30ca6b..4dc9a22 100644 --- a/doc/doc_files/getactorcenter.html +++ b/doc/doc_files/getactorcenter.html @@ -3,15 +3,16 @@ - getActorCenter [RCBasic Doc] + GetActorCenter [RCBasic Doc] -

    sub getActorCenter( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorCenter( actor, ByRef x, ByRef y, ByRef z)

    Gets an actor's center of mass position. This is useful for setting the origin of constraints.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorcollision.html b/doc/doc_files/getactorcollision.html index 39726d8..da55489 100644 --- a/doc/doc_files/getactorcollision.html +++ b/doc/doc_files/getactorcollision.html @@ -7,7 +7,7 @@ -

    function GetActorCollision(actor1, actor2)

    +

    Function GetActorCollision(actor1, actor2)

    Returns true if 2 actors collide

    @@ -15,6 +15,7 @@ Note: This function will work with solid and non solid actors

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorcurrentanimation.html b/doc/doc_files/getactorcurrentanimation.html index e1b09e7..eedae97 100644 --- a/doc/doc_files/getactorcurrentanimation.html +++ b/doc/doc_files/getactorcurrentanimation.html @@ -19,6 +19,7 @@ SetActorFrame

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorframe.html b/doc/doc_files/getactorframe.html index 6ac58ee..5a37f5e 100644 --- a/doc/doc_files/getactorframe.html +++ b/doc/doc_files/getactorframe.html @@ -7,7 +7,7 @@ -

    function GetActorFrame(actor)

    +

    Function GetActorFrame(actor)

    Returns the current frame number an actor is currently rendering

    @@ -16,6 +16,7 @@ GetActorAnimationFrame

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorgravity.html b/doc/doc_files/getactorgravity.html index b437ee9..351841e 100644 --- a/doc/doc_files/getactorgravity.html +++ b/doc/doc_files/getactorgravity.html @@ -7,7 +7,7 @@ -

    sub GetActorGravity( actor, ByRef x, ByRef y, ByRef z )

    +

    Sub GetActorGravity( actor, ByRef x, ByRef y, ByRef z )

    Gets the gravity of an actor along each access.

    @@ -15,6 +15,7 @@ SetActorGravity

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorinverseinertiadiaglocal.html b/doc/doc_files/getactorinverseinertiadiaglocal.html index b3c1c4d..3cc9421 100644 --- a/doc/doc_files/getactorinverseinertiadiaglocal.html +++ b/doc/doc_files/getactorinverseinertiadiaglocal.html @@ -3,15 +3,16 @@ - getActorInverseInertiaDiagLocal [RCBasic Doc] + GetActorInverseInertiaDiagLocal [RCBasic Doc] -

    sub getActorInverseInertiaDiagLocal( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorInverseInertiaDiagLocal( actor, ByRef x, ByRef y, ByRef z)

    Gets the inverse of the inertia tensor's diagonal components in the local space. This is used to compute how the actor reacts to rotational forces (torques) applied to it.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorinversemass.html b/doc/doc_files/getactorinversemass.html index 71e2b9d..e915ef2 100644 --- a/doc/doc_files/getactorinversemass.html +++ b/doc/doc_files/getactorinversemass.html @@ -3,11 +3,11 @@ - getActorInverseMass [RCBasic Doc] + GetActorInverseMass [RCBasic Doc] -

    function getActorInverseMass( actor)

    +

    Function GetActorInverseMass( actor)

    Returns an actor's inverse mass

    @@ -15,6 +15,7 @@ SetActorMassProperties

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorlineardamping.html b/doc/doc_files/getactorlineardamping.html index bb9851a..096d07d 100644 --- a/doc/doc_files/getactorlineardamping.html +++ b/doc/doc_files/getactorlineardamping.html @@ -7,7 +7,7 @@ -

    function GetActorLinearDamping( actor)

    +

    Function GetActorLinearDamping( actor)

    Return's an actor's linear damping

    @@ -16,6 +16,7 @@ GetActorAngularDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorlinearfactor.html b/doc/doc_files/getactorlinearfactor.html index 7f5f7bd..b31b81e 100644 --- a/doc/doc_files/getactorlinearfactor.html +++ b/doc/doc_files/getactorlinearfactor.html @@ -7,7 +7,7 @@ -

    sub GetActorLinearFactor( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorLinearFactor( actor, ByRef x, ByRef y, ByRef z)

    Gets an actor's linear factor

    @@ -17,6 +17,7 @@ SetActorAngularFactor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorlinearsleepthreshold.html b/doc/doc_files/getactorlinearsleepthreshold.html index 9676069..87d0d02 100644 --- a/doc/doc_files/getactorlinearsleepthreshold.html +++ b/doc/doc_files/getactorlinearsleepthreshold.html @@ -7,7 +7,7 @@ -

    function GetActorLinearSleepThreshold( actor)

    +

    Function GetActorLinearSleepThreshold( actor)

    Returns the linear deactivation threshold for the actor

    @@ -16,6 +16,7 @@ GetActorAngularSleepThreshold

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorlinearvelocitylocal.html b/doc/doc_files/getactorlinearvelocitylocal.html index 70e34d1..209ad2c 100644 --- a/doc/doc_files/getactorlinearvelocitylocal.html +++ b/doc/doc_files/getactorlinearvelocitylocal.html @@ -7,7 +7,7 @@ -

    sub GetActorLinearVelocityLocal( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorLinearVelocityLocal( actor, ByRef x, ByRef y, ByRef z)

    Gets actor's linear velocity

    @@ -16,6 +16,7 @@ SetActorLinearVelocityWorld

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorlinearvelocityworld.html b/doc/doc_files/getactorlinearvelocityworld.html index 12fef83..68dca45 100644 --- a/doc/doc_files/getactorlinearvelocityworld.html +++ b/doc/doc_files/getactorlinearvelocityworld.html @@ -3,11 +3,11 @@ - getActorLinearVelocityWorld [RCBasic Doc] + GetActorLinearVelocityWorld [RCBasic Doc] -

    sub getActorLinearVelocityWorld( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorLinearVelocityWorld( actor, ByRef x, ByRef y, ByRef z)

    Gets actor's linear velocity

    @@ -16,6 +16,7 @@ SetActorLinearVelocityWorld

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorlocalinertia.html b/doc/doc_files/getactorlocalinertia.html index a55428b..848b7fa 100644 --- a/doc/doc_files/getactorlocalinertia.html +++ b/doc/doc_files/getactorlocalinertia.html @@ -7,11 +7,12 @@ -

    sub GetActorLocalInertia( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorLocalInertia( actor, ByRef x, ByRef y, ByRef z)

    Gets the local inertia tensor of an actor. The inertia tensor describes how an actor resists rotational motion depending on its mass distribution relative to its center of mass.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactormaterial.html b/doc/doc_files/getactormaterial.html index f7d3f92..54eafd1 100644 --- a/doc/doc_files/getactormaterial.html +++ b/doc/doc_files/getactormaterial.html @@ -3,11 +3,11 @@ - getActorMaterial [RCBasic Doc] + GetActorMaterial [RCBasic Doc] -

    function getActorMaterial( actor, material_num)

    +

    Function GetActorMaterial( actor, material_num)

    Returns an actor's material id.

    @@ -15,6 +15,7 @@ Actor's can have multiple materials but generally you want material 0 for most Actor's.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactormaterialcount.html b/doc/doc_files/getactormaterialcount.html index c01310d..3f7f855 100644 --- a/doc/doc_files/getactormaterialcount.html +++ b/doc/doc_files/getactormaterialcount.html @@ -3,15 +3,16 @@ - getActorMaterialCount [RCBasic Doc] + GetActorMaterialCount [RCBasic Doc] -

    function getActorMaterialCount( actor)

    +

    Function GetActorMaterialCount( actor)

    Returns the number of materials for an actor.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactormaterialflag.html b/doc/doc_files/getactormaterialflag.html index 37298d0..3cbf2eb 100644 --- a/doc/doc_files/getactormaterialflag.html +++ b/doc/doc_files/getactormaterialflag.html @@ -3,11 +3,11 @@ - getActorMaterialFlag [RCBasic Doc] + GetActorMaterialFlag [RCBasic Doc] -

    function getActorMaterialFlag( actor, material, flag)

    +

    Function GetActorMaterialFlag( actor, material, flag)

    Returns the value of the specified material flag

    @@ -80,6 +80,7 @@ GetMaterialFlag

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactormaterialtype.html b/doc/doc_files/getactormaterialtype.html index 1f4aaf2..83495ac 100644 --- a/doc/doc_files/getactormaterialtype.html +++ b/doc/doc_files/getactormaterialtype.html @@ -7,7 +7,7 @@ -

    function GetActorMaterialType( actor, material )

    +

    Function GetActorMaterialType( actor, material )

    Returns the material type of an actor material

    @@ -130,6 +130,7 @@ SetMaterialType

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorposition.html b/doc/doc_files/getactorposition.html index f4d8fa5..72d5d9e 100644 --- a/doc/doc_files/getactorposition.html +++ b/doc/doc_files/getactorposition.html @@ -7,7 +7,7 @@ -

    sub GetActorPosition( actor, ByRef x, ByRef y, ByRef z )

    +

    Sub GetActorPosition( actor, ByRef x, ByRef y, ByRef z )

    Gets the actors position

    @@ -15,6 +15,7 @@ SetActorPosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorrotation.html b/doc/doc_files/getactorrotation.html index 84d704a..58ee118 100644 --- a/doc/doc_files/getactorrotation.html +++ b/doc/doc_files/getactorrotation.html @@ -7,7 +7,7 @@ -

    sub GetActorRotation( actor, ByRef x, ByRef y, ByRef z )

    +

    Sub GetActorRotation( actor, ByRef x, ByRef y, ByRef z )

    Gets the actors rotation on each axis

    @@ -15,6 +15,7 @@ SetActorRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorrotationq.html b/doc/doc_files/getactorrotationq.html index 4775951..21a00b1 100644 --- a/doc/doc_files/getactorrotationq.html +++ b/doc/doc_files/getactorrotationq.html @@ -7,7 +7,7 @@ -

    sub GetActorRotationQ( actor, ByRef x, ByRef y, ByRef z, ByRef w)

    +

    Sub GetActorRotationQ( actor, ByRef x, ByRef y, ByRef z, ByRef w)

    Gets the actors rotation as a quaternion.

    @@ -19,6 +19,7 @@ SetActorRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorscale.html b/doc/doc_files/getactorscale.html index 505640a..e35b1a4 100644 --- a/doc/doc_files/getactorscale.html +++ b/doc/doc_files/getactorscale.html @@ -7,7 +7,7 @@ -

    sub GetActorScale( actor, ByRef x, ByRef y, ByRef z )

    +

    Sub GetActorScale( actor, ByRef x, ByRef y, ByRef z )

    Gets an actor's scale

    @@ -15,6 +15,7 @@ SetActorScale

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorshape.html b/doc/doc_files/getactorshape.html index 897ac92..e028faa 100644 --- a/doc/doc_files/getactorshape.html +++ b/doc/doc_files/getactorshape.html @@ -7,7 +7,7 @@ -

    function GetActorShape(actor)

    +

    Function GetActorShape(actor)

    Returns the shape of an actor

    @@ -39,11 +39,22 @@
  • ACTOR_SHAPE_TRIMESH
    • +
  • + ACTOR_SHAPE_COMPOSITE +
    • +
  • + ACTOR_SHAPE_IMPACT_MESH +
    • +

    + NOTE: ACTOR_SHAPE_COMPOSITE is not a shape you can set. It is a shape that is automatically set on composite actors. +


    Related: SetActorShape + SetActorShapeEx

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactortotalforce.html b/doc/doc_files/getactortotalforce.html index a62fbe7..41df43f 100644 --- a/doc/doc_files/getactortotalforce.html +++ b/doc/doc_files/getactortotalforce.html @@ -7,7 +7,7 @@ -

    sub GetActorTotalForce( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorTotalForce( actor, ByRef x, ByRef y, ByRef z)

    Gets the total net force currently acting on an actor. This force is the sum of all external forces applied to the actor at a given point in time, including forces like gravity, applied forces, and other interactions such as contact or collision forces.

    @@ -15,6 +15,7 @@ GetActorTotalTorque

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactortotaltorque.html b/doc/doc_files/getactortotaltorque.html index fe938cd..2a529f6 100644 --- a/doc/doc_files/getactortotaltorque.html +++ b/doc/doc_files/getactortotaltorque.html @@ -7,7 +7,7 @@ -

    sub GetActorTotalTorque( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorTotalTorque( actor, ByRef x, ByRef y, ByRef z)

    Gets the total net torque currently acting on an actor. Torque represents the rotational equivalent of force, describing how different forces applied to the actor cause it to rotate. The total torque is the sum of all external torques acting on the actor, which determine how the actor will rotate or change its angular velocity.

    @@ -15,6 +15,7 @@ GetTotalForces

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactortransform.html b/doc/doc_files/getactortransform.html index dc777a7..228a00f 100644 --- a/doc/doc_files/getactortransform.html +++ b/doc/doc_files/getactortransform.html @@ -7,11 +7,12 @@ -

    sub GetActorTransform( actor, matrix )

    +

    Sub GetActorTransform( actor, matrix )

    Stores the actors absolute transformation in the given matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/getactorvelocityinlocalpoint.html b/doc/doc_files/getactorvelocityinlocalpoint.html index 3b80b6d..b1860e4 100644 --- a/doc/doc_files/getactorvelocityinlocalpoint.html +++ b/doc/doc_files/getactorvelocityinlocalpoint.html @@ -3,15 +3,16 @@ - getActorVelocityInLocalPoint [RCBasic Doc] + GetActorVelocityInLocalPoint [RCBasic Doc] -

    sub getActorVelocityInLocalPoint( actor, rel_x, rel_y, rel_z, ByRef x, ByRef y, ByRef z)

    +

    Sub GetActorVelocityInLocalPoint( actor, rel_x, rel_y, rel_z, ByRef x, ByRef y, ByRef z)

    Gets the linear velocity of a specific point on an actor, given its position in the actor's local coordinate space. This is useful for determining how fast and in what direction a particular point on the actor is moving, accounting for both the body's linear velocity and its rotational motion (angular velocity).

    +

    \ No newline at end of file diff --git a/doc/doc_files/getan8scenename.html b/doc/doc_files/getan8scenename.html index db39c07..c27c9c3 100644 --- a/doc/doc_files/getan8scenename.html +++ b/doc/doc_files/getan8scenename.html @@ -12,6 +12,7 @@ Returns the name of a scene in an an8 project

    +

    \ No newline at end of file diff --git a/doc/doc_files/getantialiasmode.html b/doc/doc_files/getantialiasmode.html index 0745651..f44edd3 100644 --- a/doc/doc_files/getantialiasmode.html +++ b/doc/doc_files/getantialiasmode.html @@ -7,7 +7,7 @@ -

    function GetAntiAliasMode( )

    +

    Function GetAntiAliasMode( )

    Returns the anti-alias mode for draw image commands

    @@ -41,6 +41,7 @@ SetAntiAliasMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/getbilinearfilter.html b/doc/doc_files/getbilinearfilter.html index 0705660..5a4abba 100644 --- a/doc/doc_files/getbilinearfilter.html +++ b/doc/doc_files/getbilinearfilter.html @@ -7,7 +7,7 @@ -

    function GetBilinearFilter()

    +

    Function GetBilinearFilter()

    Returns true if bilinear filtering is enabled

    @@ -15,6 +15,7 @@ SetBilinearFilter

    +

    \ No newline at end of file diff --git a/doc/doc_files/getblendmode.html b/doc/doc_files/getblendmode.html index bf79e94..20e19c2 100644 --- a/doc/doc_files/getblendmode.html +++ b/doc/doc_files/getblendmode.html @@ -7,7 +7,7 @@ -

    function GetBlendMode( )

    +

    Function GetBlendMode( )

    Returns the current blend mode

    @@ -53,6 +53,7 @@ SetBlendMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcameraaspectratio.html b/doc/doc_files/getcameraaspectratio.html index a3a71a9..2c57952 100644 --- a/doc/doc_files/getcameraaspectratio.html +++ b/doc/doc_files/getcameraaspectratio.html @@ -7,7 +7,7 @@ -

    function GetCameraAspectRatio( )

    +

    Function GetCameraAspectRatio( )

    Returns the camera aspect ratio for the active canvas

    @@ -15,6 +15,7 @@ SetCameraAspectRatio

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcamerafarvalue.html b/doc/doc_files/getcamerafarvalue.html index 2b4b533..18ce7fc 100644 --- a/doc/doc_files/getcamerafarvalue.html +++ b/doc/doc_files/getcamerafarvalue.html @@ -7,7 +7,7 @@ -

    function GetCameraFarValue( )

    +

    Function GetCameraFarValue( )

    Returns the far plane of the camera on the active canvas

    @@ -15,6 +15,7 @@ GetCameraNearValue

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcamerafov.html b/doc/doc_files/getcamerafov.html index 8615370..84aad00 100644 --- a/doc/doc_files/getcamerafov.html +++ b/doc/doc_files/getcamerafov.html @@ -7,11 +7,12 @@ -

    function GetCameraFOV( )

    +

    Function GetCameraFOV( )

    Returns the field of view of the camera on the active canvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcameranearvalue.html b/doc/doc_files/getcameranearvalue.html index dbce0a2..3d4601c 100644 --- a/doc/doc_files/getcameranearvalue.html +++ b/doc/doc_files/getcameranearvalue.html @@ -7,7 +7,7 @@ -

    function GetCameraNearValue( )

    +

    Function GetCameraNearValue( )

    Returns the near plane of the camera on the active canvas

    @@ -15,6 +15,7 @@ GetCameraFarValue

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcameraposition.html b/doc/doc_files/getcameraposition.html index a36f7d7..a34fd5f 100644 --- a/doc/doc_files/getcameraposition.html +++ b/doc/doc_files/getcameraposition.html @@ -7,7 +7,7 @@ -

    sub GetCameraPosition(ByRef x, ByRef y, ByRef z)

    +

    Sub GetCameraPosition(ByRef x, ByRef y, ByRef z)

    Gets the position of the camera

    @@ -16,6 +16,7 @@ TranslateCamera

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcamerarotation.html b/doc/doc_files/getcamerarotation.html index 7820621..fd9f408 100644 --- a/doc/doc_files/getcamerarotation.html +++ b/doc/doc_files/getcamerarotation.html @@ -7,7 +7,7 @@ -

    sub GetCameraRotation(ByRef x, ByRef y, ByRef z)

    +

    Sub GetCameraRotation(ByRef x, ByRef y, ByRef z)

    Gets the rotation of the camera on each axis

    @@ -16,6 +16,7 @@ RotateCamera

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcanvasalpha.html b/doc/doc_files/getcanvasalpha.html index c8a8d9a..88eb850 100644 --- a/doc/doc_files/getcanvasalpha.html +++ b/doc/doc_files/getcanvasalpha.html @@ -7,7 +7,7 @@ -

    function GetCanvasAlpha(c_num)

    +

    Function GetCanvasAlpha(c_num)

    Returns the alpha blend value of a canvas

    @@ -15,6 +15,7 @@ SetCanvasAlpha

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcanvascolormod.html b/doc/doc_files/getcanvascolormod.html index 706be0a..503a432 100644 --- a/doc/doc_files/getcanvascolormod.html +++ b/doc/doc_files/getcanvascolormod.html @@ -7,7 +7,7 @@ -

    function GetCanvasColorMod(c_num)

    +

    Function GetCanvasColorMod(c_num)

    Returns the color modulation of a canvas

    @@ -15,6 +15,7 @@ SetCanvasColorMod

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcanvasoffset.html b/doc/doc_files/getcanvasoffset.html index 12119ea..92a40f7 100644 --- a/doc/doc_files/getcanvasoffset.html +++ b/doc/doc_files/getcanvasoffset.html @@ -7,7 +7,7 @@ -

    sub GetCanvasOffset(c_num, byref x, byref y)

    +

    Sub GetCanvasOffset(c_num, ByRef x, ByRef y)

    Returns view offset of a canvas

    @@ -15,6 +15,7 @@ SetCanvasOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcanvassize.html b/doc/doc_files/getcanvassize.html index 4d9f59e..98e3dbb 100644 --- a/doc/doc_files/getcanvassize.html +++ b/doc/doc_files/getcanvassize.html @@ -7,11 +7,12 @@ -

    sub GetCanvasSize(c_num, byref w, byref h)

    +

    Sub GetCanvasSize(c_num, ByRef w, ByRef h)

    Gets the size of a canvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcanvasviewport.html b/doc/doc_files/getcanvasviewport.html index 72831b7..d287cfe 100644 --- a/doc/doc_files/getcanvasviewport.html +++ b/doc/doc_files/getcanvasviewport.html @@ -7,7 +7,7 @@ -

    sub GetCanvasViewport(c_num, byref x, byref y, byref w, byref h)

    +

    Sub GetCanvasViewport(c_num, ByRef x, ByRef y, ByRef w, ByRef h)

    Gets the position and size of a canvas viewport

    @@ -16,6 +16,7 @@ SetCanvasViewport

    +

    \ No newline at end of file diff --git a/doc/doc_files/getchannelvolume.html b/doc/doc_files/getchannelvolume.html index db50d41..a2a6c9b 100644 --- a/doc/doc_files/getchannelvolume.html +++ b/doc/doc_files/getchannelvolume.html @@ -7,11 +7,12 @@ -

    function GetChannelVolume(channel)

    +

    Function GetChannelVolume(channel)

    Returns the volume of the audio on a channel

    +

    \ No newline at end of file diff --git a/doc/doc_files/getcirclelineintersection.html b/doc/doc_files/getcirclelineintersection.html index e9b0979..c84d01e 100644 --- a/doc/doc_files/getcirclelineintersection.html +++ b/doc/doc_files/getcirclelineintersection.html @@ -7,7 +7,7 @@ -

    function GetCircleLineIntersection(circle_x, circle_y, radius, x1, y1, x2, y2, ByRef ix1, ByRef iy1, ByRef ix2, ByRef iy2)

    +

    Function GetCircleLineIntersection(circle_x, circle_y, radius, x1, y1, x2, y2, ByRef ix1, ByRef iy1, ByRef ix2, ByRef iy2)

    Calculates the points where a circle and line intersect and stores the intersection points in (ix1, iy1) and (ix2, iy2)

    @@ -15,6 +15,7 @@ NOTE: This function returns 0 if there is no intersection and 1 or 2 if there is 1 or 2 intersection points. If it only returns 1 then only (ix1, iy1) will be set.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getclipboardtext.html b/doc/doc_files/getclipboardtext.html index 58412a4..6ddd467 100644 --- a/doc/doc_files/getclipboardtext.html +++ b/doc/doc_files/getclipboardtext.html @@ -7,11 +7,12 @@ -

    function GetClipboardText$( )

    +

    Function GetClipboardText$( )

    Returns the clipboard text.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconeanglepoint.html b/doc/doc_files/getconeanglepoint.html index 2a43082..ca5db1e 100644 --- a/doc/doc_files/getconeanglepoint.html +++ b/doc/doc_files/getconeanglepoint.html @@ -3,15 +3,16 @@ - getConeAnglePoint [RCBasic Doc] + GetConeAnglePoint [RCBasic Doc] -

    sub getConeAnglePoint( constraint_id, angle, c_len, ByRef x, ByRef y, ByRef z)

    +

    Sub GetConeAnglePoint( constraint_id, angle, c_len, ByRef x, ByRef y, ByRef z)

    Computes or retrieves a point based on a given angle relative to the constraint’s twist axis.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconebiasfactor.html b/doc/doc_files/getconebiasfactor.html index 478bc1b..a61a445 100644 --- a/doc/doc_files/getconebiasfactor.html +++ b/doc/doc_files/getconebiasfactor.html @@ -3,15 +3,16 @@ - getConeBiasFactor [RCBasic Doc] + GetConeBiasFactor [RCBasic Doc] -

    function getConeBiasFactor( constraint_id)

    +

    Function GetConeBiasFactor( constraint_id)

    Returns the bias factor used to correct constraint violations (such as small positional or angular errors) during the simulation. The bias factor helps ensure that the constrained actors return to their intended positions or orientations over time by applying corrective forces or impulses.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconedamping.html b/doc/doc_files/getconedamping.html index ef38697..3517d75 100644 --- a/doc/doc_files/getconedamping.html +++ b/doc/doc_files/getconedamping.html @@ -3,15 +3,16 @@ - getConeDamping [RCBasic Doc] + GetConeDamping [RCBasic Doc] -

    function getConeDamping( constraint_id)

    +

    Function GetConeDamping( constraint_id)

    Returns the damping factor applied to the constraint. Damping is used to reduce the amount of oscillation or unwanted movement (such as excessive rotation or swinging) around the constrained actor's axes.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconefixthresh.html b/doc/doc_files/getconefixthresh.html index b022227..2b60b14 100644 --- a/doc/doc_files/getconefixthresh.html +++ b/doc/doc_files/getconefixthresh.html @@ -3,11 +3,11 @@ - getConeFixThresh [RCBasic Doc] + GetConeFixThresh [RCBasic Doc] -

    function getConeFixThresh( constraint_id)

    +

    Function GetConeFixThresh( constraint_id)

    Returns the fix threshold value associated with that constraint. This threshold is used to control how the constraint behaves when the angle of the rotation between the actors approaches the limits defined by the cone twist constraint.

    @@ -18,6 +18,7 @@ SetConeFixThresh

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconelimit.html b/doc/doc_files/getconelimit.html index 54fa5d1..ba1b7bc 100644 --- a/doc/doc_files/getconelimit.html +++ b/doc/doc_files/getconelimit.html @@ -3,11 +3,11 @@ - getConeLimit [RCBasic Doc] + GetConeLimit [RCBasic Doc] -

    function getConeLimit( constraint_id, limit_index)

    +

    Function GetConeLimit( constraint_id, limit_index)

    Returns the angular limit associated with a specific degree of freedom in the cone constraint. This limit defines the range of motion allowed around a given axis (twist, swing1, or swing2) for the constrained actors.

    @@ -29,6 +29,7 @@ Returns value is the maximum angle or range allowed for the specified degree of freedom (twist, swing1, or swing2)

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconesolveswinglimit.html b/doc/doc_files/getconesolveswinglimit.html index ad38bce..e4e6062 100644 --- a/doc/doc_files/getconesolveswinglimit.html +++ b/doc/doc_files/getconesolveswinglimit.html @@ -3,11 +3,11 @@ - getConeSolveSwingLimit [RCBasic Doc] + GetConeSolveSwingLimit [RCBasic Doc] -

    function getConeSolveSwingLimit( constraint_id)

    +

    Function GetConeSolveSwingLimit( constraint_id)

    Returns whether the swing limit of the constraint is currently being enforced during the simulation.

    @@ -15,6 +15,7 @@ The swing limit defines the boundary within which the connected actors can swing. When the bodies approach or exceed this limit, the physics engine enforces a constraint to prevent further motion. If the swing limit is exceeded during simulation, corrective forces are applied to bring the actors back within the allowed range.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconesolvetwistlimit.html b/doc/doc_files/getconesolvetwistlimit.html index 36d8535..9f9d755 100644 --- a/doc/doc_files/getconesolvetwistlimit.html +++ b/doc/doc_files/getconesolvetwistlimit.html @@ -3,11 +3,11 @@ - getConeSolveTwistLimit [RCBasic Doc] + GetConeSolveTwistLimit [RCBasic Doc] -

    function getConeSolveTwistLimit( constraint_id)

    +

    Function GetConeSolveTwistLimit( constraint_id)

    Returns whether the twist limit is currently being enforced during the simulation.

    @@ -15,6 +15,7 @@ The twist limit controls how much the connected actors can rotate around the central axis of the joint (the "twist" axis). When the actors rotate beyond this allowed limit, the physics engine applies corrective forces to keep the rotation within the defined twist range.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconeswingspan1.html b/doc/doc_files/getconeswingspan1.html index 3a3f8fe..caff541 100644 --- a/doc/doc_files/getconeswingspan1.html +++ b/doc/doc_files/getconeswingspan1.html @@ -3,11 +3,11 @@ - getConeSwingSpan1 [RCBasic Doc] + GetConeSwingSpan1 [RCBasic Doc] -

    function getConeSwingSpan1( constraint_id)

    +

    Function GetConeSwingSpan1( constraint_id)

    Returns the maximum allowed rotation angle (or "span") for the first swing axis. This swing axis is one of the two orthogonal axes around which the constrained actors are allowed to swing, forming a cone-shaped range of motion.

    @@ -18,6 +18,7 @@ GetConeSwingSpan2

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconeswingspan2.html b/doc/doc_files/getconeswingspan2.html index 0387226..8f51314 100644 --- a/doc/doc_files/getconeswingspan2.html +++ b/doc/doc_files/getconeswingspan2.html @@ -3,11 +3,11 @@ - getConeSwingSpan2 [RCBasic Doc] + GetConeSwingSpan2 [RCBasic Doc] -

    function getConeSwingSpan2( constraint_id)

    +

    Function GetConeSwingSpan2( constraint_id)

    Returns the maximum allowed rotation angle (or "span") for the second swing axis. This swing axis is one of the two orthogonal axes around which the constrained actors are allowed to swing, forming a cone-shaped range of motion.

    @@ -18,6 +18,7 @@ GetConeSwingSpan1

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconetwistangle.html b/doc/doc_files/getconetwistangle.html index df774fd..cf75122 100644 --- a/doc/doc_files/getconetwistangle.html +++ b/doc/doc_files/getconetwistangle.html @@ -3,11 +3,11 @@ - getConeTwistAngle [RCBasic Doc] + GetConeTwistAngle [RCBasic Doc] -

    function getConeTwistAngle( constraint_id)

    +

    Function GetConeTwistAngle( constraint_id)

    Returns the current twist angle between the two actors connected by the constraint

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconetwistlimitsign.html b/doc/doc_files/getconetwistlimitsign.html index 0300b03..a4cedad 100644 --- a/doc/doc_files/getconetwistlimitsign.html +++ b/doc/doc_files/getconetwistlimitsign.html @@ -3,11 +3,11 @@ - getConeTwistLimitSign [RCBasic Doc] + GetConeTwistLimitSign [RCBasic Doc] -

    function getConeTwistLimitSign( constraint_id)

    +

    Function GetConeTwistLimitSign( constraint_id)

    Returns the sign of the twist limit, which indicates the direction of the twist limit enforcement around the twist axis.

    @@ -20,6 +20,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconetwistspan.html b/doc/doc_files/getconetwistspan.html index 8ea78b9..eabd2c7 100644 --- a/doc/doc_files/getconetwistspan.html +++ b/doc/doc_files/getconetwistspan.html @@ -3,15 +3,16 @@ - getConeTwistSpan [RCBasic Doc] + GetConeTwistSpan [RCBasic Doc] -

    function getConeTwistSpan( constraint_id)

    +

    Function GetConeTwistSpan( constraint_id)

    Returns the maximum allowed twist angle for the constraint, which determines how far the connected bodies can rotate around the twist axis before the constraint enforces limits.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintactora.html b/doc/doc_files/getconstraintactora.html index 4eb3aa2..c8831dc 100644 --- a/doc/doc_files/getconstraintactora.html +++ b/doc/doc_files/getconstraintactora.html @@ -3,15 +3,16 @@ - getConstraintActorA [RCBasic Doc] + GetConstraintActorA [RCBasic Doc] -

    function getConstraintActorA( constraint_id)

    +

    Function GetConstraintActorA( constraint_id)

    Returns the first actor in a constraint

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintactorb.html b/doc/doc_files/getconstraintactorb.html index 41c5436..b345813 100644 --- a/doc/doc_files/getconstraintactorb.html +++ b/doc/doc_files/getconstraintactorb.html @@ -3,15 +3,16 @@ - getConstraintActorB [RCBasic Doc] + GetConstraintActorB [RCBasic Doc] -

    function getConstraintActorB( constraint_id)

    +

    Function GetConstraintActorB( constraint_id)

    Returns the second actor in a constraint

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintaframe.html b/doc/doc_files/getconstraintaframe.html index 0adfb04..6499b6b 100644 --- a/doc/doc_files/getconstraintaframe.html +++ b/doc/doc_files/getconstraintaframe.html @@ -7,7 +7,7 @@ -

    function GetConstraintAFrame( constraint_id, mA)

    +

    Function GetConstraintAFrame( constraint_id, mA)

    Stores the transform of the first actor in a constraint in mA

    @@ -18,6 +18,7 @@ GetConstraintBFrame

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintangularonly.html b/doc/doc_files/getconstraintangularonly.html index fbdc3f3..a65a2e0 100644 --- a/doc/doc_files/getconstraintangularonly.html +++ b/doc/doc_files/getconstraintangularonly.html @@ -3,11 +3,11 @@ - getConstraintAngularOnly [RCBasic Doc] + GetConstraintAngularOnly [RCBasic Doc] -

    function getConstraintAngularOnly( constraint_id)

    +

    Function GetConstraintAngularOnly( constraint_id)

    Returns true if the hinge constraint is set to limit only angular motion while allowing unrestricted linear (translational) motion.

    @@ -18,6 +18,7 @@ SetConstraintAngularOnly

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintappliedimpulse.html b/doc/doc_files/getconstraintappliedimpulse.html index 1cd03f1..d9ff60a 100644 --- a/doc/doc_files/getconstraintappliedimpulse.html +++ b/doc/doc_files/getconstraintappliedimpulse.html @@ -3,15 +3,16 @@ - getConstraintAppliedImpulse [RCBasic Doc] + GetConstraintAppliedImpulse [RCBasic Doc] -

    function getConstraintAppliedImpulse( constraint_id)

    +

    Function GetConstraintAppliedImpulse( constraint_id)

    Returns the impulse applied to a constraint during the last simulation step. This impulse is the force integrated over a small time step (impulse = force × time) and is applied to resolve the constraint and maintain its behavior, such as keeping two objects connected or restricting movement.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintbframe.html b/doc/doc_files/getconstraintbframe.html index 3762259..675f222 100644 --- a/doc/doc_files/getconstraintbframe.html +++ b/doc/doc_files/getconstraintbframe.html @@ -7,7 +7,7 @@ -

    function GetConstraintBFrame( constraint_id, mA)

    +

    Function GetConstraintBFrame( constraint_id, mA)

    Stores the transform of the second actor in a constraint in mA

    @@ -18,6 +18,7 @@ GetConstraintAFrame

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintbreakingimpulsethreshold.html b/doc/doc_files/getconstraintbreakingimpulsethreshold.html index 4a857de..82a73e6 100644 --- a/doc/doc_files/getconstraintbreakingimpulsethreshold.html +++ b/doc/doc_files/getconstraintbreakingimpulsethreshold.html @@ -3,11 +3,11 @@ - getConstraintBreakingImpulseThreshold [RCBasic Doc] + GetConstraintBreakingImpulseThreshold [RCBasic Doc] -

    function getConstraintBreakingImpulseThreshold( constraint_id)

    +

    Function GetConstraintBreakingImpulseThreshold( constraint_id)

    Returns the breaking impulse threshold for a given constraint. The breaking impulse threshold defines the maximum force (impulse) a constraint can withstand before it "breaks," meaning that the constraint will be deactivated and no longer enforce its rules.

    @@ -15,6 +15,7 @@ SetConstraintBreakingImpulseThreshold

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintfixedactor.html b/doc/doc_files/getconstraintfixedactor.html index 7bcee13..c8b48ef 100644 --- a/doc/doc_files/getconstraintfixedactor.html +++ b/doc/doc_files/getconstraintfixedactor.html @@ -3,15 +3,16 @@ - getConstraintFixedActor [RCBasic Doc] + GetConstraintFixedActor [RCBasic Doc] -

    function getConstraintFixedActor( constraint_id)

    +

    Function GetConstraintFixedActor( constraint_id)

    Returns the actor that is associated with a specific constraint. This is primarily applicable in constraints that involve one actor being constrained to another or to a static point in the simulation.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintframeoffseta.html b/doc/doc_files/getconstraintframeoffseta.html index c3f63fe..686db3f 100644 --- a/doc/doc_files/getconstraintframeoffseta.html +++ b/doc/doc_files/getconstraintframeoffseta.html @@ -3,11 +3,11 @@ - getConstraintFrameOffsetA [RCBasic Doc] + GetConstraintFrameOffsetA [RCBasic Doc] -

    sub getConstraintFrameOffsetA( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz)

    +

    Sub GetConstraintFrameOffsetA( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz)

    Gets the frame offset for actor A associated with a particular constraint. This frame offset defines the position and orientation of actor A relative to the constraint's anchor point.

    @@ -15,6 +15,7 @@ GetConstraintFrameOffsetB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintframeoffsetb.html b/doc/doc_files/getconstraintframeoffsetb.html index c8d92c5..6095fa3 100644 --- a/doc/doc_files/getconstraintframeoffsetb.html +++ b/doc/doc_files/getconstraintframeoffsetb.html @@ -3,11 +3,11 @@ - getConstraintFrameOffsetB [RCBasic Doc] + GetConstraintFrameOffsetB [RCBasic Doc] -

    sub getConstraintFrameOffsetB( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz)

    +

    Sub GetConstraintFrameOffsetB( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz)

    Gets the frame offset for actor B associated with a particular constraint. This frame offset defines the position and orientation of actor B relative to the constraint's anchor point.

    @@ -15,6 +15,7 @@ GetConstraintFrameOffsetA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintlimitsoftness.html b/doc/doc_files/getconstraintlimitsoftness.html index 08649a7..ed7e563 100644 --- a/doc/doc_files/getconstraintlimitsoftness.html +++ b/doc/doc_files/getconstraintlimitsoftness.html @@ -3,11 +3,11 @@ - getConstraintLimitSoftness [RCBasic Doc] + GetConstraintLimitSoftness [RCBasic Doc] -

    function getConstraintLimitSoftness( constraint_id)

    +

    Function GetConstraintLimitSoftness( constraint_id)

    Returns the softness parameter associated with the limits of the constraint. This softness affects how the constraint behaves when the angular motion of the connected actors approaches their defined limits.

    @@ -27,6 +27,7 @@ SetConstraintSoftnessOrthoAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/getconstraintsolveriterations.html b/doc/doc_files/getconstraintsolveriterations.html index ca94897..8a98f6c 100644 --- a/doc/doc_files/getconstraintsolveriterations.html +++ b/doc/doc_files/getconstraintsolveriterations.html @@ -3,15 +3,16 @@ - getConstraintSolverIterations [RCBasic Doc] + GetConstraintSolverIterations [RCBasic Doc] -

    function getConstraintSolverIterations( constraint_id)

    +

    Function GetConstraintSolverIterations( constraint_id)

    Returns the value for the number of solver iterations that have been overridden for a specific constraint or actor. Solver iterations refer to the number of times the physics engine solves for constraint forces during each simulation step.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getdesktopdisplaymode.html b/doc/doc_files/getdesktopdisplaymode.html index 51cce9a..58dd4e9 100644 --- a/doc/doc_files/getdesktopdisplaymode.html +++ b/doc/doc_files/getdesktopdisplaymode.html @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getglobalmouse.html b/doc/doc_files/getglobalmouse.html index b309a3d..8a92fcd 100644 --- a/doc/doc_files/getglobalmouse.html +++ b/doc/doc_files/getglobalmouse.html @@ -7,11 +7,12 @@ -

    sub GetGlobalMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3)

    +

    Sub GetGlobalMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3)

    Gets the global mouse position and button state

    +

    \ No newline at end of file diff --git a/doc/doc_files/getgpuinfo.html b/doc/doc_files/getgpuinfo.html index 923b84e..0295143 100644 --- a/doc/doc_files/getgpuinfo.html +++ b/doc/doc_files/getgpuinfo.html @@ -7,11 +7,12 @@ -

    function GetGPUInfo$()

    +

    Function GetGPUInfo$()

    Returns the GPU Vendor info

    +

    \ No newline at end of file diff --git a/doc/doc_files/getgravity2d.html b/doc/doc_files/getgravity2d.html index 030e929..3c1ec40 100644 --- a/doc/doc_files/getgravity2d.html +++ b/doc/doc_files/getgravity2d.html @@ -7,7 +7,7 @@ -

    sub GetGravity2D(ByRef x, ByRef y)

    +

    Sub GetGravity2D(ByRef x, ByRef y)

    Use this function for retrieving the global gravity vector. A sprite canvas layer must be open.

    @@ -15,6 +15,7 @@ SetGravity2D

    +

    \ No newline at end of file diff --git a/doc/doc_files/getgravity3d.html b/doc/doc_files/getgravity3d.html index 4d9e61b..c022fd0 100644 --- a/doc/doc_files/getgravity3d.html +++ b/doc/doc_files/getgravity3d.html @@ -7,7 +7,7 @@ -

    sub GetGravity3D(ByRef x, ByRef y, ByRef z)

    +

    Sub GetGravity3D(ByRef x, ByRef y, ByRef z)

    Gets the world gravity

    @@ -15,6 +15,7 @@ SetGravity3D

    +

    \ No newline at end of file diff --git a/doc/doc_files/getgyro.html b/doc/doc_files/getgyro.html index 3a94566..bc31908 100644 --- a/doc/doc_files/getgyro.html +++ b/doc/doc_files/getgyro.html @@ -7,11 +7,12 @@ -

    sub GetGyro(gyro_num, ByRef x, ByRef y, ByRef z)

    +

    Sub GetGyro(gyro_num, ByRef x, ByRef y, ByRef z)

    Gets the values of a Gyro sensor

    +

    \ No newline at end of file diff --git a/doc/doc_files/gethingeangle.html b/doc/doc_files/gethingeangle.html index 266b555..35ba3d5 100644 --- a/doc/doc_files/gethingeangle.html +++ b/doc/doc_files/gethingeangle.html @@ -3,15 +3,16 @@ - getHingeAngle [RCBasic Doc] + GetHingeAngle [RCBasic Doc] -

    function getHingeAngle( constraint_id)

    +

    Function GetHingeAngle( constraint_id)

    Returns the angle of a hinge constraint

    +

    \ No newline at end of file diff --git a/doc/doc_files/gethingeangleex.html b/doc/doc_files/gethingeangleex.html index 9b57eab..f6e8e84 100644 --- a/doc/doc_files/gethingeangleex.html +++ b/doc/doc_files/gethingeangleex.html @@ -3,15 +3,16 @@ - getHingeAngleEx [RCBasic Doc] + GetHingeAngleEx [RCBasic Doc] -

    function getHingeAngleEx( constraint_id, t_matrixA, t_matrixB)

    +

    Function GetHingeAngleEx( constraint_id, t_matrixA, t_matrixB)

    Returns the transforms of the 2 actors in a hinge constraint

    +

    \ No newline at end of file diff --git a/doc/doc_files/gethingelimitbiasfactor.html b/doc/doc_files/gethingelimitbiasfactor.html index ea7f555..2c46b6a 100644 --- a/doc/doc_files/gethingelimitbiasfactor.html +++ b/doc/doc_files/gethingelimitbiasfactor.html @@ -3,11 +3,11 @@ - getHingeLimitBiasFactor [RCBasic Doc] + GetHingeLimitBiasFactor [RCBasic Doc] -

    function getHingeLimitBiasFactor( constraint_id)

    +

    Function GetHingeLimitBiasFactor( constraint_id)

    Returns the bias factor associated with the limits of the hinge constraint. This bias factor affects how the constraint corrects errors when the angular position of the constrained actors approaches or exceeds the defined limits.

    @@ -15,6 +15,7 @@ The bias factor is a parameter that influences how aggressively the constraint corrects the position when the angular motion reaches the limits. A higher bias factor results in a stronger corrective force, helping to pull the constrained bodies back within their limits more quickly.

    +

    \ No newline at end of file diff --git a/doc/doc_files/gethingelimitrelaxationfactor.html b/doc/doc_files/gethingelimitrelaxationfactor.html index dad9624..b3d4d72 100644 --- a/doc/doc_files/gethingelimitrelaxationfactor.html +++ b/doc/doc_files/gethingelimitrelaxationfactor.html @@ -3,12 +3,13 @@ - getHingeLimitRelaxationFactor [RCBasic Doc] + GetHingeLimitRelaxationFactor [RCBasic Doc] -

    function getHingeLimitRelaxationFactor( constraint_id)

    +

    Function GetHingeLimitRelaxationFactor( constraint_id)

    +

    \ No newline at end of file diff --git a/doc/doc_files/gethingelimitsign.html b/doc/doc_files/gethingelimitsign.html index f2b8d70..dab0477 100644 --- a/doc/doc_files/gethingelimitsign.html +++ b/doc/doc_files/gethingelimitsign.html @@ -3,11 +3,11 @@ - getHingeLimitSign [RCBasic Doc] + GetHingeLimitSign [RCBasic Doc] -

    function getHingeLimitSign( constraint_id)

    +

    Function GetHingeLimitSign( constraint_id)

    Returns the limit sign for the hinge constraint. This value indicates the direction in which the hinge limit is applied, which can be crucial for understanding the behavior of the hinge in relation to its limits.

    @@ -18,6 +18,7 @@ SetHingeLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/gethingesolvelimit.html b/doc/doc_files/gethingesolvelimit.html index ae09066..40ea8e8 100644 --- a/doc/doc_files/gethingesolvelimit.html +++ b/doc/doc_files/gethingesolvelimit.html @@ -3,11 +3,11 @@ - getHingeSolveLimit [RCBasic Doc] + GetHingeSolveLimit [RCBasic Doc] -

    function getHingeSolveLimit( constraint_id)

    +

    Function GetHingeSolveLimit( constraint_id)

    Checks whether the hinge has reached or exceeded its angular limit during the simulation. It returns a boolean or an integer value that indicates whether the current angular position is within the constraint's angular limits or if corrective forces need to be applied.

    @@ -15,6 +15,7 @@ The "solve limit" refers to whether the current angular position is close to or outside the defined angular limits. If the constraint detects that the hinge is at the limit, it enters a solving state, where it applies corrective forces to keep the rotation within the allowed range.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getimagealpha.html b/doc/doc_files/getimagealpha.html index f411c76..d5c7944 100644 --- a/doc/doc_files/getimagealpha.html +++ b/doc/doc_files/getimagealpha.html @@ -7,11 +7,12 @@ -

    function GetImageAlpha( img_id )

    +

    Function GetImageAlpha( img_id )

    Returns the alpha blend value of an image

    +

    \ No newline at end of file diff --git a/doc/doc_files/getimagecolormod.html b/doc/doc_files/getimagecolormod.html index 37be61e..915a2aa 100644 --- a/doc/doc_files/getimagecolormod.html +++ b/doc/doc_files/getimagecolormod.html @@ -7,11 +7,12 @@ -

    function GetImageColorMod(img)

    +

    Function GetImageColorMod(img)

    Returns the color modulation of an image

    +

    \ No newline at end of file diff --git a/doc/doc_files/getimagesize.html b/doc/doc_files/getimagesize.html index 19288b5..66a5d48 100644 --- a/doc/doc_files/getimagesize.html +++ b/doc/doc_files/getimagesize.html @@ -7,11 +7,12 @@ -

    sub GetImageSize(slot, byref w, byref h)

    +

    Sub GetImageSize(slot, ByRef w, ByRef h)

    Gets the Size of an image

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointangle.html b/doc/doc_files/getjointangle.html index 461bed3..66ec302 100644 --- a/doc/doc_files/getjointangle.html +++ b/doc/doc_files/getjointangle.html @@ -3,11 +3,11 @@ - getJointAngle [RCBasic Doc] + GetJointAngle [RCBasic Doc] -

    function getJointAngle( joint_id)

    +

    Function GetJointAngle( joint_id)

    Returns the current joint angle

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointangularoffset.html b/doc/doc_files/getjointangularoffset.html index 7472f1b..6df620c 100644 --- a/doc/doc_files/getjointangularoffset.html +++ b/doc/doc_files/getjointangularoffset.html @@ -3,11 +3,11 @@ - getJointAngularOffset [RCBasic Doc] + GetJointAngularOffset [RCBasic Doc] -

    function getJointAngularOffset( joint_id)

    +

    Function GetJointAngularOffset( joint_id)

    Returns the target angular offset

    @@ -18,6 +18,7 @@ SetJointAngularOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointangularspeed.html b/doc/doc_files/getjointangularspeed.html index 9a380dc..59543c7 100644 --- a/doc/doc_files/getjointangularspeed.html +++ b/doc/doc_files/getjointangularspeed.html @@ -3,11 +3,11 @@ - getJointAngularSpeed [RCBasic Doc] + GetJointAngularSpeed [RCBasic Doc] -

    function getJointAngularSpeed( joint_id)

    +

    Function GetJointAngularSpeed( joint_id)

    Return the current joint angular speed

    @@ -15,6 +15,7 @@ Used with Wheel Joint

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointcorrectionfactor.html b/doc/doc_files/getjointcorrectionfactor.html index ec2786d..e12ef0e 100644 --- a/doc/doc_files/getjointcorrectionfactor.html +++ b/doc/doc_files/getjointcorrectionfactor.html @@ -3,11 +3,11 @@ - getJointCorrectionFactor [RCBasic Doc] + GetJointCorrectionFactor [RCBasic Doc] -

    function getJointCorrectionFactor( joint_id)

    +

    Function GetJointCorrectionFactor( joint_id)

    Returns a factor for how quickly the joint corrects deviations from its target position and rotation. This correction factor determines the responsiveness of the motor joint in achieving the desired linear and angular offsets between two connected bodies.

    @@ -18,6 +18,7 @@ GetJointCorrectionFactor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointcurrentlength.html b/doc/doc_files/getjointcurrentlength.html index a12fad9..8a59453 100644 --- a/doc/doc_files/getjointcurrentlength.html +++ b/doc/doc_files/getjointcurrentlength.html @@ -3,11 +3,11 @@ - getJointCurrentLength [RCBasic Doc] + GetJointCurrentLength [RCBasic Doc] -

    function getJointCurrentLength( joint_id)

    +

    Function GetJointCurrentLength( joint_id)

    Returns the current distance between BodyA and BodyB

    @@ -18,6 +18,7 @@ GetJointLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointcurrentlengtha.html b/doc/doc_files/getjointcurrentlengtha.html index 7831fa0..c1bd9ef 100644 --- a/doc/doc_files/getjointcurrentlengtha.html +++ b/doc/doc_files/getjointcurrentlengtha.html @@ -3,11 +3,11 @@ - getJointCurrentLengthA [RCBasic Doc] + GetJointCurrentLengthA [RCBasic Doc] -

    function getJointCurrentLengthA( joint_id)

    +

    Function GetJointCurrentLengthA( joint_id)

    Return the current length of the segment attached to bodyA.

    @@ -18,6 +18,7 @@ GetJointCurrentLengthB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointcurrentlengthb.html b/doc/doc_files/getjointcurrentlengthb.html index e1c0ce2..89b0d83 100644 --- a/doc/doc_files/getjointcurrentlengthb.html +++ b/doc/doc_files/getjointcurrentlengthb.html @@ -3,11 +3,11 @@ - getJointCurrentLengthB [RCBasic Doc] + GetJointCurrentLengthB [RCBasic Doc] -

    function getJointCurrentLengthB( joint_id)

    +

    Function GetJointCurrentLengthB( joint_id)

    Return the current length of the segment attached to bodyB.

    @@ -18,6 +18,7 @@ GetJointCurrentLengthA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointdamping.html b/doc/doc_files/getjointdamping.html index 5358486..5371159 100644 --- a/doc/doc_files/getjointdamping.html +++ b/doc/doc_files/getjointdamping.html @@ -3,11 +3,11 @@ - getJointDamping [RCBasic Doc] + GetJointDamping [RCBasic Doc] -

    function getJointDamping( joint_id)

    +

    Function GetJointDamping( joint_id)

    Returns the damping value for a joint

    @@ -29,6 +29,7 @@ SetJointDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointgroundanchora.html b/doc/doc_files/getjointgroundanchora.html index 15e94a4..740afe7 100644 --- a/doc/doc_files/getjointgroundanchora.html +++ b/doc/doc_files/getjointgroundanchora.html @@ -3,11 +3,11 @@ - getJointGroundAnchorA [RCBasic Doc] + GetJointGroundAnchorA [RCBasic Doc] -

    sub getJointGroundAnchorA( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointGroundAnchorA( joint_id, ByRef x, ByRef y)

    Gets the first ground anchor

    @@ -18,6 +18,7 @@ GetJointGroundAnchorB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointgroundanchorb.html b/doc/doc_files/getjointgroundanchorb.html index a48bbad..f3fd8e4 100644 --- a/doc/doc_files/getjointgroundanchorb.html +++ b/doc/doc_files/getjointgroundanchorb.html @@ -3,11 +3,11 @@ - getJointGroundAnchorB [RCBasic Doc] + GetJointGroundAnchorB [RCBasic Doc] -

    sub getJointGroundAnchorB( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointGroundAnchorB( joint_id, ByRef x, ByRef y)

    Gets the second ground anchor

    @@ -18,6 +18,7 @@ GetJointGroundAnchorA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlength.html b/doc/doc_files/getjointlength.html index 76e0b9a..8b4dad7 100644 --- a/doc/doc_files/getjointlength.html +++ b/doc/doc_files/getjointlength.html @@ -3,11 +3,11 @@ - getJointLength [RCBasic Doc] + GetJointLength [RCBasic Doc] -

    function getJointLength( joint_id)

    +

    Function GetJointLength( joint_id)

    Returns the Joint Length

    @@ -18,6 +18,7 @@ SetJointLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlengtha.html b/doc/doc_files/getjointlengtha.html index bbb26a4..c38d754 100644 --- a/doc/doc_files/getjointlengtha.html +++ b/doc/doc_files/getjointlengtha.html @@ -3,11 +3,11 @@ - getJointLengthA [RCBasic Doc] + GetJointLengthA [RCBasic Doc] -

    function getJointLengthA( joint_id)

    +

    Function GetJointLengthA( joint_id)

    Returns the current length of the line connecting the anchor point on the first body to its corresponding ground anchor. This length can vary based on the movement of the connected bodies.

    @@ -18,6 +18,7 @@ GetJointLengthB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlengthb.html b/doc/doc_files/getjointlengthb.html index 0a078b6..8d40c34 100644 --- a/doc/doc_files/getjointlengthb.html +++ b/doc/doc_files/getjointlengthb.html @@ -3,11 +3,11 @@ - getJointLengthB [RCBasic Doc] + GetJointLengthB [RCBasic Doc] -

    function getJointLengthB( joint_id)

    +

    Function GetJointLengthB( joint_id)

    Returns the current length of the line connecting the anchor point on the second body to its corresponding ground anchor. This length can vary based on the movement of the connected bodies.

    @@ -18,6 +18,7 @@ GetJointLengthA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlinearoffset.html b/doc/doc_files/getjointlinearoffset.html index 4561599..d88173a 100644 --- a/doc/doc_files/getjointlinearoffset.html +++ b/doc/doc_files/getjointlinearoffset.html @@ -3,11 +3,11 @@ - getJointLinearOffset [RCBasic Doc] + GetJointLinearOffset [RCBasic Doc] -

    sub getJointLinearOffset( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointLinearOffset( joint_id, ByRef x, ByRef y)

    Gets the target position offset for the connected bodies relative to each other.

    @@ -18,6 +18,7 @@ SetJointLinearOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlinearspeed.html b/doc/doc_files/getjointlinearspeed.html index 1aa5aac..f9d07fb 100644 --- a/doc/doc_files/getjointlinearspeed.html +++ b/doc/doc_files/getjointlinearspeed.html @@ -3,11 +3,11 @@ - getJointLinearSpeed [RCBasic Doc] + GetJointLinearSpeed [RCBasic Doc] -

    function getJointLinearSpeed( joint_id)

    +

    Function GetJointLinearSpeed( joint_id)

    Returns the current joint linear speed, usually in meters per second.

    @@ -15,6 +15,7 @@ Used with Wheel Joint

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlocalanchora.html b/doc/doc_files/getjointlocalanchora.html index 502a4eb..68bc131 100644 --- a/doc/doc_files/getjointlocalanchora.html +++ b/doc/doc_files/getjointlocalanchora.html @@ -3,11 +3,11 @@ - getJointLocalAnchorA [RCBasic Doc] + GetJointLocalAnchorA [RCBasic Doc] -

    sub getJointLocalAnchorA( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointLocalAnchorA( joint_id, ByRef x, ByRef y)

    Returns the local anchor point relative to bodyA's origin.

    @@ -35,6 +35,7 @@ GetJointLocalAnchorB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlocalanchorb.html b/doc/doc_files/getjointlocalanchorb.html index 1b6f117..59e578a 100644 --- a/doc/doc_files/getjointlocalanchorb.html +++ b/doc/doc_files/getjointlocalanchorb.html @@ -3,11 +3,11 @@ - getJointLocalAnchorB [RCBasic Doc] + GetJointLocalAnchorB [RCBasic Doc] -

    sub getJointLocalAnchorB( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointLocalAnchorB( joint_id, ByRef x, ByRef y)

    Returns the local anchor point relative to bodyB's origin.

    @@ -35,6 +35,7 @@ GetJointLocalAnchorA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlocalaxisa.html b/doc/doc_files/getjointlocalaxisa.html index c1e934c..10d15dd 100644 --- a/doc/doc_files/getjointlocalaxisa.html +++ b/doc/doc_files/getjointlocalaxisa.html @@ -3,11 +3,11 @@ - getJointLocalAxisA [RCBasic Doc] + GetJointLocalAxisA [RCBasic Doc] -

    sub getJointLocalAxisA( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointLocalAxisA( joint_id, ByRef x, ByRef y)

    Gets the local joint axis relative to bodyA

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointlowerlimit.html b/doc/doc_files/getjointlowerlimit.html index 6fedb2c..d2bf84b 100644 --- a/doc/doc_files/getjointlowerlimit.html +++ b/doc/doc_files/getjointlowerlimit.html @@ -3,11 +3,11 @@ - getJointLowerLimit [RCBasic Doc] + GetJointLowerLimit [RCBasic Doc] -

    function getJointLowerLimit( joint_id)

    +

    Function GetJointLowerLimit( joint_id)

    Get the lower joint translation limit, usually in meters.

    @@ -29,6 +29,7 @@ GetJointUpperLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmaxforce.html b/doc/doc_files/getjointmaxforce.html index bcc6be7..74a2114 100644 --- a/doc/doc_files/getjointmaxforce.html +++ b/doc/doc_files/getjointmaxforce.html @@ -3,11 +3,11 @@ - getJointMaxForce [RCBasic Doc] + GetJointMaxForce [RCBasic Doc] -

    function getJointMaxForce( joint_id)

    +

    Function GetJointMaxForce( joint_id)

    Return the maximum friction force in N.

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmaxlength.html b/doc/doc_files/getjointmaxlength.html index ba5f227..990f6d1 100644 --- a/doc/doc_files/getjointmaxlength.html +++ b/doc/doc_files/getjointmaxlength.html @@ -3,11 +3,11 @@ - getJointMaxLength [RCBasic Doc] + GetJointMaxLength [RCBasic Doc] -

    function getJointMaxLength( joint_id)

    +

    Function GetJointMaxLength( joint_id)

    Returns the maximum length

    @@ -18,6 +18,7 @@ GetJointMinLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmaxmotorforce.html b/doc/doc_files/getjointmaxmotorforce.html index f91df43..c66aec8 100644 --- a/doc/doc_files/getjointmaxmotorforce.html +++ b/doc/doc_files/getjointmaxmotorforce.html @@ -3,11 +3,11 @@ - getJointMaxMotorForce [RCBasic Doc] + GetJointMaxMotorForce [RCBasic Doc] -

    function getJointMaxMotorForce( joint_id)

    +

    Function GetJointMaxMotorForce( joint_id)

    Returns the maximum linear force that the motor can apply to achieve the target speed set by SetMotorSpeed. This allows you to control the power or strength of the motor along the joint’s axis.

    @@ -18,6 +18,7 @@ SetJointMaxMotorForce

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmaxmotortorque.html b/doc/doc_files/getjointmaxmotortorque.html index 30ca2ae..526e854 100644 --- a/doc/doc_files/getjointmaxmotortorque.html +++ b/doc/doc_files/getjointmaxmotortorque.html @@ -3,11 +3,11 @@ - getJointMaxMotorTorque [RCBasic Doc] + GetJointMaxMotorTorque [RCBasic Doc] -

    function getJointMaxMotorTorque( joint_id)

    +

    Function GetJointMaxMotorTorque( joint_id)

    Returns the maximum torque (rotational force) that the motor can apply to achieve the target motor speed set by SetMotorSpeed. This allows you to control how much power the motorized joint has.

    @@ -26,6 +26,7 @@ SetJointMaxMotorTorque

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmaxtorque.html b/doc/doc_files/getjointmaxtorque.html index 549db1e..9a389e4 100644 --- a/doc/doc_files/getjointmaxtorque.html +++ b/doc/doc_files/getjointmaxtorque.html @@ -3,11 +3,11 @@ - getJointMaxTorque [RCBasic Doc] + GetJointMaxTorque [RCBasic Doc] -

    function getJointMaxTorque( joint_id)

    +

    Function GetJointMaxTorque( joint_id)

    Returns the upper limit on the amount of torque (rotational force) the joint can apply, controlling how much rotational resistance or power the joint provides.

    @@ -26,6 +26,7 @@ SetJointMaxTorque

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointminlength.html b/doc/doc_files/getjointminlength.html index 5ec0d93..d6a66e6 100644 --- a/doc/doc_files/getjointminlength.html +++ b/doc/doc_files/getjointminlength.html @@ -3,11 +3,11 @@ - getJointMinLength [RCBasic Doc] + GetJointMinLength [RCBasic Doc] -

    function getJointMinLength( joint_id)

    +

    Function GetJointMinLength( joint_id)

    Returns the minimum length

    @@ -18,6 +18,7 @@ GetJointMaxLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmotorforce.html b/doc/doc_files/getjointmotorforce.html index 2aec882..fc8f705 100644 --- a/doc/doc_files/getjointmotorforce.html +++ b/doc/doc_files/getjointmotorforce.html @@ -3,11 +3,11 @@ - getJointMotorForce [RCBasic Doc] + GetJointMotorForce [RCBasic Doc] -

    function getJointMotorForce( joint_id, inv_dt)

    +

    Function GetJointMotorForce( joint_id, inv_dt)

    Return the current motor force given the inverse time step, usually in N.

    @@ -18,6 +18,7 @@ SetJointMotorForce

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmotorspeed.html b/doc/doc_files/getjointmotorspeed.html index c8f91ec..63e9217 100644 --- a/doc/doc_files/getjointmotorspeed.html +++ b/doc/doc_files/getjointmotorspeed.html @@ -3,11 +3,11 @@ - getJointMotorSpeed [RCBasic Doc] + GetJointMotorSpeed [RCBasic Doc] -

    function getJointMotorSpeed( joint_id)

    +

    Function GetJointMotorSpeed( joint_id)

    Returns the motor speed

    @@ -29,6 +29,7 @@ SetJointMotorSpeed

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointmotortorque.html b/doc/doc_files/getjointmotortorque.html index a232663..c26c64c 100644 --- a/doc/doc_files/getjointmotortorque.html +++ b/doc/doc_files/getjointmotortorque.html @@ -3,11 +3,11 @@ - getJointMotorTorque [RCBasic Doc] + GetJointMotorTorque [RCBasic Doc] -

    function getJointMotorTorque( joint_id, inv_dt)

    +

    Function GetJointMotorTorque( joint_id, inv_dt)

    Returns the current motor torque given the inverse time step. Unit is N*m.

    @@ -27,6 +27,7 @@ SetJointMaxMotorTorque

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointratio.html b/doc/doc_files/getjointratio.html index 25ceffb..17c7a31 100644 --- a/doc/doc_files/getjointratio.html +++ b/doc/doc_files/getjointratio.html @@ -3,11 +3,11 @@ - getJointRatio [RCBasic Doc] + GetJointRatio [RCBasic Doc] -

    function getJointRatio( joint_id)

    +

    Function GetJointRatio( joint_id)

    Returns the gear/pulley ratio

    @@ -26,6 +26,7 @@ SetJointRatio

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointreactionforce.html b/doc/doc_files/getjointreactionforce.html index 077797a..f126f5f 100644 --- a/doc/doc_files/getjointreactionforce.html +++ b/doc/doc_files/getjointreactionforce.html @@ -3,11 +3,11 @@ - getJointReactionForce [RCBasic Doc] + GetJointReactionForce [RCBasic Doc] -

    sub getJointReactionForce( joint_id, inv_dt, ByRef x, ByRef y)

    +

    Sub GetJointReactionForce( joint_id, inv_dt, ByRef x, ByRef y)

    Returns the reaction force on bodyB at the joint anchor in Newtons.

    @@ -18,6 +18,7 @@ GetJointReactionTorque

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointreactiontorque.html b/doc/doc_files/getjointreactiontorque.html index 119be76..64600ae 100644 --- a/doc/doc_files/getjointreactiontorque.html +++ b/doc/doc_files/getjointreactiontorque.html @@ -3,11 +3,11 @@ - getJointReactionTorque [RCBasic Doc] + GetJointReactionTorque [RCBasic Doc] -

    function getJointReactionTorque( joint_id, inv_dt)

    +

    Function GetJointReactionTorque( joint_id, inv_dt)

    Returns the reaction torque on bodyB in N*m

    @@ -18,6 +18,7 @@ GetJointReactionForce

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointreferenceangle.html b/doc/doc_files/getjointreferenceangle.html index f7727de..7d01d51 100644 --- a/doc/doc_files/getjointreferenceangle.html +++ b/doc/doc_files/getjointreferenceangle.html @@ -3,11 +3,11 @@ - getJointReferenceAngle [RCBasic Doc] + GetJointReferenceAngle [RCBasic Doc] -

    function getJointReferenceAngle( joint_id)

    +

    Function GetJointReferenceAngle( joint_id)

    Returns the reference angle.

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointspeed.html b/doc/doc_files/getjointspeed.html index aded632..8cbc346 100644 --- a/doc/doc_files/getjointspeed.html +++ b/doc/doc_files/getjointspeed.html @@ -3,11 +3,11 @@ - getJointSpeed [RCBasic Doc] + GetJointSpeed [RCBasic Doc] -

    function getJointSpeed( joint_id)

    +

    Function GetJointSpeed( joint_id)

    Returns the current joint angle speed

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointstiffness.html b/doc/doc_files/getjointstiffness.html index 216095a..0207457 100644 --- a/doc/doc_files/getjointstiffness.html +++ b/doc/doc_files/getjointstiffness.html @@ -3,11 +3,11 @@ - getJointStiffness [RCBasic Doc] + GetJointStiffness [RCBasic Doc] -

    function getJointStiffness( joint_id)

    +

    Function GetJointStiffness( joint_id)

    Returns spring stiffness

    @@ -29,6 +29,7 @@ SetJointStiffness

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointtranslation.html b/doc/doc_files/getjointtranslation.html index e11406d..c12b371 100644 --- a/doc/doc_files/getjointtranslation.html +++ b/doc/doc_files/getjointtranslation.html @@ -3,11 +3,11 @@ - getJointTranslation [RCBasic Doc] + GetJointTranslation [RCBasic Doc] -

    function getJointTranslation( joint_id)

    +

    Function GetJointTranslation( joint_id)

    Returns the current joint translation, usually in meters.

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointupperlimit.html b/doc/doc_files/getjointupperlimit.html index 8ce9b4c..6998acc 100644 --- a/doc/doc_files/getjointupperlimit.html +++ b/doc/doc_files/getjointupperlimit.html @@ -3,11 +3,11 @@ - getJointUpperLimit [RCBasic Doc] + GetJointUpperLimit [RCBasic Doc] -

    function getJointUpperLimit( joint_id)

    +

    Function GetJointUpperLimit( joint_id)

    Get the upper joint translation limit, usually in meters.

    @@ -29,6 +29,7 @@ GetJointLowerLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointworldanchora.html b/doc/doc_files/getjointworldanchora.html index 36b589c..b70985c 100644 --- a/doc/doc_files/getjointworldanchora.html +++ b/doc/doc_files/getjointworldanchora.html @@ -3,11 +3,11 @@ - getJointWorldAnchorA [RCBasic Doc] + GetJointWorldAnchorA [RCBasic Doc] -

    sub getJointWorldAnchorA( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointWorldAnchorA( joint_id, ByRef x, ByRef y)

    Get the anchor point on bodyA in world coordinates.

    @@ -18,6 +18,7 @@ GetJointWorldAnchorB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjointworldanchorb.html b/doc/doc_files/getjointworldanchorb.html index 3b4818e..de83ef0 100644 --- a/doc/doc_files/getjointworldanchorb.html +++ b/doc/doc_files/getjointworldanchorb.html @@ -3,11 +3,11 @@ - getJointWorldAnchorB [RCBasic Doc] + GetJointWorldAnchorB [RCBasic Doc] -

    sub getJointWorldAnchorB( joint_id, ByRef x, ByRef y)

    +

    Sub GetJointWorldAnchorB( joint_id, ByRef x, ByRef y)

    Get the anchor point on bodyB in world coordinates.

    @@ -18,6 +18,7 @@ GetJointWorldAnchorA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getjoytrackball.html b/doc/doc_files/getjoytrackball.html index 41455b1..043374f 100644 --- a/doc/doc_files/getjoytrackball.html +++ b/doc/doc_files/getjoytrackball.html @@ -7,11 +7,12 @@ -

    sub GetJoyTrackBall(joy_num, ball, byref dx, byref dy)

    +

    Sub GetJoyTrackBall(joy_num, ball, ByRef dx, ByRef dy)

    Gets the axis values of a track ball

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightambientcolor.html b/doc/doc_files/getlightambientcolor.html index 8f12635..a2076f6 100644 --- a/doc/doc_files/getlightambientcolor.html +++ b/doc/doc_files/getlightambientcolor.html @@ -7,11 +7,12 @@ -

    function GetLightAmbientColor( actor )

    +

    Function GetLightAmbientColor( actor )

    Returns the ambient color of a light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightattenuation.html b/doc/doc_files/getlightattenuation.html index 49d93ca..e412b58 100644 --- a/doc/doc_files/getlightattenuation.html +++ b/doc/doc_files/getlightattenuation.html @@ -7,11 +7,12 @@ -

    sub GetLightAttenuation( actor, ByRef constant, ByRef linear, ByRef quadratic)

    +

    Sub GetLightAttenuation( actor, ByRef constant, ByRef linear, ByRef quadratic)

    Gets the strength of the light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightdiffusecolor.html b/doc/doc_files/getlightdiffusecolor.html index 60ded82..55c3597 100644 --- a/doc/doc_files/getlightdiffusecolor.html +++ b/doc/doc_files/getlightdiffusecolor.html @@ -7,11 +7,12 @@ -

    function GetLightDiffuseColor( actor )

    +

    Function GetLightDiffuseColor( actor )

    Returns the diffuse color of the light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightfalloff.html b/doc/doc_files/getlightfalloff.html index f2c918f..4c10a5d 100644 --- a/doc/doc_files/getlightfalloff.html +++ b/doc/doc_files/getlightfalloff.html @@ -7,11 +7,12 @@ -

    function GetLightFalloff( actor )

    +

    Function GetLightFalloff( actor )

    Returns the strength decrease between the inner and outer cone of a light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightinnercone.html b/doc/doc_files/getlightinnercone.html index e239a92..1033acc 100644 --- a/doc/doc_files/getlightinnercone.html +++ b/doc/doc_files/getlightinnercone.html @@ -7,11 +7,12 @@ -

    function GetLightInnerCone( actor )

    +

    Function GetLightInnerCone( actor )

    Returns the inner cone of a spot light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightoutercone.html b/doc/doc_files/getlightoutercone.html index 1ed16fb..f36998f 100644 --- a/doc/doc_files/getlightoutercone.html +++ b/doc/doc_files/getlightoutercone.html @@ -7,11 +7,12 @@ -

    function GetLightOuterCone( actor )

    +

    Function GetLightOuterCone( actor )

    Returns the outer cone of a spot light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightradius.html b/doc/doc_files/getlightradius.html index a5a1b6e..c74d701 100644 --- a/doc/doc_files/getlightradius.html +++ b/doc/doc_files/getlightradius.html @@ -3,15 +3,16 @@ - getLightRadius [RCBasic Doc] + GetLightRadius [RCBasic Doc] -

    function getLightRadius( actor )

    +

    Function GetLightRadius( actor )

    Returns the radius of the light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlightspecularcolor.html b/doc/doc_files/getlightspecularcolor.html index af93eb7..55178b5 100644 --- a/doc/doc_files/getlightspecularcolor.html +++ b/doc/doc_files/getlightspecularcolor.html @@ -7,11 +7,12 @@ -

    function GetLightSpecularColor( actor )

    +

    Function GetLightSpecularColor( actor )

    Returns the specular color of a light

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlighttype.html b/doc/doc_files/getlighttype.html index 9ed49d9..eaee2ee 100644 --- a/doc/doc_files/getlighttype.html +++ b/doc/doc_files/getlighttype.html @@ -7,7 +7,7 @@ -

    function GetLightType( actor )

    +

    Function GetLightType( actor )

    Returns the type of light

    @@ -32,6 +32,7 @@ SetLightType

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlineintersection.html b/doc/doc_files/getlineintersection.html index 6aa0219..57d41e6 100644 --- a/doc/doc_files/getlineintersection.html +++ b/doc/doc_files/getlineintersection.html @@ -15,6 +15,7 @@ Returns true if there is a collision and false if not

    +

    \ No newline at end of file diff --git a/doc/doc_files/getlineplaneintersection.html b/doc/doc_files/getlineplaneintersection.html index b8e52c2..28b60cb 100644 --- a/doc/doc_files/getlineplaneintersection.html +++ b/doc/doc_files/getlineplaneintersection.html @@ -7,7 +7,7 @@ -

    function GetLinePlaneIntersection(ByRef line_point, ByRef line_direction, ByRef plane_point_1, ByRef plane_point_2, ByRef plane_point_3, ByRef intersection)

    +

    Function GetLinePlaneIntersection(ByRef line_point, ByRef line_direction, ByRef plane_point_1, ByRef plane_point_2, ByRef plane_point_3, ByRef intersection)

    This function calculates the intersection between a line and a plane in 3D space and stores the result in intersection

    @@ -35,6 +35,7 @@ Returns true if intersection point is on the plane

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialambientcolor.html b/doc/doc_files/getmaterialambientcolor.html index 6144f54..8255f4a 100644 --- a/doc/doc_files/getmaterialambientcolor.html +++ b/doc/doc_files/getmaterialambientcolor.html @@ -7,11 +7,12 @@ -

    function GetMaterialAmbientColor( material_id)

    +

    Function GetMaterialAmbientColor( material_id)

    Returns the ambient color of a material

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialantialiasing.html b/doc/doc_files/getmaterialantialiasing.html index 91bd19d..726080f 100644 --- a/doc/doc_files/getmaterialantialiasing.html +++ b/doc/doc_files/getmaterialantialiasing.html @@ -7,7 +7,7 @@ -

    function GetMaterialAntiAliasing( material_id)

    +

    Function GetMaterialAntiAliasing( material_id)

    Returns the anti-aliasing mode for the material

    @@ -41,6 +41,7 @@ SetMaterialAntiAliasing

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialbackfaceculling.html b/doc/doc_files/getmaterialbackfaceculling.html index 98557db..499a474 100644 --- a/doc/doc_files/getmaterialbackfaceculling.html +++ b/doc/doc_files/getmaterialbackfaceculling.html @@ -3,11 +3,11 @@ - getMaterialBackfaceCulling [RCBasic Doc] + GetMaterialBackfaceCulling [RCBasic Doc] -

    function getMaterialBackfaceCulling( material_id)

    +

    Function GetMaterialBackfaceCulling( material_id)

    Returns true if backface culling is enabled for a material

    @@ -15,6 +15,7 @@ SetMaterialBackfaceCulling

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialblendfactor.html b/doc/doc_files/getmaterialblendfactor.html index f214b39..9d2f124 100644 --- a/doc/doc_files/getmaterialblendfactor.html +++ b/doc/doc_files/getmaterialblendfactor.html @@ -3,15 +3,16 @@ - getMaterialBlendFactor [RCBasic Doc] + GetMaterialBlendFactor [RCBasic Doc] -

    function getMaterialBlendFactor( material_id)

    +

    Function GetMaterialBlendFactor( material_id)

    Returns a materials blend factor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialblendmode.html b/doc/doc_files/getmaterialblendmode.html index edc46e0..412e73f 100644 --- a/doc/doc_files/getmaterialblendmode.html +++ b/doc/doc_files/getmaterialblendmode.html @@ -3,11 +3,11 @@ - getMaterialBlendMode [RCBasic Doc] + GetMaterialBlendMode [RCBasic Doc] -

    function getMaterialBlendMode( material_id)

    +

    Function GetMaterialBlendMode( material_id)

    Returns a materials blend mode

    @@ -50,6 +50,7 @@ SetMaterialBlendMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialcolormask.html b/doc/doc_files/getmaterialcolormask.html index 767551e..e2f03a2 100644 --- a/doc/doc_files/getmaterialcolormask.html +++ b/doc/doc_files/getmaterialcolormask.html @@ -7,11 +7,12 @@ -

    function GetMaterialColorMask( material_id)

    +

    Function GetMaterialColorMask( material_id)

    Returns the color mask for a material

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialcolormode.html b/doc/doc_files/getmaterialcolormode.html index 614d3f2..ec5dd10 100644 --- a/doc/doc_files/getmaterialcolormode.html +++ b/doc/doc_files/getmaterialcolormode.html @@ -3,11 +3,11 @@ - getMaterialColorMode [RCBasic Doc] + GetMaterialColorMode [RCBasic Doc] -

    function getMaterialColorMode( material_id)

    +

    Function GetMaterialColorMode( material_id)

    Returns the color mode of a material

    @@ -38,6 +38,7 @@ SetMaterialColorMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialconstant.html b/doc/doc_files/getmaterialconstant.html index 544eb65..0070169 100644 --- a/doc/doc_files/getmaterialconstant.html +++ b/doc/doc_files/getmaterialconstant.html @@ -18,6 +18,7 @@ SetMaterialConstant

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialconstantname.html b/doc/doc_files/getmaterialconstantname.html index b4fb73c..18271c1 100644 --- a/doc/doc_files/getmaterialconstantname.html +++ b/doc/doc_files/getmaterialconstantname.html @@ -18,6 +18,7 @@ NumMaterialConstants

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialdiffusecolor.html b/doc/doc_files/getmaterialdiffusecolor.html index 188de37..301f039 100644 --- a/doc/doc_files/getmaterialdiffusecolor.html +++ b/doc/doc_files/getmaterialdiffusecolor.html @@ -3,11 +3,11 @@ - getMaterialDiffuseColor [RCBasic Doc] + GetMaterialDiffuseColor [RCBasic Doc] -

    function getMaterialDiffuseColor( material_id)

    +

    Function GetMaterialDiffuseColor( material_id)

    Returns a material's diffuse color

    @@ -15,6 +15,7 @@ SetMaterialDiffuseColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialemissivecolor.html b/doc/doc_files/getmaterialemissivecolor.html index e59c14c..9c12bc5 100644 --- a/doc/doc_files/getmaterialemissivecolor.html +++ b/doc/doc_files/getmaterialemissivecolor.html @@ -3,11 +3,11 @@ - getMaterialEmissiveColor [RCBasic Doc] + GetMaterialEmissiveColor [RCBasic Doc] -

    function getMaterialEmissiveColor( material_id)

    +

    Function GetMaterialEmissiveColor( material_id)

    Returns a material's emissive color

    @@ -15,6 +15,7 @@ SetMaterialEmissiveColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialflag.html b/doc/doc_files/getmaterialflag.html index 22433e0..c68e5fa 100644 --- a/doc/doc_files/getmaterialflag.html +++ b/doc/doc_files/getmaterialflag.html @@ -3,11 +3,11 @@ - getMaterialFlag [RCBasic Doc] + GetMaterialFlag [RCBasic Doc] -

    function getMaterialFlag( material_id, material_flag)

    +

    Function GetMaterialFlag( material_id, material_flag)

    Returns the value of the specified material flag

    @@ -80,6 +80,7 @@ GetActorMaterialFlag

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialfog.html b/doc/doc_files/getmaterialfog.html index 87ac07a..eddb0f3 100644 --- a/doc/doc_files/getmaterialfog.html +++ b/doc/doc_files/getmaterialfog.html @@ -3,11 +3,11 @@ - getMaterialFog [RCBasic Doc] + GetMaterialFog [RCBasic Doc] -

    function getMaterialFog( material_id)

    +

    Function GetMaterialFog( material_id)

    Returns true if fog is enabled for a material

    @@ -15,6 +15,7 @@ SetMaterialFog

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialfrontfaceculling.html b/doc/doc_files/getmaterialfrontfaceculling.html index fbf6e1e..527598a 100644 --- a/doc/doc_files/getmaterialfrontfaceculling.html +++ b/doc/doc_files/getmaterialfrontfaceculling.html @@ -3,11 +3,11 @@ - getMaterialFrontfaceCulling [RCBasic Doc] + GetMaterialFrontfaceCulling [RCBasic Doc] -

    function getMaterialFrontfaceCulling( material_id)

    +

    Function GetMaterialFrontfaceCulling( material_id)

    Returns true if front face culling is enabled for a material

    @@ -15,6 +15,7 @@ SetMaterialFrontfaceCulling

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialshininess.html b/doc/doc_files/getmaterialshininess.html index 8e5dde5..a983921 100644 --- a/doc/doc_files/getmaterialshininess.html +++ b/doc/doc_files/getmaterialshininess.html @@ -3,11 +3,11 @@ - getMaterialShininess [RCBasic Doc] + GetMaterialShininess [RCBasic Doc] -

    function getMaterialShininess( material_id)

    +

    Function GetMaterialShininess( material_id)

    Returns the shininess value for a material

    @@ -15,6 +15,7 @@ SetMaterialShininess

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialspecularcolor.html b/doc/doc_files/getmaterialspecularcolor.html index 6d226e5..8052c30 100644 --- a/doc/doc_files/getmaterialspecularcolor.html +++ b/doc/doc_files/getmaterialspecularcolor.html @@ -3,11 +3,11 @@ - getMaterialSpecularColor [RCBasic Doc] + GetMaterialSpecularColor [RCBasic Doc] -

    function getMaterialSpecularColor( material_id)

    +

    Function GetMaterialSpecularColor( material_id)

    Returns the specular color for a material

    @@ -15,6 +15,7 @@ SetMaterialSpecularColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialthickness.html b/doc/doc_files/getmaterialthickness.html index 107b84e..eb49b7e 100644 --- a/doc/doc_files/getmaterialthickness.html +++ b/doc/doc_files/getmaterialthickness.html @@ -3,11 +3,11 @@ - getMaterialThickness [RCBasic Doc] + GetMaterialThickness [RCBasic Doc] -

    function getMaterialThickness( material_id)

    +

    Function GetMaterialThickness( material_id)

    Returns a material's thickness value

    @@ -18,6 +18,7 @@ SetMaterialThickness

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaterialtype.html b/doc/doc_files/getmaterialtype.html index cbba247..8b7e17d 100644 --- a/doc/doc_files/getmaterialtype.html +++ b/doc/doc_files/getmaterialtype.html @@ -3,11 +3,11 @@ - getMaterialType [RCBasic Doc] + GetMaterialType [RCBasic Doc] -

    function getMaterialType( material_id)

    +

    Function GetMaterialType( material_id)

    Returns a material's type

    @@ -130,6 +130,7 @@ SetActorMaterialType

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmatrixrotation.html b/doc/doc_files/getmatrixrotation.html index 5ce7d7f..db09444 100644 --- a/doc/doc_files/getmatrixrotation.html +++ b/doc/doc_files/getmatrixrotation.html @@ -7,7 +7,7 @@ -

    sub GetMatrixRotation( mA, ByRef x, ByRef y, ByRef z)

    +

    Sub GetMatrixRotation( mA, ByRef x, ByRef y, ByRef z)

    Gets the rotation vector of a matrix

    @@ -15,6 +15,7 @@ SetMatrixRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmatrixscale.html b/doc/doc_files/getmatrixscale.html index 95ee4b4..e2a9c20 100644 --- a/doc/doc_files/getmatrixscale.html +++ b/doc/doc_files/getmatrixscale.html @@ -7,7 +7,7 @@ -

    sub GetMatrixScale( mA, ByRef x, ByRef y, ByRef z)

    +

    Sub GetMatrixScale( mA, ByRef x, ByRef y, ByRef z)

    Gets the scale vector of a matrix

    @@ -15,6 +15,7 @@ SetMatrixScale

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmatrixsize.html b/doc/doc_files/getmatrixsize.html index b8eb6ac..b976300 100644 --- a/doc/doc_files/getmatrixsize.html +++ b/doc/doc_files/getmatrixsize.html @@ -7,7 +7,7 @@ -

    sub GetMatrixSize(mA, ByRef r, ByRef c)

    +

    Sub GetMatrixSize(mA, ByRef r, ByRef c)

    Gets the number of rows and columns in a matrix

    @@ -15,6 +15,7 @@ DimMatrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmatrixtranslation.html b/doc/doc_files/getmatrixtranslation.html index 19e3c65..5a417b8 100644 --- a/doc/doc_files/getmatrixtranslation.html +++ b/doc/doc_files/getmatrixtranslation.html @@ -7,7 +7,7 @@ -

    sub GetMatrixTranslation( mA, ByRef x, ByRef y, ByRef z)

    +

    Sub GetMatrixTranslation( mA, ByRef x, ByRef y, ByRef z)

    Get the position vector of a matrix

    @@ -15,6 +15,7 @@ SetMatrixTranslation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmaxparticlespersecond.html b/doc/doc_files/getmaxparticlespersecond.html index c6ede50..3b4feff 100644 --- a/doc/doc_files/getmaxparticlespersecond.html +++ b/doc/doc_files/getmaxparticlespersecond.html @@ -3,11 +3,11 @@ - getMaxParticlesPerSecond [RCBasic Doc] + GetMaxParticlesPerSecond [RCBasic Doc] -

    function getMaxParticlesPerSecond( actor)

    +

    Function GetMaxParticlesPerSecond( actor)

    Returns the max number of particles emitted per second

    @@ -17,6 +17,7 @@ SetMinParticlesPerSecond

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmeshboundingbox.html b/doc/doc_files/getmeshboundingbox.html index 4b8457a..e08767e 100644 --- a/doc/doc_files/getmeshboundingbox.html +++ b/doc/doc_files/getmeshboundingbox.html @@ -16,6 +16,7 @@ ReCalculateMeshBoundingBox

    +

    \ No newline at end of file diff --git a/doc/doc_files/getminparticlespersecond.html b/doc/doc_files/getminparticlespersecond.html index 3bd31f6..ab435f1 100644 --- a/doc/doc_files/getminparticlespersecond.html +++ b/doc/doc_files/getminparticlespersecond.html @@ -3,11 +3,11 @@ - getMinParticlesPerSecond [RCBasic Doc] + GetMinParticlesPerSecond [RCBasic Doc] -

    function getMinParticlesPerSecond( actor)

    +

    Function GetMinParticlesPerSecond( actor)

    Returns the min number of particles emitted per second

    @@ -17,6 +17,7 @@ SetMaxParticlesPerSecond

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmouse.html b/doc/doc_files/getmouse.html index ba9b9d8..1f00e8c 100644 --- a/doc/doc_files/getmouse.html +++ b/doc/doc_files/getmouse.html @@ -7,7 +7,7 @@ -

    sub GetMouse(byref x, byref y, byref mb1, byref mb2, byref mb3)

    +

    Sub GetMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3)

    Gets the mouse position and button state local to the graphics window

    @@ -18,6 +18,7 @@ MouseButton

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmousewheel.html b/doc/doc_files/getmousewheel.html index 2d02a60..f22f9c8 100644 --- a/doc/doc_files/getmousewheel.html +++ b/doc/doc_files/getmousewheel.html @@ -7,7 +7,7 @@ -

    sub GetMouseWheel(byref x_axis, byref y_axis)

    +

    Sub GetMouseWheel(ByRef x_axis, ByRef y_axis)

    Gets the axis positions of the mouse wheel

    @@ -16,6 +16,7 @@ GetGlobalMouse

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmultitouch.html b/doc/doc_files/getmultitouch.html index 6f75de2..3087e59 100644 --- a/doc/doc_files/getmultitouch.html +++ b/doc/doc_files/getmultitouch.html @@ -7,11 +7,12 @@ -

    sub GetMultiTouch(byref status, byref x, byref y, byref fingers, byref dist, byref theta)

    +

    Sub GetMultiTouch(ByRef status, ByRef x, ByRef y, ByRef fingers, ByRef dist, ByRef theta)

    Gets the status, position, number of fingers, distance between the fingers and rotation of a multi-finger gesture

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmusicposition.html b/doc/doc_files/getmusicposition.html index 8b65e66..1eadefe 100644 --- a/doc/doc_files/getmusicposition.html +++ b/doc/doc_files/getmusicposition.html @@ -7,7 +7,7 @@ -

    function GetMusicPosition()

    +

    Function GetMusicPosition()

    Returns the position of the music track

    @@ -15,6 +15,7 @@ SetMusicPosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/getmusicvolume.html b/doc/doc_files/getmusicvolume.html index b0304d2..02f062c 100644 --- a/doc/doc_files/getmusicvolume.html +++ b/doc/doc_files/getmusicvolume.html @@ -7,11 +7,12 @@ -

    function GetMusicVolume()

    +

    Function GetMusicVolume()

    Returns the music track's volume

    +

    \ No newline at end of file diff --git a/doc/doc_files/getnuman8scenes.html b/doc/doc_files/getnuman8scenes.html index 5ef92e1..08b9549 100644 --- a/doc/doc_files/getnuman8scenes.html +++ b/doc/doc_files/getnuman8scenes.html @@ -15,6 +15,7 @@ LoadAN8

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlebox.html b/doc/doc_files/getparticlebox.html index fc6f273..5dd1aad 100644 --- a/doc/doc_files/getparticlebox.html +++ b/doc/doc_files/getparticlebox.html @@ -3,15 +3,16 @@ - getParticleBox [RCBasic Doc] + GetParticleBox [RCBasic Doc] -

    sub getParticleBox( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z)

    +

    Sub GetParticleBox( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z)

    Gets the bounding box for a particle emitter

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlecenter.html b/doc/doc_files/getparticlecenter.html index ad64feb..4df8ec3 100644 --- a/doc/doc_files/getparticlecenter.html +++ b/doc/doc_files/getparticlecenter.html @@ -3,11 +3,11 @@ - getParticleCenter [RCBasic Doc] + GetParticleCenter [RCBasic Doc] -

    sub getParticleCenter( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetParticleCenter( actor, ByRef x, ByRef y, ByRef z)

    Gets the center of a particle emitter

    @@ -18,6 +18,7 @@ SetParticleCenter

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticledirection.html b/doc/doc_files/getparticledirection.html index b152366..d67fcd0 100644 --- a/doc/doc_files/getparticledirection.html +++ b/doc/doc_files/getparticledirection.html @@ -3,11 +3,11 @@ - getParticleDirection [RCBasic Doc] + GetParticleDirection [RCBasic Doc] -

    sub getParticleDirection( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetParticleDirection( actor, ByRef x, ByRef y, ByRef z)

    Gets the direction of a particle emitter

    @@ -15,6 +15,7 @@ SetParticleDirection

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlelength.html b/doc/doc_files/getparticlelength.html index 29c284e..a62bb53 100644 --- a/doc/doc_files/getparticlelength.html +++ b/doc/doc_files/getparticlelength.html @@ -3,11 +3,11 @@ - getParticleLength [RCBasic Doc] + GetParticleLength [RCBasic Doc] -

    function getParticleLength( actor)

    +

    Function GetParticleLength( actor)

    Returns the length of a cylinder particle emitter

    @@ -18,6 +18,7 @@ SetParticleLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxangle.html b/doc/doc_files/getparticlemaxangle.html index 205652e..cc44089 100644 --- a/doc/doc_files/getparticlemaxangle.html +++ b/doc/doc_files/getparticlemaxangle.html @@ -3,11 +3,11 @@ - getParticleMaxAngle [RCBasic Doc] + GetParticleMaxAngle [RCBasic Doc] -

    function getParticleMaxAngle( actor)

    +

    Function GetParticleMaxAngle( actor)

    Returns the max angle of particle emission

    @@ -15,6 +15,7 @@ SetParticleMaxAngle

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxlife.html b/doc/doc_files/getparticlemaxlife.html index fd2813e..f86c1d9 100644 --- a/doc/doc_files/getparticlemaxlife.html +++ b/doc/doc_files/getparticlemaxlife.html @@ -3,11 +3,11 @@ - getParticleMaxLife [RCBasic Doc] + GetParticleMaxLife [RCBasic Doc] -

    function getParticleMaxLife( actor)

    +

    Function GetParticleMaxLife( actor)

    Returns the max life of the particle emission

    @@ -18,6 +18,7 @@ SetParticleMaxLife

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxstartcolor.html b/doc/doc_files/getparticlemaxstartcolor.html index b01a34e..c48e1b9 100644 --- a/doc/doc_files/getparticlemaxstartcolor.html +++ b/doc/doc_files/getparticlemaxstartcolor.html @@ -3,11 +3,11 @@ - getParticleMaxStartColor [RCBasic Doc] + GetParticleMaxStartColor [RCBasic Doc] -

    function getParticleMaxStartColor( actor)

    +

    Function GetParticleMaxStartColor( actor)

    Returns max starting color for particles

    @@ -15,6 +15,7 @@ SetParticleMaxStartColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxstartsize.html b/doc/doc_files/getparticlemaxstartsize.html index b368780..c1e434f 100644 --- a/doc/doc_files/getparticlemaxstartsize.html +++ b/doc/doc_files/getparticlemaxstartsize.html @@ -3,11 +3,11 @@ - getParticleMaxStartSize [RCBasic Doc] + GetParticleMaxStartSize [RCBasic Doc] -

    sub getParticleMaxStartSize( actor, ByRef w, ByRef h)

    +

    Sub GetParticleMaxStartSize( actor, ByRef w, ByRef h)

    Gets the max start size for the particles

    @@ -15,6 +15,7 @@ SetParticleMaxStartSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticleminlife.html b/doc/doc_files/getparticleminlife.html index 00e0518..459af26 100644 --- a/doc/doc_files/getparticleminlife.html +++ b/doc/doc_files/getparticleminlife.html @@ -3,11 +3,11 @@ - getParticleMinLife [RCBasic Doc] + GetParticleMinLife [RCBasic Doc] -

    function getParticleMinLife( actor)

    +

    Function GetParticleMinLife( actor)

    Get the min life of particles

    @@ -18,6 +18,7 @@ SetParticleMinLife

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticleminstartcolor.html b/doc/doc_files/getparticleminstartcolor.html index 005ef5b..c767d70 100644 --- a/doc/doc_files/getparticleminstartcolor.html +++ b/doc/doc_files/getparticleminstartcolor.html @@ -3,11 +3,11 @@ - getParticleMinStartColor [RCBasic Doc] + GetParticleMinStartColor [RCBasic Doc] -

    function getParticleMinStartColor( actor)

    +

    Function GetParticleMinStartColor( actor)

    Returns the min start color for particles

    @@ -15,6 +15,7 @@ SetParticleMinStartColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticleminstartsize.html b/doc/doc_files/getparticleminstartsize.html index 7a47a4d..5394751 100644 --- a/doc/doc_files/getparticleminstartsize.html +++ b/doc/doc_files/getparticleminstartsize.html @@ -3,11 +3,11 @@ - getParticleMinStartSize [RCBasic Doc] + GetParticleMinStartSize [RCBasic Doc] -

    sub getParticleMinStartSize( actor, ByRef w, ByRef h)

    +

    Sub GetParticleMinStartSize( actor, ByRef w, ByRef h)

    Gets the min start size for particle emitter

    @@ -15,6 +15,7 @@ SetParticleMinStartSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlenormal.html b/doc/doc_files/getparticlenormal.html index 184b6ff..6198335 100644 --- a/doc/doc_files/getparticlenormal.html +++ b/doc/doc_files/getparticlenormal.html @@ -3,11 +3,11 @@ - getParticleNormal [RCBasic Doc] + GetParticleNormal [RCBasic Doc] -

    sub getParticleNormal( actor, ByRef x, ByRef y, ByRef z)

    +

    Sub GetParticleNormal( actor, ByRef x, ByRef y, ByRef z)

    Gets the normal of a particle emitter

    @@ -18,6 +18,7 @@ SetParticleNormal

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticlenormaldirectionmod.html b/doc/doc_files/getparticlenormaldirectionmod.html index 2c231af..25280b8 100644 --- a/doc/doc_files/getparticlenormaldirectionmod.html +++ b/doc/doc_files/getparticlenormaldirectionmod.html @@ -3,11 +3,11 @@ - getParticleNormalDirectionMod [RCBasic Doc] + GetParticleNormalDirectionMod [RCBasic Doc] -

    function getParticleNormalDirectionMod( actor)

    +

    Function GetParticleNormalDirectionMod( actor)

    Returns the normal direction modifier for a particle emitter

    @@ -18,6 +18,7 @@ SetParticleNormalDirectionMod

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticleradius.html b/doc/doc_files/getparticleradius.html index 5ecfe11..26f43cb 100644 --- a/doc/doc_files/getparticleradius.html +++ b/doc/doc_files/getparticleradius.html @@ -3,11 +3,11 @@ - getParticleRadius [RCBasic Doc] + GetParticleRadius [RCBasic Doc] -

    function getParticleRadius( actor)

    +

    Function GetParticleRadius( actor)

    Returns the radius of a particle emitter

    @@ -18,6 +18,7 @@ SetParticleRadius

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticleringthickness.html b/doc/doc_files/getparticleringthickness.html index 78d32ba..e8cefe8 100644 --- a/doc/doc_files/getparticleringthickness.html +++ b/doc/doc_files/getparticleringthickness.html @@ -3,11 +3,11 @@ - getParticleRingThickness [RCBasic Doc] + GetParticleRingThickness [RCBasic Doc] -

    function getParticleRingThickness( actor)

    +

    Function GetParticleRingThickness( actor)

    Returns the thickness of a ring emitter

    @@ -18,6 +18,7 @@ SetParticleRingThickness

    +

    \ No newline at end of file diff --git a/doc/doc_files/getparticletype.html b/doc/doc_files/getparticletype.html index f71720c..ce6c713 100644 --- a/doc/doc_files/getparticletype.html +++ b/doc/doc_files/getparticletype.html @@ -3,11 +3,11 @@ - getParticleType [RCBasic Doc] + GetParticleType [RCBasic Doc] -

    function getParticleType( actor )

    +

    Function GetParticleType( actor )

    Returns the particle type

    @@ -38,6 +38,7 @@ CreateParticleActor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getpixel.html b/doc/doc_files/getpixel.html index 5c0a75e..3b2546d 100644 --- a/doc/doc_files/getpixel.html +++ b/doc/doc_files/getpixel.html @@ -7,11 +7,12 @@ -

    function GetPixel(x,y)

    +

    Function GetPixel(x,y)

    Returns the color of a pixel

    +

    \ No newline at end of file diff --git a/doc/doc_files/getpointpivota.html b/doc/doc_files/getpointpivota.html index 667a691..6094d73 100644 --- a/doc/doc_files/getpointpivota.html +++ b/doc/doc_files/getpointpivota.html @@ -3,11 +3,11 @@ - getPointPivotA [RCBasic Doc] + GetPointPivotA [RCBasic Doc] -

    sub getPointPivotA( constraint_id, ByRef x, ByRef y, ByRef z)

    +

    Sub GetPointPivotA( constraint_id, ByRef x, ByRef y, ByRef z)

    Gets the pivot point on the first actor (Body A) of the constraint. This pivot point defines the specific location in the local space of Body A where the point-to-point constraint is anchored.

    @@ -16,6 +16,7 @@ SetPointPivotA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getpointpivotb.html b/doc/doc_files/getpointpivotb.html index 798eae4..bbed6ea 100644 --- a/doc/doc_files/getpointpivotb.html +++ b/doc/doc_files/getpointpivotb.html @@ -3,11 +3,11 @@ - getPointPivotB [RCBasic Doc] + GetPointPivotB [RCBasic Doc] -

    sub getPointtPivotB( constraint_id, ByRef x, ByRef y, ByRef z)

    +

    Sub GetPointtPivotB( constraint_id, ByRef x, ByRef y, ByRef z)

    Gets the pivot point on the first actor (Body B) of the constraint. This pivot point defines the specific location in the local space of Body B where the point-to-point constraint is anchored.

    @@ -16,6 +16,7 @@ SetPointPivotB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getpowerinfo.html b/doc/doc_files/getpowerinfo.html index 564f0e6..08ab6e3 100644 --- a/doc/doc_files/getpowerinfo.html +++ b/doc/doc_files/getpowerinfo.html @@ -35,6 +35,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/getprojectionmatrix.html b/doc/doc_files/getprojectionmatrix.html index e81eb1c..7e43385 100644 --- a/doc/doc_files/getprojectionmatrix.html +++ b/doc/doc_files/getprojectionmatrix.html @@ -26,6 +26,7 @@ SetProjectionMatrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/getprojectorfov.html b/doc/doc_files/getprojectorfov.html index 25efbdc..e91fda3 100644 --- a/doc/doc_files/getprojectorfov.html +++ b/doc/doc_files/getprojectorfov.html @@ -15,6 +15,7 @@ SetProjectorFOV

    +

    \ No newline at end of file diff --git a/doc/doc_files/getprojectortarget.html b/doc/doc_files/getprojectortarget.html index 7c0d6e2..d20f64d 100644 --- a/doc/doc_files/getprojectortarget.html +++ b/doc/doc_files/getprojectortarget.html @@ -15,6 +15,7 @@ SetProjectorTarget

    +

    \ No newline at end of file diff --git a/doc/doc_files/getrayhit2d.html b/doc/doc_files/getrayhit2d.html index a3cd111..61efaf9 100644 --- a/doc/doc_files/getrayhit2d.html +++ b/doc/doc_files/getrayhit2d.html @@ -7,7 +7,7 @@ -

    sub GetRayHit2D( index, ByRef spr_id, ByRef x, ByRef y, ByRef normal_x, ByRef normal_y )

    +

    Sub GetRayHit2D( index, ByRef spr_id, ByRef x, ByRef y, ByRef normal_x, ByRef normal_y )

    This function will get the collision point and the normal of a ray hit.

    @@ -30,6 +30,7 @@ CastRay2D_All

    +

    \ No newline at end of file diff --git a/doc/doc_files/getrayhit3d.html b/doc/doc_files/getrayhit3d.html index 83d13c6..74f3a95 100644 --- a/doc/doc_files/getrayhit3d.html +++ b/doc/doc_files/getrayhit3d.html @@ -7,7 +7,7 @@ -

    sub GetRayHit3D( index, ByRef actor_id, ByRef x, ByRef y, ByRef z, ByRef normal_x, ByRef normal_y, ByRef normal_z )

    +

    Sub GetRayHit3D( index, ByRef actor_id, ByRef x, ByRef y, ByRef z, ByRef normal_x, ByRef normal_y, ByRef normal_z )

    This function will get the collision point and the normal of a ray hit.

    @@ -30,6 +30,7 @@ GetRayHit2D

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsceneambientcolor.html b/doc/doc_files/getsceneambientcolor.html index 7ebcc57..44ec2de 100644 --- a/doc/doc_files/getsceneambientcolor.html +++ b/doc/doc_files/getsceneambientcolor.html @@ -15,6 +15,7 @@ SetSceneAmbientColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getscenefog.html b/doc/doc_files/getscenefog.html index 14080f8..b0639ba 100644 --- a/doc/doc_files/getscenefog.html +++ b/doc/doc_files/getscenefog.html @@ -9,6 +9,7 @@

    Sub GetSceneFog (ByRef color, ByRef fog_type, ByRef start_val, ByRef end_val, ByRef density, ByRef pixelFog, ByRef rangeFog)

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsceneshadowcolor.html b/doc/doc_files/getsceneshadowcolor.html index 2a594c0..7fb9507 100644 --- a/doc/doc_files/getsceneshadowcolor.html +++ b/doc/doc_files/getsceneshadowcolor.html @@ -15,6 +15,7 @@ SetSceneShadowColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideanchora.html b/doc/doc_files/getslideanchora.html index fde1430..397c5c6 100644 --- a/doc/doc_files/getslideanchora.html +++ b/doc/doc_files/getslideanchora.html @@ -7,7 +7,7 @@ -

    sub GetSlideAnchorA( constraint_id, ByRef x, ByRef y, ByRef z)

    +

    Sub GetSlideAnchorA( constraint_id, ByRef x, ByRef y, ByRef z)

    Gets the anchor point of the first actor in world space, where the slider constraint is acting on the actor. This point represents the location of the slider's reference frame on body A in the global coordinate system.

    @@ -15,6 +15,7 @@ GetSlideAnchorB

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideanchorb.html b/doc/doc_files/getslideanchorb.html index 0ead8a9..a85a860 100644 --- a/doc/doc_files/getslideanchorb.html +++ b/doc/doc_files/getslideanchorb.html @@ -7,7 +7,7 @@ -

    sub GetSlideAnchorB( constraint_id, ByRef x, ByRef y, ByRef z)

    +

    Sub GetSlideAnchorB( constraint_id, ByRef x, ByRef y, ByRef z)

    Gets the anchor point of the first actor in world space, where the slider constraint is acting on the actor. This point represents the location of the slider's reference frame on body B in the global coordinate system.

    @@ -15,6 +15,7 @@ GetSlideAnchorA

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideangdepth.html b/doc/doc_files/getslideangdepth.html index 2694e72..47ac37f 100644 --- a/doc/doc_files/getslideangdepth.html +++ b/doc/doc_files/getslideangdepth.html @@ -7,11 +7,12 @@ -

    function GetSlideAngDepth( constraint_id)

    +

    Function GetSlideAngDepth( constraint_id)

    Gets the angular depth or the angular deviation from the expected orientation of the two actors (or one actor and the world) constrained by the slider. This "angular depth" refers to how much the actors are misaligned rotationally relative to the constraint’s expected or allowed configuration.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideangularpos.html b/doc/doc_files/getslideangularpos.html index e9a63cb..91b5ffa 100644 --- a/doc/doc_files/getslideangularpos.html +++ b/doc/doc_files/getslideangularpos.html @@ -3,15 +3,16 @@ - getSlideAngularPos [RCBasic Doc] + GetSlideAngularPos [RCBasic Doc] -

    function getSlideAngularPos( constraint_id)

    +

    Function GetSlideAngularPos( constraint_id)

    Gets the current angular position of an actor relative to the other actor (or the world) around the slider's axis of motion. Specifically, it measures how much an actor has rotated around the axis that is defined for the slider constraint.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidedampingdirang.html b/doc/doc_files/getslidedampingdirang.html index 2b14798..6076c0c 100644 --- a/doc/doc_files/getslidedampingdirang.html +++ b/doc/doc_files/getslidedampingdirang.html @@ -3,11 +3,11 @@ - getSlideDampingDirAng [RCBasic Doc] + GetSlideDampingDirAng [RCBasic Doc] -

    function getSlideDampingDirAng( constraint_id)

    +

    Function GetSlideDampingDirAng( constraint_id)

    Returns the angular directional damping value. This damping factor specifically affects angular motion in the direction of movement along the constraint's axes.

    @@ -18,6 +18,7 @@ SetSlideDampingDirAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidedampingdirlin.html b/doc/doc_files/getslidedampingdirlin.html index 6845718..12d587c 100644 --- a/doc/doc_files/getslidedampingdirlin.html +++ b/doc/doc_files/getslidedampingdirlin.html @@ -3,11 +3,11 @@ - getSlideDampingDirLin [RCBasic Doc] + GetSlideDampingDirLin [RCBasic Doc] -

    function getSlideDampingDirLin( constraint_id)

    +

    Function GetSlideDampingDirLin( constraint_id)

    Returns the linear directional damping value for a constraint. This value applies to the linear (translational) motion of an object along the constraint's axis of movement.

    @@ -18,6 +18,7 @@ SetSlideDampingDirLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidedampinglimang.html b/doc/doc_files/getslidedampinglimang.html index 0c27759..c15a980 100644 --- a/doc/doc_files/getslidedampinglimang.html +++ b/doc/doc_files/getslidedampinglimang.html @@ -3,11 +3,11 @@ - getSlideDampingLimAng [RCBasic Doc] + GetSlideDampingLimAng [RCBasic Doc] -

    function getSlideDampingLimAng( constraint_id)

    +

    Function GetSlideDampingLimAng( constraint_id)

    Returns the angular limit damping factor for a constraint. This damping applies specifically to the angular motion of an object when it reaches the limit of its allowed rotational range.

    @@ -15,6 +15,7 @@ SetSlideDampingLimAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidedampinglimlin.html b/doc/doc_files/getslidedampinglimlin.html index bbb8c85..0d22c26 100644 --- a/doc/doc_files/getslidedampinglimlin.html +++ b/doc/doc_files/getslidedampinglimlin.html @@ -3,11 +3,11 @@ - getSlideDampingLimLin [RCBasic Doc] + GetSlideDampingLimLin [RCBasic Doc] -

    function getSlideDampingLimLin( constraint_id)

    +

    Function GetSlideDampingLimLin( constraint_id)

    Returns the linear limit damping factor for a constraint. This damping applies specifically to the linear (translational) motion of an object when it reaches the limit of its allowed range of movement along a specific axis.

    @@ -18,6 +18,7 @@ SetSlideDampingLimLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidedampingorthoang.html b/doc/doc_files/getslidedampingorthoang.html index 53ea0f7..ec57354 100644 --- a/doc/doc_files/getslidedampingorthoang.html +++ b/doc/doc_files/getslidedampingorthoang.html @@ -3,11 +3,11 @@ - getSlideDampingOrthoAng [RCBasic Doc] + GetSlideDampingOrthoAng [RCBasic Doc] -

    function getSlideDampingOrthoAng( constraint_id)

    +

    Function GetSlideDampingOrthoAng( constraint_id)

    Returns the orthogonal angular damping factor applied to a constraint. This damping affects angular (rotational) motion that occurs perpendicular to the primary axis of movement defined by the constraint.

    @@ -15,6 +15,7 @@ SetSlideDampingOrthoAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidedampingortholin.html b/doc/doc_files/getslidedampingortholin.html index 8a15024..2906c51 100644 --- a/doc/doc_files/getslidedampingortholin.html +++ b/doc/doc_files/getslidedampingortholin.html @@ -3,11 +3,11 @@ - getSlideDampingOrthoLin [RCBasic Doc] + GetSlideDampingOrthoLin [RCBasic Doc] -

    function getSlideDampingOrthoLin( constraint_id)

    +

    Function GetSlideDampingOrthoLin( constraint_id)

    Returns the orthogonal linear damping factor for a constraint. This damping affects the linear (translational) motion of an object that occurs perpendicular to the primary direction of movement defined by the constraint.

    @@ -18,6 +18,7 @@ SetSlideDampingOrthoLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidelindepth.html b/doc/doc_files/getslidelindepth.html index 19ae897..23fa8fa 100644 --- a/doc/doc_files/getslidelindepth.html +++ b/doc/doc_files/getslidelindepth.html @@ -3,11 +3,11 @@ - getSlideLinDepth [RCBasic Doc] + GetSlideLinDepth [RCBasic Doc] -

    function getSlideLinDepth( constraint_id)

    +

    Function GetSlideLinDepth( constraint_id)

    Returns the linear depth of the slider constraint. This value indicates how much the actors connected by the slider constraint are overlapping or penetrating each other in the linear (translational) direction.

    @@ -15,6 +15,7 @@ The linear depth is a measure of how far the actors are penetrating each other along the linear axis defined by the slider constraint. A positive value indicates that the actors are overlapping, while a value of zero means they are in contact but not penetrating. Negative values typically imply that the actors are separated.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidelinearpos.html b/doc/doc_files/getslidelinearpos.html index 73bafbc..f2357dd 100644 --- a/doc/doc_files/getslidelinearpos.html +++ b/doc/doc_files/getslidelinearpos.html @@ -3,11 +3,11 @@ - getSlideLinearPos [RCBasic Doc] + GetSlideLinearPos [RCBasic Doc] -

    function getSlideLinearPos( constraint_id)

    +

    Function GetSlideLinearPos( constraint_id)

    Returns the current linear position of the slider constraint along its defined axis. This position reflects how far the connected actors have moved along the slider's linear axis since the constraint was created or last reset.

    @@ -15,6 +15,7 @@ This value can be positive or negative, depending on the relative positions of the two bodies connected by the slider.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideloweranglimit.html b/doc/doc_files/getslideloweranglimit.html index 8041fbc..4ae944d 100644 --- a/doc/doc_files/getslideloweranglimit.html +++ b/doc/doc_files/getslideloweranglimit.html @@ -3,11 +3,11 @@ - getSlideLowerAngLimit [RCBasic Doc] + GetSlideLowerAngLimit [RCBasic Doc] -

    function getSlideLowerAngLimit( constraint_id)

    +

    Function GetSlideLowerAngLimit( constraint_id)

    Returns the lower angular limit of the constraint. This value specifies the minimum angle allowed for the rotation of the connected actors around the axis perpendicular to the sliding direction defined by the slider constraint.

    @@ -18,6 +18,7 @@ GetSlideLowerLinLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidelowerlinlimit.html b/doc/doc_files/getslidelowerlinlimit.html index 573ec02..71c5f80 100644 --- a/doc/doc_files/getslidelowerlinlimit.html +++ b/doc/doc_files/getslidelowerlinlimit.html @@ -3,11 +3,11 @@ - getSlideLowerLinLimit [RCBasic Doc] + GetSlideLowerLinLimit [RCBasic Doc] -

    function getSlideLowerLinLimit( constraint_id)

    +

    Function GetSlideLowerLinLimit( constraint_id)

    Returns the lower linear limit for the translational (sliding) motion along the slider's axis. This value specifies the minimum allowable position for the connected actors along the defined axis of the slider constraint.

    @@ -18,6 +18,7 @@ SetSlideLowerLinLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutiondirang.html b/doc/doc_files/getsliderestitutiondirang.html index 9976925..2dfeaa3 100644 --- a/doc/doc_files/getsliderestitutiondirang.html +++ b/doc/doc_files/getsliderestitutiondirang.html @@ -3,11 +3,11 @@ - getSlideRestitutionDirAng [RCBasic Doc] + GetSlideRestitutionDirAng [RCBasic Doc] -

    function getSlideRestitutionDirAng( constraint_id)

    +

    Function GetSlideRestitutionDirAng( constraint_id)

    Returns the restitution value for angular motion. The restitution coefficient is a measure of how much energy is conserved in a collision or constraint interaction, specifically for angular movements.

    @@ -18,6 +18,7 @@ SetSlideRestitutionDirAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutiondirlin.html b/doc/doc_files/getsliderestitutiondirlin.html index ad8dd51..354f852 100644 --- a/doc/doc_files/getsliderestitutiondirlin.html +++ b/doc/doc_files/getsliderestitutiondirlin.html @@ -3,11 +3,11 @@ - getSlideRestitutionDirLin [RCBasic Doc] + GetSlideRestitutionDirLin [RCBasic Doc] -

    function getSlideRestitutionDirLin( constraint_id)

    +

    Function GetSlideRestitutionDirLin( constraint_id)

    Returns the restitution value for linear motion. This value determines how much energy is conserved in a collision or interaction involving linear movements of the connected actors.

    @@ -18,6 +18,7 @@ SetSlideRestitutionDirLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionlimang.html b/doc/doc_files/getsliderestitutionlimang.html index 7348673..fe676f3 100644 --- a/doc/doc_files/getsliderestitutionlimang.html +++ b/doc/doc_files/getsliderestitutionlimang.html @@ -3,11 +3,11 @@ - getSlideRestitutionLimAng [RCBasic Doc] + GetSlideRestitutionLimAng [RCBasic Doc] -

    function getSlideRestitutionLimAng( constraint_id)

    +

    Function GetSlideRestitutionLimAng( constraint_id)

    Returns the restitution value for angular limit. This value determines how much energy is conserved when the angular motion of the connected actors reaches the angular limits of the slider constraint. Essentially, it controls how "bouncy" the rotation is when it hits the angular limit of the constraint.

    @@ -18,6 +18,7 @@ SetSlideRestitutionLimAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionlimlin.html b/doc/doc_files/getsliderestitutionlimlin.html index 78ff5fd..dac74c5 100644 --- a/doc/doc_files/getsliderestitutionlimlin.html +++ b/doc/doc_files/getsliderestitutionlimlin.html @@ -3,11 +3,11 @@ - getSlideRestitutionLimLin [RCBasic Doc] + GetSlideRestitutionLimLin [RCBasic Doc] -

    function getSlideRestitutionLimLin( constraint_id)

    +

    Function GetSlideRestitutionLimLin( constraint_id)

    Returns the restitution value for the linear limit of the constraint. This value controls how much energy is conserved (or how "bouncy" the interaction is) when the connected actors reach the linear limits of the slider constraint, which restricts the movement along the sliding axis.

    @@ -18,6 +18,7 @@ SetSlideRestitutionLimLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionorthoang.html b/doc/doc_files/getsliderestitutionorthoang.html index 7786ea3..3f27780 100644 --- a/doc/doc_files/getsliderestitutionorthoang.html +++ b/doc/doc_files/getsliderestitutionorthoang.html @@ -3,11 +3,11 @@ - getSlideRestitutionOrthoAng [RCBasic Doc] + GetSlideRestitutionOrthoAng [RCBasic Doc] -

    function getSlideRestitutionOrthoAng( constraint_id)

    +

    Function GetSlideRestitutionOrthoAng( constraint_id)

    Returns the restitution value for orthogonal angular motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when rotational movement occurs in a direction orthogonal (perpendicular) to the slider's primary axis of movement.

    @@ -21,6 +21,7 @@ SetSlideRestitutionOrthoAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionortholin.html b/doc/doc_files/getsliderestitutionortholin.html index 3d4d2f7..6a0a6ad 100644 --- a/doc/doc_files/getsliderestitutionortholin.html +++ b/doc/doc_files/getsliderestitutionortholin.html @@ -3,11 +3,11 @@ - getSlideRestitutionOrthoLin [RCBasic Doc] + GetSlideRestitutionOrthoLin [RCBasic Doc] -

    function getSlideRestitutionOrthoLin( constraint_id)

    +

    Function GetSlideRestitutionOrthoLin( constraint_id)

    Returns the restitution value for orthogonal linear motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when linear motion occurs in a direction orthogonal (perpendicular) to the primary sliding axis of the constraint.

    @@ -21,6 +21,7 @@ SetSlideRestitutionOrthoLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessdirang.html b/doc/doc_files/getslidesoftnessdirang.html index da6acd2..b7b5b0c 100644 --- a/doc/doc_files/getslidesoftnessdirang.html +++ b/doc/doc_files/getslidesoftnessdirang.html @@ -3,11 +3,11 @@ - getSlideSoftnessDirAng [RCBasic Doc] + GetSlideSoftnessDirAng [RCBasic Doc] -

    function getSlideSoftnessDirAng( constraint_id)

    +

    Function GetSlideSoftnessDirAng( constraint_id)

    Returns the softness parameter for the angular motion of the constraint. This parameter is used to define how "soft" or "rigid" the limits of angular motion are, particularly when the angular limits are reached.

    @@ -15,6 +15,7 @@ The softness parameter defines how smoothly the constraint responds to limit violations. A higher softness value allows for more gradual movements when limits are approached, while a lower value creates a more rigid response. Softness is particularly useful in simulations to avoid harsh impacts or stiff movements when limits are reached.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessdirlin.html b/doc/doc_files/getslidesoftnessdirlin.html index b829876..10d69c2 100644 --- a/doc/doc_files/getslidesoftnessdirlin.html +++ b/doc/doc_files/getslidesoftnessdirlin.html @@ -3,11 +3,11 @@ - getSlideSoftnessDirLin [RCBasic Doc] + GetSlideSoftnessDirLin [RCBasic Doc] -

    function getSlideSoftnessDirLin( constraint_id)

    +

    Function GetSlideSoftnessDirLin( constraint_id)

    Returns the softness parameter for the linear motion of the constraint. This parameter influences how the constraint responds when the linear limits of movement are reached along the sliding axis, determining whether the response is soft and gradual or more rigid.

    @@ -15,6 +15,7 @@ In the context of constraints, softness defines how "compliant" or "stiff" the constraint behaves when the limits are approached. A higher softness value makes the constraint respond more softly and gradually as the limit is approached, while a lower value makes the response stiffer and more rigid.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnesslimang.html b/doc/doc_files/getslidesoftnesslimang.html index b1599c0..a59a5e1 100644 --- a/doc/doc_files/getslidesoftnesslimang.html +++ b/doc/doc_files/getslidesoftnesslimang.html @@ -3,11 +3,11 @@ - getSlideSoftnessLimAng [RCBasic Doc] + GetSlideSoftnessLimAng [RCBasic Doc] -

    function getSlideSoftnessLimAng( constraint_id)

    +

    Function GetSlideSoftnessLimAng( constraint_id)

    Returns the softness parameter for the angular limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors reach their angular rotational limits around the slider's axis of rotation.

    @@ -15,6 +15,7 @@ The softness parameter defines how compliant or stiff the constraint behaves when the motion approaches a limit. A higher softness makes the constraint more flexible, allowing for smoother motion near the limit. A lower softness makes the limit response more rigid and immediate.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnesslimlin.html b/doc/doc_files/getslidesoftnesslimlin.html index 7f57e4e..ea507f9 100644 --- a/doc/doc_files/getslidesoftnesslimlin.html +++ b/doc/doc_files/getslidesoftnesslimlin.html @@ -3,11 +3,11 @@ - getSlideSoftnessLimLin [RCBasic Doc] + GetSlideSoftnessLimLin [RCBasic Doc] -

    function getSlideSoftnessLimLin( constraint_id)

    +

    Function GetSlideSoftnessLimLin( constraint_id)

    Returns the softness parameter for the linear limits of the constraint. This parameter influences how "soft" or "rigid" the constraint behaves when the connected actors reach their linear (sliding) limits along the constraint's axis of motion.

    @@ -15,6 +15,7 @@ The softness parameter defines how compliant or stiff the constraint behaves when limits are approached. A higher softness value allows for a more gradual and flexible response as the limit is reached, while a lower softness value results in a stiffer and more rigid response.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessorthoang.html b/doc/doc_files/getslidesoftnessorthoang.html index 1907905..f36d05b 100644 --- a/doc/doc_files/getslidesoftnessorthoang.html +++ b/doc/doc_files/getslidesoftnessorthoang.html @@ -3,11 +3,11 @@ - getSlideSoftnessOrthoAng [RCBasic Doc] + GetSlideSoftnessOrthoAng [RCBasic Doc] -

    function getSlideSoftnessOrthoAng( constraint_id)

    +

    Function GetSlideSoftnessOrthoAng( constraint_id)

    Returns the softness parameter for the orthogonal angular limits of the constraint. This parameter controls how "soft" or "rigid" the constraint behaves when angular rotation is limited along directions orthogonal (perpendicular) to the primary axis of motion.

    @@ -15,6 +15,7 @@ The softness parameter defines how compliant (soft) or stiff (rigid) the constraint behaves when the bodies approach their angular or linear limits. A higher softness value makes the limit more flexible, allowing for gradual motion, while a lower value makes the limit more rigid and restrictive.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessortholin.html b/doc/doc_files/getslidesoftnessortholin.html index e56808a..911462c 100644 --- a/doc/doc_files/getslidesoftnessortholin.html +++ b/doc/doc_files/getslidesoftnessortholin.html @@ -3,11 +3,11 @@ - getSlideSoftnessOrthoLin [RCBasic Doc] + GetSlideSoftnessOrthoLin [RCBasic Doc] -

    function getSlideSoftnessOrthoLin( constraint_id)

    +

    Function GetSlideSoftnessOrthoLin( constraint_id)

    Returns the softness parameter for the orthogonal linear limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors approach their linear movement limits in directions that are orthogonal (perpendicular) to the primary sliding axis.

    @@ -15,6 +15,7 @@ The softness parameter determines how rigid or compliant the constraint is when the actors approach their movement limits. A higher softness value allows for smoother, more flexible movement near the limit, while a lower value results in a more rigid, immediate response.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesolveanglimit.html b/doc/doc_files/getslidesolveanglimit.html index 9e15f17..8d1ac56 100644 --- a/doc/doc_files/getslidesolveanglimit.html +++ b/doc/doc_files/getslidesolveanglimit.html @@ -3,15 +3,16 @@ - getSlideSolveAngLimit [RCBasic Doc] + GetSlideSolveAngLimit [RCBasic Doc] -

    function getSlideSolveAngLimit( constraint_id)

    +

    Function GetSlideSolveAngLimit( constraint_id)

    Checks whether the angular position of the constraint has reached or exceeded its defined angular limits. It returns a value indicating if the constraint is at or beyond its lower or upper angular limit around the slider’s axis of rotation.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslidesolvelinlimit.html b/doc/doc_files/getslidesolvelinlimit.html index 475fa51..8b9db9d 100644 --- a/doc/doc_files/getslidesolvelinlimit.html +++ b/doc/doc_files/getslidesolvelinlimit.html @@ -3,15 +3,16 @@ - getSlideSolveLinLimit [RCBasic Doc] + GetSlideSolveLinLimit [RCBasic Doc] -

    function getSlideSolveLinLimit( constraint_id)

    +

    Function GetSlideSolveLinLimit( constraint_id)

    Checks whether the linear position of the constraint has reached or exceeded its defined linear limits. It returns a value indicating if the constraint is at or beyond its lower or upper linear limit along the sliding axis.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideupperanglimit.html b/doc/doc_files/getslideupperanglimit.html index 00e8be0..06ae932 100644 --- a/doc/doc_files/getslideupperanglimit.html +++ b/doc/doc_files/getslideupperanglimit.html @@ -3,11 +3,11 @@ - getSlideUpperAngLimit [RCBasic Doc] + GetSlideUpperAngLimit [RCBasic Doc] -

    function getSlideUpperAngLimit( constraint_id)

    +

    Function GetSlideUpperAngLimit( constraint_id)

    Returns the upper limit of the angular movement allowed for the constraint. This function is crucial for determining how much rotational freedom is allowed around the axis of rotation defined by the slider constraint.

    @@ -15,6 +15,7 @@ The upper angular limit specifies the maximum allowed rotation around the rotational axis for the slider constraint. If the relative rotation between the two actors exceeds this angle, corrective forces are applied to maintain the constraint and prevent further rotation.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideupperlinlimit.html b/doc/doc_files/getslideupperlinlimit.html index d818381..f748630 100644 --- a/doc/doc_files/getslideupperlinlimit.html +++ b/doc/doc_files/getslideupperlinlimit.html @@ -3,11 +3,11 @@ - getSlideUpperLinLimit [RCBasic Doc] + GetSlideUpperLinLimit [RCBasic Doc] -

    function getSlideUpperLinLimit( constraint_id)

    +

    Function GetSlideUpperLinLimit( constraint_id)

    Returns the upper limit for linear movement along the constraint's axis. This is a crucial function for controlling how far the connected actors can slide along that axis before the constraint enforces limits.

    @@ -15,6 +15,7 @@ The upper linear limit specifies the maximum distance that the connected actors can move away from each other along the slider's axis. If the relative movement exceeds this limit, the constraint will apply corrective forces to stop further movement.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getslideuseframeoffset.html b/doc/doc_files/getslideuseframeoffset.html index ca7d288..644eafd 100644 --- a/doc/doc_files/getslideuseframeoffset.html +++ b/doc/doc_files/getslideuseframeoffset.html @@ -3,15 +3,16 @@ - getSlideUseFrameOffset [RCBasic Doc] + GetSlideUseFrameOffset [RCBasic Doc] -

    function getSlideUseFrameOffset( constraint_id)

    +

    Function GetSlideUseFrameOffset( constraint_id)

    Returns a boolean value indicating whether the constraint is using frame offsets for its linear and angular limits.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getsoundvolume.html b/doc/doc_files/getsoundvolume.html index 5b57123..7f4eb39 100644 --- a/doc/doc_files/getsoundvolume.html +++ b/doc/doc_files/getsoundvolume.html @@ -7,11 +7,12 @@ -

    function GetSoundVolume(slot)

    +

    Function GetSoundVolume(slot)

    Returns the given sounds volume.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteaabb.html b/doc/doc_files/getspriteaabb.html index cf0e4b6..2dd4528 100644 --- a/doc/doc_files/getspriteaabb.html +++ b/doc/doc_files/getspriteaabb.html @@ -7,11 +7,12 @@ -

    sub GetSpriteAABB( spr_id, ByRef x1, ByRef y1, ByRef x2, ByRef y2 )

    +

    Sub GetSpriteAABB( spr_id, ByRef x1, ByRef y1, ByRef x2, ByRef y2 )

    Returns the axis aligned bounding box for a sprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritealpha.html b/doc/doc_files/getspritealpha.html index 3915fd1..de4d132 100644 --- a/doc/doc_files/getspritealpha.html +++ b/doc/doc_files/getspritealpha.html @@ -12,6 +12,7 @@ Returns the alpha value of a sprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteangulardamping.html b/doc/doc_files/getspriteangulardamping.html index 5f162b7..f9cadd0 100644 --- a/doc/doc_files/getspriteangulardamping.html +++ b/doc/doc_files/getspriteangulardamping.html @@ -3,11 +3,11 @@ - getSpriteAngularDamping [RCBasic Doc] + GetSpriteAngularDamping [RCBasic Doc] -

    function getSpriteAngularDamping( spr_id)

    +

    Function GetSpriteAngularDamping( spr_id)

    Returns a sprite's angular damping

    @@ -15,6 +15,7 @@ ApplySpriteAngularDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteangularvelocity.html b/doc/doc_files/getspriteangularvelocity.html index 86ff4b9..42234fa 100644 --- a/doc/doc_files/getspriteangularvelocity.html +++ b/doc/doc_files/getspriteangularvelocity.html @@ -3,15 +3,16 @@ - getSpriteAngularVelocity [RCBasic Doc] + GetSpriteAngularVelocity [RCBasic Doc] -

    function getSpriteAngularVelocity( spr_id)

    +

    Function GetSpriteAngularVelocity( spr_id)

    Returns the angular velocity

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteanimation.html b/doc/doc_files/getspriteanimation.html index 0c2f637..53fc186 100644 --- a/doc/doc_files/getspriteanimation.html +++ b/doc/doc_files/getspriteanimation.html @@ -15,6 +15,7 @@ SetSpriteAnimation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteanimationframe.html b/doc/doc_files/getspriteanimationframe.html index dcdb858..b07ebc0 100644 --- a/doc/doc_files/getspriteanimationframe.html +++ b/doc/doc_files/getspriteanimationframe.html @@ -12,6 +12,7 @@ Returns the frame index in the image source that is set to anim_frame in a sprite's animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteanimationlength.html b/doc/doc_files/getspriteanimationlength.html index 8e52551..4b12ce6 100644 --- a/doc/doc_files/getspriteanimationlength.html +++ b/doc/doc_files/getspriteanimationlength.html @@ -12,6 +12,7 @@ Returns the number of frames in a sprite animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteanimationspeed.html b/doc/doc_files/getspriteanimationspeed.html index 6da5421..d1acc34 100644 --- a/doc/doc_files/getspriteanimationspeed.html +++ b/doc/doc_files/getspriteanimationspeed.html @@ -12,6 +12,7 @@ Returns the frames per second of a sprite animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteboxsize.html b/doc/doc_files/getspriteboxsize.html index bbb5848..68dcea9 100644 --- a/doc/doc_files/getspriteboxsize.html +++ b/doc/doc_files/getspriteboxsize.html @@ -18,6 +18,7 @@ SetSpriteBox

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecanvasantialiasmode.html b/doc/doc_files/getspritecanvasantialiasmode.html index 454e4da..f95c972 100644 --- a/doc/doc_files/getspritecanvasantialiasmode.html +++ b/doc/doc_files/getspritecanvasantialiasmode.html @@ -7,7 +7,7 @@ -

    function GetSpriteCanvasAntiAliasMode( c_num )

    +

    Function GetSpriteCanvasAntiAliasMode( c_num )

    Returns the anti-alias mode for a sprite canvas

    @@ -41,6 +41,7 @@ SetSpriteCanvasAntiAliasMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecanvasbilinearfilter.html b/doc/doc_files/getspritecanvasbilinearfilter.html index bbdfa1d..74caa77 100644 --- a/doc/doc_files/getspritecanvasbilinearfilter.html +++ b/doc/doc_files/getspritecanvasbilinearfilter.html @@ -7,7 +7,7 @@ -

    function GetSpriteCanvasBilinearFilter( c_num )

    +

    Function GetSpriteCanvasBilinearFilter( c_num )

    Returns the bi-linear filter flag for the sprite canvas

    @@ -15,6 +15,7 @@ SetSpriteCanvasBilinearFilter

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecanvasblendmode.html b/doc/doc_files/getspritecanvasblendmode.html index 8d879ea..84145d0 100644 --- a/doc/doc_files/getspritecanvasblendmode.html +++ b/doc/doc_files/getspritecanvasblendmode.html @@ -7,7 +7,7 @@ -

    function GetSpriteCanvasBlendMode( c_num )

    +

    Function GetSpriteCanvasBlendMode( c_num )

    Returns the blend mode used to render sprites on the sprite canvas

    @@ -51,6 +51,7 @@ SetBlendMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecanvasphysics.html b/doc/doc_files/getspritecanvasphysics.html index 6129498..8709218 100644 --- a/doc/doc_files/getspritecanvasphysics.html +++ b/doc/doc_files/getspritecanvasphysics.html @@ -7,7 +7,7 @@ -

    function GetSpriteCanvasPhysics( c_num )

    +

    Function GetSpriteCanvasPhysics( c_num )

    Returns the physics stage of a sprite canvas

    @@ -18,6 +18,7 @@ SetCanvasPhysics2D

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecanvasrenderpriority.html b/doc/doc_files/getspritecanvasrenderpriority.html index 40a1bf3..251aec9 100644 --- a/doc/doc_files/getspritecanvasrenderpriority.html +++ b/doc/doc_files/getspritecanvasrenderpriority.html @@ -7,7 +7,7 @@ -

    sub GetSpriteCanvasRenderPriority( c_num, ByRef priority, ByRef order )

    +

    Sub GetSpriteCanvasRenderPriority( c_num, ByRef priority, ByRef order )

    Gets the order sprites are rendered on a sprite canvas.

    @@ -59,6 +59,7 @@ SetSpriteCanvasRenderPriority

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecenter.html b/doc/doc_files/getspritecenter.html index 4b15521..b7df228 100644 --- a/doc/doc_files/getspritecenter.html +++ b/doc/doc_files/getspritecenter.html @@ -3,15 +3,16 @@ - getSpriteCenter [RCBasic Doc] + GetSpriteCenter [RCBasic Doc] -

    sub getSpriteCenter( spr_id, ByRef x, ByRef y)

    +

    Sub GetSpriteCenter( spr_id, ByRef x, ByRef y)

    Returns a sprites center of mass

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecolormod.html b/doc/doc_files/getspritecolormod.html index 26f50f3..f8a7337 100644 --- a/doc/doc_files/getspritecolormod.html +++ b/doc/doc_files/getspritecolormod.html @@ -9,6 +9,7 @@

    Function GetSpriteColorMod(sprite)

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritecurrentanimationframe.html b/doc/doc_files/getspritecurrentanimationframe.html index db7b998..ad00279 100644 --- a/doc/doc_files/getspritecurrentanimationframe.html +++ b/doc/doc_files/getspritecurrentanimationframe.html @@ -12,6 +12,7 @@ Returns the current frame of a sprite's animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritedensity.html b/doc/doc_files/getspritedensity.html index 5453506..e85bf6a 100644 --- a/doc/doc_files/getspritedensity.html +++ b/doc/doc_files/getspritedensity.html @@ -7,7 +7,7 @@ -

    function GetSpriteDensity( spr_id )

    +

    Function GetSpriteDensity( spr_id )

    Returns the density of a sprite. Higher density means a heavier sprite.

    @@ -15,6 +15,7 @@ SetSpriteDensity

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteframe.html b/doc/doc_files/getspriteframe.html index 32d375f..bfcb7e8 100644 --- a/doc/doc_files/getspriteframe.html +++ b/doc/doc_files/getspriteframe.html @@ -12,6 +12,7 @@ Returns the current frame in a sprite's source that it's on in its animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritefriction.html b/doc/doc_files/getspritefriction.html index 1c8b2dc..b8914c2 100644 --- a/doc/doc_files/getspritefriction.html +++ b/doc/doc_files/getspritefriction.html @@ -7,7 +7,7 @@ -

    function GetSpriteFriction( spr_id )

    +

    Function GetSpriteFriction( spr_id )

    Returns a sprite's friction

    @@ -15,6 +15,7 @@ GetSpriteFriction

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritegravityscale.html b/doc/doc_files/getspritegravityscale.html index 6c5c398..f82aba6 100644 --- a/doc/doc_files/getspritegravityscale.html +++ b/doc/doc_files/getspritegravityscale.html @@ -3,11 +3,11 @@ - getSpriteGravityScale [RCBasic Doc] + GetSpriteGravityScale [RCBasic Doc] -

    function getSpriteGravityScale( spr_id)

    +

    Function GetSpriteGravityScale( spr_id)

    Returns a sprite's gravity scale

    @@ -15,6 +15,7 @@ SetSpriteGravityScale

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteinertia.html b/doc/doc_files/getspriteinertia.html index eeb916f..e583418 100644 --- a/doc/doc_files/getspriteinertia.html +++ b/doc/doc_files/getspriteinertia.html @@ -3,15 +3,16 @@ - getSpriteInertia [RCBasic Doc] + GetSpriteInertia [RCBasic Doc] -

    function getSpriteInertia( spr_id)

    +

    Function GetSpriteInertia( spr_id)

    Returns the rotational inertia of the body about the local origin.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritelineardamping.html b/doc/doc_files/getspritelineardamping.html index afe2642..9bdf30b 100644 --- a/doc/doc_files/getspritelineardamping.html +++ b/doc/doc_files/getspritelineardamping.html @@ -3,11 +3,11 @@ - getSpriteLinearDamping [RCBasic Doc] + GetSpriteLinearDamping [RCBasic Doc] -

    function getSpriteLinearDamping( spr_id)

    +

    Function GetSpriteLinearDamping( spr_id)

    Returns a sprite's linear damping value

    @@ -15,6 +15,7 @@ SetSpriteLinearDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritelinearvelocity.html b/doc/doc_files/getspritelinearvelocity.html index f64f442..6ca73d2 100644 --- a/doc/doc_files/getspritelinearvelocity.html +++ b/doc/doc_files/getspritelinearvelocity.html @@ -3,11 +3,11 @@ - getSpriteLinearVelocity [RCBasic Doc] + GetSpriteLinearVelocity [RCBasic Doc] -

    sub getSpriteLinearVelocity( spr_id, ByRef x, ByRef y)

    +

    Sub GetSpriteLinearVelocity( spr_id, ByRef x, ByRef y)

    Gets the linear velocity of a sprite

    @@ -15,6 +15,7 @@ SetSpriteLinearVelocity

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritelinearvelocityfromlocalpoint.html b/doc/doc_files/getspritelinearvelocityfromlocalpoint.html index 06096bf..ac9e89b 100644 --- a/doc/doc_files/getspritelinearvelocityfromlocalpoint.html +++ b/doc/doc_files/getspritelinearvelocityfromlocalpoint.html @@ -3,15 +3,16 @@ - getSpriteLinearVelocityFromLocalPoint [RCBasic Doc] + GetSpriteLinearVelocityFromLocalPoint [RCBasic Doc] -

    sub getSpriteLinearVelocityFromLocalPoint( spr_id, pX, pY, ByRef x, ByRef y)

    +

    Sub GetSpriteLinearVelocityFromLocalPoint( spr_id, pX, pY, ByRef x, ByRef y)

    Get the world velocity of a local point.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritelinearvelocityfromworldpoint.html b/doc/doc_files/getspritelinearvelocityfromworldpoint.html index c1c7785..a2127b1 100644 --- a/doc/doc_files/getspritelinearvelocityfromworldpoint.html +++ b/doc/doc_files/getspritelinearvelocityfromworldpoint.html @@ -3,15 +3,16 @@ - getSpriteLinearVelocityFromWorldPoint [RCBasic Doc] + GetSpriteLinearVelocityFromWorldPoint [RCBasic Doc] -

    sub getSpriteLinearVelocityFromWorldPoint( spr_id, wX, wY, ByRef x, ByRef y)

    +

    Sub GetSpriteLinearVelocityFromWorldPoint( spr_id, wX, wY, ByRef x, ByRef y)

    Get the world linear velocity of a world point attached to this body.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritelocalpoint.html b/doc/doc_files/getspritelocalpoint.html index 73801d3..35023ae 100644 --- a/doc/doc_files/getspritelocalpoint.html +++ b/doc/doc_files/getspritelocalpoint.html @@ -3,15 +3,16 @@ - getSpriteLocalPoint [RCBasic Doc] + GetSpriteLocalPoint [RCBasic Doc] -

    sub getSpriteLocalPoint( spr_id, wX, wY, ByRef x, ByRef y)

    +

    Sub GetSpriteLocalPoint( spr_id, wX, wY, ByRef x, ByRef y)

    Gets a local point relative to the body's origin given a world point.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritelocalvector.html b/doc/doc_files/getspritelocalvector.html index 65102dd..eff2a2a 100644 --- a/doc/doc_files/getspritelocalvector.html +++ b/doc/doc_files/getspritelocalvector.html @@ -3,15 +3,16 @@ - getSpriteLocalVector [RCBasic Doc] + GetSpriteLocalVector [RCBasic Doc] -

    sub getSpriteLocalVector( spr_id, wX, wY, ByRef x, ByRef y)

    +

    Sub GetSpriteLocalVector( spr_id, wX, wY, ByRef x, ByRef y)

    Gets a local vector given a world vector.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritemass.html b/doc/doc_files/getspritemass.html index c008332..8b4f6e4 100644 --- a/doc/doc_files/getspritemass.html +++ b/doc/doc_files/getspritemass.html @@ -3,15 +3,16 @@ - getSpriteMass [RCBasic Doc] + GetSpriteMass [RCBasic Doc] -

    function getSpriteMass( spr_id)

    +

    Function GetSpriteMass( spr_id)

    Returns the total mass of the body.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteposition.html b/doc/doc_files/getspriteposition.html index 8c53d50..9d94146 100644 --- a/doc/doc_files/getspriteposition.html +++ b/doc/doc_files/getspriteposition.html @@ -77,6 +77,7 @@ SetSpritePosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteradius.html b/doc/doc_files/getspriteradius.html index 134c51f..553b483 100644 --- a/doc/doc_files/getspriteradius.html +++ b/doc/doc_files/getspriteradius.html @@ -18,6 +18,7 @@ SetSpriteRadius

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriterestitution.html b/doc/doc_files/getspriterestitution.html index a1e2874..5bbfbf4 100644 --- a/doc/doc_files/getspriterestitution.html +++ b/doc/doc_files/getspriterestitution.html @@ -7,7 +7,7 @@ -

    function GetSpriteRestitution( spr_id )

    +

    Function GetSpriteRestitution( spr_id )

    Returns the restitution coefficient for a sprite

    @@ -15,6 +15,7 @@ SetSpriteRestitution

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriterestitutionthreshold.html b/doc/doc_files/getspriterestitutionthreshold.html index db7b8c3..46057b2 100644 --- a/doc/doc_files/getspriterestitutionthreshold.html +++ b/doc/doc_files/getspriterestitutionthreshold.html @@ -7,7 +7,7 @@ -

    function GetSpriteRestitutionThreshold( spr_id )

    +

    Function GetSpriteRestitutionThreshold( spr_id )

    Returns the restitution velocity threshold for a sprite

    @@ -15,6 +15,7 @@ SetSpriteRestitutionThreshold

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriterotation.html b/doc/doc_files/getspriterotation.html index a1b8099..42d359c 100644 --- a/doc/doc_files/getspriterotation.html +++ b/doc/doc_files/getspriterotation.html @@ -73,6 +73,7 @@ RotateSprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritescale.html b/doc/doc_files/getspritescale.html index faffad4..0dace27 100644 --- a/doc/doc_files/getspritescale.html +++ b/doc/doc_files/getspritescale.html @@ -83,6 +83,7 @@ SetSpriteScale

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteshape.html b/doc/doc_files/getspriteshape.html index fc4ae61..96cda38 100644 --- a/doc/doc_files/getspriteshape.html +++ b/doc/doc_files/getspriteshape.html @@ -40,6 +40,7 @@ SetSpriteShape

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteshapeoffset.html b/doc/doc_files/getspriteshapeoffset.html index 73c4f41..0a97324 100644 --- a/doc/doc_files/getspriteshapeoffset.html +++ b/doc/doc_files/getspriteshapeoffset.html @@ -15,6 +15,7 @@ SetSpriteShapeOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritesize.html b/doc/doc_files/getspritesize.html index b2baa67..360e8f4 100644 --- a/doc/doc_files/getspritesize.html +++ b/doc/doc_files/getspritesize.html @@ -60,6 +60,7 @@ CreateSprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritesource.html b/doc/doc_files/getspritesource.html index 4c649e0..89d3e9a 100644 --- a/doc/doc_files/getspritesource.html +++ b/doc/doc_files/getspritesource.html @@ -51,6 +51,7 @@ CreateSprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspritetype.html b/doc/doc_files/getspritetype.html index f64e9e7..14c3bc2 100644 --- a/doc/doc_files/getspritetype.html +++ b/doc/doc_files/getspritetype.html @@ -91,6 +91,7 @@ SetSpriteType

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteworldpoint.html b/doc/doc_files/getspriteworldpoint.html index 06dea76..8ecbf38 100644 --- a/doc/doc_files/getspriteworldpoint.html +++ b/doc/doc_files/getspriteworldpoint.html @@ -3,15 +3,16 @@ - getSpriteWorldPoint [RCBasic Doc] + GetSpriteWorldPoint [RCBasic Doc] -

    sub getSpriteWorldPoint( spr_id, lX, lY, ByRef x, ByRef y)

    +

    Sub GetSpriteWorldPoint( spr_id, lX, lY, ByRef x, ByRef y)

    Get the world coordinates of a point given the local coordinates.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getspriteworldvector.html b/doc/doc_files/getspriteworldvector.html index 8834504..4fc4df4 100644 --- a/doc/doc_files/getspriteworldvector.html +++ b/doc/doc_files/getspriteworldvector.html @@ -3,15 +3,16 @@ - getSpriteWorldVector [RCBasic Doc] + GetSpriteWorldVector [RCBasic Doc] -

    sub getSpriteWorldVector( spr_id, lX, lY, ByRef x, ByRef y)

    +

    Sub GetSpriteWorldVector( spr_id, lX, lY, ByRef x, ByRef y)

    Get the world coordinates of a vector given the local coordinates.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getterraincenter.html b/doc/doc_files/getterraincenter.html index 0e86ec9..a6a5de4 100644 --- a/doc/doc_files/getterraincenter.html +++ b/doc/doc_files/getterraincenter.html @@ -7,11 +7,12 @@ -

    sub GetTerrainCenter( actor, ByRef x, ByRef y, ByRef z )

    +

    Sub GetTerrainCenter( actor, ByRef x, ByRef y, ByRef z )

    Gets the center point of a terrain actor

    +

    \ No newline at end of file diff --git a/doc/doc_files/getterrainheight.html b/doc/doc_files/getterrainheight.html index 8f84b14..2c8831e 100644 --- a/doc/doc_files/getterrainheight.html +++ b/doc/doc_files/getterrainheight.html @@ -7,11 +7,12 @@ -

    function GetTerrainHeight( actor, patchX, patchZ )

    +

    Function GetTerrainHeight( actor, patchX, patchZ )

    Returns the height of a terrain patch

    +

    \ No newline at end of file diff --git a/doc/doc_files/getterrainpatchaabb.html b/doc/doc_files/getterrainpatchaabb.html index a548878..070b9af 100644 --- a/doc/doc_files/getterrainpatchaabb.html +++ b/doc/doc_files/getterrainpatchaabb.html @@ -7,11 +7,12 @@ -

    sub GetTerrainPatchAABB( actor, patchX, patchZ, ByRef minX, ByRef minY, ByRef minZ, ByRef maxX, ByRef maxY, ByRef maxZ )

    +

    Sub GetTerrainPatchAABB( actor, patchX, patchZ, ByRef minX, ByRef minY, ByRef minZ, ByRef maxX, ByRef maxY, ByRef maxZ )

    Returns the bounding box of a terrain patch

    +

    \ No newline at end of file diff --git a/doc/doc_files/getterrainpatchlod.html b/doc/doc_files/getterrainpatchlod.html index 2a6a2f5..eeaef7e 100644 --- a/doc/doc_files/getterrainpatchlod.html +++ b/doc/doc_files/getterrainpatchlod.html @@ -7,11 +7,12 @@ -

    function GetTerrainPatchLOD( actor, patchX, patchZ )

    +

    Function GetTerrainPatchLOD( actor, patchX, patchZ )

    Returns the current level of detail for a terrain patch

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettextsize.html b/doc/doc_files/gettextsize.html index 33e8e88..29ab1fa 100644 --- a/doc/doc_files/gettextsize.html +++ b/doc/doc_files/gettextsize.html @@ -7,11 +7,12 @@ -

    sub GetTextSize(txt$, byref w, byref h)

    +

    Sub GetTextSize(txt$, ByRef w, ByRef h)

    Gets the size of the text if rendered with the current font

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettile.html b/doc/doc_files/gettile.html index 6051bae..9302bef 100644 --- a/doc/doc_files/gettile.html +++ b/doc/doc_files/gettile.html @@ -15,6 +15,7 @@ Note: (x, y) is a tile position, not an actual coordinate on the map

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettileanimationframe.html b/doc/doc_files/gettileanimationframe.html index 07b94dd..8731bc2 100644 --- a/doc/doc_files/gettileanimationframe.html +++ b/doc/doc_files/gettileanimationframe.html @@ -15,6 +15,7 @@ SetTileAnimationFrame

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettileanimationlength.html b/doc/doc_files/gettileanimationlength.html index 5f10409..508f0b8 100644 --- a/doc/doc_files/gettileanimationlength.html +++ b/doc/doc_files/gettileanimationlength.html @@ -15,6 +15,7 @@ SetTileAnimationLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettileanimationspeed.html b/doc/doc_files/gettileanimationspeed.html index db21a4a..5d8e7d5 100644 --- a/doc/doc_files/gettileanimationspeed.html +++ b/doc/doc_files/gettileanimationspeed.html @@ -15,6 +15,7 @@ SetTileAnimationSpeed

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettilemapsize.html b/doc/doc_files/gettilemapsize.html index d2246dd..1ae2ef6 100644 --- a/doc/doc_files/gettilemapsize.html +++ b/doc/doc_files/gettilemapsize.html @@ -16,6 +16,7 @@ SetTileMapSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettouch.html b/doc/doc_files/gettouch.html index 59261e5..bdf808e 100644 --- a/doc/doc_files/gettouch.html +++ b/doc/doc_files/gettouch.html @@ -7,11 +7,12 @@ -

    sub GetTouch(byref status, byref x, byref y, byref dx, byref dy)

    +

    Sub GetTouch(ByRef status, ByRef x, ByRef y, ByRef dx, ByRef dy)

    Gets the position and distance of motion of a touch event

    +

    \ No newline at end of file diff --git a/doc/doc_files/gettouchfinger.html b/doc/doc_files/gettouchfinger.html index fdfd6d0..c08b91a 100644 --- a/doc/doc_files/gettouchfinger.html +++ b/doc/doc_files/gettouchfinger.html @@ -7,11 +7,12 @@ -

    sub GetTouchFinger(finger, byref x, byref y, byref pressure)

    +

    Sub GetTouchFinger(finger, ByRef x, ByRef y, ByRef pressure)

    Gets the position and pressure of a finger on a touch event

    +

    \ No newline at end of file diff --git a/doc/doc_files/getvideodrawrect.html b/doc/doc_files/getvideodrawrect.html index 7663421..fe296cd 100644 --- a/doc/doc_files/getvideodrawrect.html +++ b/doc/doc_files/getvideodrawrect.html @@ -7,11 +7,12 @@ -

    sub GetVideoDrawRect(byref x, byref y, byref w, byref h)

    +

    Sub GetVideoDrawRect(ByRef x, ByRef y, ByRef w, ByRef h)

    Gets the position and dimensions of the area video playback is shown at.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getvideoposition.html b/doc/doc_files/getvideoposition.html index 59e3f0c..a78a937 100644 --- a/doc/doc_files/getvideoposition.html +++ b/doc/doc_files/getvideoposition.html @@ -7,11 +7,12 @@ -

    function GetVideoPosition()

    +

    Function GetVideoPosition()

    Returns the current position in the video playback.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getvideosize.html b/doc/doc_files/getvideosize.html index fbbf168..256d073 100644 --- a/doc/doc_files/getvideosize.html +++ b/doc/doc_files/getvideosize.html @@ -7,11 +7,12 @@ -

    sub GetVideoSize(byref w, byref h)

    +

    Sub GetVideoSize(ByRef w, ByRef h)

    Gets the size of video's frames

    +

    \ No newline at end of file diff --git a/doc/doc_files/getvideostats.html b/doc/doc_files/getvideostats.html index 8665598..4921c32 100644 --- a/doc/doc_files/getvideostats.html +++ b/doc/doc_files/getvideostats.html @@ -7,7 +7,7 @@ -

    sub GetVideoStats(vFile$, byref vLen, byref vfps, byref frame_w, byref frame_h)

    +

    Sub GetVideoStats(vFile$, ByRef vLen, ByRef vfps, ByRef frame_w, ByRef frame_h)

    Gets video data from a video file.

    @@ -15,6 +15,7 @@ Note: This function is slow and should not be used during time critical sections in your code.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getvideovolume.html b/doc/doc_files/getvideovolume.html index 93bd505..dcffb71 100644 --- a/doc/doc_files/getvideovolume.html +++ b/doc/doc_files/getvideovolume.html @@ -7,7 +7,7 @@ -

    function GetVideoVolume( )

    +

    Function GetVideoVolume( )

    Returns the volume of a video

    @@ -18,6 +18,7 @@ SetVideoVolume

    +

    \ No newline at end of file diff --git a/doc/doc_files/getwindowmaxsize.html b/doc/doc_files/getwindowmaxsize.html index f7e7ea9..14aaae8 100644 --- a/doc/doc_files/getwindowmaxsize.html +++ b/doc/doc_files/getwindowmaxsize.html @@ -7,11 +7,12 @@ -

    sub GetWindowMaxSize( byref w, byref h)

    +

    Sub GetWindowMaxSize( ByRef w, ByRef h)

    Gets the maximum size of a window.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getwindowminsize.html b/doc/doc_files/getwindowminsize.html index 8c4206e..cbcf0eb 100644 --- a/doc/doc_files/getwindowminsize.html +++ b/doc/doc_files/getwindowminsize.html @@ -7,11 +7,12 @@ -

    sub GetWindowMinSize( byref w, byref h)

    +

    Sub GetWindowMinSize( ByRef w, ByRef h)

    Gets the minimum size of the window.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getwindowmode.html b/doc/doc_files/getwindowmode.html index 6017212..3852cb4 100644 --- a/doc/doc_files/getwindowmode.html +++ b/doc/doc_files/getwindowmode.html @@ -7,11 +7,12 @@ -

    function GetWindowMode( )

    +

    Function GetWindowMode( )

    Returns the flags set on the given window as a bitmask. The mode set with OpenWindow() is part of this mask.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getwindowposition.html b/doc/doc_files/getwindowposition.html index 485151d..2e61b09 100644 --- a/doc/doc_files/getwindowposition.html +++ b/doc/doc_files/getwindowposition.html @@ -7,11 +7,12 @@ -

    sub GetWindowPosition( byref x, byref y )

    +

    Sub GetWindowPosition( ByRef x, ByRef y )

    Gets the window position.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getwindowsize.html b/doc/doc_files/getwindowsize.html index 3857c28..08fb19f 100644 --- a/doc/doc_files/getwindowsize.html +++ b/doc/doc_files/getwindowsize.html @@ -7,11 +7,12 @@ -

    sub GetWindowSize( byref w, byref h )

    +

    Sub GetWindowSize( ByRef w, ByRef h )

    Gets the size of the window.

    +

    \ No newline at end of file diff --git a/doc/doc_files/getworld2dautoclearforces.html b/doc/doc_files/getworld2dautoclearforces.html index 5af419d..c14871f 100644 --- a/doc/doc_files/getworld2dautoclearforces.html +++ b/doc/doc_files/getworld2dautoclearforces.html @@ -7,7 +7,7 @@ -

    function GetWorld2DAutoClearForces()

    +

    Function GetWorld2DAutoClearForces()

    Returns the auto clear forces flag for the active canvas

    @@ -15,6 +15,7 @@ SetWorld2DAutoClearForces

    +

    \ No newline at end of file diff --git a/doc/doc_files/getworld2dpositioniterations.html b/doc/doc_files/getworld2dpositioniterations.html index ffd8ebf..4a82a90 100644 --- a/doc/doc_files/getworld2dpositioniterations.html +++ b/doc/doc_files/getworld2dpositioniterations.html @@ -7,7 +7,7 @@ -

    function GetWorld2DPositionIterations()

    +

    Function GetWorld2DPositionIterations()

    Returns the number of position iterations for the position constraint solver

    @@ -15,6 +15,7 @@ SetWorld2DPositionIterations

    +

    \ No newline at end of file diff --git a/doc/doc_files/getworld2dtimestep.html b/doc/doc_files/getworld2dtimestep.html index b84826b..3d2b5a5 100644 --- a/doc/doc_files/getworld2dtimestep.html +++ b/doc/doc_files/getworld2dtimestep.html @@ -7,7 +7,7 @@ -

    function GetWorld2DTimeStep()

    +

    Function GetWorld2DTimeStep()

    Returns the timestep for the active canvas

    @@ -15,6 +15,7 @@ SetWorld2DTimeStep

    +

    \ No newline at end of file diff --git a/doc/doc_files/getworld2dvelocityiterations.html b/doc/doc_files/getworld2dvelocityiterations.html index 71f9578..fcc98d0 100644 --- a/doc/doc_files/getworld2dvelocityiterations.html +++ b/doc/doc_files/getworld2dvelocityiterations.html @@ -7,7 +7,7 @@ -

    function GetWorld2DVelocityIterations()

    +

    Function GetWorld2DVelocityIterations()

    Returns the number of velocity iterations for the velocity constraint solver

    @@ -15,6 +15,7 @@ SetWorld2DVelocityIterations

    +

    \ No newline at end of file diff --git a/doc/doc_files/getworld3dmaxsubsteps.html b/doc/doc_files/getworld3dmaxsubsteps.html index ea0bf7a..2af462a 100644 --- a/doc/doc_files/getworld3dmaxsubsteps.html +++ b/doc/doc_files/getworld3dmaxsubsteps.html @@ -7,11 +7,12 @@ -

    function GetWorld3DMaxSubSteps()

    +

    Function GetWorld3DMaxSubSteps()

    Returns the maximum substeps in the 3d physics time step

    +

    \ No newline at end of file diff --git a/doc/doc_files/getworld3dtimestep.html b/doc/doc_files/getworld3dtimestep.html index efa3afc..c3940a5 100644 --- a/doc/doc_files/getworld3dtimestep.html +++ b/doc/doc_files/getworld3dtimestep.html @@ -7,11 +7,12 @@ -

    function GetWorld3DTimeStep()

    +

    Function GetWorld3DTimeStep()

    Returns the timestep of the 3d physics simulation

    +

    \ No newline at end of file diff --git a/doc/doc_files/getworldtoviewportposition.html b/doc/doc_files/getworldtoviewportposition.html index 30c6a53..01203d1 100644 --- a/doc/doc_files/getworldtoviewportposition.html +++ b/doc/doc_files/getworldtoviewportposition.html @@ -12,6 +12,7 @@ Get the 2D coordinates for the given 3D position on the active canvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/globalmousex.html b/doc/doc_files/globalmousex.html index 184093c..f6f6fdd 100644 --- a/doc/doc_files/globalmousex.html +++ b/doc/doc_files/globalmousex.html @@ -7,7 +7,7 @@ -

    function GlobalMouseX()

    +

    Function GlobalMouseX()

    Returns the absolute X position of the mouse on the display

    @@ -16,6 +16,7 @@ GetGlobalMouse

    +

    \ No newline at end of file diff --git a/doc/doc_files/globalmousey.html b/doc/doc_files/globalmousey.html index c0e507d..81c834f 100644 --- a/doc/doc_files/globalmousey.html +++ b/doc/doc_files/globalmousey.html @@ -7,7 +7,7 @@ -

    function GlobalMouseY()

    +

    Function GlobalMouseY()

    Returns the absolute Y position of the mouse on the display

    @@ -16,6 +16,7 @@ GetGlobalMouse

    +

    \ No newline at end of file diff --git a/doc/doc_files/grabinput.html b/doc/doc_files/grabinput.html index 18ec065..b4b95b6 100644 --- a/doc/doc_files/grabinput.html +++ b/doc/doc_files/grabinput.html @@ -7,11 +7,12 @@ -

    sub GrabInput(flag)

    +

    Sub GrabInput(flag)

    Sets whether the currently active window will grab user input

    +

    \ No newline at end of file diff --git a/doc/doc_files/graphics.html b/doc/doc_files/graphics.html index 4e05290..d15372e 100644 --- a/doc/doc_files/graphics.html +++ b/doc/doc_files/graphics.html @@ -98,6 +98,7 @@ RCBasic allows you to create as many canvases as you want and you can have multiple different types of canvases at once. This is just a brief overview of how graphics work but I highly encourage you to check out all the included examples to see more of what is possible.

    +

    \ No newline at end of file diff --git a/doc/doc_files/gyroname.html b/doc/doc_files/gyroname.html index c9019d5..fd0d205 100644 --- a/doc/doc_files/gyroname.html +++ b/doc/doc_files/gyroname.html @@ -7,11 +7,12 @@ -

    function GyroName$(gyro_num)

    +

    Function GyroName$(gyro_num)

    Returns the name of the gyroscope.

    +

    \ No newline at end of file diff --git a/doc/doc_files/hasclipboardtext.html b/doc/doc_files/hasclipboardtext.html index ae63ddc..cfe5ed2 100644 --- a/doc/doc_files/hasclipboardtext.html +++ b/doc/doc_files/hasclipboardtext.html @@ -7,11 +7,12 @@ -

    function HasClipboardText()

    +

    Function HasClipboardText()

    Returns whether or not there is text in the clipboard.

    +

    \ No newline at end of file diff --git a/doc/doc_files/hello_world.html b/doc/doc_files/hello_world.html index 10c7706..2e345c7 100644 --- a/doc/doc_files/hello_world.html +++ b/doc/doc_files/hello_world.html @@ -571,6 +571,7 @@ 1. Write a program that ask the User to enter a number. Then create a loop that outputs every number between 1 and the number the user enters to the console. 2. Write a program that continues to ask the User for there name until they enter "Bob". Then tell the User "Good by Bob".

    +

    \ No newline at end of file diff --git a/doc/doc_files/hex.html b/doc/doc_files/hex.html index 1c1464d..39b13ca 100644 --- a/doc/doc_files/hex.html +++ b/doc/doc_files/hex.html @@ -7,11 +7,12 @@ -

    function Hex$(n)

    +

    Function Hex$(n)

    Returns a hexadecimal representation of a number.

    +

    \ No newline at end of file diff --git a/doc/doc_files/hexval.html b/doc/doc_files/hexval.html index ea343cf..d39f79e 100644 --- a/doc/doc_files/hexval.html +++ b/doc/doc_files/hexval.html @@ -7,11 +7,12 @@ -

    function HexVal(n$)

    +

    Function HexVal(n$)

    Returns the integer value of a hexadecimal string.

    +

    \ No newline at end of file diff --git a/doc/doc_files/hidemouse.html b/doc/doc_files/hidemouse.html index 9278c3a..43e09ff 100644 --- a/doc/doc_files/hidemouse.html +++ b/doc/doc_files/hidemouse.html @@ -7,11 +7,12 @@ -

    sub HideMouse()

    +

    Sub HideMouse()

    Makes the mouse cursor invisible.

    +

    \ No newline at end of file diff --git a/doc/doc_files/hidewindow.html b/doc/doc_files/hidewindow.html index 8a08ec0..07fb09d 100644 --- a/doc/doc_files/hidewindow.html +++ b/doc/doc_files/hidewindow.html @@ -7,7 +7,7 @@ -

    sub HideWindow( )

    +

    Sub HideWindow( )

    Sets the window invisible.

    @@ -16,6 +16,7 @@ WindowIsVisible

    +

    \ No newline at end of file diff --git a/doc/doc_files/imageexists.html b/doc/doc_files/imageexists.html index 38f81a8..d35e880 100644 --- a/doc/doc_files/imageexists.html +++ b/doc/doc_files/imageexists.html @@ -7,11 +7,12 @@ -

    function ImageExists(img)

    +

    Function ImageExists(img)

    Returns true if img is associated with an allocated image in memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/incrementmatrixcolumns.html b/doc/doc_files/incrementmatrixcolumns.html index 296bbe5..592afaa 100644 --- a/doc/doc_files/incrementmatrixcolumns.html +++ b/doc/doc_files/incrementmatrixcolumns.html @@ -7,11 +7,12 @@ -

    sub IncrementMatrixColumns(mA, mB, c, num_cols, value)

    +

    Sub IncrementMatrixColumns(mA, mB, c, num_cols, value)

    Increments all the values in a specified number of columns in matrix mA, starting from column c. The result is stored in matrix mB

    +

    \ No newline at end of file diff --git a/doc/doc_files/incrementmatrixrows.html b/doc/doc_files/incrementmatrixrows.html index 7342dee..0357fac 100644 --- a/doc/doc_files/incrementmatrixrows.html +++ b/doc/doc_files/incrementmatrixrows.html @@ -7,11 +7,12 @@ -

    sub IncrementMatrixRows(mA, mB, r, num_rows, value)

    +

    Sub IncrementMatrixRows(mA, mB, r, num_rows, value)

    Increments all the values in a specified number of rows in matrix mA, starting from row r. The result is stored in matrix mB

    +

    \ No newline at end of file diff --git a/doc/doc_files/inkey.html b/doc/doc_files/inkey.html index f5fc3ee..e8cae91 100644 --- a/doc/doc_files/inkey.html +++ b/doc/doc_files/inkey.html @@ -7,11 +7,12 @@ -

    function InKey()

    +

    Function InKey()

    Returns the character value of the key that was pressed.

    +

    \ No newline at end of file diff --git a/doc/doc_files/input.html b/doc/doc_files/input.html index 9299c02..a4bff9e 100644 --- a/doc/doc_files/input.html +++ b/doc/doc_files/input.html @@ -7,11 +7,12 @@ -

    function Input$(prompt$)

    +

    Function Input$(prompt$)

    Returns user input from the console

    +

    \ No newline at end of file diff --git a/doc/doc_files/insert.html b/doc/doc_files/insert.html index 96c239e..5146c6a 100644 --- a/doc/doc_files/insert.html +++ b/doc/doc_files/insert.html @@ -7,11 +7,12 @@ -

    function Insert$(src$, tgt$, pos)

    +

    Function Insert$(src$, tgt$, pos)

    Returns a string containing str_to_insert$ inserted into src$ at a given position

    +

    \ No newline at end of file diff --git a/doc/doc_files/insertmatrixcolumns.html b/doc/doc_files/insertmatrixcolumns.html index e1320fb..26b8d3f 100644 --- a/doc/doc_files/insertmatrixcolumns.html +++ b/doc/doc_files/insertmatrixcolumns.html @@ -7,11 +7,12 @@ -

    function InsertMatrixColumns(mA, c, num_cols)

    +

    Function InsertMatrixColumns(mA, c, num_cols)

    Insert a number of empty columns into matrix mA starting at the specified column.

    +

    \ No newline at end of file diff --git a/doc/doc_files/insertmatrixrows.html b/doc/doc_files/insertmatrixrows.html index 3769471..aa2112a 100644 --- a/doc/doc_files/insertmatrixrows.html +++ b/doc/doc_files/insertmatrixrows.html @@ -7,11 +7,12 @@ -

    function InsertMatrixRows(mA, r, num_rows)

    +

    Function InsertMatrixRows(mA, r, num_rows)

    Insert a number of empty rows into matrix mA starting at the specified row.

    +

    \ No newline at end of file diff --git a/doc/doc_files/instr.html b/doc/doc_files/instr.html index 1d9ec84..5a02762 100644 --- a/doc/doc_files/instr.html +++ b/doc/doc_files/instr.html @@ -7,11 +7,12 @@ -

    function InStr(src$, substr$)

    +

    Function InStr(src$, Substr$)

    Returns the position in src$ where substr$ is found. If not found it will return -1.

    +

    \ No newline at end of file diff --git a/doc/doc_files/int.html b/doc/doc_files/int.html index 91dc96c..16053b6 100644 --- a/doc/doc_files/int.html +++ b/doc/doc_files/int.html @@ -7,11 +7,12 @@ -

    function Int(n)

    +

    Function Int(n)

    Returns a number converted to an integer.

    +

    \ No newline at end of file diff --git a/doc/doc_files/integrateactorvelocities.html b/doc/doc_files/integrateactorvelocities.html index f70a3d7..8b12fd2 100644 --- a/doc/doc_files/integrateactorvelocities.html +++ b/doc/doc_files/integrateactorvelocities.html @@ -3,11 +3,11 @@ - integrateActorVelocities [RCBasic Doc] + IntegrateActorVelocities [RCBasic Doc] -

    sub integrateActorVelocities( actor, v_step)

    +

    Sub IntegrateActorVelocities( actor, v_step)

    Updates the linear and angular velocities of an actor based on the forces and torques applied to it over a time step.

    @@ -15,6 +15,7 @@ Note: This is more manual control than most devs will probably need

    +

    \ No newline at end of file diff --git a/doc/doc_files/interpolate.html b/doc/doc_files/interpolate.html index ce13906..7eecbbe 100644 --- a/doc/doc_files/interpolate.html +++ b/doc/doc_files/interpolate.html @@ -12,6 +12,7 @@ This function returns a value interpolated based on the comparison between a mid value in a range of given min and max values

    +

    \ No newline at end of file diff --git a/doc/doc_files/intro.html b/doc/doc_files/intro.html index 57af014..d092016 100644 --- a/doc/doc_files/intro.html +++ b/doc/doc_files/intro.html @@ -15,6 +15,7 @@ Rodney Cunningham (aka. n00b)

    +

    \ No newline at end of file diff --git a/doc/doc_files/invertmatrix.html b/doc/doc_files/invertmatrix.html index f53a454..e599060 100644 --- a/doc/doc_files/invertmatrix.html +++ b/doc/doc_files/invertmatrix.html @@ -7,11 +7,12 @@ -

    function InvertMatrix(mA, mB)

    +

    Function InvertMatrix(mA, mB)

    Stores the inverse matrix of mA in mB

    +

    \ No newline at end of file diff --git a/doc/doc_files/io.html b/doc/doc_files/io.html index 247ada9..cc486ed 100644 --- a/doc/doc_files/io.html +++ b/doc/doc_files/io.html @@ -36,6 +36,7 @@ The above example will ask the user WHAT IS YOUR NAME? and then store whatever the user types in into the variable USER_NAME$.

    +

    \ No newline at end of file diff --git a/doc/doc_files/isequalmatrix.html b/doc/doc_files/isequalmatrix.html index 56eda92..a197682 100644 --- a/doc/doc_files/isequalmatrix.html +++ b/doc/doc_files/isequalmatrix.html @@ -7,11 +7,12 @@ -

    function IsEqualMatrix(mA, mB, tolerance)

    +

    Function IsEqualMatrix(mA, mB, tolerance)

    Returns true if matrix mA is within tolerance of matrix mB

    +

    \ No newline at end of file diff --git a/doc/doc_files/joinmatrixcolumns.html b/doc/doc_files/joinmatrixcolumns.html index 5a58658..9ab3269 100644 --- a/doc/doc_files/joinmatrixcolumns.html +++ b/doc/doc_files/joinmatrixcolumns.html @@ -7,11 +7,12 @@ -

    sub JoinMatrixColumns(mA, mB, mC)

    +

    Sub JoinMatrixColumns(mA, mB, mC)

    Appends the columns in matrix mB below matrix mA.

    +

    \ No newline at end of file diff --git a/doc/doc_files/joinmatrixrows.html b/doc/doc_files/joinmatrixrows.html index d7f605d..0c2a7cd 100644 --- a/doc/doc_files/joinmatrixrows.html +++ b/doc/doc_files/joinmatrixrows.html @@ -7,11 +7,12 @@ -

    sub JoinMatrixRows(mA, mB, mC)

    +

    Sub JoinMatrixRows(mA, mB, mC)

    Appends the rows in matrix mB onto the right of matrix mA.

    +

    \ No newline at end of file diff --git a/doc/doc_files/jointexists.html b/doc/doc_files/jointexists.html index dd2208e..763183f 100644 --- a/doc/doc_files/jointexists.html +++ b/doc/doc_files/jointexists.html @@ -7,8 +7,9 @@ -

    function JointExists( joint_id )

    +

    Function JointExists( joint_id )

    +

    \ No newline at end of file diff --git a/doc/doc_files/jointislimitenabled.html b/doc/doc_files/jointislimitenabled.html index 2c2acc0..534e95c 100644 --- a/doc/doc_files/jointislimitenabled.html +++ b/doc/doc_files/jointislimitenabled.html @@ -3,11 +3,11 @@ - jointIsLimitEnabled [RCBasic Doc] + JointIsLimitEnabled [RCBasic Doc] -

    function jointIsLimitEnabled( joint_id)

    +

    Function JointIsLimitEnabled( joint_id)

    Returns whether or not the joint limit is enabled

    @@ -30,6 +30,7 @@ SetJointLimits

    +

    \ No newline at end of file diff --git a/doc/doc_files/jointmotorisenabled.html b/doc/doc_files/jointmotorisenabled.html index 21c38d7..10e3ca0 100644 --- a/doc/doc_files/jointmotorisenabled.html +++ b/doc/doc_files/jointmotorisenabled.html @@ -3,11 +3,11 @@ - jointMotorIsEnabled [RCBasic Doc] + JointMotorIsEnabled [RCBasic Doc] -

    function jointMotorIsEnabled( joint_id)

    +

    Function JointMotorIsEnabled( joint_id)

    Returns whether or not the joint motor is enabled

    @@ -29,6 +29,7 @@ EnableJointMotor

    +

    \ No newline at end of file diff --git a/doc/doc_files/joyaxis.html b/doc/doc_files/joyaxis.html index 7c8ee90..af967af 100644 --- a/doc/doc_files/joyaxis.html +++ b/doc/doc_files/joyaxis.html @@ -7,11 +7,12 @@ -

    function JoyAxis(joy_num, joy_axis)

    +

    Function JoyAxis(joy_num, joy_axis)

    Returns the value of an axis on a joystick.

    +

    \ No newline at end of file diff --git a/doc/doc_files/joybutton.html b/doc/doc_files/joybutton.html index 0d1d73f..951c5d1 100644 --- a/doc/doc_files/joybutton.html +++ b/doc/doc_files/joybutton.html @@ -7,11 +7,12 @@ -

    function JoyButton(joy_num, joy_button)

    +

    Function JoyButton(joy_num, joy_button)

    Returns true if the given button was pressed and false otherwise.

    +

    \ No newline at end of file diff --git a/doc/doc_files/joyhat.html b/doc/doc_files/joyhat.html index cd392c8..5307cd3 100644 --- a/doc/doc_files/joyhat.html +++ b/doc/doc_files/joyhat.html @@ -7,7 +7,7 @@ -

    function JoyHat(joy_num, joy_hat)

    +

    Function JoyHat(joy_num, joy_hat)

    Returns the position of the Hat.

    @@ -44,6 +44,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/joyname.html b/doc/doc_files/joyname.html index 8b84cc5..146aaaa 100644 --- a/doc/doc_files/joyname.html +++ b/doc/doc_files/joyname.html @@ -7,11 +7,12 @@ -

    function JoyName$(joy_num)

    +

    Function JoyName$(joy_num)

    Returns the joystick name.

    +

    \ No newline at end of file diff --git a/doc/doc_files/joyrumbleplay.html b/doc/doc_files/joyrumbleplay.html index 8b9bf12..b2589b1 100644 --- a/doc/doc_files/joyrumbleplay.html +++ b/doc/doc_files/joyrumbleplay.html @@ -7,7 +7,7 @@ -

    sub JoyRumblePlay(joy_num, strength, duration)

    +

    Sub JoyRumblePlay(joy_num, strength, duration)

    Rumbles a joystick at a specified strength for the specifed duration.

    @@ -20,6 +20,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/joyrumblestop.html b/doc/doc_files/joyrumblestop.html index 1d0f439..8b6816e 100644 --- a/doc/doc_files/joyrumblestop.html +++ b/doc/doc_files/joyrumblestop.html @@ -7,11 +7,12 @@ -

    sub JoyRumbleStop(joy_num)

    +

    Sub JoyRumbleStop(joy_num)

    Stops the rumble on a joystick

    +

    \ No newline at end of file diff --git a/doc/doc_files/joystickisconnected.html b/doc/doc_files/joystickisconnected.html index 02a0f3e..ca0fbfe 100644 --- a/doc/doc_files/joystickisconnected.html +++ b/doc/doc_files/joystickisconnected.html @@ -7,11 +7,12 @@ -

    function JoystickIsConnected(joy_num)

    +

    Function JoystickIsConnected(joy_num)

    Returns true if joystick is connected, or false if it isn't.

    +

    \ No newline at end of file diff --git a/doc/doc_files/joystickishaptic.html b/doc/doc_files/joystickishaptic.html index 9f8da8a..74af499 100644 --- a/doc/doc_files/joystickishaptic.html +++ b/doc/doc_files/joystickishaptic.html @@ -7,11 +7,12 @@ -

    function JoystickIsHaptic(joy_num)

    +

    Function JoystickIsHaptic(joy_num)

    Returns true if joystick has the ability to rumble.

    +

    \ No newline at end of file diff --git a/doc/doc_files/key.html b/doc/doc_files/key.html index 48ec475..dd24db4 100644 --- a/doc/doc_files/key.html +++ b/doc/doc_files/key.html @@ -7,11 +7,12 @@ -

    function Key(key_code)

    +

    Function Key(key_code)

    Returns true if the given key was pressed and false otherwise.

    +

    \ No newline at end of file diff --git a/doc/doc_files/lcase.html b/doc/doc_files/lcase.html index e0fdcff..64736d2 100644 --- a/doc/doc_files/lcase.html +++ b/doc/doc_files/lcase.html @@ -7,11 +7,12 @@ -

    function LCase$(src$)

    +

    Function LCase$(src$)

    Returns src$ converted to a completely lower-case string

    +

    \ No newline at end of file diff --git a/doc/doc_files/left.html b/doc/doc_files/left.html index 0cfc9c1..618af30 100644 --- a/doc/doc_files/left.html +++ b/doc/doc_files/left.html @@ -7,11 +7,12 @@ -

    function Left$(src$, n)

    +

    Function Left$(src$, n)

    Returns a substring n characters in length from the left side of the given string.

    +

    \ No newline at end of file diff --git a/doc/doc_files/len.html b/doc/doc_files/len.html index 206d9ed..f668b62 100644 --- a/doc/doc_files/len.html +++ b/doc/doc_files/len.html @@ -7,7 +7,7 @@ -

    function Len(src$)

    +

    Function Len(src$)

    Returns the number of characters in the given string

    @@ -18,6 +18,7 @@ Length

    +

    \ No newline at end of file diff --git a/doc/doc_files/length.html b/doc/doc_files/length.html index 80ff13f..e68fad1 100644 --- a/doc/doc_files/length.html +++ b/doc/doc_files/length.html @@ -7,7 +7,7 @@ -

    function Length(src$)

    +

    Function Length(src$)

    Returns the number of characters in the given string

    @@ -18,6 +18,7 @@ Length

    +

    \ No newline at end of file diff --git a/doc/doc_files/license.html b/doc/doc_files/license.html index 6481455..6d84c6e 100644 --- a/doc/doc_files/license.html +++ b/doc/doc_files/license.html @@ -27,6 +27,7 @@ 3. This notice may not be removed or altered from any source distribution.

    +

    \ No newline at end of file diff --git a/doc/doc_files/lightiscastingshadow.html b/doc/doc_files/lightiscastingshadow.html index 9203c78..dfd831f 100644 --- a/doc/doc_files/lightiscastingshadow.html +++ b/doc/doc_files/lightiscastingshadow.html @@ -3,11 +3,11 @@ - lightIsCastingShadow [RCBasic Doc] + LightIsCastingShadow [RCBasic Doc] -

    function lightIsCastingShadow( actor )

    +

    Function LightIsCastingShadow( actor )

    Returns true if shadow casting is enabled for the given light

    @@ -15,6 +15,7 @@ SetLightShadowCast

    +

    \ No newline at end of file diff --git a/doc/doc_files/line.html b/doc/doc_files/line.html index 337dbc8..c2815f1 100644 --- a/doc/doc_files/line.html +++ b/doc/doc_files/line.html @@ -7,11 +7,12 @@ -

    sub Line(x1, y1, x2, y2)

    +

    Sub Line(x1, y1, x2, y2)

    Draws a line

    +

    \ No newline at end of file diff --git a/doc/doc_files/line3d.html b/doc/doc_files/line3d.html index 2fb3b2a..e00747e 100644 --- a/doc/doc_files/line3d.html +++ b/doc/doc_files/line3d.html @@ -7,11 +7,12 @@ -

    sub Line3D(x1, y1, z1, x2, y2, z2)

    +

    Sub Line3D(x1, y1, z1, x2, y2, z2)

    Draws a line in 3D space

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadan8.html b/doc/doc_files/loadan8.html index a9091b8..c1a3b50 100644 --- a/doc/doc_files/loadan8.html +++ b/doc/doc_files/loadan8.html @@ -15,6 +15,7 @@ LoadMeshFromAN8

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadfont.html b/doc/doc_files/loadfont.html index 7f6dbc9..0569946 100644 --- a/doc/doc_files/loadfont.html +++ b/doc/doc_files/loadfont.html @@ -7,11 +7,12 @@ -

    function LoadFont(fnt_file$, font_size)

    +

    Function LoadFont(fnt_file$, font_size)

    Returns a font id for a font with glyphs of font_size

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadimage.html b/doc/doc_files/loadimage.html index 134134d..b5bdd06 100644 --- a/doc/doc_files/loadimage.html +++ b/doc/doc_files/loadimage.html @@ -7,11 +7,12 @@ -

    function LoadImage( img$ )

    +

    Function LoadImage( img$ )

    Returns an image id for an image loaded into memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadimageex.html b/doc/doc_files/loadimageex.html index 261dc7d..9d86787 100644 --- a/doc/doc_files/loadimageex.html +++ b/doc/doc_files/loadimageex.html @@ -7,11 +7,12 @@ -

    function LoadImageEx(img$, colkey)

    +

    Function LoadImageEx(img$, colkey)

    Returns an image id for an image loaded into memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadmesh.html b/doc/doc_files/loadmesh.html index 70bc16d..fa1f56b 100644 --- a/doc/doc_files/loadmesh.html +++ b/doc/doc_files/loadmesh.html @@ -7,7 +7,7 @@ -

    function LoadMesh( mesh_file$ )

    +

    Function LoadMesh( mesh_file$ )

    Returns a mesh id for the loaded mesh

    @@ -90,6 +90,7 @@ LoadMeshFromArchive

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadmeshfroman8.html b/doc/doc_files/loadmeshfroman8.html index dbc4486..7494c40 100644 --- a/doc/doc_files/loadmeshfroman8.html +++ b/doc/doc_files/loadmeshfroman8.html @@ -20,6 +20,7 @@ LoadMeshFromArchive

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadmeshfromarchive.html b/doc/doc_files/loadmeshfromarchive.html index 52eb137..bdd5f03 100644 --- a/doc/doc_files/loadmeshfromarchive.html +++ b/doc/doc_files/loadmeshfromarchive.html @@ -7,7 +7,7 @@ -

    function LoadMeshFromArchive( archive$, mesh_file$ )

    +

    Function LoadMeshFromArchive( archive$, mesh_file$ )

    Returns a mesh id for the loaded mesh from an archive (*.zip, *.pak, etc.)

    @@ -90,6 +90,7 @@ LoadMesh

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadmusic.html b/doc/doc_files/loadmusic.html index 92857fb..d464bf4 100644 --- a/doc/doc_files/loadmusic.html +++ b/doc/doc_files/loadmusic.html @@ -7,11 +7,12 @@ -

    sub LoadMusic(music_file$)

    +

    Sub LoadMusic(music_file$)

    Loads a music track

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadsound.html b/doc/doc_files/loadsound.html index 0f3cd47..6cabfff 100644 --- a/doc/doc_files/loadsound.html +++ b/doc/doc_files/loadsound.html @@ -7,11 +7,12 @@ -

    function LoadSound(snd_file$)

    +

    Function LoadSound(snd_file$)

    Returns an id for a loaded audio track

    +

    \ No newline at end of file diff --git a/doc/doc_files/loadvideo.html b/doc/doc_files/loadvideo.html index 1ee8c1e..f6b310e 100644 --- a/doc/doc_files/loadvideo.html +++ b/doc/doc_files/loadvideo.html @@ -7,11 +7,12 @@ -

    sub LoadVideo(vid$)

    +

    Sub LoadVideo(vid$)

    Loads a video track

    +

    \ No newline at end of file diff --git a/doc/doc_files/log.html b/doc/doc_files/log.html index 772da3a..7064c42 100644 --- a/doc/doc_files/log.html +++ b/doc/doc_files/log.html @@ -7,11 +7,12 @@ -

    function Log(n)

    +

    Function Log(n)

    Returns the logarithm of a number.

    +

    \ No newline at end of file diff --git a/doc/doc_files/loops.html b/doc/doc_files/loops.html index 8faa18e..df9a7b0 100644 --- a/doc/doc_files/loops.html +++ b/doc/doc_files/loops.html @@ -78,6 +78,7 @@ The above code will output the numbers 0 to 4 to the console. This form of the DO loop will continue to loop until the loop condition is true.

    +

    \ No newline at end of file diff --git a/doc/doc_files/ltrim.html b/doc/doc_files/ltrim.html index ef3f472..7ce2bdd 100644 --- a/doc/doc_files/ltrim.html +++ b/doc/doc_files/ltrim.html @@ -7,7 +7,7 @@ -

    function LTrim$(src$)

    +

    Function LTrim$(src$)

    Returns src$ with all the spaces before the first non-space character removed.

    @@ -16,6 +16,7 @@ Trim

    +

    \ No newline at end of file diff --git a/doc/doc_files/makedir.html b/doc/doc_files/makedir.html index 79585d6..ab2ca4b 100644 --- a/doc/doc_files/makedir.html +++ b/doc/doc_files/makedir.html @@ -7,11 +7,12 @@ -

    function MakeDir(p$)

    +

    Function MakeDir(p$)

    Creates a new directory.

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialexists.html b/doc/doc_files/materialexists.html index 19dd058..a1b832a 100644 --- a/doc/doc_files/materialexists.html +++ b/doc/doc_files/materialexists.html @@ -7,11 +7,12 @@ -

    function MaterialExists( material )

    +

    Function MaterialExists( material )

    Returns true if the material id is an existing material

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialisaplhablend.html b/doc/doc_files/materialisaplhablend.html index 638739e..e1cd5fa 100644 --- a/doc/doc_files/materialisaplhablend.html +++ b/doc/doc_files/materialisaplhablend.html @@ -7,11 +7,12 @@ -

    function MaterialIsAplhaBlend( material_id)

    +

    Function MaterialIsAplhaBlend( material_id)

    Returns true if alpha blending is enabled for a material

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialisgouraudshaded.html b/doc/doc_files/materialisgouraudshaded.html index 5e9c3d8..ac543c1 100644 --- a/doc/doc_files/materialisgouraudshaded.html +++ b/doc/doc_files/materialisgouraudshaded.html @@ -7,11 +7,12 @@ -

    function MaterialIsGouraudShaded( material_id )

    +

    Function MaterialIsGouraudShaded( material_id )

    Returns true if material is set to goraud shading

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialislit.html b/doc/doc_files/materialislit.html index 8d8cccb..f7fd3b9 100644 --- a/doc/doc_files/materialislit.html +++ b/doc/doc_files/materialislit.html @@ -7,7 +7,7 @@ -

    function MaterialIsLit( material_id )

    +

    Function MaterialIsLit( material_id )

    Returns true if a material is affected by lights in the scene

    @@ -15,6 +15,7 @@ SetMaterialLighting

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialisnormalized.html b/doc/doc_files/materialisnormalized.html index 97072ff..acb25c5 100644 --- a/doc/doc_files/materialisnormalized.html +++ b/doc/doc_files/materialisnormalized.html @@ -7,11 +7,12 @@ -

    function MaterialIsNormalized( material_id )

    +

    Function MaterialIsNormalized( material_id )

    Returns true if material has normalized normals

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialispointcloud.html b/doc/doc_files/materialispointcloud.html index e978c96..05987f5 100644 --- a/doc/doc_files/materialispointcloud.html +++ b/doc/doc_files/materialispointcloud.html @@ -7,11 +7,12 @@ -

    function MaterialIsPointCloud( material_id )

    +

    Function MaterialIsPointCloud( material_id )

    Returns true if material is set to render with point cloud

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialistransparent.html b/doc/doc_files/materialistransparent.html index 5dc3329..6de4f21 100644 --- a/doc/doc_files/materialistransparent.html +++ b/doc/doc_files/materialistransparent.html @@ -7,11 +7,12 @@ -

    function MaterialIsTransparent( material_id)

    +

    Function MaterialIsTransparent( material_id)

    Returns true if material is transparent

    +

    \ No newline at end of file diff --git a/doc/doc_files/materialiswireframe.html b/doc/doc_files/materialiswireframe.html index 4aa8ba5..7799a72 100644 --- a/doc/doc_files/materialiswireframe.html +++ b/doc/doc_files/materialiswireframe.html @@ -7,11 +7,12 @@ -

    function MaterialIsWireframe( material_id )

    +

    Function MaterialIsWireframe( material_id )

    Returns true if the material is rendered with non-filled triangles

    +

    \ No newline at end of file diff --git a/doc/doc_files/matrixfrombuffer.html b/doc/doc_files/matrixfrombuffer.html index 09bf0eb..2f15c60 100644 --- a/doc/doc_files/matrixfrombuffer.html +++ b/doc/doc_files/matrixfrombuffer.html @@ -7,7 +7,7 @@ -

    sub MatrixFromBuffer(mA, r, c, ByRef buffer)

    +

    Sub MatrixFromBuffer(mA, r, c, ByRef buffer)

    Creates a matrix from an array.

    @@ -15,6 +15,7 @@ NOTE: buffer must have the same number of dimensions as the desired matrix for the structure to remain intact.

    +

    \ No newline at end of file diff --git a/doc/doc_files/matrixvalue.html b/doc/doc_files/matrixvalue.html index af8f0a5..526a3b7 100644 --- a/doc/doc_files/matrixvalue.html +++ b/doc/doc_files/matrixvalue.html @@ -7,11 +7,12 @@ -

    function MatrixValue(mA, r, c)

    +

    Function MatrixValue(mA, r, c)

    Returns the value stored at the given row and column in the matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/max.html b/doc/doc_files/max.html index 6624701..43102bd 100644 --- a/doc/doc_files/max.html +++ b/doc/doc_files/max.html @@ -7,7 +7,7 @@ -

    function Max(a, b)

    +

    Function Max(a, b)

    Returns the highest of two numbers.

    @@ -15,6 +15,7 @@ Min

    +

    \ No newline at end of file diff --git a/doc/doc_files/maximizewindow.html b/doc/doc_files/maximizewindow.html index 9de4ccd..ec0d286 100644 --- a/doc/doc_files/maximizewindow.html +++ b/doc/doc_files/maximizewindow.html @@ -7,11 +7,12 @@ -

    sub MaximizeWindow()

    +

    Sub MaximizeWindow()

    Maximizes the window

    +

    \ No newline at end of file diff --git a/doc/doc_files/messagebox.html b/doc/doc_files/messagebox.html index d7b1f94..b37bee0 100644 --- a/doc/doc_files/messagebox.html +++ b/doc/doc_files/messagebox.html @@ -7,11 +7,12 @@ -

    function MessageBox(title$, msg$)

    +

    Function MessageBox(title$, msg$)

    Displays a message box

    +

    \ No newline at end of file diff --git a/doc/doc_files/mid.html b/doc/doc_files/mid.html index d772a11..8d3e598 100644 --- a/doc/doc_files/mid.html +++ b/doc/doc_files/mid.html @@ -7,11 +7,12 @@ -

    function Mid$(src$, start, n)

    +

    Function Mid$(src$, start, n)

    Returns a substring n characters long starting at start pos.

    +

    \ No newline at end of file diff --git a/doc/doc_files/min.html b/doc/doc_files/min.html index 04397c2..34b945e 100644 --- a/doc/doc_files/min.html +++ b/doc/doc_files/min.html @@ -7,7 +7,7 @@ -

    function Min(a, b)

    +

    Function Min(a, b)

    Returns the lowest of two numbers.

    @@ -15,6 +15,7 @@ Max

    +

    \ No newline at end of file diff --git a/doc/doc_files/minimizewindow.html b/doc/doc_files/minimizewindow.html index c8fec6c..2a8b3be 100644 --- a/doc/doc_files/minimizewindow.html +++ b/doc/doc_files/minimizewindow.html @@ -7,11 +7,12 @@ -

    sub MinimizeWindow()

    +

    Sub MinimizeWindow()

    Minimizes the window

    +

    \ No newline at end of file diff --git a/doc/doc_files/mousebutton.html b/doc/doc_files/mousebutton.html index c3e33ee..96ec7dc 100644 --- a/doc/doc_files/mousebutton.html +++ b/doc/doc_files/mousebutton.html @@ -7,11 +7,12 @@ -

    function MouseButton(mb)

    +

    Function MouseButton(mb)

    Returns true if mouse button is pressed

    +

    \ No newline at end of file diff --git a/doc/doc_files/mouseisvisible.html b/doc/doc_files/mouseisvisible.html index cabdca0..3d654bd 100644 --- a/doc/doc_files/mouseisvisible.html +++ b/doc/doc_files/mouseisvisible.html @@ -7,7 +7,7 @@ -

    function MouseIsVisible()

    +

    Function MouseIsVisible()

    Returns true if mouse cursor is shown

    @@ -16,6 +16,7 @@ HideMouse

    +

    \ No newline at end of file diff --git a/doc/doc_files/mousewheelx.html b/doc/doc_files/mousewheelx.html index 54151f6..45d765a 100644 --- a/doc/doc_files/mousewheelx.html +++ b/doc/doc_files/mousewheelx.html @@ -7,11 +7,12 @@ -

    function MouseWheelX()

    +

    Function MouseWheelX()

    Returns the value of the x axis on the mouse wheel

    +

    \ No newline at end of file diff --git a/doc/doc_files/mousewheely.html b/doc/doc_files/mousewheely.html index 2dcfa4f..ad511f3 100644 --- a/doc/doc_files/mousewheely.html +++ b/doc/doc_files/mousewheely.html @@ -7,11 +7,12 @@ -

    function MouseWheelY()

    +

    Function MouseWheelY()

    Returns the value of the y axis on the mouse wheel

    +

    \ No newline at end of file diff --git a/doc/doc_files/mousex.html b/doc/doc_files/mousex.html index 4c1bd58..db49245 100644 --- a/doc/doc_files/mousex.html +++ b/doc/doc_files/mousex.html @@ -7,11 +7,12 @@ -

    function MouseX()

    +

    Function MouseX()

    Returns the mouse x position

    +

    \ No newline at end of file diff --git a/doc/doc_files/mousey.html b/doc/doc_files/mousey.html index eef1ed6..e9e4ac5 100644 --- a/doc/doc_files/mousey.html +++ b/doc/doc_files/mousey.html @@ -7,11 +7,12 @@ -

    function MouseY()

    +

    Function MouseY()

    Returns the mouse y position

    +

    \ No newline at end of file diff --git a/doc/doc_files/movefile.html b/doc/doc_files/movefile.html index 3360ea1..215f79a 100644 --- a/doc/doc_files/movefile.html +++ b/doc/doc_files/movefile.html @@ -7,7 +7,7 @@ -

    function MoveFile(src$, dst$)

    +

    Function MoveFile(src$, dst$)

    Moves a file on the system.

    @@ -15,6 +15,7 @@ Returns true if the file was able to be moved and false if it wasn't

    +

    \ No newline at end of file diff --git a/doc/doc_files/multiplymatrix.html b/doc/doc_files/multiplymatrix.html index 1e90784..724b3ef 100644 --- a/doc/doc_files/multiplymatrix.html +++ b/doc/doc_files/multiplymatrix.html @@ -7,11 +7,12 @@ -

    function MultiplyMatrix(mA, mB, mC)

    +

    Function MultiplyMatrix(mA, mB, mC)

    Multiply matrix mA and mB and store the result in mC

    +

    \ No newline at end of file diff --git a/doc/doc_files/musicexists.html b/doc/doc_files/musicexists.html index b93109c..657800c 100644 --- a/doc/doc_files/musicexists.html +++ b/doc/doc_files/musicexists.html @@ -7,11 +7,12 @@ -

    function MusicExists()

    +

    Function MusicExists()

    Returns true if there is a music track loaded

    +

    \ No newline at end of file diff --git a/doc/doc_files/musicisplaying.html b/doc/doc_files/musicisplaying.html index 92448dd..6e0b15f 100644 --- a/doc/doc_files/musicisplaying.html +++ b/doc/doc_files/musicisplaying.html @@ -7,11 +7,12 @@ -

    function MusicIsPlaying()

    +

    Function MusicIsPlaying()

    Returns true if the music track is currently playing

    +

    \ No newline at end of file diff --git a/doc/doc_files/nav_bottom.html b/doc/doc_files/nav_bottom.html index c73ee0a..fb32d8c 100644 --- a/doc/doc_files/nav_bottom.html +++ b/doc/doc_files/nav_bottom.html @@ -9,7 +9,6 @@ body { background-color: #212837; color: #FFFFFF; } a { color: #40bfb8; } a::before { - content: "---"; font-family: monospace, monospace; display: inline-block; margin-right: 6px; @@ -152,6 +151,22 @@
  • GetLinePlaneIntersection
    • +
  • GetLineAngle
    • + +
  • DotProduct
    • + +
  • InterpolateVector
    • + +
  • InterpolateVectorQ
    • + +
  • VectorIsBetweenPoints
    • + +
  • NormalizeVector
    • + +
  • GetHorizontalAngle
    • + +
  • GetRotationToTarget
    • + @@ -530,6 +545,8 @@
  • PostEffectIsActive
    • +
  • GetPostEffectType
    • + @@ -574,6 +591,8 @@
  • Triangle3D
    • +
  • SetRenderCirclePoints
    • + @@ -640,6 +659,8 @@
  • DrawImage_FlipEx
    • +
  • SaveBMP
    • +
  • SetAntiAliasMode
  • GetAntiAliasMode
    • @@ -836,6 +857,8 @@
  • TextHeight
    • +
  • ActiveFont
    • + @@ -1238,6 +1261,12 @@
  • GetSpriteAlpha
    • +
  • AddSpriteChild
    • + +
  • RemoveSpriteChild
    • + +
  • GetSpriteChildIndex
    • + @@ -1276,6 +1305,8 @@
  • DeleteSpriteAnimation
    • +
  • GetSpriteAnimationSource
    • + @@ -1692,6 +1723,12 @@
  • CreateParticleActor
    • +
  • CreateProjectorActor
    • + +
  • CreateCompositeActor
    • + +
  • CreateVehicleActor
    • +
  • DeleteActor
  • GetActorTransform
    • @@ -1730,7 +1767,7 @@
  • ActorExists
    • -
  • CreateProjectorActor
    • +
  • GetActorType
    • @@ -1770,6 +1807,22 @@
  • DeleteActorAnimation
    • +
  • GetActorBoneCount
    • + +
  • GetActorBoneIndex
    • + +
  • GetActorBoneName$
    • + +
  • GetActorBonePosition
    • + +
  • GetActorBoneRotation
    • + +
  • GetActorBoneScale
    • + +
  • GetActorBoneRelativeTranform
    • + +
  • GetActorBoneAbsoluteTranform
    • + @@ -1904,6 +1957,8 @@
  • SetActorShapeEx
    • +
  • SetActorImpactMesh
    • + @@ -2214,6 +2269,22 @@
  • Pipeline_Render
    • +
  • SetPhysics3D
    • + +
  • GetPhysics3D
    • + + + + + + + + + + + + +

    +

    \ No newline at end of file diff --git a/doc/doc_files/scope.html b/doc/doc_files/scope.html index 4ea7241..6a228f7 100644 --- a/doc/doc_files/scope.html +++ b/doc/doc_files/scope.html @@ -25,6 +25,7 @@ The above program WILL NOT COMPILE. That is because the variable B was created inside the scope of the WHILE loop and nothing outside the WHILE loop will be able to access it. The variable A was created outside the WHILE loop so the variable A could be used anywhere in this example. So a variable can go into a deeper scope than where it was created but it cannot go to a lesser scope than where it was created. A scope deepens every time a new block is started. Blocks refer to the code within a loop, within a Function, or within a Sub Routine.

    +

    \ No newline at end of file diff --git a/doc/doc_files/seek.html b/doc/doc_files/seek.html index b4d0282..dc7bc09 100644 --- a/doc/doc_files/seek.html +++ b/doc/doc_files/seek.html @@ -7,7 +7,7 @@ -

    function Seek(stream, pos)

    +

    Function Seek(stream, pos)

    Sets the position within a file to read from or write to.

    @@ -15,6 +15,7 @@ Tell

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorangularfactor.html b/doc/doc_files/setactorangularfactor.html index 8edd8fc..fa99596 100644 --- a/doc/doc_files/setactorangularfactor.html +++ b/doc/doc_files/setactorangularfactor.html @@ -7,7 +7,7 @@ -

    sub SetActorAngularFactor( actor, x, y, z)

    +

    Sub SetActorAngularFactor( actor, x, y, z)

    Sets an actor's angular factor.

    @@ -20,6 +20,7 @@ SetActorLinearFactor

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorangularvelocitylocal.html b/doc/doc_files/setactorangularvelocitylocal.html index dd326d2..d627bfc 100644 --- a/doc/doc_files/setactorangularvelocitylocal.html +++ b/doc/doc_files/setactorangularvelocitylocal.html @@ -3,11 +3,11 @@ - setActorAngularVelocityLocal [RCBasic Doc] + SetActorAngularVelocityLocal [RCBasic Doc] -

    sub setActorAngularVelocityLocal( actor, x, y, z)

    +

    Sub SetActorAngularVelocityLocal( actor, x, y, z)

    Sets an actor's Angular Velocity

    @@ -17,6 +17,7 @@ SetActorAngularVelocityWorld

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorangularvelocityworld.html b/doc/doc_files/setactorangularvelocityworld.html index 568a1fd..34b34e9 100644 --- a/doc/doc_files/setactorangularvelocityworld.html +++ b/doc/doc_files/setactorangularvelocityworld.html @@ -3,11 +3,11 @@ - setActorAngularVelocityWorld [RCBasic Doc] + SetActorAngularVelocityWorld [RCBasic Doc] -

    sub setActorAngularVelocityWorld( actor, x, y, z)

    +

    Sub SetActorAngularVelocityWorld( actor, x, y, z)

    Sets an actor's Angular Velocity

    @@ -17,6 +17,7 @@ SetActorAngularVelocityLocal

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactoranimation.html b/doc/doc_files/setactoranimation.html index 572de60..38011dc 100644 --- a/doc/doc_files/setactoranimation.html +++ b/doc/doc_files/setactoranimation.html @@ -7,7 +7,7 @@ -

    sub SetActorAnimation( actor, animation, num_loops)

    +

    Sub SetActorAnimation( actor, animation, num_loops)

    Sets the current animation for an actor to start playing

    @@ -26,6 +26,7 @@ CreateActorAnimation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactoranimationframes.html b/doc/doc_files/setactoranimationframes.html index 2e1687e..24d0a8c 100644 --- a/doc/doc_files/setactoranimationframes.html +++ b/doc/doc_files/setactoranimationframes.html @@ -7,7 +7,7 @@ -

    sub SetActorAnimationFrames(actor, animation, start_frame, end_frame)

    +

    Sub SetActorAnimationFrames(actor, animation, start_frame, end_frame)

    Changes the frames that plays in an actor's animation

    @@ -15,6 +15,7 @@ CreateActorAnimation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactoranimationspeed.html b/doc/doc_files/setactoranimationspeed.html index 20d9ced..8974090 100644 --- a/doc/doc_files/setactoranimationspeed.html +++ b/doc/doc_files/setactoranimationspeed.html @@ -7,7 +7,7 @@ -

    sub SetActorAnimationSpeed( actor, animation, speed )

    +

    Sub SetActorAnimationSpeed( actor, animation, speed )

    Set the FPS of an actor animation

    @@ -15,6 +15,7 @@ GetActorAnimationSpeed

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorautoculling.html b/doc/doc_files/setactorautoculling.html index b7bc3d6..ac349ff 100644 --- a/doc/doc_files/setactorautoculling.html +++ b/doc/doc_files/setactorautoculling.html @@ -7,7 +7,7 @@ -

    sub SetActorAutoCulling( actor, cull_type )

    +

    Sub SetActorAutoCulling( actor, cull_type )

    Sets the automatic culling state for an actor

    @@ -35,6 +35,7 @@ GetActorAutoCulling

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactordamping.html b/doc/doc_files/setactordamping.html index decd63e..7eb0c9d 100644 --- a/doc/doc_files/setactordamping.html +++ b/doc/doc_files/setactordamping.html @@ -3,11 +3,11 @@ - setActorDamping [RCBasic Doc] + SetActorDamping [RCBasic Doc] -

    sub setActorDamping( actor, lin_damping, ang_damping)

    +

    Sub SetActorDamping( actor, lin_damping, ang_damping)

    Sets the linear and angular damping for an actor

    @@ -16,6 +16,7 @@ GetActorAngularDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorframe.html b/doc/doc_files/setactorframe.html index abca648..f00f675 100644 --- a/doc/doc_files/setactorframe.html +++ b/doc/doc_files/setactorframe.html @@ -7,7 +7,7 @@ -

    sub SetActorFrame( actor, frame )

    +

    Sub SetActorFrame( actor, frame )

    Sets the current frame of an actor

    @@ -18,6 +18,7 @@ GetActorFrame

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorgravity.html b/doc/doc_files/setactorgravity.html index 707fdf7..af65758 100644 --- a/doc/doc_files/setactorgravity.html +++ b/doc/doc_files/setactorgravity.html @@ -7,7 +7,7 @@ -

    sub SetActorGravity( actor, x, y, z )

    +

    Sub SetActorGravity( actor, x, y, z )

    Sets the gravity vector of an actor.

    @@ -15,6 +15,7 @@ SetGravity3D

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorinverseinertiadiaglocal.html b/doc/doc_files/setactorinverseinertiadiaglocal.html index 1d4290f..e02a3c2 100644 --- a/doc/doc_files/setactorinverseinertiadiaglocal.html +++ b/doc/doc_files/setactorinverseinertiadiaglocal.html @@ -7,7 +7,7 @@ -

    sub SetActorInverseInertiaDiagLocal( actor, x, y, z)

    +

    Sub SetActorInverseInertiaDiagLocal( actor, x, y, z)

    Sets the inverse of the inertia tensor's diagonal components in an actor's local space. This is used to compute how the actor reacts to rotational forces (torques) applied to it.

    @@ -15,6 +15,7 @@ GetActorInverseInertiaDiagLocal

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorlinearfactor.html b/doc/doc_files/setactorlinearfactor.html index b4b4961..b28e72c 100644 --- a/doc/doc_files/setactorlinearfactor.html +++ b/doc/doc_files/setactorlinearfactor.html @@ -7,7 +7,7 @@ -

    sub SetActorLinearFactor( actor, x, y, z)

    +

    Sub SetActorLinearFactor( actor, x, y, z)

    Sets an actor's linear factor.

    @@ -20,6 +20,7 @@ GetActorAngularFactor

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorlinearvelocitylocal.html b/doc/doc_files/setactorlinearvelocitylocal.html index 40bddcc..734d14e 100644 --- a/doc/doc_files/setactorlinearvelocitylocal.html +++ b/doc/doc_files/setactorlinearvelocitylocal.html @@ -3,11 +3,11 @@ - setActorLinearVelocityLocal [RCBasic Doc] + SetActorLinearVelocityLocal [RCBasic Doc] -

    sub setActorLinearVelocityLocal( actor, x, y, z)

    +

    Sub SetActorLinearVelocityLocal( actor, x, y, z)

    Sets actor's linear velocity

    @@ -16,6 +16,7 @@ SetActorLinearVelocityWorld

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorlinearvelocityworld.html b/doc/doc_files/setactorlinearvelocityworld.html index c98f700..fb01d0d 100644 --- a/doc/doc_files/setactorlinearvelocityworld.html +++ b/doc/doc_files/setactorlinearvelocityworld.html @@ -3,11 +3,11 @@ - setActorLinearVelocityWorld [RCBasic Doc] + SetActorLinearVelocityWorld [RCBasic Doc] -

    sub setActorLinearVelocityWorld( actor, x, y, z)

    +

    Sub SetActorLinearVelocityWorld( actor, x, y, z)

    Sets actor's linear velocity

    @@ -16,6 +16,7 @@ GetActorLinearVelocityWorld

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactormassproperties.html b/doc/doc_files/setactormassproperties.html index 1453fc5..0791382 100644 --- a/doc/doc_files/setactormassproperties.html +++ b/doc/doc_files/setactormassproperties.html @@ -3,11 +3,11 @@ - setActorMassProperties [RCBasic Doc] + SetActorMassProperties [RCBasic Doc] -

    sub setActorMassProperties( actor, mass, inertia_x, inertia_y, inertia_z)

    +

    Sub SetActorMassProperties( actor, mass, inertia_x, inertia_y, inertia_z)

    Set the mass and local inertia of an actor. This is crucial for defining how the actor behaves under the influence of forces and torques, especially when it comes to simulating realistic motion and rotation.

    @@ -35,6 +35,7 @@ GetActorInverseMass

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactormaterial.html b/doc/doc_files/setactormaterial.html index cbc4d92..a857eda 100644 --- a/doc/doc_files/setactormaterial.html +++ b/doc/doc_files/setactormaterial.html @@ -3,11 +3,11 @@ - setActorMaterial [RCBasic Doc] + SetActorMaterial [RCBasic Doc] -

    sub setActorMaterial( actor, material_num, material_id)

    +

    Sub SetActorMaterial( actor, material_num, material_id)

    Sets a material on an actor

    @@ -18,6 +18,7 @@ GetActorMaterial

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactormaterialflag.html b/doc/doc_files/setactormaterialflag.html index f7bb01b..6dc4270 100644 --- a/doc/doc_files/setactormaterialflag.html +++ b/doc/doc_files/setactormaterialflag.html @@ -3,11 +3,11 @@ - setActorMaterialFlag [RCBasic Doc] + SetActorMaterialFlag [RCBasic Doc] -

    sub setActorMaterialFlag( actor, flag, flag_value)

    +

    Sub SetActorMaterialFlag( actor, flag, flag_value)

    Sets the value of an actor's material flag.

    @@ -84,6 +84,7 @@ GetActorMaterial

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactormaterialtype.html b/doc/doc_files/setactormaterialtype.html index 533e71f..ce44746 100644 --- a/doc/doc_files/setactormaterialtype.html +++ b/doc/doc_files/setactormaterialtype.html @@ -3,11 +3,11 @@ - setActorMaterialType [RCBasic Doc] + SetActorMaterialType [RCBasic Doc] -

    sub setActorMaterialType( actor, material_type)

    +

    Sub SetActorMaterialType( actor, material_type)

    Sets the material type of an actor material

    @@ -132,6 +132,7 @@ GetActorMaterial

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactormd2animation.html b/doc/doc_files/setactormd2animation.html index 66e48bf..64ddb1e 100644 --- a/doc/doc_files/setactormd2animation.html +++ b/doc/doc_files/setactormd2animation.html @@ -7,7 +7,7 @@ -

    sub SetActorMD2Animation( actor, anim )

    +

    Sub SetActorMD2Animation( actor, anim )

    Sets the current animation for an *.md2 model

    @@ -83,6 +83,7 @@ SetActorMD2AnimationByName

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactormd2animationbyname.html b/doc/doc_files/setactormd2animationbyname.html index 2f1b6f6..6a0cf3e 100644 --- a/doc/doc_files/setactormd2animationbyname.html +++ b/doc/doc_files/setactormd2animationbyname.html @@ -7,7 +7,7 @@ -

    sub SetActorMD2AnimationByName( actor, anim_name$ )

    +

    Sub SetActorMD2AnimationByName( actor, anim_name$ )

    Sets the current animation for an *.md2 model

    @@ -15,6 +15,7 @@ SetActorMD2Animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorposition.html b/doc/doc_files/setactorposition.html index ee1d056..b2c0543 100644 --- a/doc/doc_files/setactorposition.html +++ b/doc/doc_files/setactorposition.html @@ -7,7 +7,7 @@ -

    sub SetActorPosition( actor, x, y, z )

    +

    Sub SetActorPosition( actor, x, y, z )

    Sets the absolute position of an actor

    @@ -17,6 +17,7 @@ GetActorPosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorrotation.html b/doc/doc_files/setactorrotation.html index 70af4ed..a56c60f 100644 --- a/doc/doc_files/setactorrotation.html +++ b/doc/doc_files/setactorrotation.html @@ -7,7 +7,7 @@ -

    sub SetActorRotation( actor, x, y, z )

    +

    Sub SetActorRotation( actor, x, y, z )

    Sets the rotation of an actor around each axis

    @@ -16,6 +16,7 @@ GetActorRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorscale.html b/doc/doc_files/setactorscale.html index f115673..859d1ce 100644 --- a/doc/doc_files/setactorscale.html +++ b/doc/doc_files/setactorscale.html @@ -7,7 +7,7 @@ -

    sub SetActorScale( actor, x, y, z )

    +

    Sub SetActorScale( actor, x, y, z )

    Sets the scale of an actor

    @@ -16,6 +16,7 @@ GetActorScale

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorshape.html b/doc/doc_files/setactorshape.html index aa227c2..20fad1d 100644 --- a/doc/doc_files/setactorshape.html +++ b/doc/doc_files/setactorshape.html @@ -7,7 +7,7 @@ -

    sub SetActorShape( actor, shape_type, mass)

    +

    Sub SetActorShape( actor, shape_type, mass)

    Sets the shape of an actor

    @@ -39,11 +39,22 @@
  • ACTOR_SHAPE_TRIMESH
    • +
  • + ACTOR_SHAPE_COMPOSITE +
    • +
  • + ACTOR_SHAPE_IMPACT_MESH +
    • +

    + NOTE: ACTOR_SHAPE_COMPOSITE is not a shape you can set. It is a shape that is automatically set on composite actors. +


    Related: + SetActorShapeEx GetActorShape

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorsleepstate.html b/doc/doc_files/setactorsleepstate.html index 968f735..380e0fc 100644 --- a/doc/doc_files/setactorsleepstate.html +++ b/doc/doc_files/setactorsleepstate.html @@ -7,8 +7,9 @@ -

    sub SetActorSleepState(actor, state)

    +

    Sub SetActorSleepState(actor, state)

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorsleepthresholds.html b/doc/doc_files/setactorsleepthresholds.html index cd19c17..9320e6c 100644 --- a/doc/doc_files/setactorsleepthresholds.html +++ b/doc/doc_files/setactorsleepthresholds.html @@ -3,11 +3,11 @@ - setActorSleepThresholds [RCBasic Doc] + SetActorSleepThresholds [RCBasic Doc] -

    sub setActorSleepThresholds( actor, linear, angular)

    +

    Sub SetActorSleepThresholds( actor, linear, angular)

    Sets the linear and angular deactivation thresholds for an actor

    @@ -16,6 +16,7 @@ GetActorAngularSleepThreshold

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorsolid.html b/doc/doc_files/setactorsolid.html index 71f6cb0..3204949 100644 --- a/doc/doc_files/setactorsolid.html +++ b/doc/doc_files/setactorsolid.html @@ -7,7 +7,7 @@ -

    sub SetActorSolid(actor, flag)

    +

    Sub SetActorSolid(actor, flag)

    Sets whether an actor has physics and collision response applied to it

    @@ -18,6 +18,7 @@ ActorIsSolid

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactortexture.html b/doc/doc_files/setactortexture.html index 35d04be..ad7a813 100644 --- a/doc/doc_files/setactortexture.html +++ b/doc/doc_files/setactortexture.html @@ -3,11 +3,11 @@ - setActorTexture [RCBasic Doc] + SetActorTexture [RCBasic Doc] -

    sub setActorTexture( actor, layer, image_id)

    +

    Sub SetActorTexture( actor, layer, image_id)

    Sets the texture for an actor's default material

    @@ -15,6 +15,7 @@ Note: Generally you want to use texture layer 0

    +

    \ No newline at end of file diff --git a/doc/doc_files/setactorvisible.html b/doc/doc_files/setactorvisible.html index 7892e26..3a3337d 100644 --- a/doc/doc_files/setactorvisible.html +++ b/doc/doc_files/setactorvisible.html @@ -7,7 +7,7 @@ -

    sub SetActorVisible( actor, flag )

    +

    Sub SetActorVisible( actor, flag )

    Sets whether the actor is visible in the scene

    @@ -15,6 +15,7 @@ ActorIsVisible

    +

    \ No newline at end of file diff --git a/doc/doc_files/setantialiasmode.html b/doc/doc_files/setantialiasmode.html index afb80da..1bd6726 100644 --- a/doc/doc_files/setantialiasmode.html +++ b/doc/doc_files/setantialiasmode.html @@ -7,7 +7,7 @@ -

    sub SetAntiAliasMode( aa_mode )

    +

    Sub SetAntiAliasMode( aa_mode )

    Sets the anti-alias mode for draw image commands

    @@ -41,6 +41,7 @@ GetAntiAliasMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/setbilinearfilter.html b/doc/doc_files/setbilinearfilter.html index 7c903d9..ab3020f 100644 --- a/doc/doc_files/setbilinearfilter.html +++ b/doc/doc_files/setbilinearfilter.html @@ -3,15 +3,16 @@ - setBilinearFilter [RCBasic Doc] + SetBilinearFilter [RCBasic Doc] -

    sub setBilinearFilter( flag )

    +

    Sub SetBilinearFilter( flag )

    Enables or disables the bilinear filter for drawing 2D images

    +

    \ No newline at end of file diff --git a/doc/doc_files/setblendmode.html b/doc/doc_files/setblendmode.html index 4e1c251..efd7065 100644 --- a/doc/doc_files/setblendmode.html +++ b/doc/doc_files/setblendmode.html @@ -7,7 +7,7 @@ -

    sub SetBlendMode( blend_mode )

    +

    Sub SetBlendMode( blend_mode )

    Sets the current blend mode

    @@ -53,6 +53,7 @@ SetBlendMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcameraaspectratio.html b/doc/doc_files/setcameraaspectratio.html index 19ce197..c2c7980 100644 --- a/doc/doc_files/setcameraaspectratio.html +++ b/doc/doc_files/setcameraaspectratio.html @@ -7,7 +7,7 @@ -

    sub SetCameraAspectRatio( aspect )

    +

    Sub SetCameraAspectRatio( aspect )

    Sets the aspect ratio for the active canvas camera

    @@ -15,6 +15,7 @@ GetCameraAspectRatio

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcamerafarvalue.html b/doc/doc_files/setcamerafarvalue.html index 74ded46..f12005e 100644 --- a/doc/doc_files/setcamerafarvalue.html +++ b/doc/doc_files/setcamerafarvalue.html @@ -7,7 +7,7 @@ -

    sub SetCameraFarValue( zf )

    +

    Sub SetCameraFarValue( zf )

    Sets the distance to the camera far plane

    @@ -15,6 +15,7 @@ GetCameraFarValue

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcamerafov.html b/doc/doc_files/setcamerafov.html index 30660fb..02a2df3 100644 --- a/doc/doc_files/setcamerafov.html +++ b/doc/doc_files/setcamerafov.html @@ -7,7 +7,7 @@ -

    sub SetCameraFOV( fov )

    +

    Sub SetCameraFOV( fov )

    Sets the camera's field of view

    @@ -15,6 +15,7 @@ GetCameraFOV

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcameranearvalue.html b/doc/doc_files/setcameranearvalue.html index f2645fe..95f7dd4 100644 --- a/doc/doc_files/setcameranearvalue.html +++ b/doc/doc_files/setcameranearvalue.html @@ -7,7 +7,7 @@ -

    sub SetCameraNearValue( zn )

    +

    Sub SetCameraNearValue( zn )

    Sets the distance of the camera near plane

    @@ -15,6 +15,7 @@ GetCameraNearValue

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcameraposition.html b/doc/doc_files/setcameraposition.html index 8c3277f..d4d14e6 100644 --- a/doc/doc_files/setcameraposition.html +++ b/doc/doc_files/setcameraposition.html @@ -7,7 +7,7 @@ -

    sub SetCameraPosition( x, y, z)

    +

    Sub SetCameraPosition( x, y, z)

    Sets the absolute position of the camera in the scene

    @@ -16,6 +16,7 @@ GetCameraPosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcamerarotation.html b/doc/doc_files/setcamerarotation.html index 9b26220..39ec2fd 100644 --- a/doc/doc_files/setcamerarotation.html +++ b/doc/doc_files/setcamerarotation.html @@ -7,7 +7,7 @@ -

    sub SetCameraRotation( x, y, z)

    +

    Sub SetCameraRotation( x, y, z)

    Sets the rotation of the camera around each axis

    @@ -16,6 +16,7 @@ GetCameraRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcanvasalpha.html b/doc/doc_files/setcanvasalpha.html index 07d853e..2d19738 100644 --- a/doc/doc_files/setcanvasalpha.html +++ b/doc/doc_files/setcanvasalpha.html @@ -7,11 +7,12 @@ -

    sub SetCanvasAlpha(c_num, a)

    +

    Sub SetCanvasAlpha(c_num, a)

    Sets the alpha blending value for a canvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcanvascolormod.html b/doc/doc_files/setcanvascolormod.html index a931c8f..19b1026 100644 --- a/doc/doc_files/setcanvascolormod.html +++ b/doc/doc_files/setcanvascolormod.html @@ -7,11 +7,12 @@ -

    sub SetCanvasColorMod(c_num, c)

    +

    Sub SetCanvasColorMod(c_num, c)

    Sets the color modulation value for a canvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcanvasoffset.html b/doc/doc_files/setcanvasoffset.html index e28e19f..0a25ca8 100644 --- a/doc/doc_files/setcanvasoffset.html +++ b/doc/doc_files/setcanvasoffset.html @@ -7,7 +7,7 @@ -

    sub SetCanvasOffset(c_num, x, y)

    +

    Sub SetCanvasOffset(c_num, x, y)

    Sets the offset of a canvas

    @@ -18,6 +18,7 @@ GetCanvasOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcanvasphysics2d.html b/doc/doc_files/setcanvasphysics2d.html index 4479a6d..081ef13 100644 --- a/doc/doc_files/setcanvasphysics2d.html +++ b/doc/doc_files/setcanvasphysics2d.html @@ -7,8 +7,9 @@ -

    sub SetCanvasPhysics2D(c_num, state)

    +

    Sub SetCanvasPhysics2D(c_num, state)

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcanvasviewport.html b/doc/doc_files/setcanvasviewport.html index e7c3277..e490680 100644 --- a/doc/doc_files/setcanvasviewport.html +++ b/doc/doc_files/setcanvasviewport.html @@ -7,7 +7,7 @@ -

    sub SetCanvasViewport(cnum, x, y, w, h)

    +

    Sub SetCanvasViewport(cnum, x, y, w, h)

    Sets the position and size of a canvas viewport

    @@ -15,6 +15,7 @@ GetCanvasViewport

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcanvasvisible.html b/doc/doc_files/setcanvasvisible.html index c7e7553..dcac474 100644 --- a/doc/doc_files/setcanvasvisible.html +++ b/doc/doc_files/setcanvasvisible.html @@ -7,7 +7,7 @@ -

    sub SetCanvasVisible(c_num, flag)

    +

    Sub SetCanvasVisible(c_num, flag)

    Sets whether a canvas is shown or not.

    @@ -15,6 +15,7 @@ CanvasIsVisible

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcanvasz.html b/doc/doc_files/setcanvasz.html index acc6547..4198cdc 100644 --- a/doc/doc_files/setcanvasz.html +++ b/doc/doc_files/setcanvasz.html @@ -7,7 +7,7 @@ -

    sub SetCanvasZ(c_num, z)

    +

    Sub SetCanvasZ(c_num, z)

    Sets the Canvas Z Order.

    @@ -18,6 +18,7 @@ SetCanvasZ

    +

    \ No newline at end of file diff --git a/doc/doc_files/setchanneldistance.html b/doc/doc_files/setchanneldistance.html index 492e331..a5eb536 100644 --- a/doc/doc_files/setchanneldistance.html +++ b/doc/doc_files/setchanneldistance.html @@ -7,7 +7,7 @@ -

    function SetChannelDistance(channel, dist_value)

    +

    Function SetChannelDistance(channel, dist_value)

    Set a volume adjustment effect due to distance. distance must be a value between 0 and 255. Returns 0 on error.

    @@ -15,6 +15,7 @@ NOTE: Setting distance to 0 will cancel the effect

    +

    \ No newline at end of file diff --git a/doc/doc_files/setchannelpanning.html b/doc/doc_files/setchannelpanning.html index fcce1d4..93ac805 100644 --- a/doc/doc_files/setchannelpanning.html +++ b/doc/doc_files/setchannelpanning.html @@ -7,7 +7,7 @@ -

    function SetChannelPanning(channel, left_value, right_value)

    +

    Function SetChannelPanning(channel, left_value, right_value)

    Set Panning effect for channel. left_value and right_value must be a value between 0 and 255. Returns 0 on error.

    @@ -15,6 +15,7 @@ NOTE: Setting both left and right to 255 will cancel the pan effect

    +

    \ No newline at end of file diff --git a/doc/doc_files/setchannelspaceposition.html b/doc/doc_files/setchannelspaceposition.html index e26faca..512a3d1 100644 --- a/doc/doc_files/setchannelspaceposition.html +++ b/doc/doc_files/setchannelspaceposition.html @@ -7,7 +7,7 @@ -

    function SetChannelSpacePosition(channel, angle, distance)

    +

    Function SetChannelSpacePosition(channel, angle, distance)

    Simulates audio in 3D space

    @@ -19,6 +19,7 @@ SetChannelPanning

    +

    \ No newline at end of file diff --git a/doc/doc_files/setchannelvolume.html b/doc/doc_files/setchannelvolume.html index 2da40fe..bd1570f 100644 --- a/doc/doc_files/setchannelvolume.html +++ b/doc/doc_files/setchannelvolume.html @@ -7,11 +7,12 @@ -

    sub SetChannelVolume(channel, vol)

    +

    Sub SetChannelVolume(channel, vol)

    Sets the volume of the audio on a channel

    +

    \ No newline at end of file diff --git a/doc/doc_files/setclearcolor.html b/doc/doc_files/setclearcolor.html index e01229f..4ececf1 100644 --- a/doc/doc_files/setclearcolor.html +++ b/doc/doc_files/setclearcolor.html @@ -7,7 +7,7 @@ -

    sub SetClearColor(c)

    +

    Sub SetClearColor(c)

    Sets the color that a canvas is cleared to on ClearCanvas()

    @@ -15,6 +15,7 @@ ClearCanvas

    +

    \ No newline at end of file diff --git a/doc/doc_files/setclipboardtext.html b/doc/doc_files/setclipboardtext.html index ed45c23..f7ac009 100644 --- a/doc/doc_files/setclipboardtext.html +++ b/doc/doc_files/setclipboardtext.html @@ -7,11 +7,12 @@ -

    sub SetClipboardText(txt$)

    +

    Sub SetClipboardText(txt$)

    Sets the clipboard text.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setcolor.html b/doc/doc_files/setcolor.html index 21734b7..7496bcb 100644 --- a/doc/doc_files/setcolor.html +++ b/doc/doc_files/setcolor.html @@ -7,11 +7,12 @@ -

    sub SetColor(c)

    +

    Sub SetColor(c)

    Sets the current draw color

    +

    \ No newline at end of file diff --git a/doc/doc_files/setconedamping.html b/doc/doc_files/setconedamping.html index cca7c29..e9bb058 100644 --- a/doc/doc_files/setconedamping.html +++ b/doc/doc_files/setconedamping.html @@ -3,15 +3,16 @@ - setConeDamping [RCBasic Doc] + SetConeDamping [RCBasic Doc] -

    sub setConeDamping( constraint_id, damping)

    +

    Sub SetConeDamping( constraint_id, damping)

    Returns the damping factor applied to the constraint. Damping is used to reduce the amount of oscillation or unwanted movement (such as excessive rotation or swinging) around the constrained actor's axes.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setconefixthresh.html b/doc/doc_files/setconefixthresh.html index f73d70c..9073cf2 100644 --- a/doc/doc_files/setconefixthresh.html +++ b/doc/doc_files/setconefixthresh.html @@ -3,11 +3,11 @@ - setConeFixThresh [RCBasic Doc] + SetConeFixThresh [RCBasic Doc] -

    sub setConeFixThresh( constraint_id, fixThresh)

    +

    Sub SetConeFixThresh( constraint_id, fixThresh)

    Sets the fix threshold value associated with that constraint. This threshold is used to control how the constraint behaves when the angle of the rotation between the actors approaches the limits defined by the cone twist constraint.

    @@ -18,6 +18,7 @@ GetConeFixThresh

    +

    \ No newline at end of file diff --git a/doc/doc_files/setconelimit.html b/doc/doc_files/setconelimit.html index e884fad..14be0aa 100644 --- a/doc/doc_files/setconelimit.html +++ b/doc/doc_files/setconelimit.html @@ -3,11 +3,11 @@ - setConeLimit [RCBasic Doc] + SetConeLimit [RCBasic Doc] -

    sub setConeLimit( constraint_id, swingSpan1, swingSpan2, twistSpan, softness, bias_factor, relaxation_factor)

    +

    Sub SetConeLimit( constraint_id, swingSpan1, swingSpan2, twistSpan, softness, bias_factor, relaxation_factor)

    Sets the angular limits for the rotation of the constrained actors. These limits specify how much twisting and swinging is permitted between the two actors connected by the constraint, ensuring the motion stays within a desired range.

    @@ -24,6 +24,7 @@ GetConeLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/setconstraintangularonly.html b/doc/doc_files/setconstraintangularonly.html index 0b47bc6..6c7f280 100644 --- a/doc/doc_files/setconstraintangularonly.html +++ b/doc/doc_files/setconstraintangularonly.html @@ -3,11 +3,11 @@ - setConstraintAngularOnly [RCBasic Doc] + SetConstraintAngularOnly [RCBasic Doc] -

    sub setConstraintAngularOnly( constraint_id, flag)

    +

    Sub SetConstraintAngularOnly( constraint_id, flag)

    Sets the hinge constraint to limit only angular motion while allowing unrestricted linear (translational) motion.

    @@ -15,6 +15,7 @@ GetConstraintAngularOnly

    +

    \ No newline at end of file diff --git a/doc/doc_files/setconstraintbreakingimpulsethreshold.html b/doc/doc_files/setconstraintbreakingimpulsethreshold.html index 8068509..63363a7 100644 --- a/doc/doc_files/setconstraintbreakingimpulsethreshold.html +++ b/doc/doc_files/setconstraintbreakingimpulsethreshold.html @@ -3,11 +3,11 @@ - setConstraintBreakingImpulseThreshold [RCBasic Doc] + SetConstraintBreakingImpulseThreshold [RCBasic Doc] -

    sub setConstraintBreakingImpulseThreshold( constraint_id, threshold)

    +

    Sub SetConstraintBreakingImpulseThreshold( constraint_id, threshold)

    Sets the breaking impulse threshold for a given constraint. The breaking impulse threshold defines the maximum force (impulse) a constraint can withstand before it "breaks," meaning that the constraint will be deactivated and no longer enforce its rules.

    @@ -15,6 +15,7 @@ GetConstraintBreakingImpulseThreshold

    +

    \ No newline at end of file diff --git a/doc/doc_files/setconstraintframes.html b/doc/doc_files/setconstraintframes.html index faca0ba..0657749 100644 --- a/doc/doc_files/setconstraintframes.html +++ b/doc/doc_files/setconstraintframes.html @@ -3,11 +3,11 @@ - setConstraintFrames [RCBasic Doc] + SetConstraintFrames [RCBasic Doc] -

    sub setConstraintFrames( constraint_id, frameA_matrix, frameB_matrix)

    +

    Sub SetConstraintFrames( constraint_id, frameA_matrix, frameB_matrix)

    Defines the reference frames for the constraint. This function establishes how the constraint is oriented in the local coordinate systems of the connected actors.

    @@ -15,6 +15,7 @@ The reference frames define the orientation and position of the constraint relative to each of the connected actors. Each actor can have its own local coordinate system, and the frames help establish how the constraint interacts with these systems.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setconstraintsolveriterations.html b/doc/doc_files/setconstraintsolveriterations.html index 5e5a03d..c7b42da 100644 --- a/doc/doc_files/setconstraintsolveriterations.html +++ b/doc/doc_files/setconstraintsolveriterations.html @@ -3,15 +3,16 @@ - setConstraintSolverIterations [RCBasic Doc] + SetConstraintSolverIterations [RCBasic Doc] -

    sub setConstraintSolverIterations( constraint_id, num)

    +

    Sub SetConstraintSolverIterations( constraint_id, num)

    Sets the value for the number of solver iterations that have been overridden for a specific constraint or actor. Solver iterations refer to the number of times the physics engine solves for constraint forces during each simulation step.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setenv.html b/doc/doc_files/setenv.html index 558774f..915bfac 100644 --- a/doc/doc_files/setenv.html +++ b/doc/doc_files/setenv.html @@ -7,7 +7,7 @@ -

    sub SetEnv(var$, value$)

    +

    Sub SetEnv(var$, value$)

    Sets the value of an environment variable

    @@ -15,6 +15,7 @@ Env$

    +

    \ No newline at end of file diff --git a/doc/doc_files/setfont.html b/doc/doc_files/setfont.html index 168aee5..1789e84 100644 --- a/doc/doc_files/setfont.html +++ b/doc/doc_files/setfont.html @@ -7,7 +7,7 @@ -

    sub SetFont(fnt_id)

    +

    Sub SetFont(fnt_id)

    Sets the active font for text rendering

    @@ -15,6 +15,7 @@ DrawText

    +

    \ No newline at end of file diff --git a/doc/doc_files/setfps.html b/doc/doc_files/setfps.html index a2e4ee4..8964e15 100644 --- a/doc/doc_files/setfps.html +++ b/doc/doc_files/setfps.html @@ -9,6 +9,7 @@

    Sub SetFPS(fps_val)

    +

    \ No newline at end of file diff --git a/doc/doc_files/setgravity2d.html b/doc/doc_files/setgravity2d.html index e231e64..0141f18 100644 --- a/doc/doc_files/setgravity2d.html +++ b/doc/doc_files/setgravity2d.html @@ -7,7 +7,7 @@ -

    sub SetGravity2D(x, y)

    +

    Sub SetGravity2D(x, y)

    Use this function for setting the global gravity vector. A sprite canvas layer must be active.

    @@ -15,6 +15,7 @@ GetGravity2D

    +

    \ No newline at end of file diff --git a/doc/doc_files/setgravity3d.html b/doc/doc_files/setgravity3d.html index 0859ac0..e9a2caa 100644 --- a/doc/doc_files/setgravity3d.html +++ b/doc/doc_files/setgravity3d.html @@ -7,11 +7,12 @@ -

    sub SetGravity3D(x, y, z)

    +

    Sub SetGravity3D(x, y, z)

    Sets the world gravity

    +

    \ No newline at end of file diff --git a/doc/doc_files/sethingeaxis.html b/doc/doc_files/sethingeaxis.html index cf8117a..0242568 100644 --- a/doc/doc_files/sethingeaxis.html +++ b/doc/doc_files/sethingeaxis.html @@ -3,11 +3,11 @@ - setHingeAxis [RCBasic Doc] + SetHingeAxis [RCBasic Doc] -

    sub setHingeAxis( constraint_id, x, y, z)

    +

    Sub SetHingeAxis( constraint_id, x, y, z)

    Defines the axis of rotation around which the hinge constraint allows the connected actors to rotate. This function is essential for establishing how the two actors will interact in terms of rotational motion.

    @@ -15,6 +15,7 @@ The axis of rotation defines the direction in which the hinge can rotate. For example, if you want a door to swing open, you would set the axis to be perpendicular to the plane of the door and aligned with the hinge line.

    +

    \ No newline at end of file diff --git a/doc/doc_files/sethingelimit.html b/doc/doc_files/sethingelimit.html index ae1849f..baf64fc 100644 --- a/doc/doc_files/sethingelimit.html +++ b/doc/doc_files/sethingelimit.html @@ -3,11 +3,11 @@ - setHingeLimit [RCBasic Doc] + SetHingeLimit [RCBasic Doc] -

    sub setHingeLimit( constraint_id, low, high, softness, bias_factor, relaxation_factor)

    +

    Sub SetHingeLimit( constraint_id, low, high, softness, bias_factor, relaxation_factor)

    Defines the angular limits of the hinge's rotation. A hinge constraint allows two actors (or one actor and the world) to rotate around a single axis, similar to a door hinge. This function restricts how far this rotation can go by setting minimum and maximum angles.

    @@ -38,6 +38,7 @@ GetHingeSolveLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/setidentitymatrix.html b/doc/doc_files/setidentitymatrix.html index a737be0..2ffda55 100644 --- a/doc/doc_files/setidentitymatrix.html +++ b/doc/doc_files/setidentitymatrix.html @@ -7,7 +7,7 @@ -

    sub SetIdentityMatrix(mA, n)

    +

    Sub SetIdentityMatrix(mA, n)

    Sets matrix mA to an identity matrix of n rows and n columns.

    @@ -15,6 +15,7 @@ For most transform operations (ie. translate, rotate, and scale) it is recommended to start from and identity matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/setimagealpha.html b/doc/doc_files/setimagealpha.html index 43ea08b..28a5e8b 100644 --- a/doc/doc_files/setimagealpha.html +++ b/doc/doc_files/setimagealpha.html @@ -7,7 +7,7 @@ -

    sub SetImageAlpha(slot, a)

    +

    Sub SetImageAlpha(slot, a)

    Sets the alpha blending value for an image. This value only applies in 2D drawing commands.

    @@ -15,6 +15,7 @@ GetImageAlpha

    +

    \ No newline at end of file diff --git a/doc/doc_files/setimagecolormod.html b/doc/doc_files/setimagecolormod.html index 1e1caa4..dae35a8 100644 --- a/doc/doc_files/setimagecolormod.html +++ b/doc/doc_files/setimagecolormod.html @@ -7,11 +7,12 @@ -

    sub SetImageColorMod(img_id, c)

    +

    Sub SetImageColorMod(img_id, c)

    Sets the color modulation vlaue for an image

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointangularoffset.html b/doc/doc_files/setjointangularoffset.html index 30c9ed2..8616249 100644 --- a/doc/doc_files/setjointangularoffset.html +++ b/doc/doc_files/setjointangularoffset.html @@ -3,11 +3,11 @@ - setJointAngularOffset [RCBasic Doc] + SetJointAngularOffset [RCBasic Doc] -

    sub setJointAngularOffset( joint_id, angleOffset)

    +

    Sub SetJointAngularOffset( joint_id, angleOffset)

    Set the target angular offset

    @@ -18,6 +18,7 @@ GetJointAngularOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointcorrectionfactor.html b/doc/doc_files/setjointcorrectionfactor.html index 4e332c1..9b8639c 100644 --- a/doc/doc_files/setjointcorrectionfactor.html +++ b/doc/doc_files/setjointcorrectionfactor.html @@ -3,11 +3,11 @@ - setJointCorrectionFactor [RCBasic Doc] + SetJointCorrectionFactor [RCBasic Doc] -

    sub setJointCorrectionFactor( joint_id, factor)

    +

    Sub SetJointCorrectionFactor( joint_id, factor)

    Sets how quickly the joint corrects deviations from its target position and rotation. This correction factor determines the responsiveness of the motor joint in achieving the desired linear and angular offsets between two connected bodies.

    @@ -18,6 +18,7 @@ GetJointCorrectionFactor

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointdamping.html b/doc/doc_files/setjointdamping.html index e0387a2..fd91bbc 100644 --- a/doc/doc_files/setjointdamping.html +++ b/doc/doc_files/setjointdamping.html @@ -3,11 +3,11 @@ - setJointDamping [RCBasic Doc] + SetJointDamping [RCBasic Doc] -

    sub setJointDamping( joint_id, damping)

    +

    Sub SetJointDamping( joint_id, damping)

    Sets the damping value for a joint

    @@ -29,6 +29,7 @@ GetJointDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointlength.html b/doc/doc_files/setjointlength.html index 9e4c2c3..0fe6f6e 100644 --- a/doc/doc_files/setjointlength.html +++ b/doc/doc_files/setjointlength.html @@ -3,11 +3,11 @@ - setJointLength [RCBasic Doc] + SetJointLength [RCBasic Doc] -

    sub setJointLength( joint_id, jlen)

    +

    Sub SetJointLength( joint_id, jlen)

    Set the fixed distance between two connected bodies. This distance acts as a "target length" that the joint will try to maintain, applying forces to keep the bodies at that separation.

    @@ -18,6 +18,7 @@ GetJointLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointlimits.html b/doc/doc_files/setjointlimits.html index 78a2412..10e1cb7 100644 --- a/doc/doc_files/setjointlimits.html +++ b/doc/doc_files/setjointlimits.html @@ -3,11 +3,11 @@ - setJointLimits [RCBasic Doc] + SetJointLimits [RCBasic Doc] -

    sub setJointLimits( joint_id, lower_limit, upper_limit)

    +

    Sub SetJointLimits( joint_id, lower_limit, upper_limit)

    Sets the minimum and maximum limits, restricting how far or how much rotation the connected bodies can move relative to each other.

    @@ -30,6 +30,7 @@ GetJointUpperLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointlinearoffset.html b/doc/doc_files/setjointlinearoffset.html index a38112c..3138386 100644 --- a/doc/doc_files/setjointlinearoffset.html +++ b/doc/doc_files/setjointlinearoffset.html @@ -3,11 +3,11 @@ - setJointLinearOffset [RCBasic Doc] + SetJointLinearOffset [RCBasic Doc] -

    sub setJointLinearOffset( joint_id, x, y)

    +

    Sub SetJointLinearOffset( joint_id, x, y)

    Specify a target position offset for the connected bodies relative to each other.

    @@ -18,6 +18,7 @@ GetJointLinearOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointmaxforce.html b/doc/doc_files/setjointmaxforce.html index da1b6e0..522fd3a 100644 --- a/doc/doc_files/setjointmaxforce.html +++ b/doc/doc_files/setjointmaxforce.html @@ -3,11 +3,11 @@ - setJointMaxForce [RCBasic Doc] + SetJointMaxForce [RCBasic Doc] -

    sub setJointMaxForce( joint_id, force)

    +

    Sub SetJointMaxForce( joint_id, force)

    Sets an upper limit on the amount of force the joint can apply to the connected bodies, helping to control how much resistance or power the joint provides.

    @@ -23,6 +23,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointmaxlength.html b/doc/doc_files/setjointmaxlength.html index 14f5418..042f262 100644 --- a/doc/doc_files/setjointmaxlength.html +++ b/doc/doc_files/setjointmaxlength.html @@ -3,11 +3,11 @@ - setJointMaxLength [RCBasic Doc] + SetJointMaxLength [RCBasic Doc] -

    sub setJointMaxLength( joint_id, jlen)

    +

    Sub SetJointMaxLength( joint_id, jlen)

    Set the maximum allowable length between two connected bodies

    @@ -18,6 +18,7 @@ SetJointMinLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointmaxmotorforce.html b/doc/doc_files/setjointmaxmotorforce.html index 2eec341..1341e4f 100644 --- a/doc/doc_files/setjointmaxmotorforce.html +++ b/doc/doc_files/setjointmaxmotorforce.html @@ -3,11 +3,11 @@ - setJointMaxMotorForce [RCBasic Doc] + SetJointMaxMotorForce [RCBasic Doc] -

    sub setJointMaxMotorForce( joint_id, force)

    +

    Sub SetJointMaxMotorForce( joint_id, force)

    Limits the maximum linear force that the motor can apply to achieve the target speed set by SetMotorSpeed. This allows you to control the power or strength of the motor along the joint’s axis.

    @@ -18,6 +18,7 @@ GetJointMaxMotorForce

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointmaxmotortorque.html b/doc/doc_files/setjointmaxmotortorque.html index e523045..dedf8f3 100644 --- a/doc/doc_files/setjointmaxmotortorque.html +++ b/doc/doc_files/setjointmaxmotortorque.html @@ -3,11 +3,11 @@ - setJointMaxMotorTorque [RCBasic Doc] + SetJointMaxMotorTorque [RCBasic Doc] -

    sub setJointMaxMotorTorque( joint_id, torque)

    +

    Sub SetJointMaxMotorTorque( joint_id, torque)

    Limits the maximum torque (rotational force) that the motor can apply to achieve the target motor speed set by SetMotorSpeed. This allows you to control how much power the motorized joint has.

    @@ -26,6 +26,7 @@ GetJointMaxMotorTorque

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointmaxtorque.html b/doc/doc_files/setjointmaxtorque.html index 6efd262..ee74bed 100644 --- a/doc/doc_files/setjointmaxtorque.html +++ b/doc/doc_files/setjointmaxtorque.html @@ -3,11 +3,11 @@ - setJointMaxTorque [RCBasic Doc] + SetJointMaxTorque [RCBasic Doc] -

    sub setJointMaxTorque( joint_id, torque)

    +

    Sub SetJointMaxTorque( joint_id, torque)

    Sets an upper limit on the amount of torque (rotational force) the joint can apply, controlling how much rotational resistance or power the joint provides.

    @@ -26,6 +26,7 @@ GetJointMaxTorque

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointminlength.html b/doc/doc_files/setjointminlength.html index 6a211d6..05628cd 100644 --- a/doc/doc_files/setjointminlength.html +++ b/doc/doc_files/setjointminlength.html @@ -3,11 +3,11 @@ - setJointMinLength [RCBasic Doc] + SetJointMinLength [RCBasic Doc] -

    sub setJointMinLength( joint_id, jlen)

    +

    Sub SetJointMinLength( joint_id, jlen)

    Set the minimum allowable length between two connected bodies

    @@ -18,6 +18,7 @@ SetJointMaxLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointmotorspeed.html b/doc/doc_files/setjointmotorspeed.html index c422a78..d392a17 100644 --- a/doc/doc_files/setjointmotorspeed.html +++ b/doc/doc_files/setjointmotorspeed.html @@ -3,11 +3,11 @@ - setJointMotorSpeed [RCBasic Doc] + SetJointMotorSpeed [RCBasic Doc] -

    sub setJointMotorSpeed( joint_id, speed)

    +

    Sub SetJointMotorSpeed( joint_id, speed)

    Used on joints that support motors, such as revolute joints and prismatic joints, to control the speed at which the motor applies force to achieve movement.

    @@ -29,6 +29,7 @@ GetJointMotorSpeed

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointorigin.html b/doc/doc_files/setjointorigin.html index e10355f..2cf4104 100644 --- a/doc/doc_files/setjointorigin.html +++ b/doc/doc_files/setjointorigin.html @@ -3,11 +3,11 @@ - setJointOrigin [RCBasic Doc] + SetJointOrigin [RCBasic Doc] -

    sub setJointOrigin( joint_id, x, y)

    +

    Sub SetJointOrigin( joint_id, x, y)

    Shift the world origin. This is particularly useful in large simulations where objects might move far from the initial origin, potentially causing precision issues in floating-point calculations.

    @@ -15,6 +15,7 @@ Used with Pulley Joint

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointratio.html b/doc/doc_files/setjointratio.html index 7f3805e..2b3782b 100644 --- a/doc/doc_files/setjointratio.html +++ b/doc/doc_files/setjointratio.html @@ -3,11 +3,11 @@ - setJointRatio [RCBasic Doc] + SetJointRatio [RCBasic Doc] -

    sub setJointRatio( joint_id, j_ratio)

    +

    Sub SetJointRatio( joint_id, j_ratio)

    Determines how much one joint’s movement affects the other, enabling complex, synchronized motion.

    @@ -18,6 +18,7 @@ GetJointRatio

    +

    \ No newline at end of file diff --git a/doc/doc_files/setjointstiffness.html b/doc/doc_files/setjointstiffness.html index 8d0aa77..623bbd0 100644 --- a/doc/doc_files/setjointstiffness.html +++ b/doc/doc_files/setjointstiffness.html @@ -3,11 +3,11 @@ - setJointStiffness [RCBasic Doc] + SetJointStiffness [RCBasic Doc] -

    sub setJointStiffness( joint_id, stiffness)

    +

    Sub SetJointStiffness( joint_id, stiffness)

    Sets how rigid a joint is

    @@ -29,6 +29,7 @@ GetJointStiffness

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightambientcolor.html b/doc/doc_files/setlightambientcolor.html index cc6293a..e256d06 100644 --- a/doc/doc_files/setlightambientcolor.html +++ b/doc/doc_files/setlightambientcolor.html @@ -7,11 +7,12 @@ -

    sub SetLightAmbientColor( actor, color )

    +

    Sub SetLightAmbientColor( actor, color )

    Sets the ambient color for a light

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightattenuation.html b/doc/doc_files/setlightattenuation.html index 4982366..23fecce 100644 --- a/doc/doc_files/setlightattenuation.html +++ b/doc/doc_files/setlightattenuation.html @@ -7,11 +7,12 @@ -

    sub SetLightAttenuation( actor, l_constant, l_linear, l_quadratic )

    +

    Sub SetLightAttenuation( actor, l_constant, l_linear, l_quadratic )

    Sets the light strength fading over distance. Overrident by setting radius.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightdiffusecolor.html b/doc/doc_files/setlightdiffusecolor.html index b412acf..6063c57 100644 --- a/doc/doc_files/setlightdiffusecolor.html +++ b/doc/doc_files/setlightdiffusecolor.html @@ -7,11 +7,12 @@ -

    sub SetLightDiffuseColor( actor, color )

    +

    Sub SetLightDiffuseColor( actor, color )

    Sets a light's diffuse color

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightfalloff.html b/doc/doc_files/setlightfalloff.html index deb7f5e..e531f13 100644 --- a/doc/doc_files/setlightfalloff.html +++ b/doc/doc_files/setlightfalloff.html @@ -7,7 +7,7 @@ -

    sub SetLightFalloff( actor, falloff )

    +

    Sub SetLightFalloff( actor, falloff )

    Sets the strength decrease between the inner and outer cone of a light

    @@ -15,6 +15,7 @@ Note: Only applies to spot lights

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightinnercone.html b/doc/doc_files/setlightinnercone.html index 5a79e57..a958cb5 100644 --- a/doc/doc_files/setlightinnercone.html +++ b/doc/doc_files/setlightinnercone.html @@ -7,11 +7,12 @@ -

    sub SetLightInnerCone( actor, angle )

    +

    Sub SetLightInnerCone( actor, angle )

    Sets the inner cone of a spot light

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightoutercone.html b/doc/doc_files/setlightoutercone.html index a4bc1fc..55d0ce6 100644 --- a/doc/doc_files/setlightoutercone.html +++ b/doc/doc_files/setlightoutercone.html @@ -7,11 +7,12 @@ -

    sub SetLightOuterCone( actor, angle)

    +

    Sub SetLightOuterCone( actor, angle)

    Sets the outer cone of a spot light

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightradius.html b/doc/doc_files/setlightradius.html index fdb58a2..df6e6d3 100644 --- a/doc/doc_files/setlightradius.html +++ b/doc/doc_files/setlightradius.html @@ -7,7 +7,7 @@ -

    sub SetLightRadius( actor, radius )

    +

    Sub SetLightRadius( actor, radius )

    Sets the radius of a light

    @@ -15,6 +15,7 @@ GetLightRadius

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightshadowcast.html b/doc/doc_files/setlightshadowcast.html index e90f2de..8261ee5 100644 --- a/doc/doc_files/setlightshadowcast.html +++ b/doc/doc_files/setlightshadowcast.html @@ -3,11 +3,11 @@ - setLightShadowCast [RCBasic Doc] + SetLightShadowCast [RCBasic Doc] -

    sub setLightShadowCast( actor, flag )

    +

    Sub SetLightShadowCast( actor, flag )

    Sets whether a light will cast shadows on actors that have shadows enabled

    @@ -15,6 +15,7 @@ AddActorShadow

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlightspecularcolor.html b/doc/doc_files/setlightspecularcolor.html index 9fd9afe..02b5ec5 100644 --- a/doc/doc_files/setlightspecularcolor.html +++ b/doc/doc_files/setlightspecularcolor.html @@ -7,11 +7,12 @@ -

    sub SetLightSpecularColor( actor, color )

    +

    Sub SetLightSpecularColor( actor, color )

    Sets the specular color of a light

    +

    \ No newline at end of file diff --git a/doc/doc_files/setlighttype.html b/doc/doc_files/setlighttype.html index 234c955..0e2b11e 100644 --- a/doc/doc_files/setlighttype.html +++ b/doc/doc_files/setlighttype.html @@ -3,11 +3,11 @@ - setLightType [RCBasic Doc] + SetLightType [RCBasic Doc] -

    sub setLightType( actor, light_type )

    +

    Sub SetLightType( actor, light_type )

    Sets the type of light

    @@ -29,6 +29,7 @@ SetLightType

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialambientcolor.html b/doc/doc_files/setmaterialambientcolor.html index 46f78ef..3b1fcc4 100644 --- a/doc/doc_files/setmaterialambientcolor.html +++ b/doc/doc_files/setmaterialambientcolor.html @@ -3,15 +3,16 @@ - setMaterialAmbientColor [RCBasic Doc] + SetMaterialAmbientColor [RCBasic Doc] -

    sub setMaterialAmbientColor( material_id, color)

    +

    Sub SetMaterialAmbientColor( material_id, color)

    Sets the ambient color of a material

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialantialiasing.html b/doc/doc_files/setmaterialantialiasing.html index c0dd5e8..d9ae0de 100644 --- a/doc/doc_files/setmaterialantialiasing.html +++ b/doc/doc_files/setmaterialantialiasing.html @@ -3,11 +3,11 @@ - setMaterialAntiAliasing [RCBasic Doc] + SetMaterialAntiAliasing [RCBasic Doc] -

    sub setMaterialAntiAliasing( material_id, aa)

    +

    Sub SetMaterialAntiAliasing( material_id, aa)

    Sets the anti-aliasing mode for the material

    @@ -41,6 +41,7 @@ GetMaterialAntiAliasing

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialbackfaceculling.html b/doc/doc_files/setmaterialbackfaceculling.html index a5cc25e..d3e82d9 100644 --- a/doc/doc_files/setmaterialbackfaceculling.html +++ b/doc/doc_files/setmaterialbackfaceculling.html @@ -3,11 +3,11 @@ - setMaterialBackfaceCulling [RCBasic Doc] + SetMaterialBackfaceCulling [RCBasic Doc] -

    sub setMaterialBackfaceCulling( material_id, flag)

    +

    Sub SetMaterialBackfaceCulling( material_id, flag)

    Enables or disables material backface culling

    @@ -15,6 +15,7 @@ GetMaterialBackfaceCulling

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialblendfactor.html b/doc/doc_files/setmaterialblendfactor.html index b30bdc4..7fe31a0 100644 --- a/doc/doc_files/setmaterialblendfactor.html +++ b/doc/doc_files/setmaterialblendfactor.html @@ -3,15 +3,16 @@ - setMaterialBlendFactor [RCBasic Doc] + SetMaterialBlendFactor [RCBasic Doc] -

    sub setMaterialBlendFactor( material_id, bf)

    +

    Sub SetMaterialBlendFactor( material_id, bf)

    Sets the blend factor for a material

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialblendmode.html b/doc/doc_files/setmaterialblendmode.html index 0c46af5..6b47031 100644 --- a/doc/doc_files/setmaterialblendmode.html +++ b/doc/doc_files/setmaterialblendmode.html @@ -3,11 +3,11 @@ - setMaterialBlendMode [RCBasic Doc] + SetMaterialBlendMode [RCBasic Doc] -

    sub setMaterialBlendMode( material_id, blend_mode)

    +

    Sub SetMaterialBlendMode( material_id, blend_mode)

    Sets a material's blend mode

    @@ -50,6 +50,7 @@ SetMaterialBlendMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialcolormask.html b/doc/doc_files/setmaterialcolormask.html index 240a9ca..8fd6f15 100644 --- a/doc/doc_files/setmaterialcolormask.html +++ b/doc/doc_files/setmaterialcolormask.html @@ -3,11 +3,11 @@ - setMaterialColorMask [RCBasic Doc] + SetMaterialColorMask [RCBasic Doc] -

    sub setMaterialColorMask( material_id, color_mask)

    +

    Sub SetMaterialColorMask( material_id, color_mask)

    Sets a color mask for a material

    @@ -15,6 +15,7 @@ GetMaterialColorMask

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialcolormode.html b/doc/doc_files/setmaterialcolormode.html index fb42bb5..45f53d3 100644 --- a/doc/doc_files/setmaterialcolormode.html +++ b/doc/doc_files/setmaterialcolormode.html @@ -3,11 +3,11 @@ - setMaterialColorMode [RCBasic Doc] + SetMaterialColorMode [RCBasic Doc] -

    sub setMaterialColorMode( material_id, color_mode)

    +

    Sub SetMaterialColorMode( material_id, color_mode)

    Sets the color mode of a material

    @@ -38,6 +38,7 @@ GetMaterialColorMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialconstant.html b/doc/doc_files/setmaterialconstant.html index d2a0cf0..05de077 100644 --- a/doc/doc_files/setmaterialconstant.html +++ b/doc/doc_files/setmaterialconstant.html @@ -195,6 +195,7 @@ GetMaterialConstant

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialdiffusecolor.html b/doc/doc_files/setmaterialdiffusecolor.html index 45eb2d9..165c319 100644 --- a/doc/doc_files/setmaterialdiffusecolor.html +++ b/doc/doc_files/setmaterialdiffusecolor.html @@ -3,15 +3,16 @@ - setMaterialDiffuseColor [RCBasic Doc] + SetMaterialDiffuseColor [RCBasic Doc] -

    sub setMaterialDiffuseColor( material_id, color)

    +

    Sub SetMaterialDiffuseColor( material_id, color)

    Set's a material's diffuse color

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialemissivecolor.html b/doc/doc_files/setmaterialemissivecolor.html index df51ebf..ba95d0e 100644 --- a/doc/doc_files/setmaterialemissivecolor.html +++ b/doc/doc_files/setmaterialemissivecolor.html @@ -3,15 +3,16 @@ - setMaterialEmissiveColor [RCBasic Doc] + SetMaterialEmissiveColor [RCBasic Doc] -

    sub setMaterialEmissiveColor( material_id, color)

    +

    Sub SetMaterialEmissiveColor( material_id, color)

    Set's a material's emissive color

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialflag.html b/doc/doc_files/setmaterialflag.html index 728f4fb..c3d0aeb 100644 --- a/doc/doc_files/setmaterialflag.html +++ b/doc/doc_files/setmaterialflag.html @@ -3,11 +3,11 @@ - setMaterialFlag [RCBasic Doc] + SetMaterialFlag [RCBasic Doc] -

    sub setMaterialFlag( material_id, material_flag, f_value)

    +

    Sub SetMaterialFlag( material_id, material_flag, f_value)

    Sets the value of the specified material flag

    @@ -81,6 +81,7 @@ GetActorMaterialFlag

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialfog.html b/doc/doc_files/setmaterialfog.html index b15ec5d..0a9f30c 100644 --- a/doc/doc_files/setmaterialfog.html +++ b/doc/doc_files/setmaterialfog.html @@ -3,15 +3,16 @@ - setMaterialFog [RCBasic Doc] + SetMaterialFog [RCBasic Doc] -

    sub setMaterialFog( material_id, flag)

    +

    Sub SetMaterialFog( material_id, flag)

    Enables or disables fog

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialfrontfaceculling.html b/doc/doc_files/setmaterialfrontfaceculling.html index 75e2008..6a6b541 100644 --- a/doc/doc_files/setmaterialfrontfaceculling.html +++ b/doc/doc_files/setmaterialfrontfaceculling.html @@ -3,15 +3,16 @@ - setMaterialFrontfaceCulling [RCBasic Doc] + SetMaterialFrontfaceCulling [RCBasic Doc] -

    sub setMaterialFrontFaceCulling( material_id, flag)

    +

    Sub SetMaterialFrontFaceCulling( material_id, flag)

    Enables or disables front face culling

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialgouraudshading.html b/doc/doc_files/setmaterialgouraudshading.html index a1493f2..cdf4271 100644 --- a/doc/doc_files/setmaterialgouraudshading.html +++ b/doc/doc_files/setmaterialgouraudshading.html @@ -3,11 +3,11 @@ - setMaterialGouraudShading [RCBasic Doc] + SetMaterialGouraudShading [RCBasic Doc] -

    sub setMaterialGouraudShading( material_id, flag)

    +

    Sub SetMaterialGouraudShading( material_id, flag)

    Sets whether material will use gourad shading or flat shading

    @@ -15,6 +15,7 @@ True for goraud, False for flat

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmateriallighting.html b/doc/doc_files/setmateriallighting.html index 727e318..99b6d1e 100644 --- a/doc/doc_files/setmateriallighting.html +++ b/doc/doc_files/setmateriallighting.html @@ -3,15 +3,16 @@ - setMaterialLighting [RCBasic Doc] + SetMaterialLighting [RCBasic Doc] -

    sub setMaterialLighting( material_id, flag)

    +

    Sub SetMaterialLighting( material_id, flag)

    Sets whether material will be lighted or not

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialnormalize.html b/doc/doc_files/setmaterialnormalize.html index 64a1396..b4a8f41 100644 --- a/doc/doc_files/setmaterialnormalize.html +++ b/doc/doc_files/setmaterialnormalize.html @@ -3,15 +3,16 @@ - setMaterialNormalize [RCBasic Doc] + SetMaterialNormalize [RCBasic Doc] -

    sub setMaterialNormalize( material_id, flag)

    +

    Sub SetMaterialNormalize( material_id, flag)

    Sets whether normals should be normalized

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialpointcloud.html b/doc/doc_files/setmaterialpointcloud.html index b39615a..c3f5941 100644 --- a/doc/doc_files/setmaterialpointcloud.html +++ b/doc/doc_files/setmaterialpointcloud.html @@ -3,15 +3,16 @@ - setMaterialPointCloud [RCBasic Doc] + SetMaterialPointCloud [RCBasic Doc] -

    sub setMaterialPointCloud( material_id, flag)

    +

    Sub SetMaterialPointCloud( material_id, flag)

    Sets whether material is drawn as a point cloud or filled triangles

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialshininess.html b/doc/doc_files/setmaterialshininess.html index 10b96ab..ff9429f 100644 --- a/doc/doc_files/setmaterialshininess.html +++ b/doc/doc_files/setmaterialshininess.html @@ -3,11 +3,11 @@ - setMaterialShininess [RCBasic Doc] + SetMaterialShininess [RCBasic Doc] -

    sub setMaterialShininess( material_id, shininess)

    +

    Sub SetMaterialShininess( material_id, shininess)

    Sets the size of specular highlights

    @@ -15,6 +15,7 @@ Values range from 0 to 128

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialspecularcolor.html b/doc/doc_files/setmaterialspecularcolor.html index 3a85dbe..4e4368f 100644 --- a/doc/doc_files/setmaterialspecularcolor.html +++ b/doc/doc_files/setmaterialspecularcolor.html @@ -3,15 +3,16 @@ - setMaterialSpecularColor [RCBasic Doc] + SetMaterialSpecularColor [RCBasic Doc] -

    sub setMaterialSpecularColor( material_id, color)

    +

    Sub SetMaterialSpecularColor( material_id, color)

    Sets the specular color of a material

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialtexture.html b/doc/doc_files/setmaterialtexture.html index 428687e..f613d1b 100644 --- a/doc/doc_files/setmaterialtexture.html +++ b/doc/doc_files/setmaterialtexture.html @@ -3,11 +3,11 @@ - setMaterialTexture [RCBasic Doc] + SetMaterialTexture [RCBasic Doc] -

    sub setMaterialTexture( material_id, level, img_id)

    +

    Sub SetMaterialTexture( material_id, level, img_id)

    Sets the texture on a specified texture level of a material

    @@ -15,6 +15,7 @@ Note: Generally you want to just set level 0

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialtexturecanvas.html b/doc/doc_files/setmaterialtexturecanvas.html index 3ba3dc7..d2195bd 100644 --- a/doc/doc_files/setmaterialtexturecanvas.html +++ b/doc/doc_files/setmaterialtexturecanvas.html @@ -3,15 +3,16 @@ - setMaterialTextureCanvas [RCBasic Doc] + SetMaterialTextureCanvas [RCBasic Doc] -

    sub setMaterialTextureCanvas( material_id, level, canvas_id)

    +

    Sub SetMaterialTextureCanvas( material_id, level, canvas_id)

    Sets a material's texture source as a canvas.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialthickness.html b/doc/doc_files/setmaterialthickness.html index c1f3700..91ffe5a 100644 --- a/doc/doc_files/setmaterialthickness.html +++ b/doc/doc_files/setmaterialthickness.html @@ -3,15 +3,16 @@ - setMaterialThickness [RCBasic Doc] + SetMaterialThickness [RCBasic Doc] -

    sub setMaterialThickness( material_id, thickness)

    +

    Sub SetMaterialThickness( material_id, thickness)

    Sets the thickness of non 3d elements

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialtype.html b/doc/doc_files/setmaterialtype.html index 9fe2b62..e1e9a66 100644 --- a/doc/doc_files/setmaterialtype.html +++ b/doc/doc_files/setmaterialtype.html @@ -7,7 +7,7 @@ -

    sub SetMaterialType( material_id, mat_type)

    +

    Sub SetMaterialType( material_id, mat_type)

    Sets the material type

    @@ -128,6 +128,7 @@ GetMaterialType

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaterialwireframe.html b/doc/doc_files/setmaterialwireframe.html index cdfb95c..368e0b2 100644 --- a/doc/doc_files/setmaterialwireframe.html +++ b/doc/doc_files/setmaterialwireframe.html @@ -3,15 +3,16 @@ - setMaterialWireframe [RCBasic Doc] + SetMaterialWireframe [RCBasic Doc] -

    sub setMaterialWireframe( material_id, flag)

    +

    Sub SetMaterialWireframe( material_id, flag)

    Sets whether a material is draw as unfilled triangles or filled triangles

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmatrixrotation.html b/doc/doc_files/setmatrixrotation.html index b60280f..6e356ec 100644 --- a/doc/doc_files/setmatrixrotation.html +++ b/doc/doc_files/setmatrixrotation.html @@ -7,11 +7,12 @@ -

    sub SetMatrixRotation( mA, x, y, z )

    +

    Sub SetMatrixRotation( mA, x, y, z )

    Sets the rotation vector of a matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmatrixscale.html b/doc/doc_files/setmatrixscale.html index 1d596aa..34d0cb9 100644 --- a/doc/doc_files/setmatrixscale.html +++ b/doc/doc_files/setmatrixscale.html @@ -7,11 +7,12 @@ -

    sub SetMatrixScale( mA, x, y, z )

    +

    Sub SetMatrixScale( mA, x, y, z )

    Sets the scale vector of a matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmatrixtranslation.html b/doc/doc_files/setmatrixtranslation.html index addc06f..d39db12 100644 --- a/doc/doc_files/setmatrixtranslation.html +++ b/doc/doc_files/setmatrixtranslation.html @@ -7,11 +7,12 @@ -

    sub SetMatrixTranslation( mA, x, y, z )

    +

    Sub SetMatrixTranslation( mA, x, y, z )

    Sets the translation vector of a matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmatrixvalue.html b/doc/doc_files/setmatrixvalue.html index fb53102..7a8a059 100644 --- a/doc/doc_files/setmatrixvalue.html +++ b/doc/doc_files/setmatrixvalue.html @@ -7,11 +7,12 @@ -

    sub SetMatrixValue(mA, r, c, v)

    +

    Sub SetMatrixValue(mA, r, c, v)

    Sets the value of a cell in a matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmaxparticlespersecond.html b/doc/doc_files/setmaxparticlespersecond.html index 395147f..06d1fd7 100644 --- a/doc/doc_files/setmaxparticlespersecond.html +++ b/doc/doc_files/setmaxparticlespersecond.html @@ -3,11 +3,11 @@ - setMaxParticlesPerSecond [RCBasic Doc] + SetMaxParticlesPerSecond [RCBasic Doc] -

    sub setMaxParticlesPerSecond( actor, maxParticlesPerSecond)

    +

    Sub SetMaxParticlesPerSecond( actor, maxParticlesPerSecond)

    Sets the max number of particles emitted per second

    @@ -17,6 +17,7 @@ SetMinParticlesPerSecond

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmeshboundingbox.html b/doc/doc_files/setmeshboundingbox.html index b784e8b..7a673af 100644 --- a/doc/doc_files/setmeshboundingbox.html +++ b/doc/doc_files/setmeshboundingbox.html @@ -19,6 +19,7 @@ ReCalculateMeshBoundingBox

    +

    \ No newline at end of file diff --git a/doc/doc_files/setminparticlespersecond.html b/doc/doc_files/setminparticlespersecond.html index d5a8b1d..649aab4 100644 --- a/doc/doc_files/setminparticlespersecond.html +++ b/doc/doc_files/setminparticlespersecond.html @@ -3,11 +3,11 @@ - setMinParticlesPerSecond [RCBasic Doc] + SetMinParticlesPerSecond [RCBasic Doc] -

    sub setMinParticlesPerSecond( actor, minParticlesPerSecond)

    +

    Sub SetMinParticlesPerSecond( actor, minParticlesPerSecond)

    Sets the max number of particles emitted per second

    @@ -17,6 +17,7 @@ SetMaxParticlesPerSecond

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmouserelative.html b/doc/doc_files/setmouserelative.html index f85d444..f04ba2a 100644 --- a/doc/doc_files/setmouserelative.html +++ b/doc/doc_files/setmouserelative.html @@ -7,11 +7,12 @@ -

    sub SetMouseRelative(flag)

    +

    Sub SetMouseRelative(flag)

    Constrains the mouse to the window

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmousezone.html b/doc/doc_files/setmousezone.html index 784a62e..15cf180 100644 --- a/doc/doc_files/setmousezone.html +++ b/doc/doc_files/setmousezone.html @@ -7,11 +7,12 @@ -

    sub SetMouseZone(x, y, w, h)

    +

    Sub SetMouseZone(x, y, w, h)

    Constrains the mouse to a specified area of the window

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmusicposition.html b/doc/doc_files/setmusicposition.html index 5770617..a2ad84c 100644 --- a/doc/doc_files/setmusicposition.html +++ b/doc/doc_files/setmusicposition.html @@ -7,11 +7,12 @@ -

    sub SetMusicPosition(pos)

    +

    Sub SetMusicPosition(pos)

    Sets the position of the loaded music track

    +

    \ No newline at end of file diff --git a/doc/doc_files/setmusicvolume.html b/doc/doc_files/setmusicvolume.html index e9bc35d..6fff5ca 100644 --- a/doc/doc_files/setmusicvolume.html +++ b/doc/doc_files/setmusicvolume.html @@ -7,11 +7,12 @@ -

    sub SetMusicVolume(vol)

    +

    Sub SetMusicVolume(vol)

    Sets the volume of the loaded music track

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlebox.html b/doc/doc_files/setparticlebox.html index aeb4177..5450bf7 100644 --- a/doc/doc_files/setparticlebox.html +++ b/doc/doc_files/setparticlebox.html @@ -3,15 +3,16 @@ - setParticleBox [RCBasic Doc] + SetParticleBox [RCBasic Doc] -

    sub setParticleBox( actor, min_x, min_y, min_z, max_x, max_y, max_z)

    +

    Sub SetParticleBox( actor, min_x, min_y, min_z, max_x, max_y, max_z)

    Sets the bounding box for a particle emitter

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlecenter.html b/doc/doc_files/setparticlecenter.html index c7cde86..c97a91a 100644 --- a/doc/doc_files/setparticlecenter.html +++ b/doc/doc_files/setparticlecenter.html @@ -3,11 +3,11 @@ - setParticleCenter [RCBasic Doc] + SetParticleCenter [RCBasic Doc] -

    sub setParticleCenter( actor, x, y, z)

    +

    Sub SetParticleCenter( actor, x, y, z)

    Sets the center of a particle emitter

    @@ -18,6 +18,7 @@ GetParticleCenter

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticledirection.html b/doc/doc_files/setparticledirection.html index c4385f6..d973c8e 100644 --- a/doc/doc_files/setparticledirection.html +++ b/doc/doc_files/setparticledirection.html @@ -3,11 +3,11 @@ - setParticleDirection [RCBasic Doc] + SetParticleDirection [RCBasic Doc] -

    sub setParticleDirection( actor, x, y, z)

    +

    Sub SetParticleDirection( actor, x, y, z)

    Sets the direction of a particle emitter

    @@ -15,6 +15,7 @@ GetParticleDirection

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlelength.html b/doc/doc_files/setparticlelength.html index f7623d2..68a70c6 100644 --- a/doc/doc_files/setparticlelength.html +++ b/doc/doc_files/setparticlelength.html @@ -3,11 +3,11 @@ - setParticleLength [RCBasic Doc] + SetParticleLength [RCBasic Doc] -

    sub setParticleLength( actor, p_len)

    +

    Sub SetParticleLength( actor, p_len)

    Sets the length of a cylinder particle emitter

    @@ -18,6 +18,7 @@ GetParticleLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxangle.html b/doc/doc_files/setparticlemaxangle.html index 95f204d..d304354 100644 --- a/doc/doc_files/setparticlemaxangle.html +++ b/doc/doc_files/setparticlemaxangle.html @@ -3,11 +3,11 @@ - setParticleMaxAngle [RCBasic Doc] + SetParticleMaxAngle [RCBasic Doc] -

    sub setParticleMaxAngle( actor, maxAngle)

    +

    Sub SetParticleMaxAngle( actor, maxAngle)

    Sets the max angle of particle emission

    @@ -15,6 +15,7 @@ GetParticleMaxAngle

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxlife.html b/doc/doc_files/setparticlemaxlife.html index d636ab5..2c91391 100644 --- a/doc/doc_files/setparticlemaxlife.html +++ b/doc/doc_files/setparticlemaxlife.html @@ -3,11 +3,11 @@ - setParticleMaxLife [RCBasic Doc] + SetParticleMaxLife [RCBasic Doc] -

    sub setParticleMaxLife( actor, maxLife)

    +

    Sub SetParticleMaxLife( actor, maxLife)

    Sets the max life of the particle emission

    @@ -18,6 +18,7 @@ GetParticleMaxLife

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxstartcolor.html b/doc/doc_files/setparticlemaxstartcolor.html index cc22d19..6d5aedf 100644 --- a/doc/doc_files/setparticlemaxstartcolor.html +++ b/doc/doc_files/setparticlemaxstartcolor.html @@ -3,11 +3,11 @@ - setParticleMaxStartColor [RCBasic Doc] + SetParticleMaxStartColor [RCBasic Doc] -

    sub setParticleMaxStartColor( actor, color)

    +

    Sub SetParticleMaxStartColor( actor, color)

    Sets max starting color for particles

    @@ -15,6 +15,7 @@ SetParticleMaxStartColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxstartsize.html b/doc/doc_files/setparticlemaxstartsize.html index 333289d..e0819f5 100644 --- a/doc/doc_files/setparticlemaxstartsize.html +++ b/doc/doc_files/setparticlemaxstartsize.html @@ -3,11 +3,11 @@ - setParticleMaxStartSize [RCBasic Doc] + SetParticleMaxStartSize [RCBasic Doc] -

    sub setParticleMaxStartSize( actor, w, h)

    +

    Sub SetParticleMaxStartSize( actor, w, h)

    Sets the max start size for the particles

    @@ -15,6 +15,7 @@ SetParticleMaxStartSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlemesh.html b/doc/doc_files/setparticlemesh.html index b5d20bf..df0b73d 100644 --- a/doc/doc_files/setparticlemesh.html +++ b/doc/doc_files/setparticlemesh.html @@ -3,11 +3,11 @@ - setParticleMesh [RCBasic Doc] + SetParticleMesh [RCBasic Doc] -

    sub setParticleMesh( actor, mesh)

    +

    Sub SetParticleMesh( actor, mesh)

    Sets the mesh for a mesh particle emitter

    @@ -15,6 +15,7 @@ Note: Only applies to mesh emitter

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticleminlife.html b/doc/doc_files/setparticleminlife.html index fca52ad..24d36be 100644 --- a/doc/doc_files/setparticleminlife.html +++ b/doc/doc_files/setparticleminlife.html @@ -3,11 +3,11 @@ - setParticleMinLife [RCBasic Doc] + SetParticleMinLife [RCBasic Doc] -

    sub setParticleMinLife( actor, minLife)

    +

    Sub SetParticleMinLife( actor, minLife)

    Set the min life of particles

    @@ -18,6 +18,7 @@ SetParticleMinLife

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticleminstartcolor.html b/doc/doc_files/setparticleminstartcolor.html index 75d3b1b..cd2b4f9 100644 --- a/doc/doc_files/setparticleminstartcolor.html +++ b/doc/doc_files/setparticleminstartcolor.html @@ -3,11 +3,11 @@ - setParticleMinStartColor [RCBasic Doc] + SetParticleMinStartColor [RCBasic Doc] -

    sub setParticleMinStartColor( actor, color)

    +

    Sub SetParticleMinStartColor( actor, color)

    Sets the min start color for particles

    @@ -15,6 +15,7 @@ GetParticleMinStartColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticleminstartsize.html b/doc/doc_files/setparticleminstartsize.html index 0d11976..999a709 100644 --- a/doc/doc_files/setparticleminstartsize.html +++ b/doc/doc_files/setparticleminstartsize.html @@ -3,11 +3,11 @@ - setParticleMinStartSize [RCBasic Doc] + SetParticleMinStartSize [RCBasic Doc] -

    sub setParticleMinStartSize( actor, w, h)

    +

    Sub SetParticleMinStartSize( actor, w, h)

    Sets the min start size for particle emitter

    @@ -15,6 +15,7 @@ GetParticleMinStartSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlenormal.html b/doc/doc_files/setparticlenormal.html index 02298b6..1826624 100644 --- a/doc/doc_files/setparticlenormal.html +++ b/doc/doc_files/setparticlenormal.html @@ -3,11 +3,11 @@ - setParticleNormal [RCBasic Doc] + SetParticleNormal [RCBasic Doc] -

    sub setParticleNormal( actor, x, y, z)

    +

    Sub SetParticleNormal( actor, x, y, z)

    Sets the normal of a particle emitter

    @@ -18,6 +18,7 @@ GetParticleNormal

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticlenormaldirectionmod.html b/doc/doc_files/setparticlenormaldirectionmod.html index f685ae2..d93bb39 100644 --- a/doc/doc_files/setparticlenormaldirectionmod.html +++ b/doc/doc_files/setparticlenormaldirectionmod.html @@ -3,11 +3,11 @@ - setParticleNormalDirectionMod [RCBasic Doc] + SetParticleNormalDirectionMod [RCBasic Doc] -

    sub setParticleNormalDirectionMod( actor, nd_mod)

    +

    Sub SetParticleNormalDirectionMod( actor, nd_mod)

    Sets the normal direction modifier for a particle emitter

    @@ -18,6 +18,7 @@ GetParticleNormalDirectionMod

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticleradius.html b/doc/doc_files/setparticleradius.html index 389b3de..4301ebe 100644 --- a/doc/doc_files/setparticleradius.html +++ b/doc/doc_files/setparticleradius.html @@ -3,11 +3,11 @@ - setParticleRadius [RCBasic Doc] + SetParticleRadius [RCBasic Doc] -

    sub setParticleRadius( actor, radius)

    +

    Sub SetParticleRadius( actor, radius)

    Sets the radius of a particle emitter

    @@ -18,6 +18,7 @@ SetParticleRadius

    +

    \ No newline at end of file diff --git a/doc/doc_files/setparticleringthickness.html b/doc/doc_files/setparticleringthickness.html index d65bb93..d006dcd 100644 --- a/doc/doc_files/setparticleringthickness.html +++ b/doc/doc_files/setparticleringthickness.html @@ -3,11 +3,11 @@ - setParticleRingThickness [RCBasic Doc] + SetParticleRingThickness [RCBasic Doc] -

    sub setParticleRingThickness( actor, ringThickness)

    +

    Sub SetParticleRingThickness( actor, ringThickness)

    Sets the thickness of a ring emitter

    @@ -18,6 +18,7 @@ GetParticleRingThickness

    +

    \ No newline at end of file diff --git a/doc/doc_files/setpointpivota.html b/doc/doc_files/setpointpivota.html index 6c1c183..3cc7c34 100644 --- a/doc/doc_files/setpointpivota.html +++ b/doc/doc_files/setpointpivota.html @@ -3,11 +3,11 @@ - setPointPivotA [RCBasic Doc] + SetPointPivotA [RCBasic Doc] -

    sub setPointPivotA( constraint_id, x, y, z)

    +

    Sub SetPointPivotA( constraint_id, x, y, z)

    Sets the pivot point on the first actor (Body A) of the constraint. This pivot point defines the specific location in the local space of Body A where the point-to-point constraint is anchored.

    @@ -16,6 +16,7 @@ SetPointPivotB

    +

    \ No newline at end of file diff --git a/doc/doc_files/setpointpivotb.html b/doc/doc_files/setpointpivotb.html index cb75d1d..1dcdbf5 100644 --- a/doc/doc_files/setpointpivotb.html +++ b/doc/doc_files/setpointpivotb.html @@ -3,11 +3,11 @@ - setPointPivotB [RCBasic Doc] + SetPointPivotB [RCBasic Doc] -

    sub setPointPivotB( constraint_id, x, y, z)

    +

    Sub SetPointPivotB( constraint_id, x, y, z)

    Sets the pivot point on the second actor (Body B) of the constraint. This pivot point defines the specific location in the local space of Body B where the point-to-point constraint is anchored.

    @@ -16,6 +16,7 @@ SetPointPivotB

    +

    \ No newline at end of file diff --git a/doc/doc_files/setprojectionmatrix.html b/doc/doc_files/setprojectionmatrix.html index 6eebabc..3277146 100644 --- a/doc/doc_files/setprojectionmatrix.html +++ b/doc/doc_files/setprojectionmatrix.html @@ -26,6 +26,7 @@ GetProjectionMatrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/setprojectorfov.html b/doc/doc_files/setprojectorfov.html index 81cf9f7..6dfbc2c 100644 --- a/doc/doc_files/setprojectorfov.html +++ b/doc/doc_files/setprojectorfov.html @@ -15,6 +15,7 @@ GetProjectorFOV

    +

    \ No newline at end of file diff --git a/doc/doc_files/setprojectortarget.html b/doc/doc_files/setprojectortarget.html index fd5f831..4f05ed4 100644 --- a/doc/doc_files/setprojectortarget.html +++ b/doc/doc_files/setprojectortarget.html @@ -12,6 +12,7 @@ Set the point a projector is pointed at

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsceneambientcolor.html b/doc/doc_files/setsceneambientcolor.html index 0898a6c..64d5ac1 100644 --- a/doc/doc_files/setsceneambientcolor.html +++ b/doc/doc_files/setsceneambientcolor.html @@ -15,6 +15,7 @@ GetSceneAmbientColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/setscenefog.html b/doc/doc_files/setscenefog.html index dc08ca1..f43c876 100644 --- a/doc/doc_files/setscenefog.html +++ b/doc/doc_files/setscenefog.html @@ -9,6 +9,7 @@

    Sub SetSceneFog (color, fog_type, start_val, end_val, density, pixelFog, rangeFog)

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsceneshadowcolor.html b/doc/doc_files/setsceneshadowcolor.html index 80b66d9..f08a364 100644 --- a/doc/doc_files/setsceneshadowcolor.html +++ b/doc/doc_files/setsceneshadowcolor.html @@ -15,6 +15,7 @@ GetSceneShadowColor

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidedampingdirang.html b/doc/doc_files/setslidedampingdirang.html index 4a6c3fa..7522e34 100644 --- a/doc/doc_files/setslidedampingdirang.html +++ b/doc/doc_files/setslidedampingdirang.html @@ -3,15 +3,16 @@ - setSlideDampingDirAng [RCBasic Doc] + SetSlideDampingDirAng [RCBasic Doc] -

    sub setSlideDampingDirAng( constraint_id, n)

    +

    Sub SetSlideDampingDirAng( constraint_id, n)

    Sets the angular directional damping value. This damping factor specifically affects angular motion in the direction of movement along the constraint's axes.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidedampingdirlin.html b/doc/doc_files/setslidedampingdirlin.html index 069b735..3b5bbb4 100644 --- a/doc/doc_files/setslidedampingdirlin.html +++ b/doc/doc_files/setslidedampingdirlin.html @@ -3,15 +3,16 @@ - setSlideDampingDirLin [RCBasic Doc] + SetSlideDampingDirLin [RCBasic Doc] -

    sub setSlideDampingDirLin( constraint_id, n)

    +

    Sub SetSlideDampingDirLin( constraint_id, n)

    Sets the linear directional damping value for a constraint. This value applies to the linear (translational) motion of an object along the constraint's axis of movement.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidedampinglimang.html b/doc/doc_files/setslidedampinglimang.html index f52aa50..e4efa1b 100644 --- a/doc/doc_files/setslidedampinglimang.html +++ b/doc/doc_files/setslidedampinglimang.html @@ -3,11 +3,11 @@ - setSlideDampingLimAng [RCBasic Doc] + SetSlideDampingLimAng [RCBasic Doc] -

    sub setSlideDampingLimAng( constraint_id, n)

    +

    Sub SetSlideDampingLimAng( constraint_id, n)

    Sets the angular limit damping factor for a constraint. This damping applies specifically to the angular motion of an object when it reaches the limit of its allowed rotational range.

    @@ -15,6 +15,7 @@ GetSlideDampingLimAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidedampinglimlin.html b/doc/doc_files/setslidedampinglimlin.html index 28636a7..5393f17 100644 --- a/doc/doc_files/setslidedampinglimlin.html +++ b/doc/doc_files/setslidedampinglimlin.html @@ -3,11 +3,11 @@ - setSlideDampingLimLin [RCBasic Doc] + SetSlideDampingLimLin [RCBasic Doc] -

    sub setSlideDampingLimLin( constraint_id, n)

    +

    Sub SetSlideDampingLimLin( constraint_id, n)

    Sets the linear limit damping factor for a constraint. This damping applies specifically to the linear (translational) motion of an object when it reaches the limit of its allowed range of movement along a specific axis.

    @@ -15,6 +15,7 @@ GetSlideDampingLimLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidedampingorthoang.html b/doc/doc_files/setslidedampingorthoang.html index b0a69df..d07fd1f 100644 --- a/doc/doc_files/setslidedampingorthoang.html +++ b/doc/doc_files/setslidedampingorthoang.html @@ -3,11 +3,11 @@ - setSlideDampingOrthoAng [RCBasic Doc] + SetSlideDampingOrthoAng [RCBasic Doc] -

    sub setSlideDampingOrthoAng( constraint_id, n)

    +

    Sub SetSlideDampingOrthoAng( constraint_id, n)

    Sets the orthogonal angular damping factor applied to a constraint. This damping affects angular (rotational) motion that occurs perpendicular to the primary axis of movement defined by the constraint.

    @@ -15,6 +15,7 @@ GetSlideDampingOrthoAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidedampingortholin.html b/doc/doc_files/setslidedampingortholin.html index a65a902..6923722 100644 --- a/doc/doc_files/setslidedampingortholin.html +++ b/doc/doc_files/setslidedampingortholin.html @@ -3,11 +3,11 @@ - setSlideDampingOrthoLin [RCBasic Doc] + SetSlideDampingOrthoLin [RCBasic Doc] -

    sub setSlideDampingOrthoLin( constraint_id, n)

    +

    Sub SetSlideDampingOrthoLin( constraint_id, n)

    Sets the orthogonal linear damping factor for a constraint. This damping affects the linear (translational) motion of an object that occurs perpendicular to the primary direction of movement defined by the constraint.

    @@ -15,6 +15,7 @@ GetSlideDampingOrthoLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslideloweranglimit.html b/doc/doc_files/setslideloweranglimit.html index 279bd9d..faae7fb 100644 --- a/doc/doc_files/setslideloweranglimit.html +++ b/doc/doc_files/setslideloweranglimit.html @@ -7,7 +7,7 @@ -

    sub SetSlideLowerAngLimit( constraint_id, n)

    +

    Sub SetSlideLowerAngLimit( constraint_id, n)

    Sets the lower angular limit of the constraint. This value specifies the minimum angle allowed for the rotation of the connected actors around the axis perpendicular to the sliding direction defined by the slider constraint.

    @@ -18,6 +18,7 @@ GetSlideLowerAngLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidelowerlinlimit.html b/doc/doc_files/setslidelowerlinlimit.html index 2c53377..1eec8c3 100644 --- a/doc/doc_files/setslidelowerlinlimit.html +++ b/doc/doc_files/setslidelowerlinlimit.html @@ -3,11 +3,11 @@ - setSlideLowerLinLimit [RCBasic Doc] + SetSlideLowerLinLimit [RCBasic Doc] -

    sub setSlideLowerLinLimit( constraint_id, n)

    +

    Sub SetSlideLowerLinLimit( constraint_id, n)

    Sets the lower linear limit for the translational (sliding) motion along the slider's axis. This value specifies the minimum allowable position for the connected actors along the defined axis of the slider constraint.

    @@ -18,6 +18,7 @@ GetSlideLowerLinLimit

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutiondirang.html b/doc/doc_files/setsliderestitutiondirang.html index be7d1dd..e4d9a0a 100644 --- a/doc/doc_files/setsliderestitutiondirang.html +++ b/doc/doc_files/setsliderestitutiondirang.html @@ -3,11 +3,11 @@ - setSlideRestitutionDirAng [RCBasic Doc] + SetSlideRestitutionDirAng [RCBasic Doc] -

    sub setSlideRestitutionDirAng( constraint_id, n)

    +

    Sub SetSlideRestitutionDirAng( constraint_id, n)

    Sets the restitution value for angular motion. The restitution coefficient is a measure of how much energy is conserved in a collision or constraint interaction, specifically for angular movements.

    @@ -18,6 +18,7 @@ GetSlideRestitutionDirAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutiondirlin.html b/doc/doc_files/setsliderestitutiondirlin.html index 0af7708..4867c5c 100644 --- a/doc/doc_files/setsliderestitutiondirlin.html +++ b/doc/doc_files/setsliderestitutiondirlin.html @@ -3,11 +3,11 @@ - setSlideRestitutionDirLin [RCBasic Doc] + SetSlideRestitutionDirLin [RCBasic Doc] -

    sub setSlideRestitutionDirLin( constraint_id, n)

    +

    Sub SetSlideRestitutionDirLin( constraint_id, n)

    Sets the restitution value for linear motion. This value determines how much energy is conserved in a collision or interaction involving linear movements of the connected actors.

    @@ -18,6 +18,7 @@ SetSlideRestitutionDirLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionlimang.html b/doc/doc_files/setsliderestitutionlimang.html index 955b9a3..596d966 100644 --- a/doc/doc_files/setsliderestitutionlimang.html +++ b/doc/doc_files/setsliderestitutionlimang.html @@ -3,11 +3,11 @@ - setSlideRestitutionLimAng [RCBasic Doc] + SetSlideRestitutionLimAng [RCBasic Doc] -

    sub setSlideRestitutionLimAng( constraint_id, n)

    +

    Sub SetSlideRestitutionLimAng( constraint_id, n)

    Sets the restitution value for angular limit. This value determines how much energy is conserved when the angular motion of the connected actors reaches the angular limits of the slider constraint. Essentially, it controls how "bouncy" the rotation is when it hits the angular limit of the constraint.

    @@ -18,6 +18,7 @@ GetSlideRestitutionLimAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionlimlin.html b/doc/doc_files/setsliderestitutionlimlin.html index 4747276..f101563 100644 --- a/doc/doc_files/setsliderestitutionlimlin.html +++ b/doc/doc_files/setsliderestitutionlimlin.html @@ -3,11 +3,11 @@ - setSlideRestitutionLimLin [RCBasic Doc] + SetSlideRestitutionLimLin [RCBasic Doc] -

    sub setSlideRestitutionLimLin( constraint_id, n)

    +

    Sub SetSlideRestitutionLimLin( constraint_id, n)

    Sets the restitution value for the linear limit of the constraint. This value controls how much energy is conserved (or how "bouncy" the interaction is) when the connected actors reach the linear limits of the slider constraint, which restricts the movement along the sliding axis.

    @@ -18,6 +18,7 @@ GetSlideRestitutionLimLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionorthoang.html b/doc/doc_files/setsliderestitutionorthoang.html index 2e877cd..63d4465 100644 --- a/doc/doc_files/setsliderestitutionorthoang.html +++ b/doc/doc_files/setsliderestitutionorthoang.html @@ -3,11 +3,11 @@ - setSlideRestitutionOrthoAng [RCBasic Doc] + SetSlideRestitutionOrthoAng [RCBasic Doc] -

    sub setSlideRestitutionOrthoAng( constraint_id, n)

    +

    Sub SetSlideRestitutionOrthoAng( constraint_id, n)

    Sets the restitution value for orthogonal angular motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when rotational movement occurs in a direction orthogonal (perpendicular) to the slider's primary axis of movement.

    @@ -21,6 +21,7 @@ GetSlideRestitutionOrthoAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionortholin.html b/doc/doc_files/setsliderestitutionortholin.html index 8ee4b4c..54ae3dd 100644 --- a/doc/doc_files/setsliderestitutionortholin.html +++ b/doc/doc_files/setsliderestitutionortholin.html @@ -3,11 +3,11 @@ - setSlideRestitutionOrthoLin [RCBasic Doc] + SetSlideRestitutionOrthoLin [RCBasic Doc] -

    sub setSlideRestitutionOrthoLin( constraint_id, n)

    +

    Sub SetSlideRestitutionOrthoLin( constraint_id, n)

    Sets the restitution value for orthogonal linear motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when linear motion occurs in a direction orthogonal (perpendicular) to the primary sliding axis of the constraint.

    @@ -21,6 +21,7 @@ GetSlideRestitutionOrthoLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessdirang.html b/doc/doc_files/setslidesoftnessdirang.html index b2080b3..1f1b4d4 100644 --- a/doc/doc_files/setslidesoftnessdirang.html +++ b/doc/doc_files/setslidesoftnessdirang.html @@ -3,11 +3,11 @@ - setSlideSoftnessDirAng [RCBasic Doc] + SetSlideSoftnessDirAng [RCBasic Doc] -

    sub setSlideSoftnessDirAng( constraint_id, n)

    +

    Sub SetSlideSoftnessDirAng( constraint_id, n)

    Sets the softness parameter for the angular motion of the constraint. This parameter is used to define how "soft" or "rigid" the limits of angular motion are, particularly when the angular limits are reached.

    @@ -18,6 +18,7 @@ GetSlideSoftnessDirAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessdirlin.html b/doc/doc_files/setslidesoftnessdirlin.html index 910a7af..b24babf 100644 --- a/doc/doc_files/setslidesoftnessdirlin.html +++ b/doc/doc_files/setslidesoftnessdirlin.html @@ -3,11 +3,11 @@ - setConstraintSoftnessDirLin [RCBasic Doc] + SetConstraintSoftnessDirLin [RCBasic Doc] -

    sub setConstraintSoftnessDirLin( constraint_id, n)

    +

    Sub SetConstraintSoftnessDirLin( constraint_id, n)

    Sets the softness parameter for the linear motion of the constraint. This parameter influences how the constraint responds when the linear limits of movement are reached along the sliding axis, determining whether the response is soft and gradual or more rigid.

    @@ -18,6 +18,7 @@ GetSlideSoftnessDirLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnesslimang.html b/doc/doc_files/setslidesoftnesslimang.html index 7e873fa..1e37d1d 100644 --- a/doc/doc_files/setslidesoftnesslimang.html +++ b/doc/doc_files/setslidesoftnesslimang.html @@ -3,11 +3,11 @@ - setSlideSoftnessLimAng [RCBasic Doc] + SetSlideSoftnessLimAng [RCBasic Doc] -

    sub setSlideSoftnessLimAng( constraint_id, n)

    +

    Sub SetSlideSoftnessLimAng( constraint_id, n)

    Sets the softness parameter for the angular limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors reach their angular rotational limits around the slider's axis of rotation.

    @@ -18,6 +18,7 @@ GetSlideSoftnessLimAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnesslimlin.html b/doc/doc_files/setslidesoftnesslimlin.html index b6bbce0..33442d6 100644 --- a/doc/doc_files/setslidesoftnesslimlin.html +++ b/doc/doc_files/setslidesoftnesslimlin.html @@ -3,11 +3,11 @@ - setSlideSoftnessLimLin [RCBasic Doc] + SetSlideSoftnessLimLin [RCBasic Doc] -

    sub setSlideSoftnessLimLin( constraint_id, n)

    +

    Sub SetSlideSoftnessLimLin( constraint_id, n)

    Sets the softness parameter for the linear limits of the constraint. This parameter influences how "soft" or "rigid" the constraint behaves when the connected actors reach their linear (sliding) limits along the constraint's axis of motion.

    @@ -18,6 +18,7 @@ GetSlideSoftnessLimLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessorthoang.html b/doc/doc_files/setslidesoftnessorthoang.html index cad7674..81de191 100644 --- a/doc/doc_files/setslidesoftnessorthoang.html +++ b/doc/doc_files/setslidesoftnessorthoang.html @@ -3,11 +3,11 @@ - setSlideSoftnessOrthoAng [RCBasic Doc] + SetSlideSoftnessOrthoAng [RCBasic Doc] -

    sub setSlideSoftnessOrthoAng( constraint_id, n)

    +

    Sub SetSlideSoftnessOrthoAng( constraint_id, n)

    Sets the softness parameter for the orthogonal angular limits of the constraint. This parameter controls how "soft" or "rigid" the constraint behaves when angular rotation is limited along directions orthogonal (perpendicular) to the primary axis of motion.

    @@ -18,6 +18,7 @@ GetSlideSoftnessOrthoAng

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessortholin.html b/doc/doc_files/setslidesoftnessortholin.html index a48db4b..d708422 100644 --- a/doc/doc_files/setslidesoftnessortholin.html +++ b/doc/doc_files/setslidesoftnessortholin.html @@ -3,11 +3,11 @@ - setConstraintSoftnessOrthoLin [RCBasic Doc] + SetConstraintSoftnessOrthoLin [RCBasic Doc] -

    sub setSlideSoftnessOrthoLin( constraint_id, n)

    +

    Sub SetSlideSoftnessOrthoLin( constraint_id, n)

    Sets the softness parameter for the orthogonal linear limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors approach their linear movement limits in directions that are orthogonal (perpendicular) to the primary sliding axis.

    @@ -18,6 +18,7 @@ GetSlideSoftnessOrthoLin

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslideupperanglimit.html b/doc/doc_files/setslideupperanglimit.html index 927a49c..47f2b30 100644 --- a/doc/doc_files/setslideupperanglimit.html +++ b/doc/doc_files/setslideupperanglimit.html @@ -3,11 +3,11 @@ - setSlideUpperAngLimit [RCBasic Doc] + SetSlideUpperAngLimit [RCBasic Doc] -

    sub setSlideUpperAngLimit( constraint_id, n)

    +

    Sub SetSlideUpperAngLimit( constraint_id, n)

    Sets the upper limit of the angular movement allowed for the constraint. This function is crucial for determining how much rotational freedom is allowed around the axis of rotation defined by the slider constraint.

    @@ -15,6 +15,7 @@ The upper angular limit specifies the maximum allowed rotation around the rotational axis for the slider constraint. If the relative rotation between the two actors exceeds this angle, corrective forces are applied to maintain the constraint and prevent further rotation.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setslideupperlinlimit.html b/doc/doc_files/setslideupperlinlimit.html index 957fe31..fa138e3 100644 --- a/doc/doc_files/setslideupperlinlimit.html +++ b/doc/doc_files/setslideupperlinlimit.html @@ -3,11 +3,11 @@ - setSlideUpperLinLimit [RCBasic Doc] + SetSlideUpperLinLimit [RCBasic Doc] -

    sub setSlideUpperLinLimit( constraint_id, n)

    +

    Sub SetSlideUpperLinLimit( constraint_id, n)

    Sets the upper limit for linear movement along the constraint's axis. This is a crucial function for controlling how far the connected actors can slide along that axis before the constraint enforces limits.

    @@ -15,6 +15,7 @@ The upper linear limit specifies the maximum distance that the connected actors can move away from each other along the slider's axis. If the relative movement exceeds this limit, the constraint will apply corrective forces to stop further movement.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsoundchannels.html b/doc/doc_files/setsoundchannels.html index e1374e8..7386b17 100644 --- a/doc/doc_files/setsoundchannels.html +++ b/doc/doc_files/setsoundchannels.html @@ -7,11 +7,12 @@ -

    sub SetSoundChannels(max_channels)

    +

    Sub SetSoundChannels(max_channels)

    Sets the maximum number of sound channels.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setsoundvolume.html b/doc/doc_files/setsoundvolume.html index 07a5d38..33401a7 100644 --- a/doc/doc_files/setsoundvolume.html +++ b/doc/doc_files/setsoundvolume.html @@ -7,11 +7,12 @@ -

    sub SetSoundVolume(snd, vol)

    +

    Sub SetSoundVolume(snd, vol)

    Sets the volume of a sound

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritealpha.html b/doc/doc_files/setspritealpha.html index 9d3286e..ad04896 100644 --- a/doc/doc_files/setspritealpha.html +++ b/doc/doc_files/setspritealpha.html @@ -12,6 +12,7 @@ Sets the alpha value of a sprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteangulardamping.html b/doc/doc_files/setspriteangulardamping.html index f30c4ab..b1d3f38 100644 --- a/doc/doc_files/setspriteangulardamping.html +++ b/doc/doc_files/setspriteangulardamping.html @@ -3,11 +3,11 @@ - setSpriteAngularDamping [RCBasic Doc] + SetSpriteAngularDamping [RCBasic Doc] -

    sub setSpriteAngularDamping( spr_id, angularDamping)

    +

    Sub SetSpriteAngularDamping( spr_id, angularDamping)

    Sets a sprite's angular damping

    @@ -15,6 +15,7 @@ GetSpriteAngularDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteangularvelocity.html b/doc/doc_files/setspriteangularvelocity.html index ace9ee9..a7f8ecb 100644 --- a/doc/doc_files/setspriteangularvelocity.html +++ b/doc/doc_files/setspriteangularvelocity.html @@ -3,11 +3,11 @@ - setSpriteAngularVelocity [RCBasic Doc] + SetSpriteAngularVelocity [RCBasic Doc] -

    sub setSpriteAngularVelocity( spr_id, av)

    +

    Sub SetSpriteAngularVelocity( spr_id, av)

    Sets the angular velocity of a sprite

    @@ -15,6 +15,7 @@ GetSpriteAngularVelocity

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteanimation.html b/doc/doc_files/setspriteanimation.html index 1add696..ff07496 100644 --- a/doc/doc_files/setspriteanimation.html +++ b/doc/doc_files/setspriteanimation.html @@ -18,6 +18,7 @@ GetSpriteAnimation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteanimationframe.html b/doc/doc_files/setspriteanimationframe.html index 1975a65..422b9c3 100644 --- a/doc/doc_files/setspriteanimationframe.html +++ b/doc/doc_files/setspriteanimationframe.html @@ -15,6 +15,7 @@ GetSpriteAnimationFrame

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteanimationlength.html b/doc/doc_files/setspriteanimationlength.html index 85e21a6..9f0c8b3 100644 --- a/doc/doc_files/setspriteanimationlength.html +++ b/doc/doc_files/setspriteanimationlength.html @@ -15,6 +15,7 @@ GetSpriteAnimationLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteanimationspeed.html b/doc/doc_files/setspriteanimationspeed.html index 84924cf..4a1206f 100644 --- a/doc/doc_files/setspriteanimationspeed.html +++ b/doc/doc_files/setspriteanimationspeed.html @@ -12,6 +12,7 @@ Sets the speed in frames per second for a sprite animation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteawake.html b/doc/doc_files/setspriteawake.html index 1314f9e..9ae519a 100644 --- a/doc/doc_files/setspriteawake.html +++ b/doc/doc_files/setspriteawake.html @@ -3,15 +3,16 @@ - setSpriteAwake [RCBasic Doc] + SetSpriteAwake [RCBasic Doc] -

    sub setSpriteAwake( spr_id, flag)

    +

    Sub SetSpriteAwake( spr_id, flag)

    Sets a sprite's sleep state

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritebox.html b/doc/doc_files/setspritebox.html index dc7e18b..ed258ec 100644 --- a/doc/doc_files/setspritebox.html +++ b/doc/doc_files/setspritebox.html @@ -15,6 +15,7 @@ NOTE: Sprite collision shape must be SPRITE_SHAPE_BOX

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritebullet.html b/doc/doc_files/setspritebullet.html index badf52c..01070c7 100644 --- a/doc/doc_files/setspritebullet.html +++ b/doc/doc_files/setspritebullet.html @@ -3,11 +3,11 @@ - setSpriteBullet [RCBasic Doc] + SetSpriteBullet [RCBasic Doc] -

    sub setSpriteBullet( spr_id, flag)

    +

    Sub SetSpriteBullet( spr_id, flag)

    Sets whether body has continuous collision detection

    @@ -18,6 +18,7 @@ SpriteIsBullet

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritecanvasantialiasmode.html b/doc/doc_files/setspritecanvasantialiasmode.html index 56fa299..7f8649e 100644 --- a/doc/doc_files/setspritecanvasantialiasmode.html +++ b/doc/doc_files/setspritecanvasantialiasmode.html @@ -7,7 +7,7 @@ -

    sub SetSpriteCanvasAntiAliasMode( c_num, aa_mode )

    +

    Sub SetSpriteCanvasAntiAliasMode( c_num, aa_mode )

    Sets the anti-alias mode for a sprite canvas

    @@ -41,6 +41,7 @@ GetSpriteCanvasAntiAliasMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritecanvasbilinearfilter.html b/doc/doc_files/setspritecanvasbilinearfilter.html index 57106cd..0a88a16 100644 --- a/doc/doc_files/setspritecanvasbilinearfilter.html +++ b/doc/doc_files/setspritecanvasbilinearfilter.html @@ -7,7 +7,7 @@ -

    sub SetSpriteCanvasBilinearFilter( c_num, flag )

    +

    Sub SetSpriteCanvasBilinearFilter( c_num, flag )

    Enables or disables bi-linear filter for the sprite canvas

    @@ -15,6 +15,7 @@ GetSpriteCanvasBilinearFilter

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritecanvasblendmode.html b/doc/doc_files/setspritecanvasblendmode.html index ba66373..8f6ee69 100644 --- a/doc/doc_files/setspritecanvasblendmode.html +++ b/doc/doc_files/setspritecanvasblendmode.html @@ -7,7 +7,7 @@ -

    sub SetSpriteCanvasBlendMode( c_num, blend_mode )

    +

    Sub SetSpriteCanvasBlendMode( c_num, blend_mode )

    Sets the blend mode used to render sprites on the given sprite canvas

    @@ -51,6 +51,7 @@ GetSpriteCanvasBlendMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritecanvasrenderpriority.html b/doc/doc_files/setspritecanvasrenderpriority.html index a758650..e81f3d5 100644 --- a/doc/doc_files/setspritecanvasrenderpriority.html +++ b/doc/doc_files/setspritecanvasrenderpriority.html @@ -7,7 +7,7 @@ -

    function SetSpriteCanvasRenderPriority( c_num, priority, order )

    +

    Function SetSpriteCanvasRenderPriority( c_num, priority, order )

    Sets the order sprites are rendered on a sprite canvas.

    @@ -62,6 +62,7 @@ GetSpriteCanvasRenderPriority

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritechain.html b/doc/doc_files/setspritechain.html index 2aab23c..8c419fd 100644 --- a/doc/doc_files/setspritechain.html +++ b/doc/doc_files/setspritechain.html @@ -15,6 +15,7 @@ NOTE: Sprite collision shape must be SPRITE_SHAPE_CHAIN

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritechainloop.html b/doc/doc_files/setspritechainloop.html index a78c1e6..b5fc004 100644 --- a/doc/doc_files/setspritechainloop.html +++ b/doc/doc_files/setspritechainloop.html @@ -18,6 +18,7 @@ NOTE: Sprite collision shape must be SPRITE_SHAPE_CHAIN

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritecolormod.html b/doc/doc_files/setspritecolormod.html index 3eaacaa..27ff9ff 100644 --- a/doc/doc_files/setspritecolormod.html +++ b/doc/doc_files/setspritecolormod.html @@ -12,6 +12,7 @@ Sets the color modulation of a sprite.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritedensity.html b/doc/doc_files/setspritedensity.html index 4912d66..943a1c0 100644 --- a/doc/doc_files/setspritedensity.html +++ b/doc/doc_files/setspritedensity.html @@ -7,7 +7,7 @@ -

    sub SetSpriteDensity( spr_id, density )

    +

    Sub SetSpriteDensity( spr_id, density )

    Sets the density of a sprite. Higher density means a heavier sprite.

    @@ -18,6 +18,7 @@ GetSpriteDensity

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritefixedrotation.html b/doc/doc_files/setspritefixedrotation.html index 59b1b60..bdf49e0 100644 --- a/doc/doc_files/setspritefixedrotation.html +++ b/doc/doc_files/setspritefixedrotation.html @@ -3,11 +3,11 @@ - setSpriteFixedRotation [RCBasic Doc] + SetSpriteFixedRotation [RCBasic Doc] -

    sub setSpriteFixedRotation( spr_id, flag )

    +

    Sub SetSpriteFixedRotation( spr_id, flag )

    Prevents sprite from being rotated by any forces applied to it

    @@ -15,6 +15,7 @@ spriteIsFixedRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteframe.html b/doc/doc_files/setspriteframe.html index 48a4752..02fb575 100644 --- a/doc/doc_files/setspriteframe.html +++ b/doc/doc_files/setspriteframe.html @@ -12,6 +12,7 @@ Sets a sprite to a frame in its frame sheet

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritefriction.html b/doc/doc_files/setspritefriction.html index abaeac8..e280868 100644 --- a/doc/doc_files/setspritefriction.html +++ b/doc/doc_files/setspritefriction.html @@ -7,7 +7,7 @@ -

    sub SetSpriteFriction( spr_id, friction )

    +

    Sub SetSpriteFriction( spr_id, friction )

    Sets a sprite's friction

    @@ -15,6 +15,7 @@ GetSpriteFriction

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritegravityscale.html b/doc/doc_files/setspritegravityscale.html index 19cff02..f525118 100644 --- a/doc/doc_files/setspritegravityscale.html +++ b/doc/doc_files/setspritegravityscale.html @@ -3,11 +3,11 @@ - setSpriteGravityScale [RCBasic Doc] + SetSpriteGravityScale [RCBasic Doc] -

    sub setSpriteGravityScale( spr_id, g_scale)

    +

    Sub SetSpriteGravityScale( spr_id, g_scale)

    Sets the affect of gravity on a sprite

    @@ -15,6 +15,7 @@ GetSpriteGravityScale

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritelineardamping.html b/doc/doc_files/setspritelineardamping.html index 929c854..7caa1cf 100644 --- a/doc/doc_files/setspritelineardamping.html +++ b/doc/doc_files/setspritelineardamping.html @@ -3,11 +3,11 @@ - setSpriteLinearDamping [RCBasic Doc] + SetSpriteLinearDamping [RCBasic Doc] -

    sub setSpriteLinearDamping( spr_id, linearDamping)

    +

    Sub SetSpriteLinearDamping( spr_id, linearDamping)

    Sets the linear damping of a sprite

    @@ -15,6 +15,7 @@ GetSpriteLinearDamping

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritelinearvelocity.html b/doc/doc_files/setspritelinearvelocity.html index 3009a35..e611623 100644 --- a/doc/doc_files/setspritelinearvelocity.html +++ b/doc/doc_files/setspritelinearvelocity.html @@ -3,11 +3,11 @@ - setSpriteLinearVelocity [RCBasic Doc] + SetSpriteLinearVelocity [RCBasic Doc] -

    sub setSpriteLinearVelocity( spr_id, x, y)

    +

    Sub SetSpriteLinearVelocity( spr_id, x, y)

    Sets a sprite's linear velocity

    @@ -15,6 +15,7 @@ GetSpriteLinearVelocity

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritepolygon.html b/doc/doc_files/setspritepolygon.html index 04fef29..50098f6 100644 --- a/doc/doc_files/setspritepolygon.html +++ b/doc/doc_files/setspritepolygon.html @@ -12,6 +12,7 @@ Sets the points in a polygon sprite shape

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteposition.html b/doc/doc_files/setspriteposition.html index 24a9aae..6dab922 100644 --- a/doc/doc_files/setspriteposition.html +++ b/doc/doc_files/setspriteposition.html @@ -54,6 +54,7 @@ CreateSprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteradius.html b/doc/doc_files/setspriteradius.html index 0aa3d79..a28ef20 100644 --- a/doc/doc_files/setspriteradius.html +++ b/doc/doc_files/setspriteradius.html @@ -18,6 +18,7 @@ GetSpriteRadius

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriterestitution.html b/doc/doc_files/setspriterestitution.html index f279e4e..9a28c5a 100644 --- a/doc/doc_files/setspriterestitution.html +++ b/doc/doc_files/setspriterestitution.html @@ -7,7 +7,7 @@ -

    sub SetSpriteRestitution( spr_id, restitution )

    +

    Sub SetSpriteRestitution( spr_id, restitution )

    Sets the restitution coefficient for a sprite

    @@ -15,6 +15,7 @@ GetSpriteRestitution

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriterestitutionthreshold.html b/doc/doc_files/setspriterestitutionthreshold.html index 07c8353..f768bd4 100644 --- a/doc/doc_files/setspriterestitutionthreshold.html +++ b/doc/doc_files/setspriterestitutionthreshold.html @@ -7,7 +7,7 @@ -

    sub SetSpriteRestitutionThreshold( spr_id, threshold )

    +

    Sub SetSpriteRestitutionThreshold( spr_id, threshold )

    Sets the restitution threshold for a sprite.

    @@ -15,6 +15,7 @@ GetSpriteRestitutionThreshold

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriterotation.html b/doc/doc_files/setspriterotation.html index 1063e8d..b93b972 100644 --- a/doc/doc_files/setspriterotation.html +++ b/doc/doc_files/setspriterotation.html @@ -50,6 +50,7 @@ RotateSprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritescale.html b/doc/doc_files/setspritescale.html index 297da88..599e6ff 100644 --- a/doc/doc_files/setspritescale.html +++ b/doc/doc_files/setspritescale.html @@ -51,6 +51,7 @@ GetSpriteScale

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteshape.html b/doc/doc_files/setspriteshape.html index b3baa01..2f5b6ab 100644 --- a/doc/doc_files/setspriteshape.html +++ b/doc/doc_files/setspriteshape.html @@ -40,6 +40,7 @@ GetSpriteShape

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspriteshapeoffset.html b/doc/doc_files/setspriteshapeoffset.html index 195a68c..e9e2cfc 100644 --- a/doc/doc_files/setspriteshapeoffset.html +++ b/doc/doc_files/setspriteshapeoffset.html @@ -15,6 +15,7 @@ GetSpriteShapeOffset

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritesleepallowed.html b/doc/doc_files/setspritesleepallowed.html index 77305f3..8fb8337 100644 --- a/doc/doc_files/setspritesleepallowed.html +++ b/doc/doc_files/setspritesleepallowed.html @@ -3,11 +3,11 @@ - setSpriteSleepAllowed [RCBasic Doc] + SetSpriteSleepAllowed [RCBasic Doc] -

    sub setSpriteSleepAllowed( spr_id, flag)

    +

    Sub SetSpriteSleepAllowed( spr_id, flag)

    Sets whether the sprite is allowed to go to sleep when it's at rest

    @@ -17,6 +17,7 @@ SpriteIsSleepAllowed

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritesolid.html b/doc/doc_files/setspritesolid.html index fb94111..ad3016f 100644 --- a/doc/doc_files/setspritesolid.html +++ b/doc/doc_files/setspritesolid.html @@ -55,6 +55,7 @@ SpriteIsSolid

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritesource.html b/doc/doc_files/setspritesource.html index 3c673f7..7c79d54 100644 --- a/doc/doc_files/setspritesource.html +++ b/doc/doc_files/setspritesource.html @@ -50,6 +50,7 @@ GetSpriteSource

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritetype.html b/doc/doc_files/setspritetype.html index f2cf80b..0d5c2b8 100644 --- a/doc/doc_files/setspritetype.html +++ b/doc/doc_files/setspritetype.html @@ -164,6 +164,7 @@ GetSpriteType

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritevisible.html b/doc/doc_files/setspritevisible.html index 73a26ce..b0762a0 100644 --- a/doc/doc_files/setspritevisible.html +++ b/doc/doc_files/setspritevisible.html @@ -48,6 +48,7 @@ SetSpriteVisible

    +

    \ No newline at end of file diff --git a/doc/doc_files/setspritez.html b/doc/doc_files/setspritez.html index f2b726d..deb804c 100644 --- a/doc/doc_files/setspritez.html +++ b/doc/doc_files/setspritez.html @@ -66,6 +66,7 @@ SpriteZ

    +

    \ No newline at end of file diff --git a/doc/doc_files/setterraincameramovementdelta.html b/doc/doc_files/setterraincameramovementdelta.html index 0a89d1c..0bd1e34 100644 --- a/doc/doc_files/setterraincameramovementdelta.html +++ b/doc/doc_files/setterraincameramovementdelta.html @@ -7,7 +7,7 @@ -

    sub SetTerrainCameraMovementDelta( actor, delta )

    +

    Sub SetTerrainCameraMovementDelta( actor, delta )

    Sets the movement camera threshold.

    @@ -15,6 +15,7 @@ It is used to determine when to recalculate indices for the actor. The default value is 10.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setterraincamerarotationdelta.html b/doc/doc_files/setterraincamerarotationdelta.html index 12b1fdb..3cab09f 100644 --- a/doc/doc_files/setterraincamerarotationdelta.html +++ b/doc/doc_files/setterraincamerarotationdelta.html @@ -7,7 +7,7 @@ -

    sub SetTerrainCameraRotationDelta( actor, delta )

    +

    Sub SetTerrainCameraRotationDelta( actor, delta )

    Sets the rotation camera threshold.

    @@ -15,6 +15,7 @@ It is used to determine when to recalculate indices for the scene node. The default value is 1.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setterrainloddistance.html b/doc/doc_files/setterrainloddistance.html index 17c8168..6076818 100644 --- a/doc/doc_files/setterrainloddistance.html +++ b/doc/doc_files/setterrainloddistance.html @@ -7,11 +7,12 @@ -

    sub SetTerrainLODDistance( actor, LOD, distance )

    +

    Sub SetTerrainLODDistance( actor, LOD, distance )

    Override the default generation of distance thresholds.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setterrainpatchlod.html b/doc/doc_files/setterrainpatchlod.html index 8d7bdb2..a4fbe62 100644 --- a/doc/doc_files/setterrainpatchlod.html +++ b/doc/doc_files/setterrainpatchlod.html @@ -7,11 +7,12 @@ -

    sub SetTerrainPatchLOD( actor, patchX, patchZ, LOD )

    +

    Sub SetTerrainPatchLOD( actor, patchX, patchZ, LOD )

    Manually sets the LOD of a patch.

    +

    \ No newline at end of file diff --git a/doc/doc_files/settile.html b/doc/doc_files/settile.html index 9b0c3e8..2afbf01 100644 --- a/doc/doc_files/settile.html +++ b/doc/doc_files/settile.html @@ -12,6 +12,7 @@ Places a tile on a tilemap

    +

    \ No newline at end of file diff --git a/doc/doc_files/settileanimationframe.html b/doc/doc_files/settileanimationframe.html index 9dd63d1..fc8ab5b 100644 --- a/doc/doc_files/settileanimationframe.html +++ b/doc/doc_files/settileanimationframe.html @@ -29,6 +29,7 @@

    +

    \ No newline at end of file diff --git a/doc/doc_files/settileanimationlength.html b/doc/doc_files/settileanimationlength.html index d86a5e3..0537053 100644 --- a/doc/doc_files/settileanimationlength.html +++ b/doc/doc_files/settileanimationlength.html @@ -15,6 +15,7 @@ GetTileAnimationLength

    +

    \ No newline at end of file diff --git a/doc/doc_files/settileanimationspeed.html b/doc/doc_files/settileanimationspeed.html index 027f3d1..a8d0ccd 100644 --- a/doc/doc_files/settileanimationspeed.html +++ b/doc/doc_files/settileanimationspeed.html @@ -15,6 +15,7 @@ GetTileAnimationSpeed

    +

    \ No newline at end of file diff --git a/doc/doc_files/settilemapsize.html b/doc/doc_files/settilemapsize.html index 5aedd8d..8acd14a 100644 --- a/doc/doc_files/settilemapsize.html +++ b/doc/doc_files/settilemapsize.html @@ -16,6 +16,7 @@ GetTileMapSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/setup.html b/doc/doc_files/setup.html index 472dfec..af26f53 100644 --- a/doc/doc_files/setup.html +++ b/doc/doc_files/setup.html @@ -9,44 +9,40 @@

    SETTING UP RCBASIC

    - RCBasic comes with 2 command-line tools for creating programs. The first is rcbasic_build which takes your sourcecode in your *.bas file and compiles it into a *.cbc file. The *.cbc file contains intermediate bytecode which can be ran with the rcbasic (rcbasic.exe on windows) application. + To get started with RCBasic, just go into the directory where RCBasic is extracted to and start up RCBasic Studio. You are now ready to start coding.

    - NOTE: On Windows, you need to include all the 32-bit dlls with the 32-bit executable and all the 64-bit dlls with the 64-bit executable. The rcbasic package tool will automatically do all of this for you as well as package for other systems as well. + RCBasic also comes with a 2D level editor called Nirvana and a 3D level editor called Serenity. If you are on linux there is a start up script for each one in the main folder where RCBasic is extracted. On Windows, just go into each folder and start up the exe for the editor you want to use.

    -

    RUN PROGRAMS FROM GEANY

    -

    -

    - LINUX In the installer directory there is a folder called geany_files. Inside the folder there is a file named filetypes.rcbasic. You can override the geany *.bas configuration by replacing the freeBasic configuration with this file. Just copy this file to the geany filedefs path, which on most linux distibutions should be (/home/.config/geany/filedefs), and rename the file to filetypes.freebasic. -

    -

    - Once you have rcbasic set up with geany you just need to create a new file and save it as *.bas. Then you can compile your program by going to Build->Compile. Once your program is compiled you can run it by going to Build->Execute. -

    -

    - NOTE: If you want to use a different file extension for rcbasic programs you can still use this file and just set it up for a different extension. Refer to the geany documentation on how to set up different file types. -

    -

    - WINDOWS Geany comes preconfigured with rcbasic on windows. Just run the start_editor.bat file and create a new *.bas file. Select the File->New with Template option in the menu to start with a simple template program. Once you have created a new *.bas file goto Build->Compile to compile your program to a *.cbc file. Then goto Build->Execute to run your program. + There is a video going over the basics of each editor here:

    +

    USING RCBASIC FROM THE COMMAND-LINE

    RCBasic will be added to path on install on linux. On Windows you will need to add the rcbasic folder to your path. Either (rcbasic/rcbasic_32) or (rcbasic/rcbasic_64) depending on your operating system. Once rcbasic is in your path you can simple pass a source file to rcbasic_build to create a *.cbc file.

    - rcbasic_build myprogram.bas 
    + rcbasic_build4 myprogram.bas 

    Once you have a *.cbc file you can pass it to rcbasic to run it.

    - rcbasic myprogram.cbc 
    + rcbasic4 myprogram.cbc 

    Both tools also except the --version argument which will simply output the version of rcbasic you are using.

    - rcbasic_build --version 
    - rcbasic -version 
    + rcbasic_build4 --version 
    + rcbasic4 -version 

    PORTING TO OTHER PLATFORMS

    @@ -55,6 +51,7 @@ From RCBasic Studio, select tools->distribute and then select the platforms you want to distribute to and click the "MAKE APP" button.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setvideodrawrect.html b/doc/doc_files/setvideodrawrect.html index a982606..42746e3 100644 --- a/doc/doc_files/setvideodrawrect.html +++ b/doc/doc_files/setvideodrawrect.html @@ -7,7 +7,7 @@ -

    sub SetVideoDrawRect(x, y, w, h)

    +

    Sub SetVideoDrawRect(x, y, w, h)

    Sets the area on the current canvas where the video will be displayed.

    @@ -15,6 +15,7 @@ Note: This is a function that was more useful in older versions of RCBasic. Currently its better to use canvas controls for this.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setvideoposition.html b/doc/doc_files/setvideoposition.html index b9864fc..8dff227 100644 --- a/doc/doc_files/setvideoposition.html +++ b/doc/doc_files/setvideoposition.html @@ -7,7 +7,7 @@ -

    sub SetVideoPosition(pos)

    +

    Sub SetVideoPosition(pos)

    Sets the position within the current video in milliseconds

    @@ -15,6 +15,7 @@ GetVideoPosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/setvideovolume.html b/doc/doc_files/setvideovolume.html index 3315799..c94c2d1 100644 --- a/doc/doc_files/setvideovolume.html +++ b/doc/doc_files/setvideovolume.html @@ -7,11 +7,12 @@ -

    sub SetVideoVolume( vol )

    +

    Sub SetVideoVolume( vol )

    Sets the volume of the video track

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowalwaysontop.html b/doc/doc_files/setwindowalwaysontop.html index 51cd0a2..bbafb98 100644 --- a/doc/doc_files/setwindowalwaysontop.html +++ b/doc/doc_files/setwindowalwaysontop.html @@ -7,11 +7,12 @@ -

    sub SetWindowAlwaysOnTop( flag )

    +

    Sub SetWindowAlwaysOnTop( flag )

    Sets the window as the highest priority on the display.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowautoclose.html b/doc/doc_files/setwindowautoclose.html index cae6f61..fab0ecd 100644 --- a/doc/doc_files/setwindowautoclose.html +++ b/doc/doc_files/setwindowautoclose.html @@ -7,11 +7,12 @@ -

    sub SetWindowAutoClose( exit_on_close )

    +

    Sub SetWindowAutoClose( exit_on_close )

    Sets whether the close button on the window closes it.

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowbordered.html b/doc/doc_files/setwindowbordered.html index 838eee9..4bc91bb 100644 --- a/doc/doc_files/setwindowbordered.html +++ b/doc/doc_files/setwindowbordered.html @@ -7,7 +7,7 @@ -

    sub SetWindowBordered( flag)

    +

    Sub SetWindowBordered( flag)

    Sets whether the window has a border or not.

    @@ -15,6 +15,7 @@ WindowIsBordered

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowfullscreen.html b/doc/doc_files/setwindowfullscreen.html index f853b17..1fa17c3 100644 --- a/doc/doc_files/setwindowfullscreen.html +++ b/doc/doc_files/setwindowfullscreen.html @@ -7,11 +7,12 @@ -

    sub SetWindowFullscreen( flag)

    +

    Sub SetWindowFullscreen( flag)

    You will never guess what this does

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowicon.html b/doc/doc_files/setwindowicon.html index daf713a..42495a2 100644 --- a/doc/doc_files/setwindowicon.html +++ b/doc/doc_files/setwindowicon.html @@ -7,11 +7,12 @@ -

    sub SetWindowIcon( img )

    +

    Sub SetWindowIcon( img )

    Sets the icon that is displayed on the window border

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowmaxsize.html b/doc/doc_files/setwindowmaxsize.html index 68bff67..806c3e8 100644 --- a/doc/doc_files/setwindowmaxsize.html +++ b/doc/doc_files/setwindowmaxsize.html @@ -7,11 +7,12 @@ -

    sub SetWindowMaxSize( w, h)

    +

    Sub SetWindowMaxSize( w, h)

    Sets the max size for a resizable window

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowminsize.html b/doc/doc_files/setwindowminsize.html index 17fcb12..cf76972 100644 --- a/doc/doc_files/setwindowminsize.html +++ b/doc/doc_files/setwindowminsize.html @@ -7,11 +7,12 @@ -

    sub SetWindowMinSize( w, h)

    +

    Sub SetWindowMinSize( w, h)

    Sets the min size for a resizable window

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowposition.html b/doc/doc_files/setwindowposition.html index 2590838..fd7388d 100644 --- a/doc/doc_files/setwindowposition.html +++ b/doc/doc_files/setwindowposition.html @@ -7,11 +7,12 @@ -

    sub SetWindowPosition( x, y )

    +

    Sub SetWindowPosition( x, y )

    Sets the position of the window on the display

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowresizable.html b/doc/doc_files/setwindowresizable.html index fc79bf9..c9264c1 100644 --- a/doc/doc_files/setwindowresizable.html +++ b/doc/doc_files/setwindowresizable.html @@ -7,11 +7,12 @@ -

    sub SetWindowResizable( flag )

    +

    Sub SetWindowResizable( flag )

    Sets whether or not a window is resizable

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowsize.html b/doc/doc_files/setwindowsize.html index 678bcc8..5486314 100644 --- a/doc/doc_files/setwindowsize.html +++ b/doc/doc_files/setwindowsize.html @@ -7,11 +7,12 @@ -

    sub SetWindowSize( w, h )

    +

    Sub SetWindowSize( w, h )

    Sets the size of a window

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowtitle.html b/doc/doc_files/setwindowtitle.html index f4c8180..8b0d7b8 100644 --- a/doc/doc_files/setwindowtitle.html +++ b/doc/doc_files/setwindowtitle.html @@ -7,11 +7,12 @@ -

    sub SetWindowTitle( title$ )

    +

    Sub SetWindowTitle( title$ )

    Sets the title of the window

    +

    \ No newline at end of file diff --git a/doc/doc_files/setwindowvsync.html b/doc/doc_files/setwindowvsync.html index 2f311c1..610dd78 100644 --- a/doc/doc_files/setwindowvsync.html +++ b/doc/doc_files/setwindowvsync.html @@ -7,8 +7,9 @@ -

    sub SetWindowVSync( flag )

    +

    Sub SetWindowVSync( flag )

    +

    \ No newline at end of file diff --git a/doc/doc_files/setworld2dautoclearforces.html b/doc/doc_files/setworld2dautoclearforces.html index 8680f37..7e5098e 100644 --- a/doc/doc_files/setworld2dautoclearforces.html +++ b/doc/doc_files/setworld2dautoclearforces.html @@ -7,7 +7,7 @@ -

    sub SetWorld2DAutoClearForces( flag )

    +

    Sub SetWorld2DAutoClearForces( flag )

    Sets the auto clear forces flag for the active canvas

    @@ -15,6 +15,7 @@ GetWorld2DAutoClearForces

    +

    \ No newline at end of file diff --git a/doc/doc_files/setworld2dpositioniterations.html b/doc/doc_files/setworld2dpositioniterations.html index 6da7829..336eee8 100644 --- a/doc/doc_files/setworld2dpositioniterations.html +++ b/doc/doc_files/setworld2dpositioniterations.html @@ -7,7 +7,7 @@ -

    sub SetWorld2DPositionIterations( p )

    +

    Sub SetWorld2DPositionIterations( p )

    Sets the number of position iterations for the position constraint solver

    @@ -15,6 +15,7 @@ GetWorld2DPositionIterations

    +

    \ No newline at end of file diff --git a/doc/doc_files/setworld2dtimestep.html b/doc/doc_files/setworld2dtimestep.html index b26b8af..d4526df 100644 --- a/doc/doc_files/setworld2dtimestep.html +++ b/doc/doc_files/setworld2dtimestep.html @@ -7,7 +7,7 @@ -

    sub SetWorld2DTimeStep( ts )

    +

    Sub SetWorld2DTimeStep( ts )

    Sets the timestep for the active canvas

    @@ -15,6 +15,7 @@ GetWorld2DTimeStep

    +

    \ No newline at end of file diff --git a/doc/doc_files/setworld2dvelocityiterations.html b/doc/doc_files/setworld2dvelocityiterations.html index 7ff62a1..48b80cc 100644 --- a/doc/doc_files/setworld2dvelocityiterations.html +++ b/doc/doc_files/setworld2dvelocityiterations.html @@ -7,7 +7,7 @@ -

    sub SetWorld2DVelocityIterations( v )

    +

    Sub SetWorld2DVelocityIterations( v )

    Sets the number of velocity iterations for the velocity constraint solver

    @@ -15,6 +15,7 @@ GetWorld2DVelocityIterations

    +

    \ No newline at end of file diff --git a/doc/doc_files/setworld3dmaxsubsteps.html b/doc/doc_files/setworld3dmaxsubsteps.html index dab9c54..3b01d00 100644 --- a/doc/doc_files/setworld3dmaxsubsteps.html +++ b/doc/doc_files/setworld3dmaxsubsteps.html @@ -7,7 +7,7 @@ -

    sub SetWorld3DMaxSubSteps( steps )

    +

    Sub SetWorld3DMaxSubSteps( steps )

    Sets the max sub steps to break the simulation up into

    @@ -18,6 +18,7 @@ SetWorld3DMaxTimeStep

    +

    \ No newline at end of file diff --git a/doc/doc_files/setworld3dtimestep.html b/doc/doc_files/setworld3dtimestep.html index ac1a233..b0af76b 100644 --- a/doc/doc_files/setworld3dtimestep.html +++ b/doc/doc_files/setworld3dtimestep.html @@ -7,7 +7,7 @@ -

    sub SetWorld3DTimeStep( ts )

    +

    Sub SetWorld3DTimeStep( ts )

    Sets the fixed time step for the physics simulation

    @@ -18,6 +18,7 @@ SetWorld3DMaxSubSteps

    +

    \ No newline at end of file diff --git a/doc/doc_files/showmouse.html b/doc/doc_files/showmouse.html index 8e4974b..94ab835 100644 --- a/doc/doc_files/showmouse.html +++ b/doc/doc_files/showmouse.html @@ -7,11 +7,12 @@ -

    sub ShowMouse()

    +

    Sub ShowMouse()

    Sets the mouse cursor visible

    +

    \ No newline at end of file diff --git a/doc/doc_files/showwindow.html b/doc/doc_files/showwindow.html index 080d503..816e86f 100644 --- a/doc/doc_files/showwindow.html +++ b/doc/doc_files/showwindow.html @@ -7,11 +7,12 @@ -

    sub ShowWindow( )

    +

    Sub ShowWindow( )

    Sets the window visible

    +

    \ No newline at end of file diff --git a/doc/doc_files/sign.html b/doc/doc_files/sign.html index 272b35d..c517c41 100644 --- a/doc/doc_files/sign.html +++ b/doc/doc_files/sign.html @@ -7,7 +7,7 @@ -

    function Sign(n)

    +

    Function Sign(n)

    Returns the sign of a number

    @@ -15,6 +15,7 @@ n < 0 returns -1 n = 0 returns 0 n > 0 returns 1

    +

    \ No newline at end of file diff --git a/doc/doc_files/sin.html b/doc/doc_files/sin.html index 62e7947..6c0c6fe 100644 --- a/doc/doc_files/sin.html +++ b/doc/doc_files/sin.html @@ -7,11 +7,12 @@ -

    function Sin(n)

    +

    Function Sin(n)

    Returns the sine of angle n

    +

    \ No newline at end of file diff --git a/doc/doc_files/size.html b/doc/doc_files/size.html index 3fd05dc..93a0f22 100644 --- a/doc/doc_files/size.html +++ b/doc/doc_files/size.html @@ -7,7 +7,7 @@ -

    function Size(s$)

    +

    Function Size(s$)

    Returns the size in bytes of a string

    @@ -19,6 +19,7 @@ Length

    +

    \ No newline at end of file diff --git a/doc/doc_files/solvematrix.html b/doc/doc_files/solvematrix.html index 597d09e..16cc63c 100644 --- a/doc/doc_files/solvematrix.html +++ b/doc/doc_files/solvematrix.html @@ -7,7 +7,7 @@ -

    function SolveMatrix(mA, mB, mC)

    +

    Function SolveMatrix(mA, mB, mC)

    Solve the system that has mA as coefficient and mB as the hand side of the equation. Stores the result in mC.

    @@ -15,6 +15,7 @@ Returns true if it was able to be solved and false if not.

    +

    \ No newline at end of file diff --git a/doc/doc_files/sound.html b/doc/doc_files/sound.html index 8c1aeb4..990151b 100644 --- a/doc/doc_files/sound.html +++ b/doc/doc_files/sound.html @@ -32,6 +32,7 @@ Music is even simpler than sound. Generally all you will want to do is load a music track and set it to loop infinitely but you have a lot of control over how the music plays as well.

    +

    \ No newline at end of file diff --git a/doc/doc_files/soundexists.html b/doc/doc_files/soundexists.html index 263c791..5c877fb 100644 --- a/doc/doc_files/soundexists.html +++ b/doc/doc_files/soundexists.html @@ -7,11 +7,12 @@ -

    function SoundExists(snd)

    +

    Function SoundExists(snd)

    Returns true if the snd id given is associated with an allocated audio track in memory

    +

    \ No newline at end of file diff --git a/doc/doc_files/soundisenabled.html b/doc/doc_files/soundisenabled.html index b74f6b6..e2ffbe1 100644 --- a/doc/doc_files/soundisenabled.html +++ b/doc/doc_files/soundisenabled.html @@ -7,11 +7,12 @@ -

    function SoundIsEnabled()

    +

    Function SoundIsEnabled()

    Returns true if the audio subsystem has been initialized.

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteanimationisplaying.html b/doc/doc_files/spriteanimationisplaying.html index ca647bb..75573a4 100644 --- a/doc/doc_files/spriteanimationisplaying.html +++ b/doc/doc_files/spriteanimationisplaying.html @@ -12,6 +12,7 @@ Returns true if there is an animation playing on the sprite

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteexists.html b/doc/doc_files/spriteexists.html index 71378e7..6e3c3be 100644 --- a/doc/doc_files/spriteexists.html +++ b/doc/doc_files/spriteexists.html @@ -12,6 +12,7 @@ Returns true if the sprite id is a valid sprite id

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteheight.html b/doc/doc_files/spriteheight.html index 8127675..4cfe526 100644 --- a/doc/doc_files/spriteheight.html +++ b/doc/doc_files/spriteheight.html @@ -59,6 +59,7 @@ GetSpriteSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteisawake.html b/doc/doc_files/spriteisawake.html index 33ed561..485272e 100644 --- a/doc/doc_files/spriteisawake.html +++ b/doc/doc_files/spriteisawake.html @@ -3,11 +3,11 @@ - spriteIsAwake [RCBasic Doc] + SpriteIsAwake [RCBasic Doc] -

    function spriteIsAwake( spr_id)

    +

    Function SpriteIsAwake( spr_id)

    Wakes a sleeping sprite

    @@ -17,6 +17,7 @@ SetSpriteSleepAllowed

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteisbullet.html b/doc/doc_files/spriteisbullet.html index 7fd5e31..31b2ed3 100644 --- a/doc/doc_files/spriteisbullet.html +++ b/doc/doc_files/spriteisbullet.html @@ -3,11 +3,11 @@ - spriteIsBullet [RCBasic Doc] + SpriteIsBullet [RCBasic Doc] -

    function spriteIsBullet( spr_id)

    +

    Function SpriteIsBullet( spr_id)

    Returns whether body has continuous collision detection

    @@ -18,6 +18,7 @@ SetSpriteBullet

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteisfixedrotation.html b/doc/doc_files/spriteisfixedrotation.html index 4fb0098..1d0f2c4 100644 --- a/doc/doc_files/spriteisfixedrotation.html +++ b/doc/doc_files/spriteisfixedrotation.html @@ -3,11 +3,11 @@ - spriteIsFixedRotation [RCBasic Doc] + SpriteIsFixedRotation [RCBasic Doc] -

    function spriteIsFixedRotation( spr_id)

    +

    Function SpriteIsFixedRotation( spr_id)

    Returns whether fixed rotation is set on the sprite

    @@ -15,6 +15,7 @@ SetSpriteFixedRotation

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteissolid.html b/doc/doc_files/spriteissolid.html index cfc65d9..ea0660f 100644 --- a/doc/doc_files/spriteissolid.html +++ b/doc/doc_files/spriteissolid.html @@ -60,6 +60,7 @@ SetSpriteSolid

    +

    \ No newline at end of file diff --git a/doc/doc_files/spriteisvisible.html b/doc/doc_files/spriteisvisible.html index c10a10b..7d4cc28 100644 --- a/doc/doc_files/spriteisvisible.html +++ b/doc/doc_files/spriteisvisible.html @@ -56,6 +56,7 @@ SetSpriteVisible

    +

    \ No newline at end of file diff --git a/doc/doc_files/spritesleepallowed.html b/doc/doc_files/spritesleepallowed.html index 8b11273..034d16d 100644 --- a/doc/doc_files/spritesleepallowed.html +++ b/doc/doc_files/spritesleepallowed.html @@ -3,11 +3,11 @@ - spriteSleepAllowed [RCBasic Doc] + SpriteSleepAllowed [RCBasic Doc] -

    function spriteSleepAllowed( spr_id)

    +

    Function SpriteSleepAllowed( spr_id)

    Whether the body is allowed to go to sleep when it's at rest

    @@ -17,6 +17,7 @@ SetSpriteAwake

    +

    \ No newline at end of file diff --git a/doc/doc_files/spritewidth.html b/doc/doc_files/spritewidth.html index cc0361c..5fae382 100644 --- a/doc/doc_files/spritewidth.html +++ b/doc/doc_files/spritewidth.html @@ -59,6 +59,7 @@ GetSpriteSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/spritex.html b/doc/doc_files/spritex.html index a95094a..17a66ff 100644 --- a/doc/doc_files/spritex.html +++ b/doc/doc_files/spritex.html @@ -77,6 +77,7 @@ GetSpritePosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/spritey.html b/doc/doc_files/spritey.html index 40512fa..739c896 100644 --- a/doc/doc_files/spritey.html +++ b/doc/doc_files/spritey.html @@ -77,6 +77,7 @@ SpriteX

    +

    \ No newline at end of file diff --git a/doc/doc_files/spritez.html b/doc/doc_files/spritez.html index 09bac66..8777254 100644 --- a/doc/doc_files/spritez.html +++ b/doc/doc_files/spritez.html @@ -78,6 +78,7 @@ SetSpriteZ

    +

    \ No newline at end of file diff --git a/doc/doc_files/sqrt.html b/doc/doc_files/sqrt.html index 58e9a70..7d90eb6 100644 --- a/doc/doc_files/sqrt.html +++ b/doc/doc_files/sqrt.html @@ -7,11 +7,12 @@ -

    function Sqrt(n)

    +

    Function Sqrt(n)

    Returns the square root of n

    +

    \ No newline at end of file diff --git a/doc/doc_files/squarematrix.html b/doc/doc_files/squarematrix.html index 8a30349..d011327 100644 --- a/doc/doc_files/squarematrix.html +++ b/doc/doc_files/squarematrix.html @@ -7,11 +7,12 @@ -

    function SquareMatrix(mA, mB)

    +

    Function SquareMatrix(mA, mB)

    Stores the square of matrix mA in the matrix mB

    +

    \ No newline at end of file diff --git a/doc/doc_files/stack_size_n.html b/doc/doc_files/stack_size_n.html index d2eb11d..13fe4e9 100644 --- a/doc/doc_files/stack_size_n.html +++ b/doc/doc_files/stack_size_n.html @@ -7,11 +7,12 @@ -

    function Stack_Size_N( num_stack )

    +

    Function Stack_Size_N( num_stack )

    Returns the number of elements on a number stack

    +

    \ No newline at end of file diff --git a/doc/doc_files/stack_size_s.html b/doc/doc_files/stack_size_s.html index 2aba495..1269be4 100644 --- a/doc/doc_files/stack_size_s.html +++ b/doc/doc_files/stack_size_s.html @@ -7,11 +7,12 @@ -

    function Stack_Size_S( str_stack )

    +

    Function Stack_Size_S( str_stack )

    Returns the number of elements on a string stack

    +

    \ No newline at end of file diff --git a/doc/doc_files/startparticleemitter.html b/doc/doc_files/startparticleemitter.html index 27a678a..3d5e187 100644 --- a/doc/doc_files/startparticleemitter.html +++ b/doc/doc_files/startparticleemitter.html @@ -3,11 +3,11 @@ - startParticleEmitter [RCBasic Doc] + StartParticleEmitter [RCBasic Doc] -

    sub startParticleEmitter( actor)

    +

    Sub StartParticleEmitter( actor)

    Starts particle emission for a particle actor

    @@ -15,6 +15,7 @@ StopParticleEmitter

    +

    \ No newline at end of file diff --git a/doc/doc_files/steam_addachievement.html b/doc/doc_files/steam_addachievement.html index 92e155d..8b81db3 100644 --- a/doc/doc_files/steam_addachievement.html +++ b/doc/doc_files/steam_addachievement.html @@ -7,7 +7,7 @@ -

    sub Steam_AddAchievement( ach_id$, ach_name$ )

    +

    Sub Steam_AddAchievement( ach_id$, ach_name$ )

    Add a steam achievement to the current program

    @@ -21,6 +21,7 @@ Steam_TriggerAchievement

    +

    \ No newline at end of file diff --git a/doc/doc_files/steam_clearachievements.html b/doc/doc_files/steam_clearachievements.html index f1b39ff..c636a0e 100644 --- a/doc/doc_files/steam_clearachievements.html +++ b/doc/doc_files/steam_clearachievements.html @@ -7,7 +7,7 @@ -

    sub Steam_ClearAchievements()

    +

    Sub Steam_ClearAchievements()

    Clear all steam achievements from the application

    @@ -18,6 +18,7 @@ Steam_TriggerAchievement

    +

    \ No newline at end of file diff --git a/doc/doc_files/steam_finalizeachievements.html b/doc/doc_files/steam_finalizeachievements.html index b71fda5..f6daee6 100644 --- a/doc/doc_files/steam_finalizeachievements.html +++ b/doc/doc_files/steam_finalizeachievements.html @@ -7,7 +7,7 @@ -

    sub Steam_FinalizeAchievements()

    +

    Sub Steam_FinalizeAchievements()

    This function must be called once all steam achievements have been added

    @@ -18,6 +18,7 @@ Steam_TriggerAchievement

    +

    \ No newline at end of file diff --git a/doc/doc_files/steam_getid.html b/doc/doc_files/steam_getid.html index a92d0d0..b729046 100644 --- a/doc/doc_files/steam_getid.html +++ b/doc/doc_files/steam_getid.html @@ -7,7 +7,7 @@ -

    function Steam_GetID$()

    +

    Function Steam_GetID$()

    Returns the steam ID of the application which is needed to use the Steamworks API

    @@ -18,6 +18,7 @@ Steam_TriggerAchievement

    +

    \ No newline at end of file diff --git a/doc/doc_files/steam_triggerachievement.html b/doc/doc_files/steam_triggerachievement.html index 095ece7..7ca139b 100644 --- a/doc/doc_files/steam_triggerachievement.html +++ b/doc/doc_files/steam_triggerachievement.html @@ -7,7 +7,7 @@ -

    function Steam_TriggerAchievement( ach_name$ )

    +

    Function Steam_TriggerAchievement( ach_name$ )

    Unlocks a steam achievement in the current application.

    @@ -21,6 +21,7 @@ Steam_GetID

    +

    \ No newline at end of file diff --git a/doc/doc_files/stopmusic.html b/doc/doc_files/stopmusic.html index dbf89ea..2b2dcce 100644 --- a/doc/doc_files/stopmusic.html +++ b/doc/doc_files/stopmusic.html @@ -7,7 +7,7 @@ -

    sub StopMusic()

    +

    Sub StopMusic()

    Stops playing the loaded music track and resets the music position to 0

    @@ -16,6 +16,7 @@ PauseMusic

    +

    \ No newline at end of file diff --git a/doc/doc_files/stopparticleemitter.html b/doc/doc_files/stopparticleemitter.html index e6a603b..3c1edc9 100644 --- a/doc/doc_files/stopparticleemitter.html +++ b/doc/doc_files/stopparticleemitter.html @@ -3,11 +3,11 @@ - stopParticleEmitter [RCBasic Doc] + StopParticleEmitter [RCBasic Doc] -

    sub stopParticleEmitter( actor)

    +

    Sub StopParticleEmitter( actor)

    Stops particle emission for a particle actor

    @@ -15,6 +15,7 @@ StartParticleEmitter

    +

    \ No newline at end of file diff --git a/doc/doc_files/stopsound.html b/doc/doc_files/stopsound.html index 967ed26..5dd50b5 100644 --- a/doc/doc_files/stopsound.html +++ b/doc/doc_files/stopsound.html @@ -7,11 +7,12 @@ -

    sub StopSound(channel)

    +

    Sub StopSound(channel)

    Stops playing sound on the specified channel

    +

    \ No newline at end of file diff --git a/doc/doc_files/stopvideo.html b/doc/doc_files/stopvideo.html index 77bfba6..40515dc 100644 --- a/doc/doc_files/stopvideo.html +++ b/doc/doc_files/stopvideo.html @@ -7,7 +7,7 @@ -

    sub StopVideo()

    +

    Sub StopVideo()

    Stops playing the loaded video track and resets the video position to 0

    @@ -16,6 +16,7 @@ PauseVideo

    +

    \ No newline at end of file diff --git a/doc/doc_files/str.html b/doc/doc_files/str.html index bfb27a0..cb3e88f 100644 --- a/doc/doc_files/str.html +++ b/doc/doc_files/str.html @@ -7,11 +7,12 @@ -

    function Str$(n)

    +

    Function Str$(n)

    Returns a number converted to a string

    +

    \ No newline at end of file diff --git a/doc/doc_files/str_f.html b/doc/doc_files/str_f.html index 8404c2f..306ee49 100644 --- a/doc/doc_files/str_f.html +++ b/doc/doc_files/str_f.html @@ -7,7 +7,7 @@ -

    function Str_F$(n)

    +

    Function Str_F$(n)

    Returns a number converted to a string in fixed notation

    @@ -19,6 +19,7 @@ Str_S$

    +

    \ No newline at end of file diff --git a/doc/doc_files/str_s.html b/doc/doc_files/str_s.html index fc93794..f4a1de7 100644 --- a/doc/doc_files/str_s.html +++ b/doc/doc_files/str_s.html @@ -7,7 +7,7 @@ -

    function Str_S$(n)

    +

    Function Str_S$(n)

    Returns a number converted to a string in scientific notation

    @@ -16,6 +16,7 @@ Str_F$

    +

    \ No newline at end of file diff --git a/doc/doc_files/stringarraycopy.html b/doc/doc_files/stringarraycopy.html index 7e76381..4295d05 100644 --- a/doc/doc_files/stringarraycopy.html +++ b/doc/doc_files/stringarraycopy.html @@ -7,7 +7,7 @@ -

    sub StringArrayCopy(ByRef src$, ByRef dst$)

    +

    Sub StringArrayCopy(ByRef src$, ByRef dst$)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArrayCopy

    +

    \ No newline at end of file diff --git a/doc/doc_files/stringarraydim.html b/doc/doc_files/stringarraydim.html index 8d1ce4f..c2ab327 100644 --- a/doc/doc_files/stringarraydim.html +++ b/doc/doc_files/stringarraydim.html @@ -7,7 +7,7 @@ -

    function StringArrayDim(Byref id$)

    +

    Function StringArrayDim(ByRef id$)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArrayDim

    +

    \ No newline at end of file diff --git a/doc/doc_files/stringarrayfill.html b/doc/doc_files/stringarrayfill.html index cfa606c..7e49023 100644 --- a/doc/doc_files/stringarrayfill.html +++ b/doc/doc_files/stringarrayfill.html @@ -7,7 +7,7 @@ -

    sub StringArrayFill(ByRef src$, fdata$)

    +

    Sub StringArrayFill(ByRef src$, fdata$)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArrayFill

    +

    \ No newline at end of file diff --git a/doc/doc_files/stringarraysize.html b/doc/doc_files/stringarraysize.html index a761347..522c478 100644 --- a/doc/doc_files/stringarraysize.html +++ b/doc/doc_files/stringarraysize.html @@ -7,7 +7,7 @@ -

    function StringArraySize(Byref id$, array_dim)

    +

    Function StringArraySize(ByRef id$, array_dim)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArraySize

    +

    \ No newline at end of file diff --git a/doc/doc_files/stringfill.html b/doc/doc_files/stringfill.html index fb98e68..65ff0c0 100644 --- a/doc/doc_files/stringfill.html +++ b/doc/doc_files/stringfill.html @@ -7,11 +7,12 @@ -

    function StringFill$(src$, n)

    +

    Function StringFill$(src$, n)

    Returns a string filled with src$ repeated n times

    +

    \ No newline at end of file diff --git a/doc/doc_files/stringfrombuffer.html b/doc/doc_files/stringfrombuffer.html index 0bc5554..85f9c82 100644 --- a/doc/doc_files/stringfrombuffer.html +++ b/doc/doc_files/stringfrombuffer.html @@ -7,11 +7,12 @@ -

    function StringFromBuffer$(ByRef buffer, buffer_size)

    +

    Function StringFromBuffer$(ByRef buffer, buffer_size)

    Returns a string generated from the character values stored in the buffer

    +

    \ No newline at end of file diff --git a/doc/doc_files/subtractmatrix.html b/doc/doc_files/subtractmatrix.html index efce740..f81ae29 100644 --- a/doc/doc_files/subtractmatrix.html +++ b/doc/doc_files/subtractmatrix.html @@ -7,11 +7,12 @@ -

    function SubtractMatrix(mA, mB, mC)

    +

    Function SubtractMatrix(mA, mB, mC)

    Stores matrix mA minus matrix mB in matrix mC

    +

    \ No newline at end of file diff --git a/doc/doc_files/swapmatrix.html b/doc/doc_files/swapmatrix.html index 9aeb654..2b362ff 100644 --- a/doc/doc_files/swapmatrix.html +++ b/doc/doc_files/swapmatrix.html @@ -7,11 +7,12 @@ -

    sub SwapMatrix(mA, mB)

    +

    Sub SwapMatrix(mA, mB)

    Swaps the contents of 2 matrices

    +

    \ No newline at end of file diff --git a/doc/doc_files/swapmatrixcolumn.html b/doc/doc_files/swapmatrixcolumn.html index d1930ff..21ccc60 100644 --- a/doc/doc_files/swapmatrixcolumn.html +++ b/doc/doc_files/swapmatrixcolumn.html @@ -7,11 +7,12 @@ -

    function SwapMatrixColumn(mA, C1, C2)

    +

    Function SwapMatrixColumn(mA, C1, C2)

    Swaps the contents of 2 columns in a matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/swapmatrixrow.html b/doc/doc_files/swapmatrixrow.html index cafced5..ddcefb2 100644 --- a/doc/doc_files/swapmatrixrow.html +++ b/doc/doc_files/swapmatrixrow.html @@ -7,11 +7,12 @@ -

    function SwapMatrixRow(mA, R1, R2)

    +

    Function SwapMatrixRow(mA, R1, R2)

    Swaps the contents of 2 rows in a matrix

    +

    \ No newline at end of file diff --git a/doc/doc_files/system.html b/doc/doc_files/system.html index ec28956..560729e 100644 --- a/doc/doc_files/system.html +++ b/doc/doc_files/system.html @@ -7,11 +7,12 @@ -

    function System(cmd$)

    +

    Function System(cmd$)

    Runs an operating system command

    +

    \ No newline at end of file diff --git a/doc/doc_files/systemram.html b/doc/doc_files/systemram.html index c4ed040..76bcda7 100644 --- a/doc/doc_files/systemram.html +++ b/doc/doc_files/systemram.html @@ -7,11 +7,12 @@ -

    function SystemRam()

    +

    Function SystemRam()

    Returns the amount of RAM available

    +

    \ No newline at end of file diff --git a/doc/doc_files/systemreturnstdout.html b/doc/doc_files/systemreturnstdout.html index 7aa7ca9..e26b553 100644 --- a/doc/doc_files/systemreturnstdout.html +++ b/doc/doc_files/systemreturnstdout.html @@ -7,7 +7,7 @@ -

    function SystemReturnStdOut$(cmd$)

    +

    Function SystemReturnStdOut$(cmd$)

    Runs an operating system command and returns the output

    @@ -15,6 +15,7 @@ System

    +

    \ No newline at end of file diff --git a/doc/doc_files/tally.html b/doc/doc_files/tally.html index 1c4819c..3c8d370 100644 --- a/doc/doc_files/tally.html +++ b/doc/doc_files/tally.html @@ -7,11 +7,12 @@ -

    function Tally(src$, substr$)

    +

    Function Tally(src$, Substr$)

    Returns the number of instances of substr$ in the src$ string

    +

    \ No newline at end of file diff --git a/doc/doc_files/tan.html b/doc/doc_files/tan.html index 0a3e829..211d81a 100644 --- a/doc/doc_files/tan.html +++ b/doc/doc_files/tan.html @@ -7,11 +7,12 @@ -

    function Tan(n)

    +

    Function Tan(n)

    Returns the tangent of n

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_acceptsocket.html b/doc/doc_files/tcp_acceptsocket.html index 57af5b0..b2e2557 100644 --- a/doc/doc_files/tcp_acceptsocket.html +++ b/doc/doc_files/tcp_acceptsocket.html @@ -7,11 +7,12 @@ -

    function TCP_AcceptSocket(server)

    +

    Function TCP_AcceptSocket(server)

    Attempts to accept a connection from a server socket. If successful it will return a client socket id. If it fails it will return -1.

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_closesocket.html b/doc/doc_files/tcp_closesocket.html index d4080c1..2f10e17 100644 --- a/doc/doc_files/tcp_closesocket.html +++ b/doc/doc_files/tcp_closesocket.html @@ -7,11 +7,12 @@ -

    sub TCP_CloseSocket(socket)

    +

    Sub TCP_CloseSocket(socket)

    Closes a socket

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_getdata.html b/doc/doc_files/tcp_getdata.html index 3d19ae9..c4c3916 100644 --- a/doc/doc_files/tcp_getdata.html +++ b/doc/doc_files/tcp_getdata.html @@ -7,11 +7,12 @@ -

    function TCP_GetData(socket, numBytes, ByRef sData$)

    +

    Function TCP_GetData(socket, numBytes, ByRef sData$)

    Reads a given number of bytes from a socket

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_opensocket.html b/doc/doc_files/tcp_opensocket.html index 1545bdf..9a70708 100644 --- a/doc/doc_files/tcp_opensocket.html +++ b/doc/doc_files/tcp_opensocket.html @@ -7,11 +7,12 @@ -

    function TCP_OpenSocket(host$, port)

    +

    Function TCP_OpenSocket(host$, port)

    Opens a socket to talk to host$ on the given port

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_remotehost.html b/doc/doc_files/tcp_remotehost.html index aeeb9a7..94c651e 100644 --- a/doc/doc_files/tcp_remotehost.html +++ b/doc/doc_files/tcp_remotehost.html @@ -7,11 +7,12 @@ -

    function TCP_RemoteHost(socket)

    +

    Function TCP_RemoteHost(socket)

    Returns the destination host address

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_remoteport.html b/doc/doc_files/tcp_remoteport.html index d17b60a..4a382b8 100644 --- a/doc/doc_files/tcp_remoteport.html +++ b/doc/doc_files/tcp_remoteport.html @@ -7,11 +7,12 @@ -

    function TCP_RemotePort(socket)

    +

    Function TCP_RemotePort(socket)

    Returns the port the socket is connecting on

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_senddata.html b/doc/doc_files/tcp_senddata.html index 342f683..1b59f9c 100644 --- a/doc/doc_files/tcp_senddata.html +++ b/doc/doc_files/tcp_senddata.html @@ -7,11 +7,12 @@ -

    sub TCP_SendData(socket, sData$)

    +

    Sub TCP_SendData(socket, sData$)

    Send data through the given socket.

    +

    \ No newline at end of file diff --git a/doc/doc_files/tcp_socketready.html b/doc/doc_files/tcp_socketready.html index 408fa0b..aa1c9e1 100644 --- a/doc/doc_files/tcp_socketready.html +++ b/doc/doc_files/tcp_socketready.html @@ -7,11 +7,12 @@ -

    function TCP_SocketReady(socket)

    +

    Function TCP_SocketReady(socket)

    Returns 0 for no activity and non zero for activity. You need to call CheckSockets() at some point before this otherwise it will always return 0.

    +

    \ No newline at end of file diff --git a/doc/doc_files/tell.html b/doc/doc_files/tell.html index f583808..e00fb1e 100644 --- a/doc/doc_files/tell.html +++ b/doc/doc_files/tell.html @@ -7,11 +7,12 @@ -

    function Tell(stream)

    +

    Function Tell(stream)

    Returns the current position within the file stream

    +

    \ No newline at end of file diff --git a/doc/doc_files/textheight.html b/doc/doc_files/textheight.html index b0f3f2d..51260b6 100644 --- a/doc/doc_files/textheight.html +++ b/doc/doc_files/textheight.html @@ -7,7 +7,7 @@ -

    function TextHeight(txt$)

    +

    Function TextHeight(txt$)

    The height of text rendered with the active font

    @@ -16,6 +16,7 @@ GetTextSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/textwidth.html b/doc/doc_files/textwidth.html index 8852b65..fa12649 100644 --- a/doc/doc_files/textwidth.html +++ b/doc/doc_files/textwidth.html @@ -7,7 +7,7 @@ -

    function TextWidth(txt$)

    +

    Function TextWidth(txt$)

    The width of text rendered with the active font

    @@ -16,6 +16,7 @@ GetTextSize

    +

    \ No newline at end of file diff --git a/doc/doc_files/ticks.html b/doc/doc_files/ticks.html index cec9e29..73595d8 100644 --- a/doc/doc_files/ticks.html +++ b/doc/doc_files/ticks.html @@ -7,11 +7,12 @@ -

    function Ticks()

    +

    Function Ticks()

    Returns the number of CPU ticks since the start of a program

    +

    \ No newline at end of file diff --git a/doc/doc_files/tilemapexists.html b/doc/doc_files/tilemapexists.html index f990462..e2abe5b 100644 --- a/doc/doc_files/tilemapexists.html +++ b/doc/doc_files/tilemapexists.html @@ -15,6 +15,7 @@ TileSetExists

    +

    \ No newline at end of file diff --git a/doc/doc_files/tilesetexists.html b/doc/doc_files/tilesetexists.html index 29b57d7..27a12ac 100644 --- a/doc/doc_files/tilesetexists.html +++ b/doc/doc_files/tilesetexists.html @@ -15,6 +15,7 @@ TileMapExists

    +

    \ No newline at end of file diff --git a/doc/doc_files/time.html b/doc/doc_files/time.html index 2e0bc47..9878a16 100644 --- a/doc/doc_files/time.html +++ b/doc/doc_files/time.html @@ -7,11 +7,12 @@ -

    function Time$()

    +

    Function Time$()

    Returns the current time in "HH:MM:SS" format

    +

    \ No newline at end of file diff --git a/doc/doc_files/timer.html b/doc/doc_files/timer.html index 813b266..8f0a639 100644 --- a/doc/doc_files/timer.html +++ b/doc/doc_files/timer.html @@ -7,11 +7,12 @@ -

    function Timer()

    +

    Function Timer()

    Returns the number of milliseconds since the start of the program.

    +

    \ No newline at end of file diff --git a/doc/doc_files/touchpressure.html b/doc/doc_files/touchpressure.html index 76e0774..0eb2d01 100644 --- a/doc/doc_files/touchpressure.html +++ b/doc/doc_files/touchpressure.html @@ -7,11 +7,12 @@ -

    function TouchPressure()

    +

    Function TouchPressure()

    Returns the touch pressure of a touch event.

    +

    \ No newline at end of file diff --git a/doc/doc_files/touchx.html b/doc/doc_files/touchx.html index 6df8b2c..32bc849 100644 --- a/doc/doc_files/touchx.html +++ b/doc/doc_files/touchx.html @@ -7,7 +7,7 @@ -

    function TouchX()

    +

    Function TouchX()

    Return the X Position of a touch event

    @@ -17,6 +17,7 @@ GetTouchFinger

    +

    \ No newline at end of file diff --git a/doc/doc_files/touchy.html b/doc/doc_files/touchy.html index b6dee75..899c3be 100644 --- a/doc/doc_files/touchy.html +++ b/doc/doc_files/touchy.html @@ -7,7 +7,7 @@ -

    function TouchY()

    +

    Function TouchY()

    Return the Y Position of a touch event

    @@ -17,6 +17,7 @@ GetTouchFinger

    +

    \ No newline at end of file diff --git a/doc/doc_files/translateactorlocal.html b/doc/doc_files/translateactorlocal.html index e6c2f7c..d5fd6f5 100644 --- a/doc/doc_files/translateactorlocal.html +++ b/doc/doc_files/translateactorlocal.html @@ -7,11 +7,12 @@ -

    sub TranslateActorLocal( actor, x, y, z )

    +

    Sub TranslateActorLocal( actor, x, y, z )

    Moves an actor relative to its current position

    +

    \ No newline at end of file diff --git a/doc/doc_files/translateactorworld.html b/doc/doc_files/translateactorworld.html index 7147fce..3373b5d 100644 --- a/doc/doc_files/translateactorworld.html +++ b/doc/doc_files/translateactorworld.html @@ -7,11 +7,12 @@ -

    sub TranslateActorWorld( actor, x, y, z )

    +

    Sub TranslateActorWorld( actor, x, y, z )

    Moves an actor relative to its current position

    +

    \ No newline at end of file diff --git a/doc/doc_files/translatecamera.html b/doc/doc_files/translatecamera.html index 5c7c46b..89c2518 100644 --- a/doc/doc_files/translatecamera.html +++ b/doc/doc_files/translatecamera.html @@ -7,11 +7,12 @@ -

    sub TranslateCamera( x, y, z)

    +

    Sub TranslateCamera( x, y, z)

    Moves the camera relative to its current position

    +

    \ No newline at end of file diff --git a/doc/doc_files/translatesprite.html b/doc/doc_files/translatesprite.html index 11f67fb..646e0a3 100644 --- a/doc/doc_files/translatesprite.html +++ b/doc/doc_files/translatesprite.html @@ -19,6 +19,7 @@ GetSpritePosition

    +

    \ No newline at end of file diff --git a/doc/doc_files/transposematrix.html b/doc/doc_files/transposematrix.html index eebd419..8273099 100644 --- a/doc/doc_files/transposematrix.html +++ b/doc/doc_files/transposematrix.html @@ -7,11 +7,12 @@ -

    function TransposeMatrix(mA, mB)

    +

    Function TransposeMatrix(mA, mB)

    Stores the transpose of matrix mA in matrix mB

    +

    \ No newline at end of file diff --git a/doc/doc_files/triangle.html b/doc/doc_files/triangle.html index ab9dc03..5333b7e 100644 --- a/doc/doc_files/triangle.html +++ b/doc/doc_files/triangle.html @@ -7,11 +7,12 @@ -

    sub Triangle(x1, y1, x2, y2, x3, y3)

    +

    Sub Triangle(x1, y1, x2, y2, x3, y3)

    Draws a filled Triangle

    +

    \ No newline at end of file diff --git a/doc/doc_files/triangle3d.html b/doc/doc_files/triangle3d.html index 95dd959..08e5c53 100644 --- a/doc/doc_files/triangle3d.html +++ b/doc/doc_files/triangle3d.html @@ -7,11 +7,12 @@ -

    sub Triangle3D(x1, y1, z1, x2, y2, z2, x3, y3, z3)

    +

    Sub Triangle3D(x1, y1, z1, x2, y2, z2, x3, y3, z3)

    Draws a triangle in 3D space

    +

    \ No newline at end of file diff --git a/doc/doc_files/trim.html b/doc/doc_files/trim.html index 888f6a2..58f3034 100644 --- a/doc/doc_files/trim.html +++ b/doc/doc_files/trim.html @@ -7,11 +7,12 @@ -

    function Trim$(src$)

    +

    Function Trim$(src$)

    Returns src$ with all leading and trailing spaces removed

    +

    \ No newline at end of file diff --git a/doc/doc_files/typearraycopy.html b/doc/doc_files/typearraycopy.html index 31eb52e..405cf73 100644 --- a/doc/doc_files/typearraycopy.html +++ b/doc/doc_files/typearraycopy.html @@ -7,7 +7,7 @@ -

    sub TypeArrayCopy(ByRef src as empty, ByRef dst as empty)

    +

    Sub TypeArrayCopy(ByRef src as empty, ByRef dst as empty)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArrayCopy

    +

    \ No newline at end of file diff --git a/doc/doc_files/typearraydim.html b/doc/doc_files/typearraydim.html index c1b7213..5bdfe85 100644 --- a/doc/doc_files/typearraydim.html +++ b/doc/doc_files/typearraydim.html @@ -7,7 +7,7 @@ -

    function TypeArrayDim(Byref id as empty)

    +

    Function TypeArrayDim(ByRef id as empty)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArrayDim

    +

    \ No newline at end of file diff --git a/doc/doc_files/typearrayfill.html b/doc/doc_files/typearrayfill.html index a93ae77..28029ff 100644 --- a/doc/doc_files/typearrayfill.html +++ b/doc/doc_files/typearrayfill.html @@ -7,7 +7,7 @@ -

    sub TypeArrayFill(ByRef src as empty, fdata as empty)

    +

    Sub TypeArrayFill(ByRef src as empty, fdata as empty)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArrayFill

    +

    \ No newline at end of file diff --git a/doc/doc_files/typearraysize.html b/doc/doc_files/typearraysize.html index 67be110..6c132e3 100644 --- a/doc/doc_files/typearraysize.html +++ b/doc/doc_files/typearraysize.html @@ -7,7 +7,7 @@ -

    function TypeArraySize(Byref id as empty, array_dim)

    +

    Function TypeArraySize(ByRef id as empty, array_dim)

    This function is exists to be internally called by the runtime but should not be called directly.

    @@ -18,6 +18,7 @@ ArraySize

    +

    \ No newline at end of file diff --git a/doc/doc_files/ucase.html b/doc/doc_files/ucase.html index 23d0d2e..15b7714 100644 --- a/doc/doc_files/ucase.html +++ b/doc/doc_files/ucase.html @@ -7,11 +7,12 @@ -

    function Ucase$(src$)

    +

    Function Ucase$(src$)

    Returns src$ with all characters uppercase

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_closesocket.html b/doc/doc_files/udp_closesocket.html index 77c1f24..8341008 100644 --- a/doc/doc_files/udp_closesocket.html +++ b/doc/doc_files/udp_closesocket.html @@ -7,11 +7,12 @@ -

    sub UDP_CloseSocket(socket)

    +

    Sub UDP_CloseSocket(socket)

    Closes a UDP Socket

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_getdata.html b/doc/doc_files/udp_getdata.html index 4d195aa..b29a923 100644 --- a/doc/doc_files/udp_getdata.html +++ b/doc/doc_files/udp_getdata.html @@ -7,11 +7,12 @@ -

    function UDP_GetData(socket, byref host$, byref port, byref sData$)

    +

    Function UDP_GetData(socket, ByRef host$, ByRef port, ByRef sData$)

    Reads data from a udp socket.

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_length.html b/doc/doc_files/udp_length.html index 061a3e0..fa0f402 100644 --- a/doc/doc_files/udp_length.html +++ b/doc/doc_files/udp_length.html @@ -7,11 +7,12 @@ -

    function UDP_Length()

    +

    Function UDP_Length()

    Returns the number of bytes read from a udp socket

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_maxlength.html b/doc/doc_files/udp_maxlength.html index 6323217..49769ce 100644 --- a/doc/doc_files/udp_maxlength.html +++ b/doc/doc_files/udp_maxlength.html @@ -7,11 +7,12 @@ -

    function UDP_MaxLength()

    +

    Function UDP_MaxLength()

    Returns the maximum number of bytes from a udp socket

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_opensocket.html b/doc/doc_files/udp_opensocket.html index cc77368..f643afb 100644 --- a/doc/doc_files/udp_opensocket.html +++ b/doc/doc_files/udp_opensocket.html @@ -7,11 +7,12 @@ -

    function UDP_OpenSocket(port)

    +

    Function UDP_OpenSocket(port)

    Opens a UDP socket

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_remotehost.html b/doc/doc_files/udp_remotehost.html index c7b5ba2..71e2283 100644 --- a/doc/doc_files/udp_remotehost.html +++ b/doc/doc_files/udp_remotehost.html @@ -7,11 +7,12 @@ -

    function UDP_RemoteHost$(socket)

    +

    Function UDP_RemoteHost$(socket)

    Returns the connected host in a udp connection

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_remoteport.html b/doc/doc_files/udp_remoteport.html index f3ab41b..1de3b83 100644 --- a/doc/doc_files/udp_remoteport.html +++ b/doc/doc_files/udp_remoteport.html @@ -7,11 +7,12 @@ -

    function UDP_RemotePort(socket)

    +

    Function UDP_RemotePort(socket)

    Returns the port the socket is connected on.

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_senddata.html b/doc/doc_files/udp_senddata.html index 5784dda..3a2df59 100644 --- a/doc/doc_files/udp_senddata.html +++ b/doc/doc_files/udp_senddata.html @@ -7,11 +7,12 @@ -

    sub UDP_SendData(socket, host$, port, sData$)

    +

    Sub UDP_SendData(socket, host$, port, sData$)

    Sends data to a host using UDP

    +

    \ No newline at end of file diff --git a/doc/doc_files/udp_socketready.html b/doc/doc_files/udp_socketready.html index 0d58e74..2b928e6 100644 --- a/doc/doc_files/udp_socketready.html +++ b/doc/doc_files/udp_socketready.html @@ -7,7 +7,7 @@ -

    function UDP_SocketReady(socket)

    +

    Function UDP_SocketReady(socket)

    Returns 0 for no activity and non zero for activity. You need to call CheckSockets() at some point before this otherwise it will always return 0.

    @@ -20,6 +20,7 @@ CheckSockets

    +

    \ No newline at end of file diff --git a/doc/doc_files/udt.html b/doc/doc_files/udt.html index 5f26144..f95c75b 100644 --- a/doc/doc_files/udt.html +++ b/doc/doc_files/udt.html @@ -68,6 +68,7 @@ If used effectively, you can drastically increase the readability and maintainability of your code. Especially in large projects.

    +

    \ No newline at end of file diff --git a/doc/doc_files/unaugmentmatrix.html b/doc/doc_files/unaugmentmatrix.html index 42c82cc..c777df8 100644 --- a/doc/doc_files/unaugmentmatrix.html +++ b/doc/doc_files/unaugmentmatrix.html @@ -7,11 +7,12 @@ -

    function UnAugmentMatrix(mA, mB, mC)

    +

    Function UnAugmentMatrix(mA, mB, mC)

    Splits matrix mA into coefficient mB and augment mC

    +

    \ No newline at end of file diff --git a/doc/doc_files/update.html b/doc/doc_files/update.html index 724af65..436213c 100644 --- a/doc/doc_files/update.html +++ b/doc/doc_files/update.html @@ -7,7 +7,7 @@ -

    sub Update()

    +

    Sub Update()

    This is the most important function in a graphics window. It must be called every frame.

    @@ -43,6 +43,7 @@ If you have a window open, you should have this function being called in your main render loop every frame.

    +

    \ No newline at end of file diff --git a/doc/doc_files/updateactorinertiatensor.html b/doc/doc_files/updateactorinertiatensor.html index ae77614..bcdac46 100644 --- a/doc/doc_files/updateactorinertiatensor.html +++ b/doc/doc_files/updateactorinertiatensor.html @@ -3,15 +3,16 @@ - updateActorInertiaTensor [RCBasic Doc] + UpdateActorInertiaTensor [RCBasic Doc] -

    sub updateActorInertiaTensor( actor)

    +

    Sub UpdateActorInertiaTensor( actor)

    Recalculates the inertia tensor of an actor, which is essential for accurately simulating how the actor reacts to forces and torques during its motion. The inertia tensor defines how the mass of the body is distributed in space and influences how the body rotates in response to applied torques.

    +

    \ No newline at end of file diff --git a/doc/doc_files/useconstraintframeoffset.html b/doc/doc_files/useconstraintframeoffset.html index 1746c40..d265ab7 100644 --- a/doc/doc_files/useconstraintframeoffset.html +++ b/doc/doc_files/useconstraintframeoffset.html @@ -3,11 +3,11 @@ - useConstraintFrameOffset [RCBasic Doc] + UseConstraintFrameOffset [RCBasic Doc] -

    sub useConstraintFrameOffset( constraint_id, flag)

    +

    Sub UseConstraintFrameOffset( constraint_id, flag)

    Enables or disables the use of frame offsets in a constraint. When frame offsets are used, the constraint operates relative to specific local frames defined in the two connected actors, rather than directly in the world frame.

    @@ -15,6 +15,7 @@ Note: Only applies to the hinge and slide constraint

    +

    \ No newline at end of file diff --git a/doc/doc_files/usehingereferenceframea.html b/doc/doc_files/usehingereferenceframea.html index c8cb9b2..b87f5bc 100644 --- a/doc/doc_files/usehingereferenceframea.html +++ b/doc/doc_files/usehingereferenceframea.html @@ -3,11 +3,11 @@ - useHingeReferenceFrameA [RCBasic Doc] + UseHingeReferenceFrameA [RCBasic Doc] -

    sub useHingeReferenceFrameA( constraint_id, flag)

    +

    Sub UseHingeReferenceFrameA( constraint_id, flag)

    Allows you to specify which actor's local reference frame is used to determine the hinge’s angular limits and motor direction.

    @@ -15,6 +15,7 @@ When flag is true the hinge constraint will use actor A's reference frame as the basis for calculating angular limits and motor directions.

    +

    \ No newline at end of file diff --git a/doc/doc_files/useparticleeverymeshvertex.html b/doc/doc_files/useparticleeverymeshvertex.html index 6065280..96bef76 100644 --- a/doc/doc_files/useparticleeverymeshvertex.html +++ b/doc/doc_files/useparticleeverymeshvertex.html @@ -3,11 +3,11 @@ - useParticleEveryMeshVertex [RCBasic Doc] + UseParticleEveryMeshVertex [RCBasic Doc] -

    sub useParticleEveryMeshVertex( actor, flag)

    +

    Sub UseParticleEveryMeshVertex( actor, flag)

    Sets whether to emit min<->max particles for every vertex or to pick min<->max vertices.

    @@ -15,6 +15,7 @@ particleIsUsingEveryMeshVertex

    +

    \ No newline at end of file diff --git a/doc/doc_files/useparticlenormaldirection.html b/doc/doc_files/useparticlenormaldirection.html index 9f30d4b..22ea6c1 100644 --- a/doc/doc_files/useparticlenormaldirection.html +++ b/doc/doc_files/useparticlenormaldirection.html @@ -3,11 +3,11 @@ - useParticleNormalDirection [RCBasic Doc] + UseParticleNormalDirection [RCBasic Doc] -

    sub useParticleNormalDirection( actor, flag)

    +

    Sub UseParticleNormalDirection( actor, flag)

    Sets whether particle emitter is using vertex normal for direction, or direction specified.

    @@ -15,6 +15,7 @@ particleIsUsingNormalDirection

    +

    \ No newline at end of file diff --git a/doc/doc_files/useparticleoutlineonly.html b/doc/doc_files/useparticleoutlineonly.html index 0524db2..c704ae6 100644 --- a/doc/doc_files/useparticleoutlineonly.html +++ b/doc/doc_files/useparticleoutlineonly.html @@ -3,11 +3,11 @@ - useParticleOutlineOnly [RCBasic Doc] + UseParticleOutlineOnly [RCBasic Doc] -

    sub useParticleOutlineOnly( actor, flag)

    +

    Sub UseParticleOutlineOnly( actor, flag)

    Set whether or not to draw points inside the cylinder.

    @@ -18,6 +18,7 @@ particleIsUsingOutlineOnly

    +

    \ No newline at end of file diff --git a/doc/doc_files/val.html b/doc/doc_files/val.html index bb16765..3253fd3 100644 --- a/doc/doc_files/val.html +++ b/doc/doc_files/val.html @@ -7,7 +7,7 @@ -

    function Val(n$)

    +

    Function Val(n$)

    Converts a string to a number and returns the value.

    @@ -15,6 +15,7 @@ Returns 0 if the string was not a valid number.

    +

    \ No newline at end of file diff --git a/doc/doc_files/var_data.html b/doc/doc_files/var_data.html index e1a4e4e..380a0ef 100644 --- a/doc/doc_files/var_data.html +++ b/doc/doc_files/var_data.html @@ -54,6 +54,7 @@ Dim A, B$, C

    +

    \ No newline at end of file diff --git a/doc/doc_files/videoend.html b/doc/doc_files/videoend.html index 0c54bb4..1d770b0 100644 --- a/doc/doc_files/videoend.html +++ b/doc/doc_files/videoend.html @@ -7,11 +7,12 @@ -

    function VideoEnd()

    +

    Function VideoEnd()

    Returns true when the currently playing video reaches the end

    +

    \ No newline at end of file diff --git a/doc/doc_files/videoexists.html b/doc/doc_files/videoexists.html index be0496c..a67b573 100644 --- a/doc/doc_files/videoexists.html +++ b/doc/doc_files/videoexists.html @@ -7,11 +7,12 @@ -

    function VideoExists()

    +

    Function VideoExists()

    Returns true if there is a video loaded

    +

    \ No newline at end of file diff --git a/doc/doc_files/videoisplaying.html b/doc/doc_files/videoisplaying.html index 117f66d..a2f3cea 100644 --- a/doc/doc_files/videoisplaying.html +++ b/doc/doc_files/videoisplaying.html @@ -7,11 +7,12 @@ -

    function VideoIsPlaying()

    +

    Function VideoIsPlaying()

    Returns true if a video is playing

    +

    \ No newline at end of file diff --git a/doc/doc_files/wait.html b/doc/doc_files/wait.html index ec887cb..0300110 100644 --- a/doc/doc_files/wait.html +++ b/doc/doc_files/wait.html @@ -7,11 +7,12 @@ -

    sub Wait(m_sec)

    +

    Sub Wait(m_sec)

    Halts execution of a program for a given number of milliseconds.

    +

    \ No newline at end of file diff --git a/doc/doc_files/waitkey.html b/doc/doc_files/waitkey.html index 4597cdc..4d2026b 100644 --- a/doc/doc_files/waitkey.html +++ b/doc/doc_files/waitkey.html @@ -7,11 +7,12 @@ -

    function WaitKey()

    +

    Function WaitKey()

    Halts execution of a program until a key is pressed.

    +

    \ No newline at end of file diff --git a/doc/doc_files/warpmouse.html b/doc/doc_files/warpmouse.html index ce8f44a..21b861f 100644 --- a/doc/doc_files/warpmouse.html +++ b/doc/doc_files/warpmouse.html @@ -7,11 +7,12 @@ -

    sub WarpMouse(x, y)

    +

    Sub WarpMouse(x, y)

    Move the mouse cursor to xy position in the window

    +

    \ No newline at end of file diff --git a/doc/doc_files/warpmouseglobal.html b/doc/doc_files/warpmouseglobal.html index 184a6d9..fb38ce4 100644 --- a/doc/doc_files/warpmouseglobal.html +++ b/doc/doc_files/warpmouseglobal.html @@ -7,11 +7,12 @@ -

    sub WarpMouseGlobal(x, y)

    +

    Sub WarpMouseGlobal(x, y)

    Move the mouse cursor to xy position in the display

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowclip.html b/doc/doc_files/windowclip.html index 9b39ea0..b01576a 100644 --- a/doc/doc_files/windowclip.html +++ b/doc/doc_files/windowclip.html @@ -7,7 +7,7 @@ -

    function WindowClip(x, y, w, h)

    +

    Function WindowClip(x, y, w, h)

    Returns an image with a portion of the window stored

    @@ -15,6 +15,7 @@ CanvasClip

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowevent_close.html b/doc/doc_files/windowevent_close.html index cfd4652..116ee70 100644 --- a/doc/doc_files/windowevent_close.html +++ b/doc/doc_files/windowevent_close.html @@ -7,11 +7,12 @@ -

    function WindowEvent_Close()

    +

    Function WindowEvent_Close()

    Returns true if the window close event is called.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowevent_maximize.html b/doc/doc_files/windowevent_maximize.html index 0771210..59acd53 100644 --- a/doc/doc_files/windowevent_maximize.html +++ b/doc/doc_files/windowevent_maximize.html @@ -7,11 +7,12 @@ -

    function WindowEvent_Maximize()

    +

    Function WindowEvent_Maximize()

    Returns true if the window maximize event is called.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowevent_minimize.html b/doc/doc_files/windowevent_minimize.html index 7300635..25362bd 100644 --- a/doc/doc_files/windowevent_minimize.html +++ b/doc/doc_files/windowevent_minimize.html @@ -7,11 +7,12 @@ -

    function WindowEvent_Minimize()

    +

    Function WindowEvent_Minimize()

    Returns true if the window minimize event is called.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowevent_resize.html b/doc/doc_files/windowevent_resize.html index d8e6529..b8f915a 100644 --- a/doc/doc_files/windowevent_resize.html +++ b/doc/doc_files/windowevent_resize.html @@ -7,11 +7,12 @@ -

    function WindowEvent_Resize()

    +

    Function WindowEvent_Resize()

    Returns true if the window resize event is called.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowexists.html b/doc/doc_files/windowexists.html index 3611124..a71d7db 100644 --- a/doc/doc_files/windowexists.html +++ b/doc/doc_files/windowexists.html @@ -7,11 +7,12 @@ -

    function WindowExists()

    +

    Function WindowExists()

    Returns true if the window is open

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowhasinputfocus.html b/doc/doc_files/windowhasinputfocus.html index 45662a4..42cd46f 100644 --- a/doc/doc_files/windowhasinputfocus.html +++ b/doc/doc_files/windowhasinputfocus.html @@ -7,11 +7,12 @@ -

    function WindowHasInputFocus()

    +

    Function WindowHasInputFocus()

    Returns true if the window has input focus, otherwise it returns false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowhasmousefocus.html b/doc/doc_files/windowhasmousefocus.html index 3da56fd..28d2f90 100644 --- a/doc/doc_files/windowhasmousefocus.html +++ b/doc/doc_files/windowhasmousefocus.html @@ -7,11 +7,12 @@ -

    function WindowHasMouseFocus()

    +

    Function WindowHasMouseFocus()

    Returns true if the window has mouse focus, otherwise it returns false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowisbordered.html b/doc/doc_files/windowisbordered.html index 97a56b1..f1c5031 100644 --- a/doc/doc_files/windowisbordered.html +++ b/doc/doc_files/windowisbordered.html @@ -7,11 +7,12 @@ -

    function WindowIsBordered()

    +

    Function WindowIsBordered()

    Returns true if the window has a border, otherwise it will return false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowisfullscreen.html b/doc/doc_files/windowisfullscreen.html index 9a493e0..6f9f8e8 100644 --- a/doc/doc_files/windowisfullscreen.html +++ b/doc/doc_files/windowisfullscreen.html @@ -7,11 +7,12 @@ -

    function WindowIsFullscreen()

    +

    Function WindowIsFullscreen()

    Returns true if the window is fullscreen, otherwise it will return false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowisgrabbed.html b/doc/doc_files/windowisgrabbed.html index 0ad0977..e92b5cb 100644 --- a/doc/doc_files/windowisgrabbed.html +++ b/doc/doc_files/windowisgrabbed.html @@ -7,11 +7,12 @@ -

    function WindowIsGrabbed( )

    +

    Function WindowIsGrabbed( )

    Returns the window that is currently grabbing input. It returns -1 on failure.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowismaximized.html b/doc/doc_files/windowismaximized.html index 1e41434..7e60185 100644 --- a/doc/doc_files/windowismaximized.html +++ b/doc/doc_files/windowismaximized.html @@ -7,11 +7,12 @@ -

    function WindowIsMaximized()

    +

    Function WindowIsMaximized()

    Returns true if the window is maximized, otherwise it will return false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowisminimized.html b/doc/doc_files/windowisminimized.html index bebd6a4..7d9d49f 100644 --- a/doc/doc_files/windowisminimized.html +++ b/doc/doc_files/windowisminimized.html @@ -7,11 +7,12 @@ -

    function WindowIsMinimized()

    +

    Function WindowIsMinimized()

    Returns true if the window is minimized, otherwise it will return false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowisresizable.html b/doc/doc_files/windowisresizable.html index 4adbfa3..ae2f63a 100644 --- a/doc/doc_files/windowisresizable.html +++ b/doc/doc_files/windowisresizable.html @@ -7,11 +7,12 @@ -

    function WindowIsResizable()

    +

    Function WindowIsResizable()

    Returns true if the window is resizable, otherwise it will return false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowisvisible.html b/doc/doc_files/windowisvisible.html index 62ad21a..28bd372 100644 --- a/doc/doc_files/windowisvisible.html +++ b/doc/doc_files/windowisvisible.html @@ -7,11 +7,12 @@ -

    function WindowIsVisible()

    +

    Function WindowIsVisible()

    Returns true if the window is visible, otherwise it returns false.

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowmode.html b/doc/doc_files/windowmode.html index 3013cdd..c6a426c 100644 --- a/doc/doc_files/windowmode.html +++ b/doc/doc_files/windowmode.html @@ -7,7 +7,7 @@ -

    function WindowMode(visible, fullscreen, resizable, borderless, highDPI)

    +

    Function WindowMode(visible, fullscreen, resizable, borderless, highDPI)

    Returns a bitmask of the combined window flags that can be used in OpenWindow() to set the mode for the window.

    @@ -34,6 +34,7 @@ GetWindowMode

    +

    \ No newline at end of file diff --git a/doc/doc_files/windowtitle.html b/doc/doc_files/windowtitle.html index f833cd0..ea70e15 100644 --- a/doc/doc_files/windowtitle.html +++ b/doc/doc_files/windowtitle.html @@ -7,7 +7,7 @@ -

    function WindowTitle$( )

    +

    Function WindowTitle$( )

    Returns the window title

    @@ -15,6 +15,7 @@ SetWindowTitle

    +

    \ No newline at end of file diff --git a/doc/doc_files/write.html b/doc/doc_files/write.html index 859d72c..b09229e 100644 --- a/doc/doc_files/write.html +++ b/doc/doc_files/write.html @@ -7,7 +7,7 @@ -

    sub Write(stream, txt$)

    +

    Sub Write(stream, txt$)

    Writes a string to a file.

    @@ -15,6 +15,7 @@ WriteLine

    +

    \ No newline at end of file diff --git a/doc/doc_files/writebyte.html b/doc/doc_files/writebyte.html index d760352..c98b5e0 100644 --- a/doc/doc_files/writebyte.html +++ b/doc/doc_files/writebyte.html @@ -7,7 +7,7 @@ -

    sub WriteByte(stream, byte)

    +

    Sub WriteByte(stream, byte)

    Writes a byte to the file.

    @@ -15,6 +15,7 @@ WriteByteBuffer

    +

    \ No newline at end of file diff --git a/doc/doc_files/writebytebuffer.html b/doc/doc_files/writebytebuffer.html index 5534572..d91c030 100644 --- a/doc/doc_files/writebytebuffer.html +++ b/doc/doc_files/writebytebuffer.html @@ -7,11 +7,12 @@ -

    function WriteByteBuffer(stream, ByRef buf, buf_size)

    +

    Function WriteByteBuffer(stream, ByRef buf, buf_size)

    Writes a number of bytes from a buffer to the file stream.

    +

    \ No newline at end of file diff --git a/doc/doc_files/writeline.html b/doc/doc_files/writeline.html index 126cd6f..46788f7 100644 --- a/doc/doc_files/writeline.html +++ b/doc/doc_files/writeline.html @@ -7,7 +7,7 @@ -

    sub WriteLine(stream, txt$)

    +

    Sub WriteLine(stream, txt$)

    Writes a string to a text file with a new-line appended at the end

    @@ -16,6 +16,7 @@ ReadLine$

    +

    \ No newline at end of file diff --git a/doc/doc_files/xorbit.html b/doc/doc_files/xorbit.html index 81d1fe0..ed4638c 100644 --- a/doc/doc_files/xorbit.html +++ b/doc/doc_files/xorbit.html @@ -7,7 +7,7 @@ -

    function XOrBit(a, b)

    +

    Function XOrBit(a, b)

    Returns the value of the bitwise XOR operation on the operands A and B

    @@ -16,6 +16,7 @@ AndBit

    +

    \ No newline at end of file diff --git a/doc/doc_files/zeromatrix.html b/doc/doc_files/zeromatrix.html index 2700775..fea9116 100644 --- a/doc/doc_files/zeromatrix.html +++ b/doc/doc_files/zeromatrix.html @@ -7,7 +7,7 @@ -

    sub ZeroMatrix(mA)

    +

    Sub ZeroMatrix(mA)

    Clears a matrix

    @@ -18,6 +18,7 @@ ClearMatrix

    +

    \ No newline at end of file diff --git a/doc/files/abs.txt b/doc/files/abs.txt index 2e9aecd..e4bd60a 100644 --- a/doc/files/abs.txt +++ b/doc/files/abs.txt @@ -1,4 +1,5 @@ #title Abs [RCBasic Doc] -#header function Abs(n) +#header Function Abs(n) Returns the absolute value of n + diff --git a/doc/files/accelname.txt b/doc/files/accelname.txt index 9acdb1e..12d34a6 100644 --- a/doc/files/accelname.txt +++ b/doc/files/accelname.txt @@ -1,6 +1,7 @@ #title AccelName$ [RCBasic Doc] -#header function AccelName$(accel_num) +#header Function AccelName$(accel_num) Returns the name of an accelerometer + diff --git a/doc/files/acos.txt b/doc/files/acos.txt index 0553ead..154eaa6 100644 --- a/doc/files/acos.txt +++ b/doc/files/acos.txt @@ -1,4 +1,5 @@ #title Acos [RCBasic Doc] -#header function Acos(n) +#header Function Acos(n) Returns the Arcosine of n + diff --git a/doc/files/activecanvas.txt b/doc/files/activecanvas.txt index 11e416b..51bcd7a 100644 --- a/doc/files/activecanvas.txt +++ b/doc/files/activecanvas.txt @@ -1,5 +1,5 @@ #title ActiveCanvas [RCBasic Doc] -#header function ActiveCanvas() +#header Function ActiveCanvas() Returns the canvas that drawing commands are currently applied to @@ -20,3 +20,4 @@ If ActiveCanvas() = c2 Then Print "Active canvas is now c2" End If #/code + diff --git a/doc/files/activefont.txt b/doc/files/activefont.txt new file mode 100644 index 0000000..09e2385 --- /dev/null +++ b/doc/files/activefont.txt @@ -0,0 +1,15 @@ +#title ActiveFont [RCBasic Doc] +#header Function ActiveFont() + +Returns the current font that will be used with DrawText + +#code +test_font = LoadFont("test_font.ttf", 12) +SetFont(test_font) +If ActiveFont() = test_font Then + Print "Test Font is active" +End If +#/code + +#ref LoadFont SetFont DrawText + diff --git a/doc/files/actoranimationislooped.txt b/doc/files/actoranimationislooped.txt deleted file mode 100644 index 81c89ee..0000000 --- a/doc/files/actoranimationislooped.txt +++ /dev/null @@ -1,8 +0,0 @@ -#title ActorAnimationIsLooped [RCBasic Doc] -#header function ActorAnimationIsLooped( actor ) - -Returns true if an actors animation is set to looped. - -Note: Actor animation is set to looped with the LoopActorAnimation() function. - -#ref LoopActorAnimation diff --git a/doc/files/actoranimationisplaying.txt b/doc/files/actoranimationisplaying.txt index e833853..2a0d61e 100644 --- a/doc/files/actoranimationisplaying.txt +++ b/doc/files/actoranimationisplaying.txt @@ -1,6 +1,7 @@ #title ActorAnimationIsPlaying [RCBasic Doc] -#header function ActorAnimationIsPlaying(actor) +#header Function ActorAnimationIsPlaying(actor) Returns true if an actor is currently playing an animation Note: If the number of loops in the animation is set to -1 then this will always be true since it does not return false until it plays the last frame in the last loop + diff --git a/doc/files/actorexists.txt b/doc/files/actorexists.txt index 2b585c8..85fd863 100644 --- a/doc/files/actorexists.txt +++ b/doc/files/actorexists.txt @@ -1,4 +1,5 @@ #title ActorExists [RCBasic Doc] -#header function ActorExists( actor ) +#header Function ActorExists( actor ) Returns true if the id passed is a valid actor + diff --git a/doc/files/actorisintransition.txt b/doc/files/actorisintransition.txt deleted file mode 100644 index 6839ff7..0000000 --- a/doc/files/actorisintransition.txt +++ /dev/null @@ -1,6 +0,0 @@ -#title ActorIsInTransition [RCBasic Doc] -#header function ActorIsInTransition( actor ) - -Returns true if actor is in a transition from its current frame to the frame set in the StartActorTransition() function - -#ref StartActorTransition StopActorTransition GetActorTransitionTime diff --git a/doc/files/actorissolid.txt b/doc/files/actorissolid.txt index 8233454..6a28a69 100644 --- a/doc/files/actorissolid.txt +++ b/doc/files/actorissolid.txt @@ -1,5 +1,5 @@ #title ActorIsSolid [RCBasic Doc] -#header function ActorIsSolid(actor) +#header Function ActorIsSolid(actor) Returns true or false depending on if physics and collision response applies to an actor. @@ -13,3 +13,4 @@ Print "Actor solid state: "; ActorIsSolid(actor) 'This will output 0 #/end #ref SetActorSolid + diff --git a/doc/files/actorisvisible.txt b/doc/files/actorisvisible.txt index 3b85c29..4e05419 100644 --- a/doc/files/actorisvisible.txt +++ b/doc/files/actorisvisible.txt @@ -1,5 +1,5 @@ #title ActorIsVisible [RCBasic Doc] -#header function ActorIsVisible( actor ) +#header Function ActorIsVisible( actor ) Returns true if an actor is visible @@ -11,3 +11,4 @@ Print "Actor solid state: "; ActorIsSolid(actor) 'Outputs 0 #/code #ref SetActorVisible + diff --git a/doc/files/addactorshadow.txt b/doc/files/addactorshadow.txt index 4680595..62f198a 100644 --- a/doc/files/addactorshadow.txt +++ b/doc/files/addactorshadow.txt @@ -1,5 +1,5 @@ #title AddActorShadow [RCBasic Doc] -#header sub AddActorShadow( actor ) +#header Sub AddActorShadow( actor ) Cast a shadow on an actor during lighting calculations @@ -7,3 +7,4 @@ Note: Also check the section on lights for more info #ref RemoveActorShadow + diff --git a/doc/files/addcompositechild.txt b/doc/files/addcompositechild.txt new file mode 100644 index 0000000..710d33a --- /dev/null +++ b/doc/files/addcompositechild.txt @@ -0,0 +1,11 @@ +#title AddCompositeChild [RCBasic Doc] +#header Function AddCompositeChild(actor, child_actor, t_matrix) + +Adds a child Actor to a composite actor. + +Returns the child index in the composite actor. + +NOTE: Reference the included Composite Demo for an example + +#ref CreateCompositeActor + diff --git a/doc/files/addmatrix.txt b/doc/files/addmatrix.txt index dd6365e..abe2c47 100644 --- a/doc/files/addmatrix.txt +++ b/doc/files/addmatrix.txt @@ -1,4 +1,5 @@ #title AddMatrix [RCBasic Doc] -#header function AddMatrix(mA, mB, mC) +#header Function AddMatrix(mA, mB, mC) Adds matrix mA to matrix mB and stores the results in mC + diff --git a/doc/files/addmeshbuffer.txt b/doc/files/addmeshbuffer.txt index c9f8296..3ba76ed 100644 --- a/doc/files/addmeshbuffer.txt +++ b/doc/files/addmeshbuffer.txt @@ -1,6 +1,7 @@ #title AddMeshBuffer [RCBasic Doc] -#header sub AddMeshBuffer( mesh, vertex_count, ByRef vertex_data, ByRef normal_data, ByRef uv_data, index_count, ByRef index_data ) +#header Sub AddMeshBuffer( mesh, vertex_count, ByRef vertex_data, ByRef normal_data, ByRef uv_data, index_count, ByRef index_data ) Sets the vertices, normals, and texture coordinates for a mesh #ref CreateMesh + diff --git a/doc/files/addprojectoreffectactor.txt b/doc/files/addprojectoreffectactor.txt new file mode 100644 index 0000000..1c0d2a1 --- /dev/null +++ b/doc/files/addprojectoreffectactor.txt @@ -0,0 +1,11 @@ +#title AddProjectorEffectActor [RCBasic Doc] +#header Function AddProjectorEffectActor(actor, tgt_actor) + +Add an effect actor from a projector. + +Returns the index of the effect actor in the projector. + +Refer to the included Projector Demo for an example + +#ref RemoveProjectorEffectActor + diff --git a/doc/files/addsceneskybox.txt b/doc/files/addsceneskybox.txt index dcb6afd..e407288 100644 --- a/doc/files/addsceneskybox.txt +++ b/doc/files/addsceneskybox.txt @@ -1,6 +1,7 @@ #title AddSceneSkyBox [RCBasic Doc] -#header sub AddSceneSkyBox( img_top, img_bottom, img_left, img_right, img_front, img_back) +#header Sub AddSceneSkyBox( img_top, img_bottom, img_left, img_right, img_front, img_back) Generates a skybox based on the provided images. #ref AddSceneSkyDome AddSceneSkyDomeEx + diff --git a/doc/files/addsceneskydome.txt b/doc/files/addsceneskydome.txt index 7f29b40..c315be9 100644 --- a/doc/files/addsceneskydome.txt +++ b/doc/files/addsceneskydome.txt @@ -1,6 +1,7 @@ #title AddSceneSkyDome [RCBasic Doc] -#header sub AddSceneSkyDome( img ) +#header Sub AddSceneSkyDome( img ) Adds a sky dome to the scene #ref AddSceneSkyDomeEx + diff --git a/doc/files/addsceneskydomeex.txt b/doc/files/addsceneskydomeex.txt index 170e06c..8cdb5c5 100644 --- a/doc/files/addsceneskydomeex.txt +++ b/doc/files/addsceneskydomeex.txt @@ -1,5 +1,5 @@ #title AddSceneSkyDomeEx [RCBasic Doc] -#header sub AddSceneSkyDomeEx( img, horiRes, vertRes, txPercentage, spherePercentage, radius) +#header Sub AddSceneSkyDomeEx( img, horiRes, vertRes, txPercentage, spherePercentage, radius) Adds a sky dome to the scene @@ -13,3 +13,4 @@ Adds a sky dome to the scene #/list #ref AddSceneSkyBox AddSceneSkyDome + diff --git a/doc/files/addspritechild.txt b/doc/files/addspritechild.txt new file mode 100644 index 0000000..26eed5c --- /dev/null +++ b/doc/files/addspritechild.txt @@ -0,0 +1,7 @@ +#title AddSpriteChild [RCBasic Doc] +#header Function AddSpriteChild(sprite, child_sprite, x, y) + +Adds a sprite as a child to another sprite. Child sprite is offset by given position. + +#ref RemoveSpriteChild + diff --git a/doc/files/addvehiclewheel.txt b/doc/files/addvehiclewheel.txt new file mode 100644 index 0000000..79a9088 --- /dev/null +++ b/doc/files/addvehiclewheel.txt @@ -0,0 +1,11 @@ +#title AddVehicleWheel [RCBasic Doc] +#header Function AddVehicleWheel( actor, wheel_actor, is_front_wheel ) + +Add a wheel to a vehicle actor + +is_front_wheel sets whether it should be considered a front wheel for physics and control + +NOTE: Once an actor is set as a wheel, the vehicle controls all transforms for the actor + +#ref CreateVehicleActor + diff --git a/doc/files/adjointmatrix.txt b/doc/files/adjointmatrix.txt index 1291a51..de94311 100644 --- a/doc/files/adjointmatrix.txt +++ b/doc/files/adjointmatrix.txt @@ -1,4 +1,5 @@ #title AdjointMatrix [RCBasic Doc] -#header function AdjointMatrix(mA, mB) +#header Function AdjointMatrix(mA, mB) Stores the adjoint matrix of mA in mB + diff --git a/doc/files/andbit.txt b/doc/files/andbit.txt index bd9085d..f30f338 100644 --- a/doc/files/andbit.txt +++ b/doc/files/andbit.txt @@ -1,4 +1,5 @@ #title AndBit [RCBasic Doc] -#header function AndBit(a,b) +#header Function AndBit(a,b) Returns the bitwise AND operation of 2 numbers + diff --git a/doc/files/android_getexternalstoragepath.txt b/doc/files/android_getexternalstoragepath.txt index 7ea51de..05894c9 100644 --- a/doc/files/android_getexternalstoragepath.txt +++ b/doc/files/android_getexternalstoragepath.txt @@ -1,6 +1,7 @@ #title Android_GetExternalStoragePath$ [RCBasic Doc] -#header function Android_GetExternalStoragePath$() +#header Function Android_GetExternalStoragePath$() Returns the designated external storage path #ref Android_GetExternalStorageState Android_GetInternalStoragePath$ + diff --git a/doc/files/android_getexternalstoragestate.txt b/doc/files/android_getexternalstoragestate.txt index 2b31fa4..de2218b 100644 --- a/doc/files/android_getexternalstoragestate.txt +++ b/doc/files/android_getexternalstoragestate.txt @@ -1,5 +1,5 @@ #title Android_GetExternalStorageState [RCBasic Doc] -#header function Android_GetExternalStorageState() +#header Function Android_GetExternalStorageState() Returns a bitmask of these values: #list @@ -14,3 +14,4 @@ End If #/code #ref Android_GetExternalStoragePath$ Android_GetInternalStoragePath$ + diff --git a/doc/files/android_getinternalstoragepath.txt b/doc/files/android_getinternalstoragepath.txt index abeb531..2fc6bf8 100644 --- a/doc/files/android_getinternalstoragepath.txt +++ b/doc/files/android_getinternalstoragepath.txt @@ -1,6 +1,7 @@ #title Android_GetInternalStoragePath$ [RCBasic Doc] -#header function Android_GetInternalStoragePath$() +#header Function Android_GetInternalStoragePath$() Returns the internal storage path #ref Android_GetExternalStorageState Android_GetExternalStoragePath$ + diff --git a/doc/files/android_jni_message.txt b/doc/files/android_jni_message.txt index f44ab82..7d8eda6 100644 --- a/doc/files/android_jni_message.txt +++ b/doc/files/android_jni_message.txt @@ -1,6 +1,7 @@ #title Android_JNI_Message$ [RCBasic Doc] -#header function Android_JNI_Message$(arg$) +#header Function Android_JNI_Message$(arg$) Passes arg$ to the rcbasic_android_interface() method in the java code for your android app. The java method returns a string. #ref Runtime_Utility_Message$ + diff --git a/doc/files/applyactorcentralforcelocal.txt b/doc/files/applyactorcentralforcelocal.txt index 94abf73..03f6c59 100644 --- a/doc/files/applyactorcentralforcelocal.txt +++ b/doc/files/applyactorcentralforcelocal.txt @@ -1,5 +1,5 @@ #title ApplyActorCentralForceLocal [RCBasic Doc] -#header sub ApplyActorCentralForceLocal( actor, x, y, z) +#header Sub ApplyActorCentralForceLocal( actor, x, y, z) Applies a force to the center of mass of an actor in local coordinate space. This force impacts the linear velocity of the object without affecting its rotation. @@ -8,3 +8,4 @@ Applies a force to the center of mass of an actor in local coordinate space. Thi #/list #ref ApplyActorCentralForceWorld ApplyActorCentralImpulseLocal ApplyActorCentralImpulseWorld + diff --git a/doc/files/applyactorcentralforceworld.txt b/doc/files/applyactorcentralforceworld.txt index 30d917a..80c11db 100644 --- a/doc/files/applyactorcentralforceworld.txt +++ b/doc/files/applyactorcentralforceworld.txt @@ -1,5 +1,5 @@ #title ApplyActorCentralForceWorld [RCBasic Doc] -#header sub ApplyActorCentralForceWorld( actor, x, y, z) +#header Sub ApplyActorCentralForceWorld( actor, x, y, z) Applies a force to the center of mass of an actor in world coordinate space. This force impacts the linear velocity of the object without affecting its rotation. @@ -8,3 +8,4 @@ Applies a force to the center of mass of an actor in world coordinate space. Thi #/list #ref ApplyActorCentralForceLocal ApplyActorCentralImpulseLocal ApplyActorCentralImpulseWorld + diff --git a/doc/files/applyactorcentralimpulselocal.txt b/doc/files/applyactorcentralimpulselocal.txt index 8c992f1..3d42a13 100644 --- a/doc/files/applyactorcentralimpulselocal.txt +++ b/doc/files/applyactorcentralimpulselocal.txt @@ -1,5 +1,5 @@ #title ApplyActorCentralImpulseLocal [RCBasic Doc] -#header sub ApplyActorCentralImpulseLocal( actor, x, y, z) +#header Sub ApplyActorCentralImpulseLocal( actor, x, y, z) Applies an impulse directly to the center of mass of an actor. An impulse differs from a continuous force in that it applies an immediate, short-duration change to the velocity of the actor. It affects the linear velocity but does not generate rotational effects (since it's applied to the center of mass). @@ -8,3 +8,4 @@ Applies an impulse directly to the center of mass of an actor. An impulse differ #/list #ref ApplyActorCentralForceLocal ApplyActorCentralForceWorld ApplyActorCentralImpulseWorld + diff --git a/doc/files/applyactorcentralimpulseworld.txt b/doc/files/applyactorcentralimpulseworld.txt index 388714d..f29ceb2 100644 --- a/doc/files/applyactorcentralimpulseworld.txt +++ b/doc/files/applyactorcentralimpulseworld.txt @@ -1,5 +1,5 @@ #title ApplyActorCentralImpulseWorld [RCBasic Doc] -#header sub ApplyActorCentralImpulseWorld( actor, x, y, z) +#header Sub ApplyActorCentralImpulseWorld( actor, x, y, z) Applies an impulse directly to the center of mass of an actor. An impulse differs from a continuous force in that it applies an immediate, short-duration change to the velocity of the actor. It affects the linear velocity but does not generate rotational effects (since it's applied to the center of mass). @@ -9,3 +9,4 @@ Applies an impulse directly to the center of mass of an actor. An impulse differ #ref ApplyActorCentralForceLocal ApplyActorCentralForceWorld ApplyActorCentralImpulseLocal + diff --git a/doc/files/applyactordamping.txt b/doc/files/applyactordamping.txt index 525881c..2d90197 100644 --- a/doc/files/applyactordamping.txt +++ b/doc/files/applyactordamping.txt @@ -1,5 +1,5 @@ #title ApplyActorDamping [RCBasic Doc] -#header sub ApplyActorDamping( actor, timeStep) +#header Sub ApplyActorDamping( actor, timeStep) Reduces the velocity of an actor over time, simulating the effect of friction or air resistance. @@ -20,3 +20,4 @@ Wend #/code #ref setActorDamping getActorLinearDamping getActorAngularDamping + diff --git a/doc/files/applyactorforcelocal.txt b/doc/files/applyactorforcelocal.txt index a7e104f..daf3efa 100644 --- a/doc/files/applyactorforcelocal.txt +++ b/doc/files/applyactorforcelocal.txt @@ -1,5 +1,5 @@ #title ApplyActorForceLocal [RCBasic Doc] -#header sub ApplyActorForceLocal( actor, x, y, z, rel_x, rel_y, rel_z) +#header Sub ApplyActorForceLocal( actor, x, y, z, rel_x, rel_y, rel_z) Applies a force to an actor at a specific point. Unlike ApplyActorCentralForce(local/world), which applies force only at the center of mass (affecting linear velocity), this can generate both linear motion and rotation (torque), depending on where the force is applied relative to the center of mass. @@ -9,3 +9,4 @@ Applies a force to an actor at a specific point. Unlike ApplyActorCentralForce(l #/list #ref ApplyActorForceWorld ApplyActorCentralForceLocal ApplyActorCentralForceWorld + diff --git a/doc/files/applyactorforceworld.txt b/doc/files/applyactorforceworld.txt index 65462be..77fb871 100644 --- a/doc/files/applyactorforceworld.txt +++ b/doc/files/applyactorforceworld.txt @@ -1,5 +1,5 @@ #title ApplyActorForceWorld [RCBasic Doc] -#header sub ApplyActorForceWorld( actor, x, y, z, rel_x, rel_y, rel_z) +#header Sub ApplyActorForceWorld( actor, x, y, z, rel_x, rel_y, rel_z) Applies a force to an actor at a specific point. Unlike ApplyActorCentralForce(local/world), which applies force only at the center of mass (affecting linear velocity), this can generate both linear motion and rotation (torque), depending on where the force is applied relative to the center of mass. @@ -9,3 +9,4 @@ Applies a force to an actor at a specific point. Unlike ApplyActorCentralForce(l #/list #ref ApplyActorForceLocal ApplyActorCentralForceLocal ApplyActorCentralForceWorld + diff --git a/doc/files/applyactorimpulselocal.txt b/doc/files/applyactorimpulselocal.txt index 03e8898..5fe00f6 100644 --- a/doc/files/applyactorimpulselocal.txt +++ b/doc/files/applyactorimpulselocal.txt @@ -1,5 +1,5 @@ #title ApplyActorImpulseLocal [RCBasic Doc] -#header sub ApplyActorImpulseLocal( actor, x, y, z, rel_x, rel_y, rel_z) +#header Sub ApplyActorImpulseLocal( actor, x, y, z, rel_x, rel_y, rel_z) Applies an impulse to an actor at a specific point. Unlike ApplyActorCentralImpulse(local/world), which applies impulse only at the center of mass (affecting linear velocity), this can generate both linear motion and rotation (torque), depending on where the force is applied relative to the center of mass. @@ -10,3 +10,4 @@ Applies an impulse to an actor at a specific point. Unlike ApplyActorCentralImpu #ref ApplyActorImpulseWorld ApplyActorForceLocal ApplyActorForceWorld + diff --git a/doc/files/applyactorimpulseworld.txt b/doc/files/applyactorimpulseworld.txt index 92d6da9..f493069 100644 --- a/doc/files/applyactorimpulseworld.txt +++ b/doc/files/applyactorimpulseworld.txt @@ -9,3 +9,4 @@ Applies an impulse to an actor at a specific point. Unlike ApplyActorCentralImpu #/list #ref ApplyActorImpulseLocal ApplyActorForceLocal ApplyActorForceWorld + diff --git a/doc/files/applyactortorqueimpulselocal.txt b/doc/files/applyactortorqueimpulselocal.txt index 9ed03df..d484cfe 100644 --- a/doc/files/applyactortorqueimpulselocal.txt +++ b/doc/files/applyactortorqueimpulselocal.txt @@ -8,3 +8,4 @@ Applies an impulse that directly affects the angular velocity of an actor, causi #/list #ref ApplyActorTorque ApplyActorTorqueImpulseWorld + diff --git a/doc/files/applyactortorqueimpulseworld.txt b/doc/files/applyactortorqueimpulseworld.txt index e8126f5..123d04f 100644 --- a/doc/files/applyactortorqueimpulseworld.txt +++ b/doc/files/applyactortorqueimpulseworld.txt @@ -8,3 +8,4 @@ Applies an impulse that directly affects the angular velocity of an actor, causi #/list #ref ApplyActorTorque ApplyActorTorqueImpulseLocal + diff --git a/doc/files/applyactortorquelocal.txt b/doc/files/applyactortorquelocal.txt index 4e3a0ee..8fdedfb 100644 --- a/doc/files/applyactortorquelocal.txt +++ b/doc/files/applyactortorquelocal.txt @@ -8,3 +8,4 @@ Applies a continuous torque to an actor, causing it to accelerate its rotational #/list #ref ApplyActorTorqueWorld ApplyActorTorqueImpulseLocal ApplyActorTorqueImpulseWorld + diff --git a/doc/files/applyactortorqueworld.txt b/doc/files/applyactortorqueworld.txt index cde6ac9..e44bd1d 100644 --- a/doc/files/applyactortorqueworld.txt +++ b/doc/files/applyactortorqueworld.txt @@ -9,3 +9,4 @@ Applies a continuous torque to an actor, causing it to accelerate its rotational #ref ApplyActorTorqueLocal ApplyActorTorqueImpulseLocal ApplyActorTorqueImpulseWorld + diff --git a/doc/files/applyspriteangularimpulse.txt b/doc/files/applyspriteangularimpulse.txt index f95015d..062a827 100644 --- a/doc/files/applyspriteangularimpulse.txt +++ b/doc/files/applyspriteangularimpulse.txt @@ -1,6 +1,7 @@ -#title applySpriteAngularImpulse [RCBasic Doc] -#header sub applySpriteAngularImpulse( spr_id, impulse) +#title ApplySpriteAngularImpulse [RCBasic Doc] +#header Sub ApplySpriteAngularImpulse( spr_id, impulse) Apply an angular impulse to a body. This method affects the body’s rotational motion, changing its angular velocity based on the impulse applied. #ref ApplySpriteLinearImpulse + diff --git a/doc/files/applyspritecentralforce.txt b/doc/files/applyspritecentralforce.txt index 2853be5..36535ea 100644 --- a/doc/files/applyspritecentralforce.txt +++ b/doc/files/applyspritecentralforce.txt @@ -1,4 +1,5 @@ -#title applySpriteCentralForce [RCBasic Doc] -#header sub applySpriteCentralForce( spr_id, x, y) +#title ApplySpriteCentralForce [RCBasic Doc] +#header Sub ApplySpriteCentralForce( spr_id, x, y) Apply a continuous force to a body at its center of mass, regardless of the body's current orientation. This method affects the body's linear motion and is useful for simulating forces like gravity, wind, or any other directional force. + diff --git a/doc/files/applyspriteforce.txt b/doc/files/applyspriteforce.txt index e7c803f..6e46b9e 100644 --- a/doc/files/applyspriteforce.txt +++ b/doc/files/applyspriteforce.txt @@ -1,4 +1,5 @@ -#title applySpriteForce [RCBasic Doc] -#header sub applySpriteForce( spr_id, fX, fY, pX, pY) +#title ApplySpriteForce [RCBasic Doc] +#header Sub ApplySpriteForce( spr_id, fX, fY, pX, pY) Apply a force at a world point. If the force is not applied at the center of mass, it will generate a torque and affect the angular velocity. This wakes up the body. + diff --git a/doc/files/applyspritelinearimpulse.txt b/doc/files/applyspritelinearimpulse.txt index 2ec8881..e98a670 100644 --- a/doc/files/applyspritelinearimpulse.txt +++ b/doc/files/applyspritelinearimpulse.txt @@ -1,6 +1,7 @@ -#title applySpriteLinearImpulse [RCBasic Doc] -#header sub applySpriteLinearImpulse( spr_id, iX, iY, pX, pY) +#title ApplySpriteLinearImpulse [RCBasic Doc] +#header Sub ApplySpriteLinearImpulse( spr_id, iX, iY, pX, pY) Apply an instantaneous linear impulse to a body. This method directly affects the body’s linear motion by changing its velocity based on the impulse applied. #ref ApplySpriteAngularImpulse + diff --git a/doc/files/applyspritetorque.txt b/doc/files/applyspritetorque.txt index 6e8c84a..020374a 100644 --- a/doc/files/applyspritetorque.txt +++ b/doc/files/applyspritetorque.txt @@ -1,4 +1,5 @@ -#title applySpriteTorque [RCBasic Doc] -#header sub applySpriteTorque( spr_id, torque) +#title ApplySpriteTorque [RCBasic Doc] +#header Sub ApplySpriteTorque( spr_id, torque) Apply a torque. This affects the angular velocity without affecting the linear velocity of the center of mass. + diff --git a/doc/files/applywheelengineforce.txt b/doc/files/applywheelengineforce.txt new file mode 100644 index 0000000..0c8691d --- /dev/null +++ b/doc/files/applywheelengineforce.txt @@ -0,0 +1,7 @@ +#title ApplyWheelEngineForce [RCBasic Doc] +#header Sub ApplyWheelEngineForce( actor, wheel, force ) + +Apply force to a wheel. + +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. + diff --git a/doc/files/arraycopy.txt b/doc/files/arraycopy.txt index 9e28c4a..090fb6f 100644 --- a/doc/files/arraycopy.txt +++ b/doc/files/arraycopy.txt @@ -1,8 +1,9 @@ #title ArrayCopy [RCBasic Doc] -#header sub ArrayCopy(ByRef src, ByRef dst) +#header Sub ArrayCopy(ByRef src, ByRef dst) Copies the contents of src array to dst array Note: This function is a special case in that it can take any type for src or dst #ref ArrayDim ArraySize ArrayFill + diff --git a/doc/files/arraydim.txt b/doc/files/arraydim.txt index 4cba66b..5fee256 100644 --- a/doc/files/arraydim.txt +++ b/doc/files/arraydim.txt @@ -1,6 +1,7 @@ #title ArrayDim [RCBasic Doc] -#header function ArrayDim(Byref id) +#header Function ArrayDim(ByRef id) Returns the number of dimensions in an array #ref ArrayCopy ArrayFill ArraySize + diff --git a/doc/files/arrayfill.txt b/doc/files/arrayfill.txt index 08ff811..08fb8bf 100644 --- a/doc/files/arrayfill.txt +++ b/doc/files/arrayfill.txt @@ -4,3 +4,4 @@ Fills all the elements in an array with the value in fdata #ref ArrayCopy ArrayDim ArraySize + diff --git a/doc/files/arraysize.txt b/doc/files/arraysize.txt index e05767e..03cd5c5 100644 --- a/doc/files/arraysize.txt +++ b/doc/files/arraysize.txt @@ -1,6 +1,7 @@ #title ArraySize [RCBasic Doc] -#header Function ArraySize(Byref id, array_dim) +#header Function ArraySize(ByRef id, array_dim) Returns the number of elements in the given dimension of an array #ref ArrayDim ArrayCopy ArrayFill + diff --git a/doc/files/asc.txt b/doc/files/asc.txt index 6450a9e..8be6fc5 100644 --- a/doc/files/asc.txt +++ b/doc/files/asc.txt @@ -2,3 +2,4 @@ #header Function Asc(c$) Returns the ASCII value of a character. + diff --git a/doc/files/asin.txt b/doc/files/asin.txt index c1ab938..c9de9b2 100644 --- a/doc/files/asin.txt +++ b/doc/files/asin.txt @@ -2,3 +2,4 @@ #header Function Asin(n) Returns the ArcSine of a number. + diff --git a/doc/files/atan.txt b/doc/files/atan.txt index f23eeaf..9bc4657 100644 --- a/doc/files/atan.txt +++ b/doc/files/atan.txt @@ -2,3 +2,4 @@ #header Function Atan(n) Returns the ArcTangent of a number. + diff --git a/doc/files/atan2.txt b/doc/files/atan2.txt index fd37713..2d94a70 100644 --- a/doc/files/atan2.txt +++ b/doc/files/atan2.txt @@ -2,3 +2,4 @@ #header Function ATan2(y, x) Returns the ArcTangent of x and y + diff --git a/doc/files/augmentmatrix.txt b/doc/files/augmentmatrix.txt index 2a0e4c5..0fc79bf 100644 --- a/doc/files/augmentmatrix.txt +++ b/doc/files/augmentmatrix.txt @@ -1,6 +1,7 @@ #title AugmentMatrix [RCBasic Doc] -#header function AugmentMatrix(mA, mB, mC) +#header Function AugmentMatrix(mA, mB, mC) Appends the columns of matrix mB onto matrix mA and stores the result in mC. NOTE: Must mA and mB must be the same number of rows. + diff --git a/doc/files/bin.txt b/doc/files/bin.txt index 7b40444..69a0178 100644 --- a/doc/files/bin.txt +++ b/doc/files/bin.txt @@ -1,4 +1,5 @@ #title Bin$ [RCBasic Doc] -#header function Bin$(n) +#header Function Bin$(n) Returns the binary representation of a number. + diff --git a/doc/files/box3d.txt b/doc/files/box3d.txt index c750680..6e5b776 100644 --- a/doc/files/box3d.txt +++ b/doc/files/box3d.txt @@ -1,4 +1,5 @@ #title Box3D [RCBasic Doc] -#header sub Box3D(min_x, min_y, min_z, max_x, max_y, max_z) +#header Sub Box3D(min_x, min_y, min_z, max_x, max_y, max_z) Draws a box in 3D space + diff --git a/doc/files/bufferfromimage.txt b/doc/files/bufferfromimage.txt index 02a4cd2..475fc81 100644 --- a/doc/files/bufferfromimage.txt +++ b/doc/files/bufferfromimage.txt @@ -1,4 +1,5 @@ #title BufferFromImage [RCBasic Doc] -#header sub BufferFromImage(slot, byref buffer) +#header Sub BufferFromImage(slot, ByRef buffer) + diff --git a/doc/files/bufferfrommatrix.txt b/doc/files/bufferfrommatrix.txt index fbadd93..24fb1d5 100644 --- a/doc/files/bufferfrommatrix.txt +++ b/doc/files/bufferfrommatrix.txt @@ -1,8 +1,9 @@ #title BufferFromMatrix [RCBasic Doc] -#header sub BufferFromMatrix(ByRef buffer, mA) +#header Sub BufferFromMatrix(ByRef buffer, mA) Saves the matrix mA in an array NOTE: buffer must have the same number of dimensions as the desired matrix for the structure to remain intact. #ref MatrixFromBuffer + diff --git a/doc/files/bufferfromstring.txt b/doc/files/bufferfromstring.txt index f249035..8124f13 100644 --- a/doc/files/bufferfromstring.txt +++ b/doc/files/bufferfromstring.txt @@ -1,6 +1,7 @@ #title BufferFromString [RCBasic Doc] -#header function BufferFromString(s$, ByRef buffer) +#header Function BufferFromString(s$, ByRef buffer) Stores the byte value of a string into a number buffer #ref StringFromBuffer$ + diff --git a/doc/files/calculatecompositeprincipaltransform.txt b/doc/files/calculatecompositeprincipaltransform.txt new file mode 100644 index 0000000..1e6969c --- /dev/null +++ b/doc/files/calculatecompositeprincipaltransform.txt @@ -0,0 +1,14 @@ +#title CalculateCompositePrincipalTransform [RCBasic Doc] +#header Sub CalculateCompositePrincipalTransform(actor, ByRef masses, principal_matrix, ByRef x, ByRef y, ByRef z) + +Calculates the center of mass and principal intertia axes for a composite actor. + +Parameters: +#list ul +#li masses - An array with masses for each child in the compound shape +#li principal_matrix - This will be set to principal axis transform +#li (x, y, z) - Inertia +#/list + +#ref CreateCompositeActor + diff --git a/doc/files/canvas.txt b/doc/files/canvas.txt index 49cd21d..ff6af03 100644 --- a/doc/files/canvas.txt +++ b/doc/files/canvas.txt @@ -1,6 +1,7 @@ #title Canvas [RCBasic Doc] -#header sub Canvas(c_num) +#header Sub Canvas(c_num) Sets the active canvas for drawing commands to use #ref ActiveCanvas + diff --git a/doc/files/canvasclip.txt b/doc/files/canvasclip.txt index 7391245..79a3ce2 100644 --- a/doc/files/canvasclip.txt +++ b/doc/files/canvasclip.txt @@ -1,6 +1,7 @@ #title CanvasClip [RCBasic Doc] -#header function CanvasClip(x, y, w, h) +#header Function CanvasClip(x, y, w, h) Returns an image id with a selected portion of the active drawing canvas saved #ref WindowClip + diff --git a/doc/files/canvasisvisible.txt b/doc/files/canvasisvisible.txt index 8e4c4e4..91d14c5 100644 --- a/doc/files/canvasisvisible.txt +++ b/doc/files/canvasisvisible.txt @@ -1,6 +1,7 @@ #title CanvasIsVisible [RCBasic Doc] -#header function CanvasIsVisible(c_num) +#header Function CanvasIsVisible(c_num) Returns true if a canvas is shown in the Window #ref SetCanvasVisible + diff --git a/doc/files/canvasz.txt b/doc/files/canvasz.txt index b4bd84b..6a1a249 100644 --- a/doc/files/canvasz.txt +++ b/doc/files/canvasz.txt @@ -1,8 +1,9 @@ #title CanvasZ [RCBasic Doc] -#header function CanvasZ(c_num) +#header Function CanvasZ(c_num) Returns the Canvas Z Order. Note: Canvases with a higher Z order are drawn first and those with lower values will be drawn on top #ref SetCanvasZ + diff --git a/doc/files/castray2d.txt b/doc/files/castray2d.txt index b39c75e..500ceab 100644 --- a/doc/files/castray2d.txt +++ b/doc/files/castray2d.txt @@ -1,5 +1,5 @@ #title CastRay2D [RCBasic Doc] -#header function CastRay2D( from_x, from_y, to_x, to_y ) +#header Function CastRay2D( from_x, from_y, to_x, to_y ) Cast a ray and get the closest hit on the ray @@ -8,3 +8,4 @@ Returns 1 if there is a hit and 0 if not NOTE: GetRayHit2D is used to read each hit #ref GetRayHit3D CastRay3D CastRay3D_All CastRay2D_All GetRayHit2D + diff --git a/doc/files/castray2d_all.txt b/doc/files/castray2d_all.txt index 2093841..127a826 100644 --- a/doc/files/castray2d_all.txt +++ b/doc/files/castray2d_all.txt @@ -1,5 +1,5 @@ #title CastRay2D_All [RCBasic Doc] -#header function CastRay2D_All( from_x, from_y, to_x, to_y ) +#header Function CastRay2D_All( from_x, from_y, to_x, to_y ) Cast a ray and gets all hits on the ray @@ -8,3 +8,4 @@ Returns the number of hits from the ray cast NOTE: GetRayHit2D is used to read each hit #ref GetRayHit3D CastRay3D CastRay3D_All CastRay2D GetRayHit2D + diff --git a/doc/files/castray3d.txt b/doc/files/castray3d.txt index 77ef899..ca676eb 100644 --- a/doc/files/castray3d.txt +++ b/doc/files/castray3d.txt @@ -1,5 +1,5 @@ #title CastRay3D [RCBasic Doc] -#header function CastRay3D( from_x, from_y, from_z, to_x, to_y, to_z ) +#header Function CastRay3D( from_x, from_y, from_z, to_x, to_y, to_z ) Cast a ray and get the closest hit on the ray @@ -8,3 +8,4 @@ Returns 1 if there is a hit and 0 if not NOTE: GetRayHit3D is used to read each hit #ref GetRayHit3D CastRay3D_All CastRay2D CastRay2D_All GetRayHit2D + diff --git a/doc/files/castray3d_all.txt b/doc/files/castray3d_all.txt index 3e20f67..82b8d63 100644 --- a/doc/files/castray3d_all.txt +++ b/doc/files/castray3d_all.txt @@ -1,5 +1,5 @@ #title CastRay3D_All [RCBasic Doc] -#header function CastRay3D_All( from_x, from_y, from_z, to_x, to_y, to_z ) +#header Function CastRay3D_All( from_x, from_y, from_z, to_x, to_y, to_z ) Cast a ray and gets all hits on the ray @@ -8,3 +8,4 @@ Returns the number of hits from the ray cast NOTE: GetRayHit3D is used to read each hit #ref GetRayHit3D CastRay3D CastRay2D CastRay2D_All GetRayHit2D + diff --git a/doc/files/changedir.txt b/doc/files/changedir.txt index 4b894a5..f8bf276 100644 --- a/doc/files/changedir.txt +++ b/doc/files/changedir.txt @@ -1,4 +1,5 @@ #title ChangeDir [RCBasic Doc] -#header sub ChangeDir(p$) +#header Sub ChangeDir(p$) Sets the working directory that the directory commands use + diff --git a/doc/files/channelispaused.txt b/doc/files/channelispaused.txt index 39ea742..f3758b8 100644 --- a/doc/files/channelispaused.txt +++ b/doc/files/channelispaused.txt @@ -1,6 +1,7 @@ #title ChannelIsPaused [RCBasic Doc] -#header function ChannelIsPaused(channel) +#header Function ChannelIsPaused(channel) Returns true if an audio channel is currently paused #ref PauseSound + diff --git a/doc/files/channelisplaying.txt b/doc/files/channelisplaying.txt index 73fdfc7..03ee63f 100644 --- a/doc/files/channelisplaying.txt +++ b/doc/files/channelisplaying.txt @@ -1,6 +1,7 @@ #title ChannelIsPlaying [RCBasic Doc] -#header function ChannelIsPlaying(channel) +#header Function ChannelIsPlaying(channel) Returns true if an audio channel is playing #ref ChannelIsPaused PlaySound PlaySoundTimed + diff --git a/doc/files/checksockets.txt b/doc/files/checksockets.txt index efdfd03..8dedb31 100644 --- a/doc/files/checksockets.txt +++ b/doc/files/checksockets.txt @@ -1,7 +1,8 @@ #title CheckSockets [RCBasic Doc] -#header function CheckSockets(timeout_ms) +#header Function CheckSockets(timeout_ms) Checks all connected sockets for activity. If timeout_ms is greater than 0 than it will wait that many milliseconds. If less than 0 it will wait for over 49 days (hint: there is no reason what so ever to set this less than 0). Returns the number of sockets that have activity (ie. a connection was made or data was sent) + diff --git a/doc/files/chr.txt b/doc/files/chr.txt index 81ec84c..7717498 100644 --- a/doc/files/chr.txt +++ b/doc/files/chr.txt @@ -1,4 +1,5 @@ #title Chr$ [RCBasic Doc] -#header function Chr$(n) +#header Function Chr$(n) Returns the character with the matching ASCII value n. + diff --git a/doc/files/cint32.txt b/doc/files/cint32.txt index f70a19b..9e183c1 100644 --- a/doc/files/cint32.txt +++ b/doc/files/cint32.txt @@ -1,4 +1,5 @@ #title CInt32 [RCBasic Doc] -#header function CInt32(i) +#header Function CInt32(i) Returns a 32-bit signed integer. + diff --git a/doc/files/cint64.txt b/doc/files/cint64.txt index 63e5915..ca6daf2 100644 --- a/doc/files/cint64.txt +++ b/doc/files/cint64.txt @@ -1,4 +1,5 @@ #title CInt64 [RCBasic Doc] -#header function CInt64(i) +#header Function CInt64(i) Returns a 64-bit signed integer. + diff --git a/doc/files/circle.txt b/doc/files/circle.txt index 65abcfe..c85901f 100644 --- a/doc/files/circle.txt +++ b/doc/files/circle.txt @@ -1,4 +1,5 @@ #title Circle [RCBasic Doc] -#header sub Circle(x,y,radius) +#header Sub Circle(x,y,radius) Draws a circle on the current canvas. + diff --git a/doc/files/circlefill.txt b/doc/files/circlefill.txt index 88e6ff3..2dff024 100644 --- a/doc/files/circlefill.txt +++ b/doc/files/circlefill.txt @@ -1,4 +1,5 @@ #title CircleFill [RCBasic Doc] -#header sub CircleFill(x,y,radius) +#header Sub CircleFill(x,y,radius) Draws a filled circle on the current canvas. + diff --git a/doc/files/clearactorforces.txt b/doc/files/clearactorforces.txt index cbfeb71..7b88805 100644 --- a/doc/files/clearactorforces.txt +++ b/doc/files/clearactorforces.txt @@ -1,5 +1,5 @@ -#title clearActorForces [RCBasic Doc] -#header sub clearActorForces( actor) +#title ClearActorForces [RCBasic Doc] +#header Sub ClearActorForces( actor) Resets or clears all the forces and torques that have been applied to a rigid body in the current simulation step. This ensures that any forces, including linear forces and torques, do not accumulate from one simulation step to the next. @@ -9,3 +9,4 @@ Resets or clears all the forces and torques that have been applied to a rigid bo #li Does Not Affect Velocity: It clears only the applied forces and torques, but the current velocity (linear and angular) of the actor remains unchanged. #li Typically Used in Each Simulation Step: Used to reset forces after each step, so that only new forces applied in the next step will affect the body. #/list + diff --git a/doc/files/clearcanvas.txt b/doc/files/clearcanvas.txt index 3deb5fe..44e72d4 100644 --- a/doc/files/clearcanvas.txt +++ b/doc/files/clearcanvas.txt @@ -1,6 +1,7 @@ #title ClearCanvas [RCBasic Doc] -#header sub ClearCanvas() +#header Sub ClearCanvas() Clears the active drawing canvas NOTE: This is only for drawing canvases (ie. Those opened with OpenCanvas()) + diff --git a/doc/files/clearmatrix.txt b/doc/files/clearmatrix.txt index 53b23d6..6494e83 100644 --- a/doc/files/clearmatrix.txt +++ b/doc/files/clearmatrix.txt @@ -1,4 +1,5 @@ #title ClearMatrix [RCBasic Doc] -#header sub ClearMatrix(mA) +#header Sub ClearMatrix(mA) Sets all elements in a matrix to zero + diff --git a/doc/files/clearmatrixcolumns.txt b/doc/files/clearmatrixcolumns.txt index 4cae668..8ab7868 100644 --- a/doc/files/clearmatrixcolumns.txt +++ b/doc/files/clearmatrixcolumns.txt @@ -1,6 +1,7 @@ #title ClearMatrixColumns [RCBasic Doc] -#header function ClearMatrixColumns(mA, c, num_cols) +#header Function ClearMatrixColumns(mA, c, num_cols) Sets all elements in the matrix columns specified to zero. #ref ClearMatrix ClearMatrixRows + diff --git a/doc/files/clearmatrixrows.txt b/doc/files/clearmatrixrows.txt index cc1d416..998e047 100644 --- a/doc/files/clearmatrixrows.txt +++ b/doc/files/clearmatrixrows.txt @@ -1,6 +1,7 @@ #title ClearMatrixRows [RCBasic Doc] -#header function ClearMatrixRows(mA, r, num_rows) +#header Function ClearMatrixRows(mA, r, num_rows) Sets all elements in the matrix rows specified to zero. #ref ClearMatrix ClearMatrixColumns + diff --git a/doc/files/clearmousezone.txt b/doc/files/clearmousezone.txt index 953683a..da31367 100644 --- a/doc/files/clearmousezone.txt +++ b/doc/files/clearmousezone.txt @@ -1,4 +1,5 @@ #title ClearMouseZone [RCBasic Doc] -#header sub ClearMouseZone() +#header Sub ClearMouseZone() Removes the previously set mouse zone from the window + diff --git a/doc/files/clearposteffect.txt b/doc/files/clearposteffect.txt new file mode 100644 index 0000000..cdad015 --- /dev/null +++ b/doc/files/clearposteffect.txt @@ -0,0 +1,5 @@ +#title ClearPostEffect [RCBasic Doc] +#header Sub ClearPostEffect( c_num ) + +Removes the current post effect from the canvas. + diff --git a/doc/files/clearscene.txt b/doc/files/clearscene.txt index 92e11c1..01bd2fa 100644 --- a/doc/files/clearscene.txt +++ b/doc/files/clearscene.txt @@ -2,3 +2,4 @@ #header Sub ClearScene() + diff --git a/doc/files/clearstack_n.txt b/doc/files/clearstack_n.txt index 60dc4dc..0aa6733 100644 --- a/doc/files/clearstack_n.txt +++ b/doc/files/clearstack_n.txt @@ -1,6 +1,7 @@ #title ClearStack_N [RCBasic Doc] -#header sub ClearStack_N( num_stack ) +#header Sub ClearStack_N( num_stack ) Removes all elements from the stack #ref ClearStack_S + diff --git a/doc/files/clearstack_s.txt b/doc/files/clearstack_s.txt index 020ce91..5a5d7e7 100644 --- a/doc/files/clearstack_s.txt +++ b/doc/files/clearstack_s.txt @@ -1,6 +1,7 @@ #title ClearStack_S [RCBasic Doc] -#header sub ClearStack_S( str_stack ) +#header Sub ClearStack_S( str_stack ) Removes all elements from the stack #ref ClearStack_N + diff --git a/doc/files/clipmatrix.txt b/doc/files/clipmatrix.txt index 001e5c2..1983c1d 100644 --- a/doc/files/clipmatrix.txt +++ b/doc/files/clipmatrix.txt @@ -1,4 +1,5 @@ #title ClipMatrix [RCBasic Doc] -#header sub ClipMatrix(mA, r, c, num_rows, num_cols, mB) +#header Sub ClipMatrix(mA, r, c, num_rows, num_cols, mB) Copies the specified portion of matrix mA into matrix mB + diff --git a/doc/files/clonecanvas.txt b/doc/files/clonecanvas.txt index 8910bca..f28fd2e 100644 --- a/doc/files/clonecanvas.txt +++ b/doc/files/clonecanvas.txt @@ -1,5 +1,5 @@ #title CloneCanvas [RCBasic Doc] -#header function CloneCanvas(c_num, mode) +#header Function CloneCanvas(c_num, mode) Returns a clone of a canvas. Clone canvases are mirrors of the original canvas so when you draw to one it will also be on the other. This is useful for a splitscreen 2d game. @@ -7,3 +7,4 @@ Mode is a canvas render mode like the one passed to OpenCanvas() #ref OpenCanvas + diff --git a/doc/files/closecanvas.txt b/doc/files/closecanvas.txt index c78af01..32acb3a 100644 --- a/doc/files/closecanvas.txt +++ b/doc/files/closecanvas.txt @@ -4,3 +4,4 @@ Closes a canvas #ref OpenCanvas + diff --git a/doc/files/closefile.txt b/doc/files/closefile.txt index 21efc01..391f07e 100644 --- a/doc/files/closefile.txt +++ b/doc/files/closefile.txt @@ -1,6 +1,7 @@ #title CloseFile [RCBasic Doc] -#header sub CloseFile( stream ) +#header Sub CloseFile( stream ) Closes a file #ref OpenFile + diff --git a/doc/files/closewindow.txt b/doc/files/closewindow.txt index 05c9656..07513f6 100644 --- a/doc/files/closewindow.txt +++ b/doc/files/closewindow.txt @@ -1,6 +1,7 @@ #title CloseWindow [RCBasic Doc] -#header sub CloseWindow( ) +#header Sub CloseWindow( ) Closes the graphics window #ref OpenWindow + diff --git a/doc/files/cls.txt b/doc/files/cls.txt index eaedc84..c715d01 100644 --- a/doc/files/cls.txt +++ b/doc/files/cls.txt @@ -1,4 +1,5 @@ #title Cls [RCBasic Doc] -#header sub Cls() +#header Sub Cls() Clears the back buffer on the window + diff --git a/doc/files/cofactormatrix.txt b/doc/files/cofactormatrix.txt index 19a1431..a42c4f3 100644 --- a/doc/files/cofactormatrix.txt +++ b/doc/files/cofactormatrix.txt @@ -1,6 +1,7 @@ #title CofactorMatrix [RCBasic Doc] -#header sub CofactorMatrix(mA, r, c) +#header Sub CofactorMatrix(mA, r, c) Sets matrix mA to a cofactor. This will change the original matrix so it is recommended to copy the matrix if you still need the original matrix. #ref CopyMatrix + diff --git a/doc/files/colorkey.txt b/doc/files/colorkey.txt index 1d00863..0ed9e3d 100644 --- a/doc/files/colorkey.txt +++ b/doc/files/colorkey.txt @@ -1,4 +1,5 @@ #title ColorKey [RCBasic Doc] -#header sub ColorKey(img_id, c) +#header Sub ColorKey(img_id, c) Sets the color key for an image + diff --git a/doc/files/command.txt b/doc/files/command.txt index 9b71e89..73c7f6a 100644 --- a/doc/files/command.txt +++ b/doc/files/command.txt @@ -1,8 +1,9 @@ #title Command$ [RCBasic Doc] -#header function Command$(arg) +#header Function Command$(arg) Returns command line arguments passed to a program. Note: Command$(0) will always be the program being executed ( your_program.cbc ) #ref NumCommands + diff --git a/doc/files/computeactorangularimpulsedenominator.txt b/doc/files/computeactorangularimpulsedenominator.txt index ecf5e43..415a3f1 100644 --- a/doc/files/computeactorangularimpulsedenominator.txt +++ b/doc/files/computeactorangularimpulsedenominator.txt @@ -1,6 +1,7 @@ #title ComputeActorAngularImpulseDenominator [RCBasic Doc] -#header function ComputeActorAngularImpulseDenominator( actor, x, y, z) +#header Function ComputeActorAngularImpulseDenominator( actor, x, y, z) Computes a scalar value that represents how an actor will respond to an angular impulse at a given point, taking into account the actor's inertia tensor (which governs how the object resists rotation). This function is particularly useful in calculating the actor's rotational response to an impulse, typically during collision resolution or constraints involving rotation. #ref ComputeActorImpulseDenominator + diff --git a/doc/files/computeactorgyroimpulselocal.txt b/doc/files/computeactorgyroimpulselocal.txt index bafdf61..eccba2f 100644 --- a/doc/files/computeactorgyroimpulselocal.txt +++ b/doc/files/computeactorgyroimpulselocal.txt @@ -1,6 +1,7 @@ #title ComputeActorGyroImpulseLocal [RCBasic Doc] -#header sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z) +#header Sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z) Computes the gyroscopic impulse for an actor in an implicit manner, based on the actor's current angular velocity and inertia. This function is used to simulate the gyroscopic effect—also known as gyroscopic precession—which occurs when a rotating object experiences a torque that causes its axis of rotation to change. #ref ComputeActorGyroImpulseWorld + diff --git a/doc/files/computeactorgyroimpulseworld.txt b/doc/files/computeactorgyroimpulseworld.txt index 875f3fb..a421304 100644 --- a/doc/files/computeactorgyroimpulseworld.txt +++ b/doc/files/computeactorgyroimpulseworld.txt @@ -1,6 +1,7 @@ #title ComputeActorGyroImpulseWorld [RCBasic Doc] -#header sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z) +#header Sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z) Computes the gyroscopic impulse for an actor in an implicit manner, but in this case, it performs the calculation relative to the world frame of reference, rather than the actor’s local frame. This function is used to handle the gyroscopic effects (i.e., gyroscopic precession) of a rotating object when a torque is applied, affecting its axis of rotation. #ref ComputeActorGyroImpulseLocal + diff --git a/doc/files/computeactorimpulsedenominator.txt b/doc/files/computeactorimpulsedenominator.txt index c0b0cc0..7a5035d 100644 --- a/doc/files/computeactorimpulsedenominator.txt +++ b/doc/files/computeactorimpulsedenominator.txt @@ -1,6 +1,7 @@ #title ComputeActorImpulseDenominator [RCBasic Doc] -#header function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z) +#header Function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z) Computes a scalar value related to how a rigid body will respond to an applied impulse at a given point. It’s primarily used internally in the physics engine to calculate how an object’s mass, inertia, and shape will affect the outcome of impulses, particularly in collisions or constraints like contact points between objects. #ref ComputeActorAngularImpulseDenominator + diff --git a/doc/files/constraintexists.txt b/doc/files/constraintexists.txt index 1ada7e3..9019d82 100644 --- a/doc/files/constraintexists.txt +++ b/doc/files/constraintexists.txt @@ -1,4 +1,5 @@ #title ConstraintExists [RCBasic Doc] -#header function ConstraintExists( constraint_id ) +#header Function ConstraintExists( constraint_id ) Returns true if the id passed is a valid constraint + diff --git a/doc/files/converttonormalmap.txt b/doc/files/converttonormalmap.txt index 88a9edf..9af37be 100644 --- a/doc/files/converttonormalmap.txt +++ b/doc/files/converttonormalmap.txt @@ -1,4 +1,5 @@ #title ConvertToNormalMap [RCBasic Doc] -#header sub ConvertToNormalMap(img_id, amp) +#header Sub ConvertToNormalMap(img_id, amp) Converts an image to a format for normal maps + diff --git a/doc/files/copyactormaterial.txt b/doc/files/copyactormaterial.txt index 30c9ba3..4d4b9e7 100644 --- a/doc/files/copyactormaterial.txt +++ b/doc/files/copyactormaterial.txt @@ -1,4 +1,5 @@ #title CopyActorMaterial [RCBasic Doc] -#header function CopyActorMaterial( actor, material_num) +#header Function CopyActorMaterial( actor, material_num) Returns a material id for a copy of an actor's material + diff --git a/doc/files/copyfile.txt b/doc/files/copyfile.txt index af5b3a4..eb093b9 100644 --- a/doc/files/copyfile.txt +++ b/doc/files/copyfile.txt @@ -1,4 +1,5 @@ #title CopyFile [RCBasic Doc] -#header sub CopyFile(src$, dst$) +#header Sub CopyFile(src$, dst$) Copies the contents of src$ file to a new dst$ file + diff --git a/doc/files/copyimage.txt b/doc/files/copyimage.txt index 19d0008..86ebce0 100644 --- a/doc/files/copyimage.txt +++ b/doc/files/copyimage.txt @@ -1,4 +1,5 @@ #title CopyImage [RCBasic Doc] -#header function CopyImage( img_id ) +#header Function CopyImage( img_id ) Returns a copy of an image + diff --git a/doc/files/copymaterial.txt b/doc/files/copymaterial.txt index 4f7cb7e..96faded 100644 --- a/doc/files/copymaterial.txt +++ b/doc/files/copymaterial.txt @@ -1,4 +1,5 @@ #title CopyMaterial [RCBasic Doc] -#header function CopyMaterial( smaterial_id) +#header Function CopyMaterial( smaterial_id) Returns a copy of a material + diff --git a/doc/files/copymatrix.txt b/doc/files/copymatrix.txt index ffd1295..9c82932 100644 --- a/doc/files/copymatrix.txt +++ b/doc/files/copymatrix.txt @@ -1,4 +1,5 @@ #title CopyMatrix [RCBasic Doc] -#header sub CopyMatrix(mA, mB) +#header Sub CopyMatrix(mA, mB) Copies matrix mA to matrix mB + diff --git a/doc/files/copymatrixcolumns.txt b/doc/files/copymatrixcolumns.txt index be6d2d9..3ee7d00 100644 --- a/doc/files/copymatrixcolumns.txt +++ b/doc/files/copymatrixcolumns.txt @@ -1,6 +1,7 @@ #title CopyMatrixColumns [RCBasic Doc] -#header function CopyMatrixColumns(mA, mB, c, num_cols) +#header Function CopyMatrixColumns(mA, mB, c, num_cols) Copies the specified matrix columns from matrix mA to matrix mB. Note: Matrix mB will be redimensioned to the size of the copied columns. + diff --git a/doc/files/copymatrixrows.txt b/doc/files/copymatrixrows.txt index b580326..86005a7 100644 --- a/doc/files/copymatrixrows.txt +++ b/doc/files/copymatrixrows.txt @@ -1,7 +1,8 @@ #title CopyMatrixRows [RCBasic Doc] -#header function CopyMatrixRows(mA, mB, r, num_rows) +#header Function CopyMatrixRows(mA, mB, r, num_rows) Copies the specified matrix rows from matrix mA to matrix mB. Note: Matrix mB will be redimensioned to the size of the copied rows. + diff --git a/doc/files/cos.txt b/doc/files/cos.txt index 5cf7b8d..d3d5f6e 100644 --- a/doc/files/cos.txt +++ b/doc/files/cos.txt @@ -1,4 +1,5 @@ #title Cos [RCBasic Doc] -#header function Cos(n) +#header Function Cos(n) Returns the Cosine of an angle + diff --git a/doc/files/createactoranimation.txt b/doc/files/createactoranimation.txt index 697ef5d..c55c802 100644 --- a/doc/files/createactoranimation.txt +++ b/doc/files/createactoranimation.txt @@ -2,3 +2,4 @@ #header Function CreateActorAnimation(actor, start_frame, end_frame, speed) + diff --git a/doc/files/createanimatedactor.txt b/doc/files/createanimatedactor.txt index 12a89e7..af722b4 100644 --- a/doc/files/createanimatedactor.txt +++ b/doc/files/createanimatedactor.txt @@ -1,5 +1,5 @@ #title CreateAnimatedActor [RCBasic Doc] -#header function CreateAnimatedActor( mesh ) +#header Function CreateAnimatedActor( mesh ) Returns a new animated actor composed of a mesh @@ -8,3 +8,4 @@ The mesh can either be created using CreateMesh() or Loaded using LoadMesh() #ref CreateMesh LoadMesh LoadMeshFromAN8
    #ref CreateOctreeActor CreateCubeActor CreateSphereActor CreateWaterActor CreateLightActor CreateBillboardActor CreateTerrainActor + diff --git a/doc/files/createbillboardactor.txt b/doc/files/createbillboardactor.txt index d9b37bc..45fc460 100644 --- a/doc/files/createbillboardactor.txt +++ b/doc/files/createbillboardactor.txt @@ -1,8 +1,9 @@ #title CreateBillboardActor [RCBasic Doc] -#header function CreateBillboardActor( ) +#header Function CreateBillboardActor( ) Returns a billboard actor Billboard actors are flat textured planes that are always facing the camera. #ref CreateAnimatedActor CreateOctreeActor CreateSphereActor CreateWaterActor CreateLightActor CreateCubeActor CreateTerrainActor + diff --git a/doc/files/createcompositeactor.txt b/doc/files/createcompositeactor.txt new file mode 100644 index 0000000..31c0298 --- /dev/null +++ b/doc/files/createcompositeactor.txt @@ -0,0 +1,9 @@ +#title CreateCompositeActor [RCBasic Doc] +#header Function CreateCompositeActor() + +Creates a composite actor + +Refer to the included Composite Demo for an example + +#ref AddCompositeChild + diff --git a/doc/files/createconeconstraint.txt b/doc/files/createconeconstraint.txt index 4a9c9b7..8766256 100644 --- a/doc/files/createconeconstraint.txt +++ b/doc/files/createconeconstraint.txt @@ -1,5 +1,5 @@ #title CreateConeConstraint [RCBasic Doc] -#header function CreateConeConstraint( actorA, rbAFrame_matrix) +#header Function CreateConeConstraint( actorA, rbAFrame_matrix) The Cone Constraint is a type of joint constraint used to simulate realistic rotational movement between two actors (or between an actor and the world) with specific angular limits. This constraint is especially useful for simulating ball-and-socket joints with some twisting freedom but restricted cone-like movement, such as human shoulders or robotic arms. @@ -17,3 +17,4 @@ test_cone = CreateConeConstraint( actorA, rbA ) Note: It is recommended to use CreateConeConstraintEx() in most cases #ref CreateConeConstraintEx SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createconeconstraintex.txt b/doc/files/createconeconstraintex.txt index f742059..c4a0dc4 100644 --- a/doc/files/createconeconstraintex.txt +++ b/doc/files/createconeconstraintex.txt @@ -1,5 +1,5 @@ -#title createConeConstraintEx [RCBasic Doc] -#header function createConeConstraintEx( actorA, actorB, rbAFrame_matrix, rbBFrame_matrix) +#title CreateConeConstraintEx [RCBasic Doc] +#header Function CreateConeConstraintEx( actorA, actorB, rbAFrame_matrix, rbBFrame_matrix) The Cone Constraint is a type of joint constraint used to simulate realistic rotational movement between two actors (or between an actor and the world) with specific angular limits. This constraint is especially useful for simulating ball-and-socket joints with some twisting freedom but restricted cone-like movement, such as human shoulders or robotic arms. @@ -21,3 +21,4 @@ test_cone = CreateConeConstraint( actorA, rbA ) #/code #ref CreateConeConstraint SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createconemesh.txt b/doc/files/createconemesh.txt index faea361..9f74df3 100644 --- a/doc/files/createconemesh.txt +++ b/doc/files/createconemesh.txt @@ -2,3 +2,4 @@ #header Function CreateConeMesh( radius, cone_length, tesselation, top_color, bottom_color ) Create a cone mesh + diff --git a/doc/files/createcubeactor.txt b/doc/files/createcubeactor.txt index 2c0f7b7..92f632c 100644 --- a/doc/files/createcubeactor.txt +++ b/doc/files/createcubeactor.txt @@ -1,6 +1,7 @@ #title CreateCubeActor [RCBasic Doc] -#header function CreateCubeActor( cube_size ) +#header Function CreateCubeActor( cube_size ) Returns an actor with a cube mesh of the specified size ( cube_size x cube_size x cube_size ) #ref CreateAnimatedActor CreateOctreeActor CreateSphereActor CreateWaterActor CreateLightActor CreateBillboardActor CreateTerrainActor + diff --git a/doc/files/createcylindermesh.txt b/doc/files/createcylindermesh.txt index 879bfbb..c4f13f4 100644 --- a/doc/files/createcylindermesh.txt +++ b/doc/files/createcylindermesh.txt @@ -2,3 +2,4 @@ #header Function CreateCylinderMesh( radius, cylinder_length, tesselation, color, close_top ) Create a cylinder mesh + diff --git a/doc/files/createdistancejoint.txt b/doc/files/createdistancejoint.txt index 11b0ca9..9cd684b 100644 --- a/doc/files/createdistancejoint.txt +++ b/doc/files/createdistancejoint.txt @@ -1,5 +1,5 @@ -#title createDistanceJoint [RCBasic Doc] -#header function createDistanceJoint( spriteA, spriteB, aX, aY, bX, bY, collide_connect) +#title CreateDistanceJoint [RCBasic Doc] +#header Function CreateDistanceJoint( spriteA, spriteB, aX, aY, bX, bY, collide_connect) Creates a distance joint @@ -12,3 +12,4 @@ Parameters #li aX, aY - Anchor point on spriteA #li bX, bY - Anchor point on spriteB #/list + diff --git a/doc/files/createfrictionjoint.txt b/doc/files/createfrictionjoint.txt index bd5442b..79987c0 100644 --- a/doc/files/createfrictionjoint.txt +++ b/doc/files/createfrictionjoint.txt @@ -1,5 +1,5 @@ -#title createFrictionJoint [RCBasic Doc] -#header function createFrictionJoint( spriteA, spriteB, x, y, collide_connect) +#title CreateFrictionJoint [RCBasic Doc] +#header Function CreateFrictionJoint( spriteA, spriteB, x, y, collide_connect) Creates a Friction Joint @@ -12,3 +12,4 @@ Parameters #li x, y - Anchor point. A common world-space point where the friction forces will be applied on both bodies. This is usually set to the point where you want the bodies to "grip" or resist slipping relative to each other. #/list + diff --git a/doc/files/creategearjoint.txt b/doc/files/creategearjoint.txt index 8ef7d8a..70d7d27 100644 --- a/doc/files/creategearjoint.txt +++ b/doc/files/creategearjoint.txt @@ -1,5 +1,5 @@ -#title createGearJoint [RCBasic Doc] -#header function createGearJoint( jointA, jointB, g_ratio, collide_connect) +#title CreateGearJoint [RCBasic Doc] +#header Function CreateGearJoint( jointA, jointB, g_ratio, collide_connect) Creates a Gear Joint @@ -12,3 +12,4 @@ Parameters #li ratio - ratio of how much influence jointA has compared to jointB #/list + diff --git a/doc/files/createhingeconstraint.txt b/doc/files/createhingeconstraint.txt index df7fcdd..d52fa28 100644 --- a/doc/files/createhingeconstraint.txt +++ b/doc/files/createhingeconstraint.txt @@ -1,5 +1,5 @@ #title CreateHingeConstraint [RCBasic Doc] -#header function CreateHingeConstraint( actorA, frameA, useReferenceFrameA ) +#header Function CreateHingeConstraint( actorA, frameA, useReferenceFrameA ) Simulates a hinge joint, which allows two actors (or an actor and the world) to rotate around a single axis while restricting movement along the other axes. This is similar to the way a door swings on its hinges or how an elbow joint functions in the human body. @@ -15,3 +15,4 @@ Note: It is recommended to use CreateHingeConstraintEx() in most cases #ref CreateHingeConstraintEx SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createhingeconstraintex.txt b/doc/files/createhingeconstraintex.txt index ea53632..3db0a69 100644 --- a/doc/files/createhingeconstraintex.txt +++ b/doc/files/createhingeconstraintex.txt @@ -21,3 +21,4 @@ Note: It is recommended to use CreateHingeConstraintEx() in most cases #ref CreateHingeConstraint SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createimage.txt b/doc/files/createimage.txt index 116ffba..4ca0516 100644 --- a/doc/files/createimage.txt +++ b/doc/files/createimage.txt @@ -1,6 +1,7 @@ #title CreateImage [RCBasic Doc] -#header function CreateImage(w, h, byref buffer) +#header Function CreateImage(w, h, ByRef buffer) Returns an image created from the buffer provided #ref CreateImageEx LoadImage + diff --git a/doc/files/createimageex.txt b/doc/files/createimageex.txt index 11f34fe..6b59d8b 100644 --- a/doc/files/createimageex.txt +++ b/doc/files/createimageex.txt @@ -1,5 +1,5 @@ -#title createImageEx [RCBasic Doc] -#header function createImageEx(w, h, byref buffer, color) +#title CreateImageEx [RCBasic Doc] +#header Function CreateImageEx(w, h, ByRef buffer, color) Returns an image created from the buffer provided @@ -7,3 +7,4 @@ The color parameter is a color key value to apply #ref CreateImage LoadImage + diff --git a/doc/files/createlightactor.txt b/doc/files/createlightactor.txt index c0c24d4..bf4e24e 100644 --- a/doc/files/createlightactor.txt +++ b/doc/files/createlightactor.txt @@ -1,6 +1,7 @@ #title CreateLightActor [RCBasic Doc] -#header function CreateLightActor( ) +#header Function CreateLightActor( ) Returns a new light in the scene #ref CreateMeshActor CreateMeshOctreeActor CreateCubeActor CreateSphereActor CreateWaterPlaneActor CreateBillboardActor CreateTerrainActor + diff --git a/doc/files/creatematerial.txt b/doc/files/creatematerial.txt index 4cd5875..e3372d1 100644 --- a/doc/files/creatematerial.txt +++ b/doc/files/creatematerial.txt @@ -1,4 +1,5 @@ -#title createMaterial [RCBasic Doc] -#header function createMaterial() +#title CreateMaterial [RCBasic Doc] +#header Function CreateMaterial() Returns a new material + diff --git a/doc/files/createmesh.txt b/doc/files/createmesh.txt index 3f258eb..01d23b0 100644 --- a/doc/files/createmesh.txt +++ b/doc/files/createmesh.txt @@ -1,4 +1,5 @@ #title CreateMesh [RCBasic Doc] -#header function CreateMesh( ) +#header Function CreateMesh( ) Returns a new mesh + diff --git a/doc/files/createmeshactor.txt b/doc/files/createmeshactor.txt deleted file mode 100644 index 3feb78d..0000000 --- a/doc/files/createmeshactor.txt +++ /dev/null @@ -1,10 +0,0 @@ -#title CreateAnimatedActor [RCBasic Doc] -#header function CreateAnimatedActor( mesh ) - -Returns a new animated actor composed of a mesh - -The mesh can either be created using CreateMesh() or Loaded using LoadMesh() - -#ref CreateMesh LoadMesh LoadMeshFromAN8 -
    -#ref CreateOctreeActor CreateCubeActor CreateSphereActor CreateWaterPlaneActor CreateLightActor CreateBillboardActor CreateTerrainActor diff --git a/doc/files/createmotorjoint.txt b/doc/files/createmotorjoint.txt index f5426a7..7440ddb 100644 --- a/doc/files/createmotorjoint.txt +++ b/doc/files/createmotorjoint.txt @@ -1,6 +1,7 @@ -#title createMotorJoint [RCBasic Doc] -#header function createMotorJoint( spriteA, spriteB, collide_connect) +#title CreateMotorJoint [RCBasic Doc] +#header Function CreateMotorJoint( spriteA, spriteB, collide_connect) Creates a Motor Joint A motor joint is used to control the relative motion between two bodies. A typical usage is to control the movement of a dynamic body with respect to the ground. + diff --git a/doc/files/createoctreeactor.txt b/doc/files/createoctreeactor.txt index 95c9e3a..bd19844 100644 --- a/doc/files/createoctreeactor.txt +++ b/doc/files/createoctreeactor.txt @@ -1,8 +1,9 @@ #title CreateOctreeActor [RCBasic Doc] -#header function CreateOctreeActor( mesh ) +#header Function CreateOctreeActor( mesh ) Returns a mesh actor optimized for large objects (such as levels) #ref CreateMesh LoadMesh
    #ref CreateAnimatedActor CreateCubeActor CreateSphereActor CreateWaterActor CreateLightActor CreateBillboardActor CreateTerrainActor + diff --git a/doc/files/createparticleactor.txt b/doc/files/createparticleactor.txt index 8cd0ca2..c94f3f1 100644 --- a/doc/files/createparticleactor.txt +++ b/doc/files/createparticleactor.txt @@ -1,5 +1,5 @@ #title CreateParticleActor [RCBasic Doc] -#header function CreateParticleActor( particle_type ) +#header Function CreateParticleActor( particle_type ) Returns a new particle actor @@ -14,3 +14,4 @@ Possible Particle Types #/list #ref CreateMeshOctreeActor CreateCubeActor CreateSphereActor CreateWaterPlaneActor CreateLightActor CreateBillboardActor CreateTerrainActor + diff --git a/doc/files/createplanemesh.txt b/doc/files/createplanemesh.txt index 8fd005f..e3185b7 100644 --- a/doc/files/createplanemesh.txt +++ b/doc/files/createplanemesh.txt @@ -1,10 +1,12 @@ #title CreatePlaneMesh [RCBasic Doc] -#header Function CreatePlaneMesh( w, h, tileCount_w, tileCount_h ) +#header Function CreatePlaneMesh( w, h, tileCount_w, tileCount_h, txRepeat_x, txRepeat_y ) Creates a flat plane #list #li w, h - The width and height of the plane #li tileCount_w, TileCount_h - The number of subdivisions across and down the plane +#li txRepeat_x, txRepeat_y - The number of times to repeat the texture across and down the plane #/list + diff --git a/doc/files/createpointconstraint.txt b/doc/files/createpointconstraint.txt index 351ed56..5d8c7c6 100644 --- a/doc/files/createpointconstraint.txt +++ b/doc/files/createpointconstraint.txt @@ -4,3 +4,4 @@ A type of constraint that allows two actors (or an actor and the world) to move freely relative to each other while ensuring that one point on each body remains coincident. Essentially, it ensures that the two actors stay connected at a single point, but without restricting their relative rotations. This kind of constraint is useful when you need a connection that allows full rotation in all directions, such as a pendulum, ball joint, or even some suspension systems. #ref CreatePointConstraintEx + diff --git a/doc/files/createpointconstraintex.txt b/doc/files/createpointconstraintex.txt index 9817321..2b4d105 100644 --- a/doc/files/createpointconstraintex.txt +++ b/doc/files/createpointconstraintex.txt @@ -1,7 +1,8 @@ #title CreatePointConstraintEx [RCBasic Doc] -#header function CreatePointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB) +#header Function CreatePointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB) A type of constraint that allows two actors (or an actor and the world) to move freely relative to each other while ensuring that one point on each body remains coincident. Essentially, it ensures that the two actors stay connected at a single point, but without restricting their relative rotations. This kind of constraint is useful when you need a connection that allows full rotation in all directions, such as a pendulum, ball joint, or even some suspension systems. #ref CreatePointConstraint + diff --git a/doc/files/createprismaticjoint.txt b/doc/files/createprismaticjoint.txt index 3925f8e..1c0ed17 100644 --- a/doc/files/createprismaticjoint.txt +++ b/doc/files/createprismaticjoint.txt @@ -1,5 +1,5 @@ -#title createPrismaticJoint [RCBasic Doc] -#header function createPrismaticJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect) +#title CreatePrismaticJoint [RCBasic Doc] +#header Function CreatePrismaticJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect) Creates a Prismatic Joint @@ -12,3 +12,4 @@ Parameters #li aX, aY - anchor point #li axisX, axisY - Used to define a linear direction from anchor point #/list + diff --git a/doc/files/createprojectoractor.txt b/doc/files/createprojectoractor.txt index 2f69501..344719f 100644 --- a/doc/files/createprojectoractor.txt +++ b/doc/files/createprojectoractor.txt @@ -4,3 +4,4 @@ Create a projector actor. Projector actors can be used to project a texture over objects in its field of view. + diff --git a/doc/files/createpulleyjoint.txt b/doc/files/createpulleyjoint.txt index 04eee70..46dd690 100644 --- a/doc/files/createpulleyjoint.txt +++ b/doc/files/createpulleyjoint.txt @@ -1,6 +1,7 @@ -#title createPulleyJoint [RCBasic Doc] -#header function createPulleyJoint( spriteA, spriteB, gaX, gaY, gbX, gbY, aX, aY, bX, bY, j_ratio, collide_connect) +#title CreatePulleyJoint [RCBasic Doc] +#header Function CreatePulleyJoint( spriteA, spriteB, gaX, gaY, gbX, gbY, aX, aY, bX, bY, j_ratio, collide_connect) Creates a pulley joint The pulley joint is connected to two bodies and two fixed ground points. The pulley supports a ratio such that: length1 + ratio * length2 <= constant Yes, the force transmitted is scaled by the ratio. Warning: the pulley joint can get a bit squirrelly by itself. They often work better when combined with prismatic joints. You should also cover the the anchor points with static shapes to prevent one side from going to zero length. + diff --git a/doc/files/createrevolutejoint.txt b/doc/files/createrevolutejoint.txt index 979114b..1b36742 100644 --- a/doc/files/createrevolutejoint.txt +++ b/doc/files/createrevolutejoint.txt @@ -1,6 +1,7 @@ -#title createRevoluteJoint [RCBasic Doc] -#header function createRevoluteJoint( spriteA, spriteB, x, y, collide_connect) +#title CreateRevoluteJoint [RCBasic Doc] +#header Function CreateRevoluteJoint( spriteA, spriteB, x, y, collide_connect) Creates a revolute joint A revolute joint constrains two bodies to share a common point while they are free to rotate about the point. The relative rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is provided so that infinite forces are not generated. + diff --git a/doc/files/createslideconstraint.txt b/doc/files/createslideconstraint.txt index 03bd6cb..ca6942f 100644 --- a/doc/files/createslideconstraint.txt +++ b/doc/files/createslideconstraint.txt @@ -1,5 +1,5 @@ #title CreateSlideConstraint [RCBasic Doc] -#header function CreateSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA) +#header Function CreateSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA) A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems. @@ -15,3 +15,4 @@ slide = CreateSlideConstraint(actorA, frameB, true) Note: It is recommended to use CreateSlideConstraintEx() in most cases #ref CreateSlideConstraintEx SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createslideconstraintex.txt b/doc/files/createslideconstraintex.txt index 3acc1cd..f121224 100644 --- a/doc/files/createslideconstraintex.txt +++ b/doc/files/createslideconstraintex.txt @@ -1,5 +1,5 @@ #title CreateSlideConstraintEx [RCBasic Doc] -#header function CreateSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA) +#header Function CreateSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA) A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems. @@ -22,3 +22,4 @@ Note: It is recommended to use CreateSlideConstraintEx() in most cases #ref CreateSlideConstraint SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createsound.txt b/doc/files/createsound.txt index f5fc41c..cd6fd03 100644 --- a/doc/files/createsound.txt +++ b/doc/files/createsound.txt @@ -1,4 +1,5 @@ #title CreateSound [RCBasic Doc] -#header function CreateSound(byref buffer, buffer_size, vol) +#header Function CreateSound(ByRef buffer, buffer_size, vol) Returns a new sound from a buffer of raw audio data + diff --git a/doc/files/createsphereactor.txt b/doc/files/createsphereactor.txt index b8f1faa..90eae4e 100644 --- a/doc/files/createsphereactor.txt +++ b/doc/files/createsphereactor.txt @@ -1,6 +1,7 @@ #title CreateSphereActor [RCBasic Doc] -#header function CreateSphereActor( radius ) +#header Function CreateSphereActor( radius ) Returns an actor composed of a sphere mesh #ref CreateAnimatedActor CreateOctreeActor CreateBillboardActor CreateWaterActor CreateLightActor CreateCubeActor CreateTerrainActor + diff --git a/doc/files/createsprite.txt b/doc/files/createsprite.txt index 5798598..8481155 100644 --- a/doc/files/createsprite.txt +++ b/doc/files/createsprite.txt @@ -1,5 +1,5 @@ #title CreateSprite [RCBasic Doc] -#header function CreateSprite( img, frame_w, frame_h ) +#header Function CreateSprite( img, frame_w, frame_h ) This function returns a new sprite which you can place in a variable for use in your program. @@ -36,3 +36,4 @@ Here is an example of opening a sprite canvas layer, creating a sprite, setting #image "images/theEye.png" #ref OpenCanvasSpriteLayer SetSpritePosition + diff --git a/doc/files/createspriteanimation.txt b/doc/files/createspriteanimation.txt index b66598e..0c5c814 100644 --- a/doc/files/createspriteanimation.txt +++ b/doc/files/createspriteanimation.txt @@ -7,3 +7,4 @@ Returns a new sprite animation id #li anim_length - number of frames in the animation #li speed - frames per second for the animation #/list + diff --git a/doc/files/createstack_n.txt b/doc/files/createstack_n.txt index 2a1f8d3..69df418 100644 --- a/doc/files/createstack_n.txt +++ b/doc/files/createstack_n.txt @@ -1,5 +1,6 @@ #title CreateStack_N [RCBasic Doc] -#header function CreateStack_N( ) +#header Function CreateStack_N( ) Returns a new number stack + diff --git a/doc/files/createstack_s.txt b/doc/files/createstack_s.txt index 48bbc15..b47ed59 100644 --- a/doc/files/createstack_s.txt +++ b/doc/files/createstack_s.txt @@ -1,5 +1,6 @@ #title CreateStack_S [RCBasic Doc] -#header function CreateStack_S() +#header Function CreateStack_S() Returns a new string stack + diff --git a/doc/files/createterrainactor.txt b/doc/files/createterrainactor.txt index 9e97d2b..b0be396 100644 --- a/doc/files/createterrainactor.txt +++ b/doc/files/createterrainactor.txt @@ -1,8 +1,9 @@ #title CreateTerrainActor [RCBasic Doc] -#header function CreateTerrainActor( hmap_file$ ) +#header Function CreateTerrainActor( hmap_file$ ) Returns terrain generated from a height map Note: Height Maps can be any supported image format #ref CreateAnimatedActor CreateOctreeActor CreateSphereActor CreateWaterActor CreateLightActor CreateCubeActor CreateBillboardActor + diff --git a/doc/files/createtilemap.txt b/doc/files/createtilemap.txt index ebcd366..da8a8b3 100644 --- a/doc/files/createtilemap.txt +++ b/doc/files/createtilemap.txt @@ -11,3 +11,4 @@ Parameters #/list #ref CreateTileSet + diff --git a/doc/files/createtileset.txt b/doc/files/createtileset.txt index c9d3a10..f43c1aa 100644 --- a/doc/files/createtileset.txt +++ b/doc/files/createtileset.txt @@ -69,3 +69,4 @@ Wend #image "images/testTileSet.png" #ref CreateTileMap SetTile FillTile DrawTileMap + diff --git a/doc/files/createvehicleactor.txt b/doc/files/createvehicleactor.txt new file mode 100644 index 0000000..96b545b --- /dev/null +++ b/doc/files/createvehicleactor.txt @@ -0,0 +1,7 @@ +#title CreateVehicleActor [RCBasic Doc] +#header Function CreateVehicleActor( chassis_actor ) + +Creates a vehicle actor. The chassis_actor is another actor that will be attached as the main body of the vehicle. + +#ref AddVehicleWheel + diff --git a/doc/files/createvolumelightmesh.txt b/doc/files/createvolumelightmesh.txt index 2b257ed..4b79665 100644 --- a/doc/files/createvolumelightmesh.txt +++ b/doc/files/createvolumelightmesh.txt @@ -2,3 +2,4 @@ #header Function CreateVolumeLightMesh( u, v, foot_color, tail_color, lp_distance, dim_x, dim_y, dim_z ) Create a mesh to represent a light volume. + diff --git a/doc/files/createwateractor.txt b/doc/files/createwateractor.txt index 2c1577d..17db0d3 100644 --- a/doc/files/createwateractor.txt +++ b/doc/files/createwateractor.txt @@ -1,6 +1,7 @@ #title CreateWaterActor [RCBasic Doc] -#header function CreateWaterActor( mesh, waveHeight, waveSpeed, waveLength ) +#header Function CreateWaterActor( mesh, waveHeight, waveSpeed, waveLength ) Creates an actor with water properties set on a base mesh #ref CreateAnimatedActor CreateOctreeActor CreateSphereActor CreateCubeActor CreateLightActor CreateBillboardActor CreateTerrainActor + diff --git a/doc/files/createwaterplaneactor.txt b/doc/files/createwaterplaneactor.txt deleted file mode 100644 index ed1f97f..0000000 --- a/doc/files/createwaterplaneactor.txt +++ /dev/null @@ -1,6 +0,0 @@ -#title CreateWaterPlaneActor [RCBasic Doc] -#header function CreateWaterPlaneActor( w, h ) - -Returns a water plane actor - -#ref CreateMeshActor CreateMeshOctreeActor CreateCubeActor CreateSphereActor CreateLightActor CreateBillboardActor CreateTerrainActor diff --git a/doc/files/createweldjoint.txt b/doc/files/createweldjoint.txt index 997d9ff..f79cc4b 100644 --- a/doc/files/createweldjoint.txt +++ b/doc/files/createweldjoint.txt @@ -1,6 +1,7 @@ -#title createWeldJoint [RCBasic Doc] -#header function createWeldJoint( spriteA, spriteB, x, y, collide_connect) +#title CreateWeldJoint [RCBasic Doc] +#header Function CreateWeldJoint( spriteA, spriteB, x, y, collide_connect) Creates a Weld Joint A weld joint essentially glues two bodies together. A weld joint may distort somewhat because the island constraint solver is approximate. + diff --git a/doc/files/createwheeljoint.txt b/doc/files/createwheeljoint.txt index 430cc6e..b65d5fc 100644 --- a/doc/files/createwheeljoint.txt +++ b/doc/files/createwheeljoint.txt @@ -1,6 +1,7 @@ -#title createWheelJoint [RCBasic Doc] -#header function createWheelJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect) +#title CreateWheelJoint [RCBasic Doc] +#header Function CreateWheelJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect) Creates a wheel joint. A wheel joint. This joint provides two degrees of freedom: translation along an axis fixed in bodyA and rotation in the plane. In other words, it is a point to line constraint with a rotational motor and a linear spring/damper. The spring/damper is initialized upon creation. This joint is designed for vehicle suspensions. + diff --git a/doc/files/cubematrix.txt b/doc/files/cubematrix.txt index e949679..703dc56 100644 --- a/doc/files/cubematrix.txt +++ b/doc/files/cubematrix.txt @@ -1,4 +1,5 @@ #title CubeMatrix [RCBasic Doc] -#header function CubeMatrix(mA, mB) +#header Function CubeMatrix(mA, mB) Returns matrix mA raised to the 3rd power + diff --git a/doc/files/date.txt b/doc/files/date.txt index 672d718..65d297e 100644 --- a/doc/files/date.txt +++ b/doc/files/date.txt @@ -1,4 +1,5 @@ #title Date$ [RCBasic Doc] -#header function Date$() +#header Function Date$() Returns the date in "MM-DD-YYYY" format + diff --git a/doc/files/degrees.txt b/doc/files/degrees.txt index 96d0046..aab96da 100644 --- a/doc/files/degrees.txt +++ b/doc/files/degrees.txt @@ -1,4 +1,5 @@ #title Degrees [RCBasic Doc] -#header function Degrees(r) +#header Function Degrees(r) Returns angle converted from radians to degrees + diff --git a/doc/files/deleteactor.txt b/doc/files/deleteactor.txt index 3c7250d..5b6ede5 100644 --- a/doc/files/deleteactor.txt +++ b/doc/files/deleteactor.txt @@ -1,6 +1,7 @@ #title DeleteActor [RCBasic Doc] -#header sub DeleteActor( actor ) +#header Sub DeleteActor( actor ) Removes an actor from the scene and frees its memory NOTE: Actors are all removed on clearScene so make sure you don't continue using the id after that. + diff --git a/doc/files/deleteactoranimation.txt b/doc/files/deleteactoranimation.txt index edeb2ec..bc07a74 100644 --- a/doc/files/deleteactoranimation.txt +++ b/doc/files/deleteactoranimation.txt @@ -1,4 +1,5 @@ #title DeleteActorAnimation [RCBasic Doc] -#header sub DeleteActorAnimation(actor, animation) +#header Sub DeleteActorAnimation(actor, animation) Deletes an actor's animation + diff --git a/doc/files/deletean8.txt b/doc/files/deletean8.txt index e671f13..1ec17d4 100644 --- a/doc/files/deletean8.txt +++ b/doc/files/deletean8.txt @@ -2,3 +2,4 @@ #header Sub DeleteAN8( an8_project ) Clears a anim8or project from program memory. + diff --git a/doc/files/deleteconstraint.txt b/doc/files/deleteconstraint.txt index 71ab51b..9ff2847 100644 --- a/doc/files/deleteconstraint.txt +++ b/doc/files/deleteconstraint.txt @@ -2,3 +2,4 @@ #header Sub DeleteConstraint( constraint_id) Removes a constraint + diff --git a/doc/files/deletefont.txt b/doc/files/deletefont.txt index 097249b..10fe0f8 100644 --- a/doc/files/deletefont.txt +++ b/doc/files/deletefont.txt @@ -2,3 +2,4 @@ #header Sub DeleteFont(font_id) Frees a font from memory + diff --git a/doc/files/deleteimage.txt b/doc/files/deleteimage.txt index db62800..24fea0f 100644 --- a/doc/files/deleteimage.txt +++ b/doc/files/deleteimage.txt @@ -2,3 +2,4 @@ #header Sub DeleteImage(img) Removes an image from memory + diff --git a/doc/files/deletejoint.txt b/doc/files/deletejoint.txt index 6b3d983..c681b05 100644 --- a/doc/files/deletejoint.txt +++ b/doc/files/deletejoint.txt @@ -4,3 +4,4 @@ Clears a joint from memory #ref CreateDistanceJoint CreateFrictionJoint CreateGearJoint CreateMotorJoint CreatePrismaticJoint CreatePulleyJoint CreateRevoluteJoint CreateWeldJoint CreateWheelJoint + diff --git a/doc/files/deletematerial.txt b/doc/files/deletematerial.txt index 65d6173..fe81904 100644 --- a/doc/files/deletematerial.txt +++ b/doc/files/deletematerial.txt @@ -4,3 +4,4 @@ Removes a material from memory NOTE: In the case of actor materials, this will simple drop the reference to it but it will not remove the material from the actor. + diff --git a/doc/files/deletematrix.txt b/doc/files/deletematrix.txt index a1774e8..d4521b1 100644 --- a/doc/files/deletematrix.txt +++ b/doc/files/deletematrix.txt @@ -2,3 +2,4 @@ #header Sub DeleteMatrix(mA) Frees a matrix from memory + diff --git a/doc/files/deletematrixcolumns.txt b/doc/files/deletematrixcolumns.txt index 51427c0..31356af 100644 --- a/doc/files/deletematrixcolumns.txt +++ b/doc/files/deletematrixcolumns.txt @@ -1,8 +1,9 @@ #title DeleteMatrixColumns [RCBasic Doc] -#header function DeleteMatrixColumns(mA, c, num_cols) +#header Function DeleteMatrixColumns(mA, c, num_cols) Removes the specified columns from a matrix Returns false if column are outside matrix #ref DeleteMatrixRows + diff --git a/doc/files/deletematrixrows.txt b/doc/files/deletematrixrows.txt index c6e3a4a..38153d4 100644 --- a/doc/files/deletematrixrows.txt +++ b/doc/files/deletematrixrows.txt @@ -1,8 +1,9 @@ #title DeleteMatrixRows [RCBasic Doc] -#header function DeleteMatrixRows(mA, r, num_rows) +#header Function DeleteMatrixRows(mA, r, num_rows) Removes the specified rows from a matrix Returns false if rows are outside matrix #ref DeleteMatrixColumns + diff --git a/doc/files/deletemesh.txt b/doc/files/deletemesh.txt index fca2650..18b9444 100644 --- a/doc/files/deletemesh.txt +++ b/doc/files/deletemesh.txt @@ -1,4 +1,5 @@ #title DeleteMesh [RCBasic Doc] -#header sub DeleteMesh( mesh ) +#header Sub DeleteMesh( mesh ) Removes a mesh from memory + diff --git a/doc/files/deletemusic.txt b/doc/files/deletemusic.txt index 617f5ab..39193de 100644 --- a/doc/files/deletemusic.txt +++ b/doc/files/deletemusic.txt @@ -1,4 +1,5 @@ #title DeleteMusic [RCBasic Doc] -#header sub DeleteMusic() +#header Sub DeleteMusic() Removes the current music track from memory + diff --git a/doc/files/deletesound.txt b/doc/files/deletesound.txt index 73852c7..775899d 100644 --- a/doc/files/deletesound.txt +++ b/doc/files/deletesound.txt @@ -1,4 +1,5 @@ #title DeleteSound [RCBasic Doc] -#header sub DeleteSound(snd) +#header Sub DeleteSound(snd) Removes a sound from memory + diff --git a/doc/files/deletesprite.txt b/doc/files/deletesprite.txt index aea9cd6..d67aece 100644 --- a/doc/files/deletesprite.txt +++ b/doc/files/deletesprite.txt @@ -46,3 +46,4 @@ Here is an example: #image "images/theEye.png" #ref OpenCanvasSpriteLayer SetSpritePosition CreateSprite + diff --git a/doc/files/deletespriteanimation.txt b/doc/files/deletespriteanimation.txt index 3fe5d23..94ee256 100644 --- a/doc/files/deletespriteanimation.txt +++ b/doc/files/deletespriteanimation.txt @@ -4,3 +4,4 @@ Delete's a sprite's animation #ref CreateSpriteAnimation + diff --git a/doc/files/deletestack_n.txt b/doc/files/deletestack_n.txt index 672e79c..a6cb9eb 100644 --- a/doc/files/deletestack_n.txt +++ b/doc/files/deletestack_n.txt @@ -1,4 +1,5 @@ #title DeleteStack_N [RCBasic Doc] -#header sub DeleteStack_N( num_stack ) +#header Sub DeleteStack_N( num_stack ) Removes a number stack from memory + diff --git a/doc/files/deletestack_s.txt b/doc/files/deletestack_s.txt index 2969a36..52c313f 100644 --- a/doc/files/deletestack_s.txt +++ b/doc/files/deletestack_s.txt @@ -1,4 +1,5 @@ #title DeleteStack_S [RCBasic Doc] -#header sub DeleteStack_S( str_stack ) +#header Sub DeleteStack_S( str_stack ) Removes a string stack from memory + diff --git a/doc/files/deletetilemap.txt b/doc/files/deletetilemap.txt index 620d238..01c8f5b 100644 --- a/doc/files/deletetilemap.txt +++ b/doc/files/deletetilemap.txt @@ -2,3 +2,4 @@ #header Sub DeleteTileMap(tilemap) + diff --git a/doc/files/deletetileset.txt b/doc/files/deletetileset.txt index 6d5b4e0..a9a5278 100644 --- a/doc/files/deletetileset.txt +++ b/doc/files/deletetileset.txt @@ -2,3 +2,4 @@ #header Sub DeleteTileSet(tileset) + diff --git a/doc/files/deletevideo.txt b/doc/files/deletevideo.txt index 486f00b..7ef2488 100644 --- a/doc/files/deletevideo.txt +++ b/doc/files/deletevideo.txt @@ -1,4 +1,5 @@ #title DeleteVideo [RCBasic Doc] -#header sub DeleteVideo() +#header Sub DeleteVideo() Removes the current video track from memory + diff --git a/doc/files/determinant.txt b/doc/files/determinant.txt index 8d255ba..8755c50 100644 --- a/doc/files/determinant.txt +++ b/doc/files/determinant.txt @@ -1,4 +1,5 @@ #title Determinant [RCBasic Doc] -#header function Determinant(mA) +#header Function Determinant(mA) Returns the determinant of matrix mA + diff --git a/doc/files/dimmatrix.txt b/doc/files/dimmatrix.txt index c94db52..85d8c2f 100644 --- a/doc/files/dimmatrix.txt +++ b/doc/files/dimmatrix.txt @@ -1,4 +1,5 @@ #title DimMatrix [RCBasic Doc] -#header function DimMatrix(m_rows, m_cols) +#header Function DimMatrix(m_rows, m_cols) Returns a new matrix + diff --git a/doc/files/dir.txt b/doc/files/dir.txt index 7c5de53..a4ed344 100644 --- a/doc/files/dir.txt +++ b/doc/files/dir.txt @@ -1,4 +1,5 @@ #title Dir$ [RCBasic Doc] -#header function Dir$() +#header Function Dir$() Returns the current working directory + diff --git a/doc/files/direxists.txt b/doc/files/direxists.txt index 05afda9..16045ae 100644 --- a/doc/files/direxists.txt +++ b/doc/files/direxists.txt @@ -1,4 +1,5 @@ #title DirExists [RCBasic Doc] -#header function DirExists(p$) +#header Function DirExists(p$) Returns true if a directory exists and false if not + diff --git a/doc/files/dirfirst.txt b/doc/files/dirfirst.txt index 2758f31..e92efc1 100644 --- a/doc/files/dirfirst.txt +++ b/doc/files/dirfirst.txt @@ -1,4 +1,5 @@ #title DirFirst$ [RCBasic Doc] -#header function DirFirst$() +#header Function DirFirst$() Resets the directory list poll and returns the first item in the current working directory + diff --git a/doc/files/dirnext.txt b/doc/files/dirnext.txt index 8657887..a99350a 100644 --- a/doc/files/dirnext.txt +++ b/doc/files/dirnext.txt @@ -1,6 +1,7 @@ #title DirNext$ [RCBasic Doc] -#header function DirNext$() +#header Function DirNext$() Returns the next item in the directory poll #ref DirFirst$ + diff --git a/doc/files/distance2d.txt b/doc/files/distance2d.txt index ef41e31..296ad8e 100644 --- a/doc/files/distance2d.txt +++ b/doc/files/distance2d.txt @@ -2,3 +2,4 @@ #header Function Distance2D(x1, y1, x2, y2) Returns the distance between 2 points in 2d space + diff --git a/doc/files/distance3d.txt b/doc/files/distance3d.txt index 20cfffb..80e161a 100644 --- a/doc/files/distance3d.txt +++ b/doc/files/distance3d.txt @@ -3,3 +3,4 @@ Returns the distance between 2 points in 3d space + diff --git a/doc/files/dotproduct.txt b/doc/files/dotproduct.txt new file mode 100644 index 0000000..186754f --- /dev/null +++ b/doc/files/dotproduct.txt @@ -0,0 +1,5 @@ +#title DotProduct [RCBasic Doc] +#header Function DotProduct(x1, y1, z1, x2, y2, z2) + +Returns the dot product from 2 vectors + diff --git a/doc/files/drawimage.txt b/doc/files/drawimage.txt index 03d0504..346557d 100644 --- a/doc/files/drawimage.txt +++ b/doc/files/drawimage.txt @@ -1,4 +1,5 @@ #title DrawImage [RCBasic Doc] -#header sub DrawImage(img, x, y) +#header Sub DrawImage(img, x, y) Draws an image on the active canvas + diff --git a/doc/files/drawimage_blit.txt b/doc/files/drawimage_blit.txt index 3b49158..c7ddd32 100644 --- a/doc/files/drawimage_blit.txt +++ b/doc/files/drawimage_blit.txt @@ -1,4 +1,5 @@ #title DrawImage_Blit [RCBasic Doc] -#header sub DrawImage_Blit(img, x, y, src_x, src_y, src_w, src_h) +#header Sub DrawImage_Blit(img, x, y, src_x, src_y, src_w, src_h) Draws a portion of an image to the current canvas. + diff --git a/doc/files/drawimage_blitex.txt b/doc/files/drawimage_blitex.txt index b0fb003..97c80e9 100644 --- a/doc/files/drawimage_blitex.txt +++ b/doc/files/drawimage_blitex.txt @@ -1,6 +1,7 @@ #title DrawImage_BlitEx [RCBasic Doc] -#header sub DrawImage_BlitEx(slot, x, y, w, h, src_x, src_y, src_w, src_h) +#header Sub DrawImage_BlitEx(slot, x, y, w, h, src_x, src_y, src_w, src_h) Draws a portion of an image to the current canvas scaled to a given width and height. #ref DrawImage_Blit + diff --git a/doc/files/drawimage_flip.txt b/doc/files/drawimage_flip.txt index 7f55e21..a7e033a 100644 --- a/doc/files/drawimage_flip.txt +++ b/doc/files/drawimage_flip.txt @@ -1,8 +1,9 @@ #title DrawImage_Flip [RCBasic Doc] -#header sub DrawImage_Flip(slot, x, y, h, v) +#header Sub DrawImage_Flip(slot, x, y, h, v) Draws an image flipped horizontally or vertically. Note: h and v are boolean values #ref DrawImage_FlipEx + diff --git a/doc/files/drawimage_flipex.txt b/doc/files/drawimage_flipex.txt index 02e7b99..0e0be79 100644 --- a/doc/files/drawimage_flipex.txt +++ b/doc/files/drawimage_flipex.txt @@ -1,8 +1,9 @@ #title DrawImage_FlipEx [RCBasic Doc] -#header sub DrawImage_FlipEx(slot, x, y, src_x, src_y, src_w, src_h, h, v) +#header Sub DrawImage_FlipEx(slot, x, y, src_x, src_y, src_w, src_h, h, v) Draws a portion of an image flipped horizontally or vertically. Note: h and v are boolean values #ref DrawImage_Flip + diff --git a/doc/files/drawimage_rotate.txt b/doc/files/drawimage_rotate.txt index bcba804..3f18c87 100644 --- a/doc/files/drawimage_rotate.txt +++ b/doc/files/drawimage_rotate.txt @@ -1,4 +1,5 @@ #title DrawImage_Rotate [RCBasic Doc] -#header sub DrawImage_Rotate(slot, x, y, angle) +#header Sub DrawImage_Rotate(slot, x, y, angle) Draws an image to the current canvas rotated by a given angle. + diff --git a/doc/files/drawimage_rotateex.txt b/doc/files/drawimage_rotateex.txt index ccf321b..f290f47 100644 --- a/doc/files/drawimage_rotateex.txt +++ b/doc/files/drawimage_rotateex.txt @@ -1,4 +1,5 @@ #title DrawImage_RotateEx [RCBasic Doc] -#header sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle) +#header Sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle) Draws a portion of an image to the current canvas rotated by a given angle. + diff --git a/doc/files/drawimage_rotozoom.txt b/doc/files/drawimage_rotozoom.txt index 41417e7..46c7826 100644 --- a/doc/files/drawimage_rotozoom.txt +++ b/doc/files/drawimage_rotozoom.txt @@ -1,4 +1,5 @@ #title DrawImage_Rotozoom [RCBasic Doc] -#header sub DrawImage_Rotozoom(slot, x, y, angle, zx, zy) +#header Sub DrawImage_Rotozoom(slot, x, y, angle, zx, zy) Draws an image to the current canvas rotated and scaled + diff --git a/doc/files/drawimage_rotozoomex.txt b/doc/files/drawimage_rotozoomex.txt index 6f41a86..b29a973 100644 --- a/doc/files/drawimage_rotozoomex.txt +++ b/doc/files/drawimage_rotozoomex.txt @@ -1,4 +1,5 @@ #title DrawImage_RotozoomEx [RCBasic Doc] -#header sub DrawImage_RotozoomEx(slot, x, y, src_x, src_y, src_w, src_h, angle, zx, zy) +#header Sub DrawImage_RotozoomEx(slot, x, y, src_x, src_y, src_w, src_h, angle, zx, zy) Draws a portion of an image to the current canvas rotated and scaled + diff --git a/doc/files/drawimage_zoom.txt b/doc/files/drawimage_zoom.txt index 1e12138..4d7feb3 100644 --- a/doc/files/drawimage_zoom.txt +++ b/doc/files/drawimage_zoom.txt @@ -1,6 +1,7 @@ #title DrawImage_Zoom [RCBasic Doc] -#header sub DrawImage_Zoom(slot, x, y, zx, zy) +#header Sub DrawImage_Zoom(slot, x, y, zx, zy) Draws an image to the current canvas scaled by a given factor #ref DrawImage_ZoomEx + diff --git a/doc/files/drawimage_zoomex.txt b/doc/files/drawimage_zoomex.txt index 35e51bb..a451a5c 100644 --- a/doc/files/drawimage_zoomex.txt +++ b/doc/files/drawimage_zoomex.txt @@ -1,6 +1,7 @@ #title DrawImage_ZoomEx [RCBasic Doc] -#header sub DrawImage_ZoomEx(slot, x, y, src_x, src_y, src_w, src_h, zx, zy) +#header Sub DrawImage_ZoomEx(slot, x, y, src_x, src_y, src_w, src_h, zx, zy) Draws a portion of an Image to the current canvas scaled by a given factor #ref DrawImage_Zoom + diff --git a/doc/files/drawtext.txt b/doc/files/drawtext.txt index 6a6cbbe..5c66a1c 100644 --- a/doc/files/drawtext.txt +++ b/doc/files/drawtext.txt @@ -1,4 +1,5 @@ #title DrawText [RCBasic Doc] -#header sub DrawText(txt$, x, y) +#header Sub DrawText(txt$, x, y) Draws text to the current canvas + diff --git a/doc/files/drawtilemap.txt b/doc/files/drawtilemap.txt index cf491fa..fd35dd4 100644 --- a/doc/files/drawtilemap.txt +++ b/doc/files/drawtilemap.txt @@ -13,3 +13,4 @@ Parameters: #li offset_x, offset_y - The location in the tilemap to start drawing from #/list + diff --git a/doc/files/easter.txt b/doc/files/easter.txt index b5842b3..73530eb 100644 --- a/doc/files/easter.txt +++ b/doc/files/easter.txt @@ -1,4 +1,5 @@ #title Easter$ [RCBasic Doc] -#header function Easter$(year) +#header Function Easter$(year) Returns easter of the year passed to it. + diff --git a/doc/files/ellipse.txt b/doc/files/ellipse.txt index 5917639..938d651 100644 --- a/doc/files/ellipse.txt +++ b/doc/files/ellipse.txt @@ -1,4 +1,5 @@ #title Ellipse [RCBasic Doc] -#header sub Ellipse(x,y,rx,ry) +#header Sub Ellipse(x,y,rx,ry) Draws an ellipse on the current canvas. + diff --git a/doc/files/ellipsefill.txt b/doc/files/ellipsefill.txt index 4b195d6..3b80528 100644 --- a/doc/files/ellipsefill.txt +++ b/doc/files/ellipsefill.txt @@ -1,4 +1,5 @@ #title EllipseFill [RCBasic Doc] -#header sub EllipseFill(x,y,rx,ry) +#header Sub EllipseFill(x,y,rx,ry) Draws a filled ellipse on the current canvas. + diff --git a/doc/files/enablejointlimit.txt b/doc/files/enablejointlimit.txt index 231e99a..417845b 100644 --- a/doc/files/enablejointlimit.txt +++ b/doc/files/enablejointlimit.txt @@ -1,5 +1,5 @@ -#title enableJointLimit [RCBasic Doc] -#header sub enableJointLimit( joint_id, flag) +#title EnableJointLimit [RCBasic Doc] +#header Sub EnableJointLimit( joint_id, flag) Enables or disables joint limits @@ -11,3 +11,4 @@ Used with #/list #ref JointIsLimitEnabled SetJointLimits + diff --git a/doc/files/enablejointmotor.txt b/doc/files/enablejointmotor.txt index 26a4640..0039e4d 100644 --- a/doc/files/enablejointmotor.txt +++ b/doc/files/enablejointmotor.txt @@ -1,5 +1,5 @@ -#title enableJointMotor [RCBasic Doc] -#header sub enableJointMotor( joint_id, flag) +#title EnableJointMotor [RCBasic Doc] +#header Sub EnableJointMotor( joint_id, flag) Enables or disables the joint motor @@ -11,3 +11,4 @@ Used with #/list #ref JointMotorIsEnabled + diff --git a/doc/files/env.txt b/doc/files/env.txt index 630b8f0..829ad14 100644 --- a/doc/files/env.txt +++ b/doc/files/env.txt @@ -1,6 +1,7 @@ #title Env$ [RCBasic Doc] -#header function Env$(v$) +#header Function Env$(v$) Returns the value of the environment variable passed to it. #ref SetEnv + diff --git a/doc/files/eof.txt b/doc/files/eof.txt index 425a8f4..01f0f56 100644 --- a/doc/files/eof.txt +++ b/doc/files/eof.txt @@ -1,4 +1,5 @@ #title EOF [RCBasic Doc] -#header function EOF(stream) +#header Function EOF(stream) Returns true when end of file is reached + diff --git a/doc/files/evaljs.txt b/doc/files/evaljs.txt index 8136032..74204cd 100644 --- a/doc/files/evaljs.txt +++ b/doc/files/evaljs.txt @@ -6,3 +6,4 @@ Runs javascript code Returns the return value of the javascript code NOTE: ONLY WORKS IN WEB PORT + diff --git a/doc/files/exp.txt b/doc/files/exp.txt index 054b1db..d190bd1 100644 --- a/doc/files/exp.txt +++ b/doc/files/exp.txt @@ -1,4 +1,5 @@ #title Exp [RCBasic Doc] -#header function Exp(n) +#header Function Exp(n) Returns the exponential function of a number. + diff --git a/doc/files/fademusicin.txt b/doc/files/fademusicin.txt index fd48cc6..f8b6bd2 100644 --- a/doc/files/fademusicin.txt +++ b/doc/files/fademusicin.txt @@ -1,4 +1,5 @@ #title FadeMusicIn [RCBasic Doc] -#header sub FadeMusicIn(fade_time, loops) +#header Sub FadeMusicIn(fade_time, loops) Fades music in + diff --git a/doc/files/fademusicout.txt b/doc/files/fademusicout.txt index 688c293..f02c002 100644 --- a/doc/files/fademusicout.txt +++ b/doc/files/fademusicout.txt @@ -1,4 +1,5 @@ #title FadeMusicOut [RCBasic Doc] -#header sub FadeMusicOut(fade_time) +#header Sub FadeMusicOut(fade_time) Fades music out + diff --git a/doc/files/fileexists.txt b/doc/files/fileexists.txt index 0dee4f5..2be078c 100644 --- a/doc/files/fileexists.txt +++ b/doc/files/fileexists.txt @@ -1,4 +1,5 @@ #title FileExists [RCBasic Doc] -#header function FileExists(fileName$) +#header Function FileExists(fileName$) Returns true if a file exists + diff --git a/doc/files/filelength.txt b/doc/files/filelength.txt index 4a1fd6d..6261ca3 100644 --- a/doc/files/filelength.txt +++ b/doc/files/filelength.txt @@ -1,4 +1,5 @@ #title FileLength [RCBasic Doc] -#header function FileLength(fileName$) +#header Function FileLength(fileName$) Returns the size of a file in bytes. + diff --git a/doc/files/fillmatrix.txt b/doc/files/fillmatrix.txt index d86419b..978a35a 100644 --- a/doc/files/fillmatrix.txt +++ b/doc/files/fillmatrix.txt @@ -1,4 +1,5 @@ #title FillMatrix [RCBasic Doc] -#header sub FillMatrix(mA, v) +#header Sub FillMatrix(mA, v) Fills matrix with the given value + diff --git a/doc/files/fillmatrixcolumns.txt b/doc/files/fillmatrixcolumns.txt index 45f8649..0f734e5 100644 --- a/doc/files/fillmatrixcolumns.txt +++ b/doc/files/fillmatrixcolumns.txt @@ -1,4 +1,5 @@ #title FillMatrixColumns [RCBasic Doc] -#header function FillMatrixColumns(mA, c, num_cols, v) +#header Function FillMatrixColumns(mA, c, num_cols, v) Fills matrix columns with the given value starting at the given column + diff --git a/doc/files/fillmatrixrows.txt b/doc/files/fillmatrixrows.txt index 4dfdc39..f42b00b 100644 --- a/doc/files/fillmatrixrows.txt +++ b/doc/files/fillmatrixrows.txt @@ -1,4 +1,5 @@ #title FillMatrixRows [RCBasic Doc] -#header function FillMatrixRows(mA, r, num_rows, v) +#header Function FillMatrixRows(mA, r, num_rows, v) Fills matrix rows with the given value starting at the given row + diff --git a/doc/files/filltile.txt b/doc/files/filltile.txt index 2d33d7a..f8c6da6 100644 --- a/doc/files/filltile.txt +++ b/doc/files/filltile.txt @@ -4,3 +4,4 @@ Fills an area of a tile map with a specified tile + diff --git a/doc/files/flashwindow.txt b/doc/files/flashwindow.txt index 9fd4805..d72ad7d 100644 --- a/doc/files/flashwindow.txt +++ b/doc/files/flashwindow.txt @@ -1,5 +1,5 @@ #title FlashWindow [RCBasic Doc] -#header function FlashWindow( flag ) +#header Function FlashWindow( flag ) Flashes a window to specify an alert @@ -11,3 +11,4 @@ Possible flag values: #li FLASH_BRIEFLY #li FLASH_UNTIL_FOCUSED #/list + diff --git a/doc/files/flipmeshsurfaces.txt b/doc/files/flipmeshsurfaces.txt index db3dbeb..bcab175 100644 --- a/doc/files/flipmeshsurfaces.txt +++ b/doc/files/flipmeshsurfaces.txt @@ -2,3 +2,4 @@ #header Sub FlipMeshSurfaces( mesh ) Changes the facing direction of triangles in a mesh + diff --git a/doc/files/floodfill.txt b/doc/files/floodfill.txt index 4b6ad3a..eb4be11 100644 --- a/doc/files/floodfill.txt +++ b/doc/files/floodfill.txt @@ -1,6 +1,7 @@ #title FloodFill [RCBasic Doc] -#header sub FloodFill(x,y) +#header Sub FloodFill(x,y) Fills a closed shape in with the current draw color NOTE: It is not recommended to floodfill the full screen since its prone to stack overload + diff --git a/doc/files/fontexists.txt b/doc/files/fontexists.txt index 9e2c720..d990931 100644 --- a/doc/files/fontexists.txt +++ b/doc/files/fontexists.txt @@ -2,3 +2,4 @@ #header Function FontExists(fnt_id) Returns True if the specified font id is associated with a loaded font + diff --git a/doc/files/fprint.txt b/doc/files/fprint.txt index e2cc2f5..8ebee2a 100644 --- a/doc/files/fprint.txt +++ b/doc/files/fprint.txt @@ -1,6 +1,7 @@ #title Fprint [RCBasic Doc] -#header sub Fprint(txt$) +#header Sub Fprint(txt$) Outputs text to the console NOTE: It does the exact same thing as Print. This is here for legacy reasons (ie. I am too lazy to remove it.) + diff --git a/doc/files/fps.txt b/doc/files/fps.txt index 6e53436..8c7f9c7 100644 --- a/doc/files/fps.txt +++ b/doc/files/fps.txt @@ -1,4 +1,5 @@ #title FPS [RCBasic Doc] -#header function FPS() +#header Function FPS() Returns the number of frames being rendered per second + diff --git a/doc/files/frac.txt b/doc/files/frac.txt index 369f3b2..4625004 100644 --- a/doc/files/frac.txt +++ b/doc/files/frac.txt @@ -1,4 +1,5 @@ #title Frac [RCBasic Doc] -#header function Frac(n) +#header Function Frac(n) Returns the decimal portion of a number. + diff --git a/doc/files/generatecompositeaabbfromchildren.txt b/doc/files/generatecompositeaabbfromchildren.txt new file mode 100644 index 0000000..16dc6f8 --- /dev/null +++ b/doc/files/generatecompositeaabbfromchildren.txt @@ -0,0 +1,5 @@ +#title GenerateCompositeAABBFromChildren [RCBasic Doc] +#header Sub GenerateCompositeAABBFromChildren(actor) + +Generates a bounding box based on the child actors + diff --git a/doc/files/getaccel.txt b/doc/files/getaccel.txt index 8da28ae..6976506 100644 --- a/doc/files/getaccel.txt +++ b/doc/files/getaccel.txt @@ -1,4 +1,5 @@ #title GetAccel [RCBasic Doc] -#header sub GetAccel(accel_num, ByRef x, ByRef y, ByRef z) +#header Sub GetAccel(accel_num, ByRef x, ByRef y, ByRef z) Gets the axis values for an accelerometer. + diff --git a/doc/files/getactoraabb.txt b/doc/files/getactoraabb.txt index dda85b1..486ea9e 100644 --- a/doc/files/getactoraabb.txt +++ b/doc/files/getactoraabb.txt @@ -1,4 +1,5 @@ -#title getActorAABB [RCBasic Doc] -#header sub getActorAABB( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z) +#title GetActorAABB [RCBasic Doc] +#header Sub GetActorAABB( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z) Gets the bounding box for an actor. + diff --git a/doc/files/getactorangulardamping.txt b/doc/files/getactorangulardamping.txt index dfbe10a..83ca3b8 100644 --- a/doc/files/getactorangulardamping.txt +++ b/doc/files/getactorangulardamping.txt @@ -1,6 +1,7 @@ #title GetActorAngularDamping [RCBasic Doc] -#header function GetActorAngularDamping( actor) +#header Function GetActorAngularDamping( actor) Returns the amount of angular damping set on the actor #ref SetActorDamping ApplyActorDamping GetActorLinearDamping + diff --git a/doc/files/getactorangularfactor.txt b/doc/files/getactorangularfactor.txt index 9edd76b..b2ce3f8 100644 --- a/doc/files/getactorangularfactor.txt +++ b/doc/files/getactorangularfactor.txt @@ -1,6 +1,7 @@ -#title getActorAngularFactor [RCBasic Doc] -#header sub getActorAngularFactor( actor, ByRef x, ByRef y, ByRef z) +#title GetActorAngularFactor [RCBasic Doc] +#header Sub GetActorAngularFactor( actor, ByRef x, ByRef y, ByRef z) Returns the angular factor set on an actor #ref SetActorAngularFactor GetActorLinearFactor SetActorLinearFactor + diff --git a/doc/files/getactorangularsleepthreshold.txt b/doc/files/getactorangularsleepthreshold.txt index 3eded28..37389ff 100644 --- a/doc/files/getactorangularsleepthreshold.txt +++ b/doc/files/getactorangularsleepthreshold.txt @@ -1,6 +1,7 @@ #title GetActorAngularSleepThreshold [RCBasic Doc] -#header function GetActorAngularSleepThreshold( actor) +#header Function GetActorAngularSleepThreshold( actor) Returns the Angular deactivation threshold for the actor #ref SetActorSleepThresholds GetActorLinearSleepThreshold + diff --git a/doc/files/getactorangularvelocitylocal.txt b/doc/files/getactorangularvelocitylocal.txt index 105a9d3..21739d6 100644 --- a/doc/files/getactorangularvelocitylocal.txt +++ b/doc/files/getactorangularvelocitylocal.txt @@ -1,6 +1,7 @@ -#title getActorAngularVelocityLocal [RCBasic Doc] -#header sub getActorAngularVelocityLocal( actor, ByRef x, ByRef y, ByRef z) +#title GetActorAngularVelocityLocal [RCBasic Doc] +#header Sub GetActorAngularVelocityLocal( actor, ByRef x, ByRef y, ByRef z) Gets an actor's Angular Velocity #ref GetActorAngularVelocityWorld SetActorAngularVelocityLocal SetActorAngularVelocityWorld + diff --git a/doc/files/getactorangularvelocityworld.txt b/doc/files/getactorangularvelocityworld.txt index 6737f6f..064e436 100644 --- a/doc/files/getactorangularvelocityworld.txt +++ b/doc/files/getactorangularvelocityworld.txt @@ -1,6 +1,7 @@ -#title getActorAngularVelocityWorld [RCBasic Doc] -#header sub getActorAngularVelocityWorld( actor, ByRef x, ByRef y, ByRef z) +#title GetActorAngularVelocityWorld [RCBasic Doc] +#header Sub GetActorAngularVelocityWorld( actor, ByRef x, ByRef y, ByRef z) Gets an actor's Angular Velocity #ref GetActorAngularVelocityLocal SetActorAngularVelocityLocal SetActorAngularVelocityWorld + diff --git a/doc/files/getactoranimationendframe.txt b/doc/files/getactoranimationendframe.txt index 3e171f4..bbdf689 100644 --- a/doc/files/getactoranimationendframe.txt +++ b/doc/files/getactoranimationendframe.txt @@ -4,3 +4,4 @@ Returns the last frame in an actor's animation #ref SetActorAnimationFrames + diff --git a/doc/files/getactoranimationspeed.txt b/doc/files/getactoranimationspeed.txt index e16a7fb..3351d08 100644 --- a/doc/files/getactoranimationspeed.txt +++ b/doc/files/getactoranimationspeed.txt @@ -1,6 +1,7 @@ #title GetActorAnimationSpeed [RCBasic Doc] -#header function GetActorAnimationSpeed( actor, animation ) +#header Function GetActorAnimationSpeed( actor, animation ) Returns actor's animation speed in frames per second #ref SetActorAnimationSpeed + diff --git a/doc/files/getactoranimationstartframe.txt b/doc/files/getactoranimationstartframe.txt index 0b92f17..0e641e1 100644 --- a/doc/files/getactoranimationstartframe.txt +++ b/doc/files/getactoranimationstartframe.txt @@ -4,3 +4,4 @@ Returns the first frame in an actor's animation #ref SetActorAnimationFrames + diff --git a/doc/files/getactorautoculling.txt b/doc/files/getactorautoculling.txt index 38bcf49..83d9d45 100644 --- a/doc/files/getactorautoculling.txt +++ b/doc/files/getactorautoculling.txt @@ -1,5 +1,5 @@ #title GetActorAutoCulling [RCBasic Doc] -#header function GetActorAutoCulling( actor ) +#header Function GetActorAutoCulling( actor ) Returns the automatic culling state for an actor @@ -14,3 +14,4 @@ Possible Culling States #ref SetActorAutoCulling + diff --git a/doc/files/getactorboneabsolutetranform.txt b/doc/files/getactorboneabsolutetranform.txt new file mode 100644 index 0000000..7c20898 --- /dev/null +++ b/doc/files/getactorboneabsolutetranform.txt @@ -0,0 +1,8 @@ +#title GetActorBoneAbsoluteTranform [RCBasic Doc] +#header Function GetActorBoneAbsoluteTranform( actor, bone_index, t_matrix ) + +Stores the absolute transform of a bone in t_matrix + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + + diff --git a/doc/files/getactorbonecount.txt b/doc/files/getactorbonecount.txt new file mode 100644 index 0000000..1aecd56 --- /dev/null +++ b/doc/files/getactorbonecount.txt @@ -0,0 +1,8 @@ +#title GetActorBoneCount [RCBasic Doc] +#header Function GetActorBoneCount( actor ) + +Returns the number of bones in an actor + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + + diff --git a/doc/files/getactorboneindex.txt b/doc/files/getactorboneindex.txt new file mode 100644 index 0000000..aaa2253 --- /dev/null +++ b/doc/files/getactorboneindex.txt @@ -0,0 +1,8 @@ +#title GetActorBoneIndex [RCBasic Doc] +#header Function GetActorBoneIndex( actor, bone_name$ ) + +Returns a bone index based on its name + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + + diff --git a/doc/files/getactorbonename.txt b/doc/files/getactorbonename.txt new file mode 100644 index 0000000..4b15673 --- /dev/null +++ b/doc/files/getactorbonename.txt @@ -0,0 +1,8 @@ +#title GetActorBoneName$ [RCBasic Doc] +#header Function GetActorBoneName$( actor, bone_index ) + +Returns an actor's bone name + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + + diff --git a/doc/files/getactorboneposition.txt b/doc/files/getactorboneposition.txt new file mode 100644 index 0000000..d8de014 --- /dev/null +++ b/doc/files/getactorboneposition.txt @@ -0,0 +1,8 @@ +#title GetActorBonePosition [RCBasic Doc] +#header Function GetActorBonePosition( actor, bone_index, ByRef x, ByRef y, ByRef z ) + +Gets an actor's bone position + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + + diff --git a/doc/files/getactorbonerelativetranform.txt b/doc/files/getactorbonerelativetranform.txt new file mode 100644 index 0000000..e559e9e --- /dev/null +++ b/doc/files/getactorbonerelativetranform.txt @@ -0,0 +1,8 @@ +#title GetActorBoneRelativeTranform [RCBasic Doc] +#header Function GetActorBoneRelativeTranform( actor, bone_index, t_matrix ) + +Stores the local transform of a bone in t_matrix + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + + diff --git a/doc/files/getactorbonerotation.txt b/doc/files/getactorbonerotation.txt new file mode 100644 index 0000000..3fc087f --- /dev/null +++ b/doc/files/getactorbonerotation.txt @@ -0,0 +1,8 @@ +#title GetActorBoneRotation [RCBasic Doc] +#header Function GetActorBoneRotation( actor, bone_index, ByRef x, ByRef y, ByRef z ) + +Gets an actor's bone rotation + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + + diff --git a/doc/files/getactorbonescale.txt b/doc/files/getactorbonescale.txt new file mode 100644 index 0000000..ef74872 --- /dev/null +++ b/doc/files/getactorbonescale.txt @@ -0,0 +1,7 @@ +#title GetActorBoneScale [RCBasic Doc] +#header Function GetActorBoneScale( actor, bone_index, ByRef x, ByRef y, ByRef z ) + +Returns the scale transform for an actor's bone + +NOTE: This is only for actors that use skeletal animation (ie. *.b3d, *.x, *.ms3d, and actors created from Anim8or files) + diff --git a/doc/files/getactorcenter.txt b/doc/files/getactorcenter.txt index d5812bd..f6c5bf5 100644 --- a/doc/files/getactorcenter.txt +++ b/doc/files/getactorcenter.txt @@ -1,4 +1,5 @@ -#title getActorCenter [RCBasic Doc] -#header sub getActorCenter( actor, ByRef x, ByRef y, ByRef z) +#title GetActorCenter [RCBasic Doc] +#header Sub GetActorCenter( actor, ByRef x, ByRef y, ByRef z) Gets an actor's center of mass position. This is useful for setting the origin of constraints. + diff --git a/doc/files/getactorcollision.txt b/doc/files/getactorcollision.txt index 4bf4654..f9b1d6d 100644 --- a/doc/files/getactorcollision.txt +++ b/doc/files/getactorcollision.txt @@ -1,6 +1,7 @@ #title GetActorCollision [RCBasic Doc] -#header function GetActorCollision(actor1, actor2) +#header Function GetActorCollision(actor1, actor2) Returns true if 2 actors collide Note: This function will work with solid and non solid actors + diff --git a/doc/files/getactorcollisionshape.txt b/doc/files/getactorcollisionshape.txt deleted file mode 100644 index f9e329c..0000000 --- a/doc/files/getactorcollisionshape.txt +++ /dev/null @@ -1,18 +0,0 @@ -#title GetActorCollisionShape [RCBasic Doc] -#header function GetActorCollisionShape(actor) - -Returns the actor's collision shape - -Possible values: -#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 SetActorCollisionShape diff --git a/doc/files/getactorcurrentanimation.txt b/doc/files/getactorcurrentanimation.txt index 429c768..fc292ec 100644 --- a/doc/files/getactorcurrentanimation.txt +++ b/doc/files/getactorcurrentanimation.txt @@ -6,3 +6,4 @@ Returns the current animation set on an actor Note: Current animation will be 0 if the actor's frame was set with SetActorFrame() #ref SetActorAnimation SetActorFrame + diff --git a/doc/files/getactorcurrentframe.txt b/doc/files/getactorcurrentframe.txt deleted file mode 100644 index 91247b5..0000000 --- a/doc/files/getactorcurrentframe.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title GetActorCurrentFrame [RCBasic Doc] -#header function GetActorCurrentFrame( actor ) - -Returns an actor's current frame of animation diff --git a/doc/files/getactorendframe.txt b/doc/files/getactorendframe.txt deleted file mode 100644 index d4bd288..0000000 --- a/doc/files/getactorendframe.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title GetActorEndFrame [RCBasic Doc] -#header function GetActorEndFrame( actor ) - -Returns the last frame of an actor's animation diff --git a/doc/files/getactorframe.txt b/doc/files/getactorframe.txt index d9281ad..c2f10f5 100644 --- a/doc/files/getactorframe.txt +++ b/doc/files/getactorframe.txt @@ -1,7 +1,8 @@ #title GetActorFrame [RCBasic Doc] -#header function GetActorFrame(actor) +#header Function GetActorFrame(actor) Returns the current frame number an actor is currently rendering #ref SetActorFrame GetActorAnimationFrame + diff --git a/doc/files/getactorgravity.txt b/doc/files/getactorgravity.txt index 56b0dd8..c86a736 100644 --- a/doc/files/getactorgravity.txt +++ b/doc/files/getactorgravity.txt @@ -1,6 +1,7 @@ #title GetActorGravity [RCBasic Doc] -#header sub GetActorGravity( actor, ByRef x, ByRef y, ByRef z ) +#header Sub GetActorGravity( actor, ByRef x, ByRef y, ByRef z ) Gets the gravity of an actor along each access. #ref SetActorGravity + diff --git a/doc/files/getactorinverseinertiadiaglocal.txt b/doc/files/getactorinverseinertiadiaglocal.txt index 073f848..c70fd32 100644 --- a/doc/files/getactorinverseinertiadiaglocal.txt +++ b/doc/files/getactorinverseinertiadiaglocal.txt @@ -1,4 +1,5 @@ -#title getActorInverseInertiaDiagLocal [RCBasic Doc] -#header sub getActorInverseInertiaDiagLocal( actor, ByRef x, ByRef y, ByRef z) +#title GetActorInverseInertiaDiagLocal [RCBasic Doc] +#header Sub GetActorInverseInertiaDiagLocal( actor, ByRef x, ByRef y, ByRef z) Gets the inverse of the inertia tensor's diagonal components in the local space. This is used to compute how the actor reacts to rotational forces (torques) applied to it. + diff --git a/doc/files/getactorinversemass.txt b/doc/files/getactorinversemass.txt index 1e546ac..6d4b80e 100644 --- a/doc/files/getactorinversemass.txt +++ b/doc/files/getactorinversemass.txt @@ -1,6 +1,7 @@ -#title getActorInverseMass [RCBasic Doc] -#header function getActorInverseMass( actor) +#title GetActorInverseMass [RCBasic Doc] +#header Function GetActorInverseMass( actor) Returns an actor's inverse mass #ref SetActorMassProperties + diff --git a/doc/files/getactorlineardamping.txt b/doc/files/getactorlineardamping.txt index 29d4708..ff27eaf 100644 --- a/doc/files/getactorlineardamping.txt +++ b/doc/files/getactorlineardamping.txt @@ -1,6 +1,7 @@ #title GetActorLinearDamping [RCBasic Doc] -#header function GetActorLinearDamping( actor) +#header Function GetActorLinearDamping( actor) Return's an actor's linear damping #ref SetActorDamping GetActorAngularDamping + diff --git a/doc/files/getactorlinearfactor.txt b/doc/files/getactorlinearfactor.txt index 3967933..f16ac25 100644 --- a/doc/files/getactorlinearfactor.txt +++ b/doc/files/getactorlinearfactor.txt @@ -1,6 +1,7 @@ #title GetActorLinearFactor [RCBasic Doc] -#header sub GetActorLinearFactor( actor, ByRef x, ByRef y, ByRef z) +#header Sub GetActorLinearFactor( actor, ByRef x, ByRef y, ByRef z) Gets an actor's linear factor #ref SetActorLinearFactor GetActorAngularFactor SetActorAngularFactor + diff --git a/doc/files/getactorlinearsleepthreshold.txt b/doc/files/getactorlinearsleepthreshold.txt index fb22817..2e6d95c 100644 --- a/doc/files/getactorlinearsleepthreshold.txt +++ b/doc/files/getactorlinearsleepthreshold.txt @@ -1,6 +1,7 @@ #title GetActorLinearSleepThreshold [RCBasic Doc] -#header function GetActorLinearSleepThreshold( actor) +#header Function GetActorLinearSleepThreshold( actor) Returns the linear deactivation threshold for the actor #ref SetActorSleepThresholds GetActorAngularSleepThreshold + diff --git a/doc/files/getactorlinearvelocitylocal.txt b/doc/files/getactorlinearvelocitylocal.txt index a7539bd..ffa769f 100644 --- a/doc/files/getactorlinearvelocitylocal.txt +++ b/doc/files/getactorlinearvelocitylocal.txt @@ -1,6 +1,7 @@ #title GetActorLinearVelocityLocal [RCBasic Doc] -#header sub GetActorLinearVelocityLocal( actor, ByRef x, ByRef y, ByRef z) +#header Sub GetActorLinearVelocityLocal( actor, ByRef x, ByRef y, ByRef z) Gets actor's linear velocity #ref SetActorLinearVelocityLocal SetActorLinearVelocityWorld + diff --git a/doc/files/getactorlinearvelocityworld.txt b/doc/files/getactorlinearvelocityworld.txt index 52ee7d8..f9b2e84 100644 --- a/doc/files/getactorlinearvelocityworld.txt +++ b/doc/files/getactorlinearvelocityworld.txt @@ -1,7 +1,8 @@ -#title getActorLinearVelocityWorld [RCBasic Doc] -#header sub getActorLinearVelocityWorld( actor, ByRef x, ByRef y, ByRef z) +#title GetActorLinearVelocityWorld [RCBasic Doc] +#header Sub GetActorLinearVelocityWorld( actor, ByRef x, ByRef y, ByRef z) Gets actor's linear velocity #ref SetActorLinearVelocityLocal SetActorLinearVelocityWorld + diff --git a/doc/files/getactorlocalinertia.txt b/doc/files/getactorlocalinertia.txt index 7bf348c..22ffd95 100644 --- a/doc/files/getactorlocalinertia.txt +++ b/doc/files/getactorlocalinertia.txt @@ -1,5 +1,6 @@ #title GetActorLocalInertia [RCBasic Doc] -#header sub GetActorLocalInertia( actor, ByRef x, ByRef y, ByRef z) +#header Sub GetActorLocalInertia( actor, ByRef x, ByRef y, ByRef z) Gets the local inertia tensor of an actor. The inertia tensor describes how an actor resists rotational motion depending on its mass distribution relative to its center of mass. + diff --git a/doc/files/getactorlocalpointvelocity.txt b/doc/files/getactorlocalpointvelocity.txt deleted file mode 100644 index cc914e0..0000000 --- a/doc/files/getactorlocalpointvelocity.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title getActorLocalPointVelocity [RCBasic Doc] -#header sub getActorLocalPointVelocity( actor, rel_x, rel_y, rel_z, ByRef x, ByRef y, ByRef z) - -Gets the linear velocity of a specific point on an actor, given its position in the actor's local coordinate space. This is useful for determining how fast and in what direction a particular point on the actor is moving, accounting for both the body's linear velocity and its rotational motion (angular velocity). diff --git a/doc/files/getactormaterial.txt b/doc/files/getactormaterial.txt index 13d1356..dfb3f04 100644 --- a/doc/files/getactormaterial.txt +++ b/doc/files/getactormaterial.txt @@ -1,6 +1,7 @@ -#title getActorMaterial [RCBasic Doc] -#header function getActorMaterial( actor, material_num) +#title GetActorMaterial [RCBasic Doc] +#header Function GetActorMaterial( actor, material_num) Returns an actor's material id. Actor's can have multiple materials but generally you want material 0 for most Actor's. + diff --git a/doc/files/getactormaterialcount.txt b/doc/files/getactormaterialcount.txt index 6e1f86e..6e315d2 100644 --- a/doc/files/getactormaterialcount.txt +++ b/doc/files/getactormaterialcount.txt @@ -1,4 +1,5 @@ -#title getActorMaterialCount [RCBasic Doc] -#header function getActorMaterialCount( actor) +#title GetActorMaterialCount [RCBasic Doc] +#header Function GetActorMaterialCount( actor) Returns the number of materials for an actor. + diff --git a/doc/files/getactormaterialflag.txt b/doc/files/getactormaterialflag.txt index 303363d..f7d70b3 100644 --- a/doc/files/getactormaterialflag.txt +++ b/doc/files/getactormaterialflag.txt @@ -1,5 +1,5 @@ -#title getActorMaterialFlag [RCBasic Doc] -#header function getActorMaterialFlag( actor, material, flag) +#title GetActorMaterialFlag [RCBasic Doc] +#header Function GetActorMaterialFlag( actor, material, flag) Returns the value of the specified material flag @@ -28,3 +28,4 @@ Possible values for flag: #/list #ref GetMaterialFlag + diff --git a/doc/files/getactormaterialtype.txt b/doc/files/getactormaterialtype.txt index 4b042c0..982675c 100644 --- a/doc/files/getactormaterialtype.txt +++ b/doc/files/getactormaterialtype.txt @@ -1,5 +1,5 @@ #title GetActorMaterialType [RCBasic Doc] -#header function GetActorMaterialType( actor, material ) +#header Function GetActorMaterialType( actor, material ) Returns the material type of an actor material @@ -44,3 +44,4 @@ Possible material types #/list #ref SetActorMaterialType GetMaterialType SetMaterialType + diff --git a/doc/files/getactorposition.txt b/doc/files/getactorposition.txt index 5e8dc69..c18202b 100644 --- a/doc/files/getactorposition.txt +++ b/doc/files/getactorposition.txt @@ -1,6 +1,7 @@ #title GetActorPosition [RCBasic Doc] -#header sub GetActorPosition( actor, ByRef x, ByRef y, ByRef z ) +#header Sub GetActorPosition( actor, ByRef x, ByRef y, ByRef z ) Gets the actors position #ref SetActorPosition + diff --git a/doc/files/getactorrotation.txt b/doc/files/getactorrotation.txt index b8c5909..5828023 100644 --- a/doc/files/getactorrotation.txt +++ b/doc/files/getactorrotation.txt @@ -1,6 +1,7 @@ #title GetActorRotation [RCBasic Doc] -#header sub GetActorRotation( actor, ByRef x, ByRef y, ByRef z ) +#header Sub GetActorRotation( actor, ByRef x, ByRef y, ByRef z ) Gets the actors rotation on each axis #ref SetActorRotation + diff --git a/doc/files/getactorrotationq.txt b/doc/files/getactorrotationq.txt index 0197547..0e53234 100644 --- a/doc/files/getactorrotationq.txt +++ b/doc/files/getactorrotationq.txt @@ -1,8 +1,9 @@ #title GetActorRotationQ [RCBasic Doc] -#header sub GetActorRotationQ( actor, ByRef x, ByRef y, ByRef z, ByRef w) +#header Sub GetActorRotationQ( actor, ByRef x, ByRef y, ByRef z, ByRef w) Gets the actors rotation as a quaternion. Note: This is useful for calculations that require quaternion but most developers should just use GetActorTransform() #ref GetActorRotation SetActorRotation + diff --git a/doc/files/getactorscale.txt b/doc/files/getactorscale.txt index d3d1064..1428d4a 100644 --- a/doc/files/getactorscale.txt +++ b/doc/files/getactorscale.txt @@ -1,6 +1,7 @@ #title GetActorScale [RCBasic Doc] -#header sub GetActorScale( actor, ByRef x, ByRef y, ByRef z ) +#header Sub GetActorScale( actor, ByRef x, ByRef y, ByRef z ) Gets an actor's scale #ref SetActorScale + diff --git a/doc/files/getactorshape.txt b/doc/files/getactorshape.txt index 6f8df88..f5a0e0c 100644 --- a/doc/files/getactorshape.txt +++ b/doc/files/getactorshape.txt @@ -1,5 +1,5 @@ #title GetActorShape [RCBasic Doc] -#header function GetActorShape(actor) +#header Function GetActorShape(actor) Returns the shape of an actor @@ -13,6 +13,11 @@ Possible Actor Shapes #li ACTOR_SHAPE_CONE #li ACTOR_SHAPE_CONVEXHULL #li ACTOR_SHAPE_TRIMESH +#li ACTOR_SHAPE_COMPOSITE +#li ACTOR_SHAPE_IMPACT_MESH #/list -#ref SetActorShape +NOTE: ACTOR_SHAPE_COMPOSITE is not a shape you can set. It is a shape that is automatically set on composite actors. + +#ref SetActorShape SetActorShapeEx + diff --git a/doc/files/getactorstartframe.txt b/doc/files/getactorstartframe.txt deleted file mode 100644 index a48bd45..0000000 --- a/doc/files/getactorstartframe.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title GetActorStartFrame [RCBasic Doc] -#header function GetActorStartFrame( actor ) - -Returns the start frame of an actor's animation diff --git a/doc/files/getactortotalforce.txt b/doc/files/getactortotalforce.txt index e891630..a04118a 100644 --- a/doc/files/getactortotalforce.txt +++ b/doc/files/getactortotalforce.txt @@ -1,6 +1,7 @@ #title GetActorTotalForce [RCBasic Doc] -#header sub GetActorTotalForce( actor, ByRef x, ByRef y, ByRef z) +#header Sub GetActorTotalForce( actor, ByRef x, ByRef y, ByRef z) Gets the total net force currently acting on an actor. This force is the sum of all external forces applied to the actor at a given point in time, including forces like gravity, applied forces, and other interactions such as contact or collision forces. #ref GetActorTotalTorque + diff --git a/doc/files/getactortotaltorque.txt b/doc/files/getactortotaltorque.txt index 04516d8..25c7ef7 100644 --- a/doc/files/getactortotaltorque.txt +++ b/doc/files/getactortotaltorque.txt @@ -1,6 +1,7 @@ #title GetActorTotalTorque [RCBasic Doc] -#header sub GetActorTotalTorque( actor, ByRef x, ByRef y, ByRef z) +#header Sub GetActorTotalTorque( actor, ByRef x, ByRef y, ByRef z) Gets the total net torque currently acting on an actor. Torque represents the rotational equivalent of force, describing how different forces applied to the actor cause it to rotate. The total torque is the sum of all external torques acting on the actor, which determine how the actor will rotate or change its angular velocity. #ref GetTotalForces + diff --git a/doc/files/getactortransform.txt b/doc/files/getactortransform.txt index fb7ecac..6c5d6d4 100644 --- a/doc/files/getactortransform.txt +++ b/doc/files/getactortransform.txt @@ -1,4 +1,5 @@ #title GetActorTransform [RCBasic Doc] -#header sub GetActorTransform( actor, matrix ) +#header Sub GetActorTransform( actor, matrix ) Stores the actors absolute transformation in the given matrix + diff --git a/doc/files/getactortransitiontime.txt b/doc/files/getactortransitiontime.txt deleted file mode 100644 index 7bb2714..0000000 --- a/doc/files/getactortransitiontime.txt +++ /dev/null @@ -1,8 +0,0 @@ -#title GetActorTransitionTime [RCBasic Doc] -#header function GetActorTransitionTime( actor ) - -Returns the total transition time of an actor transitioning between animations - -Note: Time returned is in seconds - -#ref StartActorTransition StopActorTransition ActorIsInTransition diff --git a/doc/files/getactortype.txt b/doc/files/getactortype.txt new file mode 100644 index 0000000..d9e7354 --- /dev/null +++ b/doc/files/getactortype.txt @@ -0,0 +1,23 @@ +#title GetActorType [RCBasic Doc] +#header Function GetActorType( actor ) + +Returns an actor's type + +Actor Types +#list ul +#li ACTOR_TYPE_NONE +#li ACTOR_TYPE_MESH +#li ACTOR_TYPE_OTMESH +#li ACTOR_TYPE_LIGHT +#li ACTOR_TYPE_TERRAIN +#li ACTOR_TYPE_WATER +#li ACTOR_TYPE_BILLBOARD +#li ACTOR_TYPE_PARTICLE +#li ACTOR_TYPE_PRIMITIVE +#li ACTOR_TYPE_PROJECTOR +#li ACTOR_TYPE_COMPOSITE +#li ACTOR_TYPE_VEHICLE +#/list + +NOTE: Cube and Sphere actors both return ACTOR_TYPE_PRIMITIVE + diff --git a/doc/files/getactorvelocityinlocalpoint.txt b/doc/files/getactorvelocityinlocalpoint.txt index 9df2656..136e56e 100644 --- a/doc/files/getactorvelocityinlocalpoint.txt +++ b/doc/files/getactorvelocityinlocalpoint.txt @@ -1,5 +1,6 @@ -#title getActorVelocityInLocalPoint [RCBasic Doc] -#header sub getActorVelocityInLocalPoint( actor, rel_x, rel_y, rel_z, ByRef x, ByRef y, ByRef z) +#title GetActorVelocityInLocalPoint [RCBasic Doc] +#header Sub GetActorVelocityInLocalPoint( actor, rel_x, rel_y, rel_z, ByRef x, ByRef y, ByRef z) Gets the linear velocity of a specific point on an actor, given its position in the actor's local coordinate space. This is useful for determining how fast and in what direction a particular point on the actor is moving, accounting for both the body's linear velocity and its rotational motion (angular velocity). + diff --git a/doc/files/getan8scenename.txt b/doc/files/getan8scenename.txt index 5fbe4e1..05b3a3c 100644 --- a/doc/files/getan8scenename.txt +++ b/doc/files/getan8scenename.txt @@ -2,3 +2,4 @@ #header Function GetAN8SceneName$(an8_project, scene_num) Returns the name of a scene in an an8 project + diff --git a/doc/files/getantialiasmode.txt b/doc/files/getantialiasmode.txt index 392760c..aa48600 100644 --- a/doc/files/getantialiasmode.txt +++ b/doc/files/getantialiasmode.txt @@ -1,5 +1,5 @@ #title GetAntiAliasMode [RCBasic Doc] -#header function GetAntiAliasMode( ) +#header Function GetAntiAliasMode( ) Returns the anti-alias mode for draw image commands @@ -15,3 +15,4 @@ Possible modes #/list #ref SetAntiAliasMode + diff --git a/doc/files/getbilinearfilter.txt b/doc/files/getbilinearfilter.txt index 1cfdac2..c126e41 100644 --- a/doc/files/getbilinearfilter.txt +++ b/doc/files/getbilinearfilter.txt @@ -1,6 +1,7 @@ #title GetBilinearFilter [RCBasic Doc] -#header function GetBilinearFilter() +#header Function GetBilinearFilter() Returns true if bilinear filtering is enabled #ref SetBilinearFilter + diff --git a/doc/files/getbillboardsize.txt b/doc/files/getbillboardsize.txt new file mode 100644 index 0000000..0f9def0 --- /dev/null +++ b/doc/files/getbillboardsize.txt @@ -0,0 +1,5 @@ +#title GetBillboardSize [RCBasic Doc] +#header Sub GetBillboardSize(actor, ByRef w, ByRef h) + +Gets the width and height of a billboard. + diff --git a/doc/files/getblendmode.txt b/doc/files/getblendmode.txt index de35dd7..5e32c8f 100644 --- a/doc/files/getblendmode.txt +++ b/doc/files/getblendmode.txt @@ -1,5 +1,5 @@ #title GetBlendMode [RCBasic Doc] -#header function GetBlendMode( ) +#header Function GetBlendMode( ) Returns the current blend mode @@ -20,3 +20,4 @@ Possible Blend Modes #/list #ref SetBlendMode + diff --git a/doc/files/getcameraaspectratio.txt b/doc/files/getcameraaspectratio.txt index afd5638..e25bfb6 100644 --- a/doc/files/getcameraaspectratio.txt +++ b/doc/files/getcameraaspectratio.txt @@ -1,6 +1,7 @@ #title GetCameraAspectRatio [RCBasic Doc] -#header function GetCameraAspectRatio( ) +#header Function GetCameraAspectRatio( ) Returns the camera aspect ratio for the active canvas #ref SetCameraAspectRatio + diff --git a/doc/files/getcamerafarvalue.txt b/doc/files/getcamerafarvalue.txt index 02ad686..2d03f93 100644 --- a/doc/files/getcamerafarvalue.txt +++ b/doc/files/getcamerafarvalue.txt @@ -1,6 +1,7 @@ #title GetCameraFarValue [RCBasic Doc] -#header function GetCameraFarValue( ) +#header Function GetCameraFarValue( ) Returns the far plane of the camera on the active canvas #ref GetCameraNearValue + diff --git a/doc/files/getcamerafov.txt b/doc/files/getcamerafov.txt index 847d494..519b25b 100644 --- a/doc/files/getcamerafov.txt +++ b/doc/files/getcamerafov.txt @@ -1,4 +1,5 @@ #title GetCameraFOV [RCBasic Doc] -#header function GetCameraFOV( ) +#header Function GetCameraFOV( ) Returns the field of view of the camera on the active canvas + diff --git a/doc/files/getcameranearvalue.txt b/doc/files/getcameranearvalue.txt index cbbeeda..ac960b8 100644 --- a/doc/files/getcameranearvalue.txt +++ b/doc/files/getcameranearvalue.txt @@ -1,6 +1,7 @@ #title GetCameraNearValue [RCBasic Doc] -#header function GetCameraNearValue( ) +#header Function GetCameraNearValue( ) Returns the near plane of the camera on the active canvas #ref GetCameraFarValue + diff --git a/doc/files/getcameraposition.txt b/doc/files/getcameraposition.txt index bfbf333..d5540c0 100644 --- a/doc/files/getcameraposition.txt +++ b/doc/files/getcameraposition.txt @@ -1,6 +1,7 @@ #title GetCameraPosition [RCBasic Doc] -#header sub GetCameraPosition(ByRef x, ByRef y, ByRef z) +#header Sub GetCameraPosition(ByRef x, ByRef y, ByRef z) Gets the position of the camera #ref SetCameraPosition TranslateCamera + diff --git a/doc/files/getcamerarotation.txt b/doc/files/getcamerarotation.txt index 5768652..c1c2ee1 100644 --- a/doc/files/getcamerarotation.txt +++ b/doc/files/getcamerarotation.txt @@ -1,6 +1,7 @@ #title GetCameraRotation [RCBasic Doc] -#header sub GetCameraRotation(ByRef x, ByRef y, ByRef z) +#header Sub GetCameraRotation(ByRef x, ByRef y, ByRef z) Gets the rotation of the camera on each axis #ref SetCameraRotation RotateCamera + diff --git a/doc/files/getcanvasalpha.txt b/doc/files/getcanvasalpha.txt index 10e1bf0..b22156f 100644 --- a/doc/files/getcanvasalpha.txt +++ b/doc/files/getcanvasalpha.txt @@ -1,6 +1,7 @@ #title GetCanvasAlpha [RCBasic Doc] -#header function GetCanvasAlpha(c_num) +#header Function GetCanvasAlpha(c_num) Returns the alpha blend value of a canvas #ref SetCanvasAlpha + diff --git a/doc/files/getcanvascolormod.txt b/doc/files/getcanvascolormod.txt index 6842661..7e0e312 100644 --- a/doc/files/getcanvascolormod.txt +++ b/doc/files/getcanvascolormod.txt @@ -1,6 +1,7 @@ #title GetCanvasColorMod [RCBasic Doc] -#header function GetCanvasColorMod(c_num) +#header Function GetCanvasColorMod(c_num) Returns the color modulation of a canvas #ref SetCanvasColorMod + diff --git a/doc/files/getcanvasoffset.txt b/doc/files/getcanvasoffset.txt index c35d618..f541219 100644 --- a/doc/files/getcanvasoffset.txt +++ b/doc/files/getcanvasoffset.txt @@ -1,6 +1,7 @@ #title GetCanvasOffset [RCBasic Doc] -#header sub GetCanvasOffset(c_num, byref x, byref y) +#header Sub GetCanvasOffset(c_num, ByRef x, ByRef y) Returns view offset of a canvas #ref SetCanvasOffset + diff --git a/doc/files/getcanvassize.txt b/doc/files/getcanvassize.txt index bdb68af..1ea3a37 100644 --- a/doc/files/getcanvassize.txt +++ b/doc/files/getcanvassize.txt @@ -1,4 +1,5 @@ #title GetCanvasSize [RCBasic Doc] -#header sub GetCanvasSize(c_num, byref w, byref h) +#header Sub GetCanvasSize(c_num, ByRef w, ByRef h) Gets the size of a canvas + diff --git a/doc/files/getcanvasviewport.txt b/doc/files/getcanvasviewport.txt index 99ad32c..e7b7e2a 100644 --- a/doc/files/getcanvasviewport.txt +++ b/doc/files/getcanvasviewport.txt @@ -1,6 +1,7 @@ #title GetCanvasViewport [RCBasic Doc] -#header sub GetCanvasViewport(c_num, byref x, byref y, byref w, byref h) +#header Sub GetCanvasViewport(c_num, ByRef x, ByRef y, ByRef w, ByRef h) Gets the position and size of a canvas viewport #ref OpenCanvas SetCanvasViewport + diff --git a/doc/files/getcanvasz.txt b/doc/files/getcanvasz.txt deleted file mode 100644 index d82f672..0000000 --- a/doc/files/getcanvasz.txt +++ /dev/null @@ -1,8 +0,0 @@ -#title GetCanvasZ [RCBasic Doc] -#header function GetCanvasZ(c_num) - -Returns the Canvas Z Order. - -Note: Canvases with a lower Z order are drawn first and those with higher values will be drawn on top - -#ref SetCanvasZ diff --git a/doc/files/getchannelvolume.txt b/doc/files/getchannelvolume.txt index 1101b98..00b9fb7 100644 --- a/doc/files/getchannelvolume.txt +++ b/doc/files/getchannelvolume.txt @@ -1,4 +1,5 @@ #title GetChannelVolume [RCBasic Doc] -#header function GetChannelVolume(channel) +#header Function GetChannelVolume(channel) Returns the volume of the audio on a channel + diff --git a/doc/files/getcirclelineintersection.txt b/doc/files/getcirclelineintersection.txt index 1026aba..f15be06 100644 --- a/doc/files/getcirclelineintersection.txt +++ b/doc/files/getcirclelineintersection.txt @@ -1,6 +1,7 @@ #title GetCircleLineIntersection [RCBasic Doc] -#header function GetCircleLineIntersection(circle_x, circle_y, radius, x1, y1, x2, y2, ByRef ix1, ByRef iy1, ByRef ix2, ByRef iy2) +#header Function GetCircleLineIntersection(circle_x, circle_y, radius, x1, y1, x2, y2, ByRef ix1, ByRef iy1, ByRef ix2, ByRef iy2) Calculates the points where a circle and line intersect and stores the intersection points in (ix1, iy1) and (ix2, iy2) NOTE: This function returns 0 if there is no intersection and 1 or 2 if there is 1 or 2 intersection points. If it only returns 1 then only (ix1, iy1) will be set. + diff --git a/doc/files/getclipboardtext.txt b/doc/files/getclipboardtext.txt index 46fc3dc..92df4e6 100644 --- a/doc/files/getclipboardtext.txt +++ b/doc/files/getclipboardtext.txt @@ -1,4 +1,5 @@ #title GetClipboardText$ [RCBasic Doc] -#header function GetClipboardText$( ) +#header Function GetClipboardText$( ) Returns the clipboard text. + diff --git a/doc/files/getcompositeaabb.txt b/doc/files/getcompositeaabb.txt new file mode 100644 index 0000000..184cc4b --- /dev/null +++ b/doc/files/getcompositeaabb.txt @@ -0,0 +1,7 @@ +#title GetCompositeAABB [RCBasic Doc] +#header Function GetCompositeAABB(actor, t_matrix, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z) + +Returns the bounding box of a composite actor + +t_matrix will store the transform for the bounding box + diff --git a/doc/files/getcompositechild.txt b/doc/files/getcompositechild.txt new file mode 100644 index 0000000..55eaa25 --- /dev/null +++ b/doc/files/getcompositechild.txt @@ -0,0 +1,5 @@ +#title GetCompositeChild [RCBasic Doc] +#header Function GetCompositeChild(actor, child_index) + +Returns the actor stored as the child actor at a given index in a composite actor + diff --git a/doc/files/getcompositechildcount.txt b/doc/files/getcompositechildcount.txt new file mode 100644 index 0000000..8e3a8e8 --- /dev/null +++ b/doc/files/getcompositechildcount.txt @@ -0,0 +1,5 @@ +#title GetCompositeChildCount [RCBasic Doc] +#header Function GetCompositeChildCount(actor) + +Returns the number of child actors in a composite actor + diff --git a/doc/files/getcompositechildindex.txt b/doc/files/getcompositechildindex.txt new file mode 100644 index 0000000..0733c09 --- /dev/null +++ b/doc/files/getcompositechildindex.txt @@ -0,0 +1,5 @@ +#title GetCompositeChildIndex [RCBasic Doc] +#header Function GetCompositeChildIndex(actor, child_actor) + +Returns the index an actor is stored at in a composite actor + diff --git a/doc/files/getcompositechildtransform.txt b/doc/files/getcompositechildtransform.txt new file mode 100644 index 0000000..cfdd8bb --- /dev/null +++ b/doc/files/getcompositechildtransform.txt @@ -0,0 +1,5 @@ +#title GetCompositeChildTransform [RCBasic Doc] +#header Function GetCompositeChildTransform(actor, child_index, t_matrix) + +Stores the transform from composite actor to the child index shape in t_matrix + diff --git a/doc/files/getcompositeupdaterevision.txt b/doc/files/getcompositeupdaterevision.txt new file mode 100644 index 0000000..e370cf4 --- /dev/null +++ b/doc/files/getcompositeupdaterevision.txt @@ -0,0 +1,5 @@ +#title GetCompositeUpdateRevision [RCBasic Doc] +#header Function GetCompositeUpdateRevision(actor) + +Returns a counter that increments when the composite actor shape is modifed + diff --git a/doc/files/getconeanglepoint.txt b/doc/files/getconeanglepoint.txt index 7376129..0ad2795 100644 --- a/doc/files/getconeanglepoint.txt +++ b/doc/files/getconeanglepoint.txt @@ -1,4 +1,5 @@ -#title getConeAnglePoint [RCBasic Doc] -#header sub getConeAnglePoint( constraint_id, angle, c_len, ByRef x, ByRef y, ByRef z) +#title GetConeAnglePoint [RCBasic Doc] +#header Sub GetConeAnglePoint( constraint_id, angle, c_len, ByRef x, ByRef y, ByRef z) Computes or retrieves a point based on a given angle relative to the constraint’s twist axis. + diff --git a/doc/files/getconebiasfactor.txt b/doc/files/getconebiasfactor.txt index 7837b87..cd62631 100644 --- a/doc/files/getconebiasfactor.txt +++ b/doc/files/getconebiasfactor.txt @@ -1,4 +1,5 @@ -#title getConeBiasFactor [RCBasic Doc] -#header function getConeBiasFactor( constraint_id) +#title GetConeBiasFactor [RCBasic Doc] +#header Function GetConeBiasFactor( constraint_id) Returns the bias factor used to correct constraint violations (such as small positional or angular errors) during the simulation. The bias factor helps ensure that the constrained actors return to their intended positions or orientations over time by applying corrective forces or impulses. + diff --git a/doc/files/getconedamping.txt b/doc/files/getconedamping.txt index bf4bb89..743ba98 100644 --- a/doc/files/getconedamping.txt +++ b/doc/files/getconedamping.txt @@ -1,6 +1,7 @@ -#title getConeDamping [RCBasic Doc] -#header function getConeDamping( constraint_id) +#title GetConeDamping [RCBasic Doc] +#header Function GetConeDamping( constraint_id) Returns the damping factor applied to the constraint. Damping is used to reduce the amount of oscillation or unwanted movement (such as excessive rotation or swinging) around the constrained actor's axes. # SetConeDamping + diff --git a/doc/files/getconefixthresh.txt b/doc/files/getconefixthresh.txt index fbce3b5..49b3151 100644 --- a/doc/files/getconefixthresh.txt +++ b/doc/files/getconefixthresh.txt @@ -1,8 +1,9 @@ -#title getConeFixThresh [RCBasic Doc] -#header function getConeFixThresh( constraint_id) +#title GetConeFixThresh [RCBasic Doc] +#header Function GetConeFixThresh( constraint_id) Returns the fix threshold value associated with that constraint. This threshold is used to control how the constraint behaves when the angle of the rotation between the actors approaches the limits defined by the cone twist constraint. The fix threshold defines a limit or tolerance for how closely the angle between the two actors can approach the constraint's limits before corrective actions are taken. When the angular motion exceeds this threshold, the constraint applies corrective forces to bring the motion back within the allowed range. #ref SetConeFixThresh + diff --git a/doc/files/getconelimit.txt b/doc/files/getconelimit.txt index cda98a0..05f8956 100644 --- a/doc/files/getconelimit.txt +++ b/doc/files/getconelimit.txt @@ -1,5 +1,5 @@ -#title getConeLimit [RCBasic Doc] -#header function getConeLimit( constraint_id, limit_index) +#title GetConeLimit [RCBasic Doc] +#header Function GetConeLimit( constraint_id, limit_index) Returns the angular limit associated with a specific degree of freedom in the cone constraint. This limit defines the range of motion allowed around a given axis (twist, swing1, or swing2) for the constrained actors. @@ -11,3 +11,4 @@ limitIndex is an integer that indicates which limit to retrieve. It typically ta #/list Returns value is the maximum angle or range allowed for the specified degree of freedom (twist, swing1, or swing2) + diff --git a/doc/files/getconesolveswinglimit.txt b/doc/files/getconesolveswinglimit.txt index 791712a..8b48bd2 100644 --- a/doc/files/getconesolveswinglimit.txt +++ b/doc/files/getconesolveswinglimit.txt @@ -1,8 +1,9 @@ -#title getConeSolveSwingLimit [RCBasic Doc] -#header function getConeSolveSwingLimit( constraint_id) +#title GetConeSolveSwingLimit [RCBasic Doc] +#header Function GetConeSolveSwingLimit( constraint_id) Returns whether the swing limit of the constraint is currently being enforced during the simulation. The swing limit defines the boundary within which the connected actors can swing. When the bodies approach or exceed this limit, the physics engine enforces a constraint to prevent further motion. If the swing limit is exceeded during simulation, corrective forces are applied to bring the actors back within the allowed range. + diff --git a/doc/files/getconesolvetwistlimit.txt b/doc/files/getconesolvetwistlimit.txt index ec224ea..bdc6bfa 100644 --- a/doc/files/getconesolvetwistlimit.txt +++ b/doc/files/getconesolvetwistlimit.txt @@ -1,7 +1,8 @@ -#title getConeSolveTwistLimit [RCBasic Doc] -#header function getConeSolveTwistLimit( constraint_id) +#title GetConeSolveTwistLimit [RCBasic Doc] +#header Function GetConeSolveTwistLimit( constraint_id) Returns whether the twist limit is currently being enforced during the simulation. The twist limit controls how much the connected actors can rotate around the central axis of the joint (the "twist" axis). When the actors rotate beyond this allowed limit, the physics engine applies corrective forces to keep the rotation within the defined twist range. + diff --git a/doc/files/getconeswingspan1.txt b/doc/files/getconeswingspan1.txt index 18e580e..b1a690b 100644 --- a/doc/files/getconeswingspan1.txt +++ b/doc/files/getconeswingspan1.txt @@ -1,8 +1,9 @@ -#title getConeSwingSpan1 [RCBasic Doc] -#header function getConeSwingSpan1( constraint_id) +#title GetConeSwingSpan1 [RCBasic Doc] +#header Function GetConeSwingSpan1( constraint_id) Returns the maximum allowed rotation angle (or "span") for the first swing axis. This swing axis is one of the two orthogonal axes around which the constrained actors are allowed to swing, forming a cone-shaped range of motion. There are two swing spans, swing span 1 and swing span 2, corresponding to the maximum allowable swing angles around each of the two swing axes. #ref GetConeSwingSpan2 + diff --git a/doc/files/getconeswingspan2.txt b/doc/files/getconeswingspan2.txt index 5ecb405..563ea91 100644 --- a/doc/files/getconeswingspan2.txt +++ b/doc/files/getconeswingspan2.txt @@ -1,8 +1,9 @@ -#title getConeSwingSpan2 [RCBasic Doc] -#header function getConeSwingSpan2( constraint_id) +#title GetConeSwingSpan2 [RCBasic Doc] +#header Function GetConeSwingSpan2( constraint_id) Returns the maximum allowed rotation angle (or "span") for the second swing axis. This swing axis is one of the two orthogonal axes around which the constrained actors are allowed to swing, forming a cone-shaped range of motion. There are two swing spans, swing span 1 and swing span 2, corresponding to the maximum allowable swing angles around each of the two swing axes. #ref GetConeSwingSpan1 + diff --git a/doc/files/getconetwistangle.txt b/doc/files/getconetwistangle.txt index b4c00e3..a2092ac 100644 --- a/doc/files/getconetwistangle.txt +++ b/doc/files/getconetwistangle.txt @@ -1,5 +1,5 @@ -#title getConeTwistAngle [RCBasic Doc] -#header function getConeTwistAngle( constraint_id) +#title GetConeTwistAngle [RCBasic Doc] +#header Function GetConeTwistAngle( constraint_id) Returns the current twist angle between the two actors connected by the constraint @@ -8,3 +8,4 @@ Returns the current twist angle between the two actors connected by the constrai #li It represents how much the actors have rotated relative to each other around the axis, which is the same axis that the twist limit is applied to. #li The twist angle can be compared to the twist limit to determine if the constraint is approaching or exceeding the allowed range of rotation. #/list + diff --git a/doc/files/getconetwistlimitsign.txt b/doc/files/getconetwistlimitsign.txt index 47a753a..ceb0d77 100644 --- a/doc/files/getconetwistlimitsign.txt +++ b/doc/files/getconetwistlimitsign.txt @@ -1,5 +1,5 @@ -#title getConeTwistLimitSign [RCBasic Doc] -#header function getConeTwistLimitSign( constraint_id) +#title GetConeTwistLimitSign [RCBasic Doc] +#header Function GetConeTwistLimitSign( constraint_id) Returns the sign of the twist limit, which indicates the direction of the twist limit enforcement around the twist axis. @@ -7,3 +7,4 @@ Returns the sign of the twist limit, which indicates the direction of the twist #li The twist limit sign determines the direction in which the twist limit is applied. #li A positive sign typically indicates a counterclockwise rotation is allowed, while a negative sign indicates a clockwise rotation is allowed. #/list + diff --git a/doc/files/getconetwistspan.txt b/doc/files/getconetwistspan.txt index b892f53..15dd61d 100644 --- a/doc/files/getconetwistspan.txt +++ b/doc/files/getconetwistspan.txt @@ -1,4 +1,5 @@ -#title getConeTwistSpan [RCBasic Doc] -#header function getConeTwistSpan( constraint_id) +#title GetConeTwistSpan [RCBasic Doc] +#header Function GetConeTwistSpan( constraint_id) Returns the maximum allowed twist angle for the constraint, which determines how far the connected bodies can rotate around the twist axis before the constraint enforces limits. + diff --git a/doc/files/getconstraintactora.txt b/doc/files/getconstraintactora.txt index 2a5767f..7081377 100644 --- a/doc/files/getconstraintactora.txt +++ b/doc/files/getconstraintactora.txt @@ -1,4 +1,5 @@ -#title getConstraintActorA [RCBasic Doc] -#header function getConstraintActorA( constraint_id) +#title GetConstraintActorA [RCBasic Doc] +#header Function GetConstraintActorA( constraint_id) Returns the first actor in a constraint + diff --git a/doc/files/getconstraintactorb.txt b/doc/files/getconstraintactorb.txt index b4bb449..d506368 100644 --- a/doc/files/getconstraintactorb.txt +++ b/doc/files/getconstraintactorb.txt @@ -1,4 +1,5 @@ -#title getConstraintActorB [RCBasic Doc] -#header function getConstraintActorB( constraint_id) +#title GetConstraintActorB [RCBasic Doc] +#header Function GetConstraintActorB( constraint_id) Returns the second actor in a constraint + diff --git a/doc/files/getconstraintaframe.txt b/doc/files/getconstraintaframe.txt index 08d4376..d2f2105 100644 --- a/doc/files/getconstraintaframe.txt +++ b/doc/files/getconstraintaframe.txt @@ -1,8 +1,9 @@ #title GetConstraintAFrame [RCBasic Doc] -#header function GetConstraintAFrame( constraint_id, mA) +#header Function GetConstraintAFrame( constraint_id, mA) Stores the transform of the first actor in a constraint in mA Note: Only applies to cone and hinge constraints #ref GetConstraintBFrame + diff --git a/doc/files/getconstraintangularonly.txt b/doc/files/getconstraintangularonly.txt index 437e99c..9c54c74 100644 --- a/doc/files/getconstraintangularonly.txt +++ b/doc/files/getconstraintangularonly.txt @@ -1,5 +1,5 @@ -#title getConstraintAngularOnly [RCBasic Doc] -#header function getConstraintAngularOnly( constraint_id) +#title GetConstraintAngularOnly [RCBasic Doc] +#header Function GetConstraintAngularOnly( constraint_id) Returns true if the hinge constraint is set to limit only angular motion while allowing unrestricted linear (translational) motion. @@ -7,3 +7,4 @@ Note: Applies to Cone and Hinge constraints #ref SetConstraintAngularOnly + diff --git a/doc/files/getconstraintappliedimpulse.txt b/doc/files/getconstraintappliedimpulse.txt index fb49e1e..f2a9cac 100644 --- a/doc/files/getconstraintappliedimpulse.txt +++ b/doc/files/getconstraintappliedimpulse.txt @@ -1,4 +1,5 @@ -#title getConstraintAppliedImpulse [RCBasic Doc] -#header function getConstraintAppliedImpulse( constraint_id) +#title GetConstraintAppliedImpulse [RCBasic Doc] +#header Function GetConstraintAppliedImpulse( constraint_id) Returns the impulse applied to a constraint during the last simulation step. This impulse is the force integrated over a small time step (impulse = force × time) and is applied to resolve the constraint and maintain its behavior, such as keeping two objects connected or restricting movement. + diff --git a/doc/files/getconstraintbframe.txt b/doc/files/getconstraintbframe.txt index 1419f08..b79e362 100644 --- a/doc/files/getconstraintbframe.txt +++ b/doc/files/getconstraintbframe.txt @@ -1,8 +1,9 @@ #title GetConstraintBFrame [RCBasic Doc] -#header function GetConstraintBFrame( constraint_id, mA) +#header Function GetConstraintBFrame( constraint_id, mA) Stores the transform of the second actor in a constraint in mA Note: Only applies to cone and hinge constraints #ref GetConstraintAFrame + diff --git a/doc/files/getconstraintbreakingimpulsethreshold.txt b/doc/files/getconstraintbreakingimpulsethreshold.txt index b206943..31eeb14 100644 --- a/doc/files/getconstraintbreakingimpulsethreshold.txt +++ b/doc/files/getconstraintbreakingimpulsethreshold.txt @@ -1,6 +1,7 @@ -#title getConstraintBreakingImpulseThreshold [RCBasic Doc] -#header function getConstraintBreakingImpulseThreshold( constraint_id) +#title GetConstraintBreakingImpulseThreshold [RCBasic Doc] +#header Function GetConstraintBreakingImpulseThreshold( constraint_id) Returns the breaking impulse threshold for a given constraint. The breaking impulse threshold defines the maximum force (impulse) a constraint can withstand before it "breaks," meaning that the constraint will be deactivated and no longer enforce its rules. #ref SetConstraintBreakingImpulseThreshold + diff --git a/doc/files/getconstraintfixedactor.txt b/doc/files/getconstraintfixedactor.txt index 35c29e1..9dfe59e 100644 --- a/doc/files/getconstraintfixedactor.txt +++ b/doc/files/getconstraintfixedactor.txt @@ -1,5 +1,6 @@ -#title getConstraintFixedActor [RCBasic Doc] -#header function getConstraintFixedActor( constraint_id) +#title GetConstraintFixedActor [RCBasic Doc] +#header Function GetConstraintFixedActor( constraint_id) Returns the actor that is associated with a specific constraint. This is primarily applicable in constraints that involve one actor being constrained to another or to a static point in the simulation. + diff --git a/doc/files/getconstraintframeoffseta.txt b/doc/files/getconstraintframeoffseta.txt index d45c687..f1737e7 100644 --- a/doc/files/getconstraintframeoffseta.txt +++ b/doc/files/getconstraintframeoffseta.txt @@ -1,6 +1,7 @@ -#title getConstraintFrameOffsetA [RCBasic Doc] -#header sub getConstraintFrameOffsetA( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz) +#title GetConstraintFrameOffsetA [RCBasic Doc] +#header Sub GetConstraintFrameOffsetA( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz) Gets the frame offset for actor A associated with a particular constraint. This frame offset defines the position and orientation of actor A relative to the constraint's anchor point. #ref GetConstraintFrameOffsetB + diff --git a/doc/files/getconstraintframeoffsetb.txt b/doc/files/getconstraintframeoffsetb.txt index c4c59a7..7157ffc 100644 --- a/doc/files/getconstraintframeoffsetb.txt +++ b/doc/files/getconstraintframeoffsetb.txt @@ -1,6 +1,7 @@ -#title getConstraintFrameOffsetB [RCBasic Doc] -#header sub getConstraintFrameOffsetB( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz) +#title GetConstraintFrameOffsetB [RCBasic Doc] +#header Sub GetConstraintFrameOffsetB( constraint_id, ByRef x, ByRef y, ByRef z, ByRef rx, ByRef ry, ByRef rz) Gets the frame offset for actor B associated with a particular constraint. This frame offset defines the position and orientation of actor B relative to the constraint's anchor point. #ref GetConstraintFrameOffsetA + diff --git a/doc/files/getconstraintlimitsoftness.txt b/doc/files/getconstraintlimitsoftness.txt index 77c85b8..cbae28a 100644 --- a/doc/files/getconstraintlimitsoftness.txt +++ b/doc/files/getconstraintlimitsoftness.txt @@ -1,5 +1,5 @@ -#title getConstraintLimitSoftness [RCBasic Doc] -#header function getConstraintLimitSoftness( constraint_id) +#title GetConstraintLimitSoftness [RCBasic Doc] +#header Function GetConstraintLimitSoftness( constraint_id) Returns the softness parameter associated with the limits of the constraint. This softness affects how the constraint behaves when the angular motion of the connected actors approaches their defined limits. @@ -9,3 +9,4 @@ Returns the softness parameter associated with the limits of the constraint. Thi #/list #ref SetConstraintSoftnessDirAng SetConstraintSoftnessDirLin SetConstraintSoftnessLimAng SetConstraintSoftnessLimLin SetConstraintSoftnessOrthoAng + diff --git a/doc/files/getconstraintsolveriterations.txt b/doc/files/getconstraintsolveriterations.txt index cbf42a2..2e5b15b 100644 --- a/doc/files/getconstraintsolveriterations.txt +++ b/doc/files/getconstraintsolveriterations.txt @@ -1,4 +1,5 @@ -#title getConstraintSolverIterations [RCBasic Doc] -#header function getConstraintSolverIterations( constraint_id) +#title GetConstraintSolverIterations [RCBasic Doc] +#header Function GetConstraintSolverIterations( constraint_id) Returns the value for the number of solver iterations that have been overridden for a specific constraint or actor. Solver iterations refer to the number of times the physics engine solves for constraint forces during each simulation step. + diff --git a/doc/files/getdesktopdisplaymode.txt b/doc/files/getdesktopdisplaymode.txt index 65150ed..4111151 100644 --- a/doc/files/getdesktopdisplaymode.txt +++ b/doc/files/getdesktopdisplaymode.txt @@ -8,3 +8,4 @@ Gets the resolution and refresh rate of a display #li w, h - The width and height of the display will be stored in these variables #li freq - The refresh rate will be stored in this variable #/list + diff --git a/doc/files/getglobalmouse.txt b/doc/files/getglobalmouse.txt index 7267e36..efcc97a 100644 --- a/doc/files/getglobalmouse.txt +++ b/doc/files/getglobalmouse.txt @@ -1,4 +1,5 @@ #title GetGlobalMouse [RCBasic Doc] -#header sub GetGlobalMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3) +#header Sub GetGlobalMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3) Gets the global mouse position and button state + diff --git a/doc/files/getgpuinfo.txt b/doc/files/getgpuinfo.txt index c3cee0b..4257479 100644 --- a/doc/files/getgpuinfo.txt +++ b/doc/files/getgpuinfo.txt @@ -1,4 +1,5 @@ #title GetGPUInfo$ [RCBasic Doc] -#header function GetGPUInfo$() +#header Function GetGPUInfo$() Returns the GPU Vendor info + diff --git a/doc/files/getgravity2d.txt b/doc/files/getgravity2d.txt index a181a73..361c3fc 100644 --- a/doc/files/getgravity2d.txt +++ b/doc/files/getgravity2d.txt @@ -1,6 +1,7 @@ #title GetGravity2D [RCBasic Doc] -#header sub GetGravity2D(ByRef x, ByRef y) +#header Sub GetGravity2D(ByRef x, ByRef y) Use this function for retrieving the global gravity vector. A sprite canvas layer must be open. #ref SetGravity2D + diff --git a/doc/files/getgravity3d.txt b/doc/files/getgravity3d.txt index ffb2a6a..4babdd3 100644 --- a/doc/files/getgravity3d.txt +++ b/doc/files/getgravity3d.txt @@ -1,6 +1,7 @@ #title GetGravity3D [RCBasic Doc] -#header sub GetGravity3D(ByRef x, ByRef y, ByRef z) +#header Sub GetGravity3D(ByRef x, ByRef y, ByRef z) Gets the world gravity #ref SetGravity3D + diff --git a/doc/files/getgyro.txt b/doc/files/getgyro.txt index b622e77..241520e 100644 --- a/doc/files/getgyro.txt +++ b/doc/files/getgyro.txt @@ -1,4 +1,5 @@ #title GetGyro [RCBasic Doc] -#header sub GetGyro(gyro_num, ByRef x, ByRef y, ByRef z) +#header Sub GetGyro(gyro_num, ByRef x, ByRef y, ByRef z) Gets the values of a Gyro sensor + diff --git a/doc/files/gethingeangle.txt b/doc/files/gethingeangle.txt index 341c02c..258760f 100644 --- a/doc/files/gethingeangle.txt +++ b/doc/files/gethingeangle.txt @@ -1,4 +1,5 @@ -#title getHingeAngle [RCBasic Doc] -#header function getHingeAngle( constraint_id) +#title GetHingeAngle [RCBasic Doc] +#header Function GetHingeAngle( constraint_id) Returns the angle of a hinge constraint + diff --git a/doc/files/gethingeangleex.txt b/doc/files/gethingeangleex.txt index c89928a..250125f 100644 --- a/doc/files/gethingeangleex.txt +++ b/doc/files/gethingeangleex.txt @@ -1,4 +1,5 @@ -#title getHingeAngleEx [RCBasic Doc] -#header function getHingeAngleEx( constraint_id, t_matrixA, t_matrixB) +#title GetHingeAngleEx [RCBasic Doc] +#header Function GetHingeAngleEx( constraint_id, t_matrixA, t_matrixB) Returns the transforms of the 2 actors in a hinge constraint + diff --git a/doc/files/gethingelimitbiasfactor.txt b/doc/files/gethingelimitbiasfactor.txt index 466156c..324256b 100644 --- a/doc/files/gethingelimitbiasfactor.txt +++ b/doc/files/gethingelimitbiasfactor.txt @@ -1,6 +1,7 @@ -#title getHingeLimitBiasFactor [RCBasic Doc] -#header function getHingeLimitBiasFactor( constraint_id) +#title GetHingeLimitBiasFactor [RCBasic Doc] +#header Function GetHingeLimitBiasFactor( constraint_id) Returns the bias factor associated with the limits of the hinge constraint. This bias factor affects how the constraint corrects errors when the angular position of the constrained actors approaches or exceeds the defined limits. The bias factor is a parameter that influences how aggressively the constraint corrects the position when the angular motion reaches the limits. A higher bias factor results in a stronger corrective force, helping to pull the constrained bodies back within their limits more quickly. + diff --git a/doc/files/gethingelimitrelaxationfactor.txt b/doc/files/gethingelimitrelaxationfactor.txt index 61f10f0..7dcf558 100644 --- a/doc/files/gethingelimitrelaxationfactor.txt +++ b/doc/files/gethingelimitrelaxationfactor.txt @@ -1,4 +1,5 @@ -#title getHingeLimitRelaxationFactor [RCBasic Doc] -#header function getHingeLimitRelaxationFactor( constraint_id) +#title GetHingeLimitRelaxationFactor [RCBasic Doc] +#header Function GetHingeLimitRelaxationFactor( constraint_id) + diff --git a/doc/files/gethingelimitsign.txt b/doc/files/gethingelimitsign.txt index 07a5d39..c47e2a5 100644 --- a/doc/files/gethingelimitsign.txt +++ b/doc/files/gethingelimitsign.txt @@ -1,8 +1,9 @@ -#title getHingeLimitSign [RCBasic Doc] -#header function getHingeLimitSign( constraint_id) +#title GetHingeLimitSign [RCBasic Doc] +#header Function GetHingeLimitSign( constraint_id) Returns the limit sign for the hinge constraint. This value indicates the direction in which the hinge limit is applied, which can be crucial for understanding the behavior of the hinge in relation to its limits. The limit sign determines whether the hinge's limits are applied in a positive or negative direction. It essentially indicates the side of the limit that is considered "active" during the simulation. #ref SetHingeLimit + diff --git a/doc/files/gethingesolvelimit.txt b/doc/files/gethingesolvelimit.txt index ce518db..7b72ad6 100644 --- a/doc/files/gethingesolvelimit.txt +++ b/doc/files/gethingesolvelimit.txt @@ -1,6 +1,7 @@ -#title getHingeSolveLimit [RCBasic Doc] -#header function getHingeSolveLimit( constraint_id) +#title GetHingeSolveLimit [RCBasic Doc] +#header Function GetHingeSolveLimit( constraint_id) Checks whether the hinge has reached or exceeded its angular limit during the simulation. It returns a boolean or an integer value that indicates whether the current angular position is within the constraint's angular limits or if corrective forces need to be applied. The "solve limit" refers to whether the current angular position is close to or outside the defined angular limits. If the constraint detects that the hinge is at the limit, it enters a solving state, where it applies corrective forces to keep the rotation within the allowed range. + diff --git a/doc/files/gethorizontalangle.txt b/doc/files/gethorizontalangle.txt new file mode 100644 index 0000000..285020c --- /dev/null +++ b/doc/files/gethorizontalangle.txt @@ -0,0 +1,5 @@ +#title GetHorizontalAngle [RCBasic Doc] +#header Sub GetHorizontalAngle(x, y, z, ByRef hx, ByRef hy, ByRef hz) + +Get the rotation vector that would make a (0,0,1) direction vector point in the same direction as the given direction vector + diff --git a/doc/files/getimagealpha.txt b/doc/files/getimagealpha.txt index 7b25488..d044ce3 100644 --- a/doc/files/getimagealpha.txt +++ b/doc/files/getimagealpha.txt @@ -1,4 +1,5 @@ #title GetImageAlpha [RCBasic Doc] -#header function GetImageAlpha( img_id ) +#header Function GetImageAlpha( img_id ) Returns the alpha blend value of an image + diff --git a/doc/files/getimagecolormod.txt b/doc/files/getimagecolormod.txt index c6b6c95..e6f310b 100644 --- a/doc/files/getimagecolormod.txt +++ b/doc/files/getimagecolormod.txt @@ -1,4 +1,5 @@ #title GetImageColorMod [RCBasic Doc] -#header function GetImageColorMod(img) +#header Function GetImageColorMod(img) Returns the color modulation of an image + diff --git a/doc/files/getimagesize.txt b/doc/files/getimagesize.txt index b58abc4..91bfad6 100644 --- a/doc/files/getimagesize.txt +++ b/doc/files/getimagesize.txt @@ -1,4 +1,5 @@ #title GetImageSize [RCBasic Doc] -#header sub GetImageSize(slot, byref w, byref h) +#header Sub GetImageSize(slot, ByRef w, ByRef h) Gets the Size of an image + diff --git a/doc/files/getjointangle.txt b/doc/files/getjointangle.txt index 995f3c9..3fc5ad9 100644 --- a/doc/files/getjointangle.txt +++ b/doc/files/getjointangle.txt @@ -1,5 +1,5 @@ -#title getJointAngle [RCBasic Doc] -#header function getJointAngle( joint_id) +#title GetJointAngle [RCBasic Doc] +#header Function GetJointAngle( joint_id) Returns the current joint angle @@ -8,3 +8,4 @@ Used with #li Revolute Joint #li Wheel Joint #/list + diff --git a/doc/files/getjointangularoffset.txt b/doc/files/getjointangularoffset.txt index cc20881..6dc7882 100644 --- a/doc/files/getjointangularoffset.txt +++ b/doc/files/getjointangularoffset.txt @@ -1,8 +1,9 @@ -#title getJointAngularOffset [RCBasic Doc] -#header function getJointAngularOffset( joint_id) +#title GetJointAngularOffset [RCBasic Doc] +#header Function GetJointAngularOffset( joint_id) Returns the target angular offset Used with Motor Joint #ref SetJointAngularOffset + diff --git a/doc/files/getjointangularspeed.txt b/doc/files/getjointangularspeed.txt index de5013b..513439b 100644 --- a/doc/files/getjointangularspeed.txt +++ b/doc/files/getjointangularspeed.txt @@ -1,6 +1,7 @@ -#title getJointAngularSpeed [RCBasic Doc] -#header function getJointAngularSpeed( joint_id) +#title GetJointAngularSpeed [RCBasic Doc] +#header Function GetJointAngularSpeed( joint_id) Return the current joint angular speed Used with Wheel Joint + diff --git a/doc/files/getjointcorrectionfactor.txt b/doc/files/getjointcorrectionfactor.txt index 08ab123..3412a65 100644 --- a/doc/files/getjointcorrectionfactor.txt +++ b/doc/files/getjointcorrectionfactor.txt @@ -1,5 +1,5 @@ -#title getJointCorrectionFactor [RCBasic Doc] -#header function getJointCorrectionFactor( joint_id) +#title GetJointCorrectionFactor [RCBasic Doc] +#header Function GetJointCorrectionFactor( joint_id) Returns a factor for how quickly the joint corrects deviations from its target position and rotation. This correction factor determines the responsiveness of the motor joint in achieving the desired linear and angular offsets between two connected bodies. @@ -7,3 +7,4 @@ Used with Motor Joints #ref GetJointCorrectionFactor + diff --git a/doc/files/getjointcurrentlength.txt b/doc/files/getjointcurrentlength.txt index e265efc..a255917 100644 --- a/doc/files/getjointcurrentlength.txt +++ b/doc/files/getjointcurrentlength.txt @@ -1,8 +1,9 @@ -#title getJointCurrentLength [RCBasic Doc] -#header function getJointCurrentLength( joint_id) +#title GetJointCurrentLength [RCBasic Doc] +#header Function GetJointCurrentLength( joint_id) Returns the current distance between BodyA and BodyB Used with Distance Joint #ref GetJointLength + diff --git a/doc/files/getjointcurrentlengtha.txt b/doc/files/getjointcurrentlengtha.txt index 7455b65..731c284 100644 --- a/doc/files/getjointcurrentlengtha.txt +++ b/doc/files/getjointcurrentlengtha.txt @@ -1,8 +1,9 @@ -#title getJointCurrentLengthA [RCBasic Doc] -#header function getJointCurrentLengthA( joint_id) +#title GetJointCurrentLengthA [RCBasic Doc] +#header Function GetJointCurrentLengthA( joint_id) Return the current length of the segment attached to bodyA. Used with Pulley Joint #ref GetJointCurrentLengthB + diff --git a/doc/files/getjointcurrentlengthb.txt b/doc/files/getjointcurrentlengthb.txt index 78e1490..d3b944d 100644 --- a/doc/files/getjointcurrentlengthb.txt +++ b/doc/files/getjointcurrentlengthb.txt @@ -1,8 +1,9 @@ -#title getJointCurrentLengthB [RCBasic Doc] -#header function getJointCurrentLengthB( joint_id) +#title GetJointCurrentLengthB [RCBasic Doc] +#header Function GetJointCurrentLengthB( joint_id) Return the current length of the segment attached to bodyB. Used with Pulley Joint #ref GetJointCurrentLengthA + diff --git a/doc/files/getjointdamping.txt b/doc/files/getjointdamping.txt index 131ecdc..0ea2831 100644 --- a/doc/files/getjointdamping.txt +++ b/doc/files/getjointdamping.txt @@ -1,5 +1,5 @@ -#title getJointDamping [RCBasic Doc] -#header function getJointDamping( joint_id) +#title GetJointDamping [RCBasic Doc] +#header Function GetJointDamping( joint_id) Returns the damping value for a joint @@ -11,3 +11,4 @@ Used with #/list #ref SetJointDamping + diff --git a/doc/files/getjointgroundanchora.txt b/doc/files/getjointgroundanchora.txt index 3abb253..0eb1746 100644 --- a/doc/files/getjointgroundanchora.txt +++ b/doc/files/getjointgroundanchora.txt @@ -1,8 +1,9 @@ -#title getJointGroundAnchorA [RCBasic Doc] -#header sub getJointGroundAnchorA( joint_id, ByRef x, ByRef y) +#title GetJointGroundAnchorA [RCBasic Doc] +#header Sub GetJointGroundAnchorA( joint_id, ByRef x, ByRef y) Gets the first ground anchor Used with Pulley Joint #ref GetJointGroundAnchorB + diff --git a/doc/files/getjointgroundanchorb.txt b/doc/files/getjointgroundanchorb.txt index ac3d8db..616f46a 100644 --- a/doc/files/getjointgroundanchorb.txt +++ b/doc/files/getjointgroundanchorb.txt @@ -1,8 +1,9 @@ -#title getJointGroundAnchorB [RCBasic Doc] -#header sub getJointGroundAnchorB( joint_id, ByRef x, ByRef y) +#title GetJointGroundAnchorB [RCBasic Doc] +#header Sub GetJointGroundAnchorB( joint_id, ByRef x, ByRef y) Gets the second ground anchor Used with Pulley Joint #ref GetJointGroundAnchorA + diff --git a/doc/files/getjointlength.txt b/doc/files/getjointlength.txt index 60a9416..de46858 100644 --- a/doc/files/getjointlength.txt +++ b/doc/files/getjointlength.txt @@ -1,5 +1,5 @@ -#title getJointLength [RCBasic Doc] -#header function getJointLength( joint_id) +#title GetJointLength [RCBasic Doc] +#header Function GetJointLength( joint_id) Returns the Joint Length @@ -7,3 +7,4 @@ Used with distance Joints #ref SetJointLength + diff --git a/doc/files/getjointlengtha.txt b/doc/files/getjointlengtha.txt index 395010a..18bd774 100644 --- a/doc/files/getjointlengtha.txt +++ b/doc/files/getjointlengtha.txt @@ -1,8 +1,9 @@ -#title getJointLengthA [RCBasic Doc] -#header function getJointLengthA( joint_id) +#title GetJointLengthA [RCBasic Doc] +#header Function GetJointLengthA( joint_id) Returns the current length of the line connecting the anchor point on the first body to its corresponding ground anchor. This length can vary based on the movement of the connected bodies. Used with Pulley Joints #ref GetJointLengthB + diff --git a/doc/files/getjointlengthb.txt b/doc/files/getjointlengthb.txt index 969f110..4d0744f 100644 --- a/doc/files/getjointlengthb.txt +++ b/doc/files/getjointlengthb.txt @@ -1,8 +1,9 @@ -#title getJointLengthB [RCBasic Doc] -#header function getJointLengthB( joint_id) +#title GetJointLengthB [RCBasic Doc] +#header Function GetJointLengthB( joint_id) Returns the current length of the line connecting the anchor point on the second body to its corresponding ground anchor. This length can vary based on the movement of the connected bodies. Used with Pulley Joints #ref GetJointLengthA + diff --git a/doc/files/getjointlinearoffset.txt b/doc/files/getjointlinearoffset.txt index e1eb1a1..bbfb9db 100644 --- a/doc/files/getjointlinearoffset.txt +++ b/doc/files/getjointlinearoffset.txt @@ -1,8 +1,9 @@ -#title getJointLinearOffset [RCBasic Doc] -#header sub getJointLinearOffset( joint_id, ByRef x, ByRef y) +#title GetJointLinearOffset [RCBasic Doc] +#header Sub GetJointLinearOffset( joint_id, ByRef x, ByRef y) Gets the target position offset for the connected bodies relative to each other. Used with Motor Joints #ref SetJointLinearOffset + diff --git a/doc/files/getjointlinearspeed.txt b/doc/files/getjointlinearspeed.txt index e773051..a917ba2 100644 --- a/doc/files/getjointlinearspeed.txt +++ b/doc/files/getjointlinearspeed.txt @@ -1,6 +1,7 @@ -#title getJointLinearSpeed [RCBasic Doc] -#header function getJointLinearSpeed( joint_id) +#title GetJointLinearSpeed [RCBasic Doc] +#header Function GetJointLinearSpeed( joint_id) Returns the current joint linear speed, usually in meters per second. Used with Wheel Joint + diff --git a/doc/files/getjointlocalanchora.txt b/doc/files/getjointlocalanchora.txt index 3ab327f..4f68a8c 100644 --- a/doc/files/getjointlocalanchora.txt +++ b/doc/files/getjointlocalanchora.txt @@ -1,5 +1,5 @@ -#title getJointLocalAnchorA [RCBasic Doc] -#header sub getJointLocalAnchorA( joint_id, ByRef x, ByRef y) +#title GetJointLocalAnchorA [RCBasic Doc] +#header Sub GetJointLocalAnchorA( joint_id, ByRef x, ByRef y) Returns the local anchor point relative to bodyA's origin. @@ -13,3 +13,4 @@ Returns the local anchor point relative to bodyA's origin. #/list #ref GetJointLocalAnchorB + diff --git a/doc/files/getjointlocalanchorb.txt b/doc/files/getjointlocalanchorb.txt index 59355b5..6ae1e36 100644 --- a/doc/files/getjointlocalanchorb.txt +++ b/doc/files/getjointlocalanchorb.txt @@ -1,5 +1,5 @@ -#title getJointLocalAnchorB [RCBasic Doc] -#header sub getJointLocalAnchorB( joint_id, ByRef x, ByRef y) +#title GetJointLocalAnchorB [RCBasic Doc] +#header Sub GetJointLocalAnchorB( joint_id, ByRef x, ByRef y) Returns the local anchor point relative to bodyB's origin. @@ -13,3 +13,4 @@ Returns the local anchor point relative to bodyB's origin. #/list #ref GetJointLocalAnchorA + diff --git a/doc/files/getjointlocalaxisa.txt b/doc/files/getjointlocalaxisa.txt index fbaf6ad..e51e132 100644 --- a/doc/files/getjointlocalaxisa.txt +++ b/doc/files/getjointlocalaxisa.txt @@ -1,5 +1,5 @@ -#title getJointLocalAxisA [RCBasic Doc] -#header sub getJointLocalAxisA( joint_id, ByRef x, ByRef y) +#title GetJointLocalAxisA [RCBasic Doc] +#header Sub GetJointLocalAxisA( joint_id, ByRef x, ByRef y) Gets the local joint axis relative to bodyA @@ -9,3 +9,4 @@ Used with #li Wheel Joint #/list + diff --git a/doc/files/getjointlowerlimit.txt b/doc/files/getjointlowerlimit.txt index 3de2db7..4c8fd4c 100644 --- a/doc/files/getjointlowerlimit.txt +++ b/doc/files/getjointlowerlimit.txt @@ -1,5 +1,5 @@ -#title getJointLowerLimit [RCBasic Doc] -#header function getJointLowerLimit( joint_id) +#title GetJointLowerLimit [RCBasic Doc] +#header Function GetJointLowerLimit( joint_id) Get the lower joint translation limit, usually in meters. @@ -11,3 +11,4 @@ Used with #/list #ref GetJointUpperLimit + diff --git a/doc/files/getjointmaxforce.txt b/doc/files/getjointmaxforce.txt index 6d9a4d4..1d92e14 100644 --- a/doc/files/getjointmaxforce.txt +++ b/doc/files/getjointmaxforce.txt @@ -1,5 +1,5 @@ -#title getJointMaxForce [RCBasic Doc] -#header function getJointMaxForce( joint_id) +#title GetJointMaxForce [RCBasic Doc] +#header Function GetJointMaxForce( joint_id) Return the maximum friction force in N. @@ -8,3 +8,4 @@ Used with #li Friction Joint #li Motor Joint #/list + diff --git a/doc/files/getjointmaxlength.txt b/doc/files/getjointmaxlength.txt index c2e08be..1cea84f 100644 --- a/doc/files/getjointmaxlength.txt +++ b/doc/files/getjointmaxlength.txt @@ -1,8 +1,9 @@ -#title getJointMaxLength [RCBasic Doc] -#header function getJointMaxLength( joint_id) +#title GetJointMaxLength [RCBasic Doc] +#header Function GetJointMaxLength( joint_id) Returns the maximum length Used with Distance Joint #ref GetJointMinLength + diff --git a/doc/files/getjointmaxmotorforce.txt b/doc/files/getjointmaxmotorforce.txt index d1cbcc9..9594263 100644 --- a/doc/files/getjointmaxmotorforce.txt +++ b/doc/files/getjointmaxmotorforce.txt @@ -1,8 +1,9 @@ -#title getJointMaxMotorForce [RCBasic Doc] -#header function getJointMaxMotorForce( joint_id) +#title GetJointMaxMotorForce [RCBasic Doc] +#header Function GetJointMaxMotorForce( joint_id) Returns the maximum linear force that the motor can apply to achieve the target speed set by SetMotorSpeed. This allows you to control the power or strength of the motor along the joint’s axis. Used with Prismatic Joint #ref SetJointMaxMotorForce + diff --git a/doc/files/getjointmaxmotortorque.txt b/doc/files/getjointmaxmotortorque.txt index 48a1ca2..bb76292 100644 --- a/doc/files/getjointmaxmotortorque.txt +++ b/doc/files/getjointmaxmotortorque.txt @@ -1,5 +1,5 @@ -#title getJointMaxMotorTorque [RCBasic Doc] -#header function getJointMaxMotorTorque( joint_id) +#title GetJointMaxMotorTorque [RCBasic Doc] +#header Function GetJointMaxMotorTorque( joint_id) Returns the maximum torque (rotational force) that the motor can apply to achieve the target motor speed set by SetMotorSpeed. This allows you to control how much power the motorized joint has. @@ -10,3 +10,4 @@ Used with #/list #ref SetJointMaxMotorTorque + diff --git a/doc/files/getjointmaxtorque.txt b/doc/files/getjointmaxtorque.txt index 479724c..5cb5233 100644 --- a/doc/files/getjointmaxtorque.txt +++ b/doc/files/getjointmaxtorque.txt @@ -1,5 +1,5 @@ -#title getJointMaxTorque [RCBasic Doc] -#header function getJointMaxTorque( joint_id) +#title GetJointMaxTorque [RCBasic Doc] +#header Function GetJointMaxTorque( joint_id) Returns the upper limit on the amount of torque (rotational force) the joint can apply, controlling how much rotational resistance or power the joint provides. @@ -10,3 +10,4 @@ Used with #/list #ref SetJointMaxTorque + diff --git a/doc/files/getjointminlength.txt b/doc/files/getjointminlength.txt index 3114321..70f61c4 100644 --- a/doc/files/getjointminlength.txt +++ b/doc/files/getjointminlength.txt @@ -1,8 +1,9 @@ -#title getJointMinLength [RCBasic Doc] -#header function getJointMinLength( joint_id) +#title GetJointMinLength [RCBasic Doc] +#header Function GetJointMinLength( joint_id) Returns the minimum length Used with Distance Joint #ref GetJointMaxLength + diff --git a/doc/files/getjointmotorforce.txt b/doc/files/getjointmotorforce.txt index e954a31..adb6817 100644 --- a/doc/files/getjointmotorforce.txt +++ b/doc/files/getjointmotorforce.txt @@ -1,8 +1,9 @@ -#title getJointMotorForce [RCBasic Doc] -#header function getJointMotorForce( joint_id, inv_dt) +#title GetJointMotorForce [RCBasic Doc] +#header Function GetJointMotorForce( joint_id, inv_dt) Return the current motor force given the inverse time step, usually in N. Used with Prismatic Joint #ref SetJointMotorForce + diff --git a/doc/files/getjointmotorspeed.txt b/doc/files/getjointmotorspeed.txt index 80b725f..15cfe78 100644 --- a/doc/files/getjointmotorspeed.txt +++ b/doc/files/getjointmotorspeed.txt @@ -1,5 +1,5 @@ -#title getJointMotorSpeed [RCBasic Doc] -#header function getJointMotorSpeed( joint_id) +#title GetJointMotorSpeed [RCBasic Doc] +#header Function GetJointMotorSpeed( joint_id) Returns the motor speed @@ -11,3 +11,4 @@ Used with #/list #ref SetJointMotorSpeed + diff --git a/doc/files/getjointmotortorque.txt b/doc/files/getjointmotortorque.txt index 022fa33..b28cee6 100644 --- a/doc/files/getjointmotortorque.txt +++ b/doc/files/getjointmotortorque.txt @@ -1,5 +1,5 @@ -#title getJointMotorTorque [RCBasic Doc] -#header function getJointMotorTorque( joint_id, inv_dt) +#title GetJointMotorTorque [RCBasic Doc] +#header Function GetJointMotorTorque( joint_id, inv_dt) Returns the current motor torque given the inverse time step. Unit is N*m. @@ -10,3 +10,4 @@ Used with #/list #ref GetJointMaxMotorTorque SetJointMaxMotorTorque + diff --git a/doc/files/getjointratio.txt b/doc/files/getjointratio.txt index 32d1ae1..f37697d 100644 --- a/doc/files/getjointratio.txt +++ b/doc/files/getjointratio.txt @@ -1,5 +1,5 @@ -#title getJointRatio [RCBasic Doc] -#header function getJointRatio( joint_id) +#title GetJointRatio [RCBasic Doc] +#header Function GetJointRatio( joint_id) Returns the gear/pulley ratio @@ -10,3 +10,4 @@ Used with #/list #ref SetJointRatio + diff --git a/doc/files/getjointreactionforce.txt b/doc/files/getjointreactionforce.txt index 179d558..62de26a 100644 --- a/doc/files/getjointreactionforce.txt +++ b/doc/files/getjointreactionforce.txt @@ -1,5 +1,5 @@ -#title getJointReactionForce [RCBasic Doc] -#header sub getJointReactionForce( joint_id, inv_dt, ByRef x, ByRef y) +#title GetJointReactionForce [RCBasic Doc] +#header Sub GetJointReactionForce( joint_id, inv_dt, ByRef x, ByRef y) Returns the reaction force on bodyB at the joint anchor in Newtons. @@ -7,3 +7,4 @@ Can be used with all joints #ref GetJointReactionTorque + diff --git a/doc/files/getjointreactiontorque.txt b/doc/files/getjointreactiontorque.txt index 1bbcf38..f6a2af8 100644 --- a/doc/files/getjointreactiontorque.txt +++ b/doc/files/getjointreactiontorque.txt @@ -1,8 +1,9 @@ -#title getJointReactionTorque [RCBasic Doc] -#header function getJointReactionTorque( joint_id, inv_dt) +#title GetJointReactionTorque [RCBasic Doc] +#header Function GetJointReactionTorque( joint_id, inv_dt) Returns the reaction torque on bodyB in N*m Can be used with all joints #ref GetJointReactionForce + diff --git a/doc/files/getjointreferenceangle.txt b/doc/files/getjointreferenceangle.txt index d30f77c..09b2472 100644 --- a/doc/files/getjointreferenceangle.txt +++ b/doc/files/getjointreferenceangle.txt @@ -1,5 +1,5 @@ -#title getJointReferenceAngle [RCBasic Doc] -#header function getJointReferenceAngle( joint_id) +#title GetJointReferenceAngle [RCBasic Doc] +#header Function GetJointReferenceAngle( joint_id) Returns the reference angle. @@ -8,3 +8,4 @@ Used with #li Prismatic Joint #li Revolute Joint #/list + diff --git a/doc/files/getjointspeed.txt b/doc/files/getjointspeed.txt index 49e647d..3556da1 100644 --- a/doc/files/getjointspeed.txt +++ b/doc/files/getjointspeed.txt @@ -1,5 +1,5 @@ -#title getJointSpeed [RCBasic Doc] -#header function getJointSpeed( joint_id) +#title GetJointSpeed [RCBasic Doc] +#header Function GetJointSpeed( joint_id) Returns the current joint angle speed @@ -8,3 +8,4 @@ Used with #li Prismatic Joint #li Revolute Joint #/list + diff --git a/doc/files/getjointstiffness.txt b/doc/files/getjointstiffness.txt index cecf85e..12c9626 100644 --- a/doc/files/getjointstiffness.txt +++ b/doc/files/getjointstiffness.txt @@ -1,5 +1,5 @@ -#title getJointStiffness [RCBasic Doc] -#header function getJointStiffness( joint_id) +#title GetJointStiffness [RCBasic Doc] +#header Function GetJointStiffness( joint_id) Returns spring stiffness @@ -11,3 +11,4 @@ Used with #/list #ref SetJointStiffness + diff --git a/doc/files/getjointtranslation.txt b/doc/files/getjointtranslation.txt index 286942c..80b09db 100644 --- a/doc/files/getjointtranslation.txt +++ b/doc/files/getjointtranslation.txt @@ -1,5 +1,5 @@ -#title getJointTranslation [RCBasic Doc] -#header function getJointTranslation( joint_id) +#title GetJointTranslation [RCBasic Doc] +#header Function GetJointTranslation( joint_id) Returns the current joint translation, usually in meters. @@ -8,3 +8,4 @@ Used with #li Prismatic Joint #li Wheel Joint #/list + diff --git a/doc/files/getjointupperlimit.txt b/doc/files/getjointupperlimit.txt index 4d96565..186dc49 100644 --- a/doc/files/getjointupperlimit.txt +++ b/doc/files/getjointupperlimit.txt @@ -1,5 +1,5 @@ -#title getJointUpperLimit [RCBasic Doc] -#header function getJointUpperLimit( joint_id) +#title GetJointUpperLimit [RCBasic Doc] +#header Function GetJointUpperLimit( joint_id) Get the upper joint translation limit, usually in meters. @@ -11,3 +11,4 @@ Used with #/list #ref GetJointLowerLimit + diff --git a/doc/files/getjointworldanchora.txt b/doc/files/getjointworldanchora.txt index 336857f..e198375 100644 --- a/doc/files/getjointworldanchora.txt +++ b/doc/files/getjointworldanchora.txt @@ -1,8 +1,9 @@ -#title getJointWorldAnchorA [RCBasic Doc] -#header sub getJointWorldAnchorA( joint_id, ByRef x, ByRef y) +#title GetJointWorldAnchorA [RCBasic Doc] +#header Sub GetJointWorldAnchorA( joint_id, ByRef x, ByRef y) Get the anchor point on bodyA in world coordinates. Can be used with all joints #ref GetJointWorldAnchorB + diff --git a/doc/files/getjointworldanchorb.txt b/doc/files/getjointworldanchorb.txt index 43a4ede..c0ef6d3 100644 --- a/doc/files/getjointworldanchorb.txt +++ b/doc/files/getjointworldanchorb.txt @@ -1,8 +1,9 @@ -#title getJointWorldAnchorB [RCBasic Doc] -#header sub getJointWorldAnchorB( joint_id, ByRef x, ByRef y) +#title GetJointWorldAnchorB [RCBasic Doc] +#header Sub GetJointWorldAnchorB( joint_id, ByRef x, ByRef y) Get the anchor point on bodyB in world coordinates. Can be used with all joints #ref GetJointWorldAnchorA + diff --git a/doc/files/getjoytrackball.txt b/doc/files/getjoytrackball.txt index 943a43e..cb23100 100644 --- a/doc/files/getjoytrackball.txt +++ b/doc/files/getjoytrackball.txt @@ -1,4 +1,5 @@ #title GetJoyTrackBall [RCBasic Doc] -#header sub GetJoyTrackBall(joy_num, ball, byref dx, byref dy) +#header Sub GetJoyTrackBall(joy_num, ball, ByRef dx, ByRef dy) Gets the axis values of a track ball + diff --git a/doc/files/getlightambientcolor.txt b/doc/files/getlightambientcolor.txt index ea6f936..0f8a719 100644 --- a/doc/files/getlightambientcolor.txt +++ b/doc/files/getlightambientcolor.txt @@ -1,4 +1,5 @@ #title GetLightAmbientColor [RCBasic Doc] -#header function GetLightAmbientColor( actor ) +#header Function GetLightAmbientColor( actor ) Returns the ambient color of a light + diff --git a/doc/files/getlightattenuation.txt b/doc/files/getlightattenuation.txt index b671d9e..09f52dd 100644 --- a/doc/files/getlightattenuation.txt +++ b/doc/files/getlightattenuation.txt @@ -1,4 +1,5 @@ #title GetLightAttenuation [RCBasic Doc] -#header sub GetLightAttenuation( actor, ByRef constant, ByRef linear, ByRef quadratic) +#header Sub GetLightAttenuation( actor, ByRef constant, ByRef linear, ByRef quadratic) Gets the strength of the light + diff --git a/doc/files/getlightdiffusecolor.txt b/doc/files/getlightdiffusecolor.txt index 643d85d..032b74c 100644 --- a/doc/files/getlightdiffusecolor.txt +++ b/doc/files/getlightdiffusecolor.txt @@ -1,4 +1,5 @@ #title GetLightDiffuseColor [RCBasic Doc] -#header function GetLightDiffuseColor( actor ) +#header Function GetLightDiffuseColor( actor ) Returns the diffuse color of the light + diff --git a/doc/files/getlightfalloff.txt b/doc/files/getlightfalloff.txt index 0a2f291..dd15de8 100644 --- a/doc/files/getlightfalloff.txt +++ b/doc/files/getlightfalloff.txt @@ -1,4 +1,5 @@ #title GetLightFalloff [RCBasic Doc] -#header function GetLightFalloff( actor ) +#header Function GetLightFalloff( actor ) Returns the strength decrease between the inner and outer cone of a light + diff --git a/doc/files/getlightinnercone.txt b/doc/files/getlightinnercone.txt index cbf606b..a6eef9f 100644 --- a/doc/files/getlightinnercone.txt +++ b/doc/files/getlightinnercone.txt @@ -1,4 +1,5 @@ #title GetLightInnerCone [RCBasic Doc] -#header function GetLightInnerCone( actor ) +#header Function GetLightInnerCone( actor ) Returns the inner cone of a spot light + diff --git a/doc/files/getlightoutercone.txt b/doc/files/getlightoutercone.txt index fd6355b..cff589c 100644 --- a/doc/files/getlightoutercone.txt +++ b/doc/files/getlightoutercone.txt @@ -1,4 +1,5 @@ #title GetLightOuterCone [RCBasic Doc] -#header function GetLightOuterCone( actor ) +#header Function GetLightOuterCone( actor ) Returns the outer cone of a spot light + diff --git a/doc/files/getlightradius.txt b/doc/files/getlightradius.txt index 97c1d9d..f7a07c5 100644 --- a/doc/files/getlightradius.txt +++ b/doc/files/getlightradius.txt @@ -1,4 +1,5 @@ -#title getLightRadius [RCBasic Doc] -#header function getLightRadius( actor ) +#title GetLightRadius [RCBasic Doc] +#header Function GetLightRadius( actor ) Returns the radius of the light + diff --git a/doc/files/getlightspecularcolor.txt b/doc/files/getlightspecularcolor.txt index 85fcc57..59cb004 100644 --- a/doc/files/getlightspecularcolor.txt +++ b/doc/files/getlightspecularcolor.txt @@ -1,4 +1,5 @@ #title GetLightSpecularColor [RCBasic Doc] -#header function GetLightSpecularColor( actor ) +#header Function GetLightSpecularColor( actor ) Returns the specular color of a light + diff --git a/doc/files/getlighttype.txt b/doc/files/getlighttype.txt index 6b4e862..69b1261 100644 --- a/doc/files/getlighttype.txt +++ b/doc/files/getlighttype.txt @@ -1,5 +1,5 @@ #title GetLightType [RCBasic Doc] -#header function GetLightType( actor ) +#header Function GetLightType( actor ) Returns the type of light @@ -13,3 +13,4 @@ Possible Light Types #/list #ref SetLightType + diff --git a/doc/files/getlineangle.txt b/doc/files/getlineangle.txt new file mode 100644 index 0000000..6a7c3c6 --- /dev/null +++ b/doc/files/getlineangle.txt @@ -0,0 +1,5 @@ +#title GetLineAngle [RCBasic Doc] +#header Function GetLineAngle(x1, y1, x2, y2) + +Gets an angle between 2 points + diff --git a/doc/files/getlineintersection.txt b/doc/files/getlineintersection.txt index 2de427b..414549e 100644 --- a/doc/files/getlineintersection.txt +++ b/doc/files/getlineintersection.txt @@ -4,3 +4,4 @@ Sets (i_x, i_y) to the intersection of lines p0-p1 and p2-p3 Returns true if there is a collision and false if not + diff --git a/doc/files/getlineplaneintersection.txt b/doc/files/getlineplaneintersection.txt index d929740..7090949 100644 --- a/doc/files/getlineplaneintersection.txt +++ b/doc/files/getlineplaneintersection.txt @@ -1,5 +1,5 @@ #title GetLinePlaneIntersection [RCBasic Doc] -#header function GetLinePlaneIntersection(ByRef line_point, ByRef line_direction, ByRef plane_point_1, ByRef plane_point_2, ByRef plane_point_3, ByRef intersection) +#header Function GetLinePlaneIntersection(ByRef line_point, ByRef line_direction, ByRef plane_point_1, ByRef plane_point_2, ByRef plane_point_3, ByRef intersection) This function calculates the intersection between a line and a plane in 3D space and stores the result in intersection @@ -13,3 +13,4 @@ Parameters: #/list Returns true if intersection point is on the plane + diff --git a/doc/files/getmaterialambientcolor.txt b/doc/files/getmaterialambientcolor.txt index 2de78a6..0aea8ad 100644 --- a/doc/files/getmaterialambientcolor.txt +++ b/doc/files/getmaterialambientcolor.txt @@ -1,4 +1,5 @@ #title GetMaterialAmbientColor [RCBasic Doc] -#header function GetMaterialAmbientColor( material_id) +#header Function GetMaterialAmbientColor( material_id) Returns the ambient color of a material + diff --git a/doc/files/getmaterialantialiasing.txt b/doc/files/getmaterialantialiasing.txt index 4541068..6ea09a5 100644 --- a/doc/files/getmaterialantialiasing.txt +++ b/doc/files/getmaterialantialiasing.txt @@ -1,5 +1,5 @@ #title GetMaterialAntiAliasing [RCBasic Doc] -#header function GetMaterialAntiAliasing( material_id) +#header Function GetMaterialAntiAliasing( material_id) Returns the anti-aliasing mode for the material @@ -15,3 +15,4 @@ Possible modes returned #/list #ref SetMaterialAntiAliasing + diff --git a/doc/files/getmaterialbackfaceculling.txt b/doc/files/getmaterialbackfaceculling.txt index ac49cc4..626e0d2 100644 --- a/doc/files/getmaterialbackfaceculling.txt +++ b/doc/files/getmaterialbackfaceculling.txt @@ -1,6 +1,7 @@ -#title getMaterialBackfaceCulling [RCBasic Doc] -#header function getMaterialBackfaceCulling( material_id) +#title GetMaterialBackfaceCulling [RCBasic Doc] +#header Function GetMaterialBackfaceCulling( material_id) Returns true if backface culling is enabled for a material #ref SetMaterialBackfaceCulling + diff --git a/doc/files/getmaterialblendfactor.txt b/doc/files/getmaterialblendfactor.txt index 11e4ee6..9a4e2c4 100644 --- a/doc/files/getmaterialblendfactor.txt +++ b/doc/files/getmaterialblendfactor.txt @@ -1,7 +1,8 @@ -#title getMaterialBlendFactor [RCBasic Doc] -#header function getMaterialBlendFactor( material_id) +#title GetMaterialBlendFactor [RCBasic Doc] +#header Function GetMaterialBlendFactor( material_id) Returns a materials blend factor + diff --git a/doc/files/getmaterialblendmode.txt b/doc/files/getmaterialblendmode.txt index 88bf52b..eddff9d 100644 --- a/doc/files/getmaterialblendmode.txt +++ b/doc/files/getmaterialblendmode.txt @@ -1,5 +1,5 @@ -#title getMaterialBlendMode [RCBasic Doc] -#header function getMaterialBlendMode( material_id) +#title GetMaterialBlendMode [RCBasic Doc] +#header Function GetMaterialBlendMode( material_id) Returns a materials blend mode @@ -18,3 +18,4 @@ Possible Blend Modes #/list #ref SetMaterialBlendMode + diff --git a/doc/files/getmaterialcolormask.txt b/doc/files/getmaterialcolormask.txt index b0eddc2..802d717 100644 --- a/doc/files/getmaterialcolormask.txt +++ b/doc/files/getmaterialcolormask.txt @@ -1,4 +1,5 @@ #title GetMaterialColorMask [RCBasic Doc] -#header function GetMaterialColorMask( material_id) +#header Function GetMaterialColorMask( material_id) Returns the color mask for a material + diff --git a/doc/files/getmaterialcolormode.txt b/doc/files/getmaterialcolormode.txt index 0f51fe2..af0460e 100644 --- a/doc/files/getmaterialcolormode.txt +++ b/doc/files/getmaterialcolormode.txt @@ -1,5 +1,5 @@ -#title getMaterialColorMode [RCBasic Doc] -#header function getMaterialColorMode( material_id) +#title GetMaterialColorMode [RCBasic Doc] +#header Function GetMaterialColorMode( material_id) Returns the color mode of a material @@ -14,3 +14,4 @@ Possible modes #/list #ref SetMaterialColorMode + diff --git a/doc/files/getmaterialconstant.txt b/doc/files/getmaterialconstant.txt index 6ac4940..828b072 100644 --- a/doc/files/getmaterialconstant.txt +++ b/doc/files/getmaterialconstant.txt @@ -6,3 +6,4 @@ Gets the constant value of an FX material NOTE: To see a list of constants for each material type, reference SetMaterialConstant() #ref SetMaterialConstant + diff --git a/doc/files/getmaterialconstantname.txt b/doc/files/getmaterialconstantname.txt index 20d5acf..472eec0 100644 --- a/doc/files/getmaterialconstantname.txt +++ b/doc/files/getmaterialconstantname.txt @@ -6,3 +6,4 @@ Returns the name of a uniform for an FX material type NOTE: index should be a number between 0 and NumMaterialConstants #ref NumMaterialConstants + diff --git a/doc/files/getmaterialdiffusecolor.txt b/doc/files/getmaterialdiffusecolor.txt index 7fb645d..d6ef5d6 100644 --- a/doc/files/getmaterialdiffusecolor.txt +++ b/doc/files/getmaterialdiffusecolor.txt @@ -1,6 +1,7 @@ -#title getMaterialDiffuseColor [RCBasic Doc] -#header function getMaterialDiffuseColor( material_id) +#title GetMaterialDiffuseColor [RCBasic Doc] +#header Function GetMaterialDiffuseColor( material_id) Returns a material's diffuse color #ref SetMaterialDiffuseColor + diff --git a/doc/files/getmaterialemissivecolor.txt b/doc/files/getmaterialemissivecolor.txt index 38cda17..fc244de 100644 --- a/doc/files/getmaterialemissivecolor.txt +++ b/doc/files/getmaterialemissivecolor.txt @@ -1,6 +1,7 @@ -#title getMaterialEmissiveColor [RCBasic Doc] -#header function getMaterialEmissiveColor( material_id) +#title GetMaterialEmissiveColor [RCBasic Doc] +#header Function GetMaterialEmissiveColor( material_id) Returns a material's emissive color #ref SetMaterialEmissiveColor + diff --git a/doc/files/getmaterialflag.txt b/doc/files/getmaterialflag.txt index 9760883..3690892 100644 --- a/doc/files/getmaterialflag.txt +++ b/doc/files/getmaterialflag.txt @@ -1,5 +1,5 @@ -#title getMaterialFlag [RCBasic Doc] -#header function getMaterialFlag( material_id, material_flag) +#title GetMaterialFlag [RCBasic Doc] +#header Function GetMaterialFlag( material_id, material_flag) Returns the value of the specified material flag @@ -28,3 +28,4 @@ Possible values for flag: #/list #ref GetActorMaterialFlag + diff --git a/doc/files/getmaterialfog.txt b/doc/files/getmaterialfog.txt index 0e7de18..55ab2a2 100644 --- a/doc/files/getmaterialfog.txt +++ b/doc/files/getmaterialfog.txt @@ -1,6 +1,7 @@ -#title getMaterialFog [RCBasic Doc] -#header function getMaterialFog( material_id) +#title GetMaterialFog [RCBasic Doc] +#header Function GetMaterialFog( material_id) Returns true if fog is enabled for a material #ref SetMaterialFog + diff --git a/doc/files/getmaterialfrontfaceculling.txt b/doc/files/getmaterialfrontfaceculling.txt index 5efcf81..4ffc002 100644 --- a/doc/files/getmaterialfrontfaceculling.txt +++ b/doc/files/getmaterialfrontfaceculling.txt @@ -1,6 +1,7 @@ -#title getMaterialFrontfaceCulling [RCBasic Doc] -#header function getMaterialFrontfaceCulling( material_id) +#title GetMaterialFrontfaceCulling [RCBasic Doc] +#header Function GetMaterialFrontfaceCulling( material_id) Returns true if front face culling is enabled for a material #ref SetMaterialFrontfaceCulling + diff --git a/doc/files/getmaterialshininess.txt b/doc/files/getmaterialshininess.txt index 976155a..7498c82 100644 --- a/doc/files/getmaterialshininess.txt +++ b/doc/files/getmaterialshininess.txt @@ -1,6 +1,7 @@ -#title getMaterialShininess [RCBasic Doc] -#header function getMaterialShininess( material_id) +#title GetMaterialShininess [RCBasic Doc] +#header Function GetMaterialShininess( material_id) Returns the shininess value for a material #ref SetMaterialShininess + diff --git a/doc/files/getmaterialspecularcolor.txt b/doc/files/getmaterialspecularcolor.txt index 4b85db8..95b8528 100644 --- a/doc/files/getmaterialspecularcolor.txt +++ b/doc/files/getmaterialspecularcolor.txt @@ -1,6 +1,7 @@ -#title getMaterialSpecularColor [RCBasic Doc] -#header function getMaterialSpecularColor( material_id) +#title GetMaterialSpecularColor [RCBasic Doc] +#header Function GetMaterialSpecularColor( material_id) Returns the specular color for a material #ref SetMaterialSpecularColor + diff --git a/doc/files/getmaterialthickness.txt b/doc/files/getmaterialthickness.txt index 1725ccd..9118e5f 100644 --- a/doc/files/getmaterialthickness.txt +++ b/doc/files/getmaterialthickness.txt @@ -1,8 +1,9 @@ -#title getMaterialThickness [RCBasic Doc] -#header function getMaterialThickness( material_id) +#title GetMaterialThickness [RCBasic Doc] +#header Function GetMaterialThickness( material_id) Returns a material's thickness value Thickness value is mainly for primitives such as lines #ref SetMaterialThickness + diff --git a/doc/files/getmaterialtype.txt b/doc/files/getmaterialtype.txt index 3303009..449194e 100644 --- a/doc/files/getmaterialtype.txt +++ b/doc/files/getmaterialtype.txt @@ -1,5 +1,5 @@ -#title getMaterialType [RCBasic Doc] -#header function getMaterialType( material_id) +#title GetMaterialType [RCBasic Doc] +#header Function GetMaterialType( material_id) Returns a material's type @@ -44,3 +44,4 @@ Possible types #/list #ref SetMaterialType GetActorMaterialType SetActorMaterialType + diff --git a/doc/files/getmatrixrotation.txt b/doc/files/getmatrixrotation.txt index d8ad74a..bfc7ec5 100644 --- a/doc/files/getmatrixrotation.txt +++ b/doc/files/getmatrixrotation.txt @@ -1,7 +1,8 @@ #title GetMatrixRotation [RCBasic Doc] -#header sub GetMatrixRotation( mA, ByRef x, ByRef y, ByRef z) +#header Sub GetMatrixRotation( mA, ByRef x, ByRef y, ByRef z) Gets the rotation vector of a matrix #ref SetMatrixRotation + diff --git a/doc/files/getmatrixscale.txt b/doc/files/getmatrixscale.txt index f0125cc..ad9f224 100644 --- a/doc/files/getmatrixscale.txt +++ b/doc/files/getmatrixscale.txt @@ -1,6 +1,7 @@ #title GetMatrixScale [RCBasic Doc] -#header sub GetMatrixScale( mA, ByRef x, ByRef y, ByRef z) +#header Sub GetMatrixScale( mA, ByRef x, ByRef y, ByRef z) Gets the scale vector of a matrix #ref SetMatrixScale + diff --git a/doc/files/getmatrixsize.txt b/doc/files/getmatrixsize.txt index 2f4ad2e..c755908 100644 --- a/doc/files/getmatrixsize.txt +++ b/doc/files/getmatrixsize.txt @@ -1,6 +1,7 @@ #title GetMatrixSize [RCBasic Doc] -#header sub GetMatrixSize(mA, ByRef r, ByRef c) +#header Sub GetMatrixSize(mA, ByRef r, ByRef c) Gets the number of rows and columns in a matrix #ref DimMatrix + diff --git a/doc/files/getmatrixtranslation.txt b/doc/files/getmatrixtranslation.txt index 66dbc20..03dae6c 100644 --- a/doc/files/getmatrixtranslation.txt +++ b/doc/files/getmatrixtranslation.txt @@ -1,6 +1,7 @@ #title GetMatrixTranslation [RCBasic Doc] -#header sub GetMatrixTranslation( mA, ByRef x, ByRef y, ByRef z) +#header Sub GetMatrixTranslation( mA, ByRef x, ByRef y, ByRef z) Get the position vector of a matrix #ref SetMatrixTranslation + diff --git a/doc/files/getmaxparticlespersecond.txt b/doc/files/getmaxparticlespersecond.txt index 2958f6b..5080ec8 100644 --- a/doc/files/getmaxparticlespersecond.txt +++ b/doc/files/getmaxparticlespersecond.txt @@ -1,6 +1,7 @@ -#title getMaxParticlesPerSecond [RCBasic Doc] -#header function getMaxParticlesPerSecond( actor) +#title GetMaxParticlesPerSecond [RCBasic Doc] +#header Function GetMaxParticlesPerSecond( actor) Returns the max number of particles emitted per second #ref SetMaxParticlesPerSecond GetMinParticlesPerSecond SetMinParticlesPerSecond + diff --git a/doc/files/getmeshboundingbox.txt b/doc/files/getmeshboundingbox.txt index cbdc329..8d9ec64 100644 --- a/doc/files/getmeshboundingbox.txt +++ b/doc/files/getmeshboundingbox.txt @@ -4,3 +4,4 @@ Gets the min and max corners of a mesh's bounding box #ref SetMeshBoundingBox ReCalculateMeshBoundingBox + diff --git a/doc/files/getmeshbuffer.txt b/doc/files/getmeshbuffer.txt new file mode 100644 index 0000000..8adbcd5 --- /dev/null +++ b/doc/files/getmeshbuffer.txt @@ -0,0 +1,7 @@ +#title GetMeshBuffer [RCBasic Doc] +#header Function GetMeshBuffer( mesh_id, buffer_index, ByRef vertex_data, ByRef normal_data, ByRef uv_data, ByRef index_data ) + +Gets the data in a mesh buffer. + +Returns TRUE if successful and FALSE if not. + diff --git a/doc/files/getmeshbuffercount.txt b/doc/files/getmeshbuffercount.txt new file mode 100644 index 0000000..a13202c --- /dev/null +++ b/doc/files/getmeshbuffercount.txt @@ -0,0 +1,5 @@ +#title GetMeshBufferCount [RCBasic Doc] +#header Function GetMeshBufferCount( mesh_id ) + +Returns the number of mesh buffers in a mesh. + diff --git a/doc/files/getmeshbufferindexcount.txt b/doc/files/getmeshbufferindexcount.txt new file mode 100644 index 0000000..1462ff4 --- /dev/null +++ b/doc/files/getmeshbufferindexcount.txt @@ -0,0 +1,5 @@ +#title GetMeshBufferIndexCount [RCBasic Doc] +#header Function GetMeshBufferIndexCount( mesh_id, buffer_index ) + +Returns the number of indices in a mesh buffer + diff --git a/doc/files/getmeshbuffervertexcount.txt b/doc/files/getmeshbuffervertexcount.txt new file mode 100644 index 0000000..2e5bbd0 --- /dev/null +++ b/doc/files/getmeshbuffervertexcount.txt @@ -0,0 +1,5 @@ +#title GetMeshBufferVertexCount [RCBasic Doc] +#header Function GetMeshBufferVertexCount( mesh_id, buffer_index ) + +Returns the number of vertices in a mesh buffer. + diff --git a/doc/files/getmeshpolygoncount.txt b/doc/files/getmeshpolygoncount.txt index 9e2bb57..6c733b2 100644 --- a/doc/files/getmeshpolygoncount.txt +++ b/doc/files/getmeshpolygoncount.txt @@ -2,3 +2,4 @@ #header Function GetMeshPolygonCount( mesh ) Returns the number of polygons in a mesh + diff --git a/doc/files/getminparticlespersecond.txt b/doc/files/getminparticlespersecond.txt index b751ae9..babc575 100644 --- a/doc/files/getminparticlespersecond.txt +++ b/doc/files/getminparticlespersecond.txt @@ -1,7 +1,8 @@ -#title getMinParticlesPerSecond [RCBasic Doc] -#header function getMinParticlesPerSecond( actor) +#title GetMinParticlesPerSecond [RCBasic Doc] +#header Function GetMinParticlesPerSecond( actor) Returns the min number of particles emitted per second #ref SetMinParticlesPerSecond GetMaxParticlesPerSecond SetMaxParticlesPerSecond + diff --git a/doc/files/getmouse.txt b/doc/files/getmouse.txt index c0361f5..b21d29b 100644 --- a/doc/files/getmouse.txt +++ b/doc/files/getmouse.txt @@ -1,6 +1,7 @@ #title GetMouse [RCBasic Doc] -#header sub GetMouse(byref x, byref y, byref mb1, byref mb2, byref mb3) +#header Sub GetMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3) Gets the mouse position and button state local to the graphics window #ref GetGlobalMouse MouseX MouseY MouseButton + diff --git a/doc/files/getmousewheel.txt b/doc/files/getmousewheel.txt index 5845da7..c3652b3 100644 --- a/doc/files/getmousewheel.txt +++ b/doc/files/getmousewheel.txt @@ -1,6 +1,7 @@ #title GetMouseWheel [RCBasic Doc] -#header sub GetMouseWheel(byref x_axis, byref y_axis) +#header Sub GetMouseWheel(ByRef x_axis, ByRef y_axis) Gets the axis positions of the mouse wheel #ref GetMouse GetGlobalMouse + diff --git a/doc/files/getmultitouch.txt b/doc/files/getmultitouch.txt index 5347b6a..a90c292 100644 --- a/doc/files/getmultitouch.txt +++ b/doc/files/getmultitouch.txt @@ -1,4 +1,5 @@ #title GetMultiTouch [RCBasic Doc] -#header sub GetMultiTouch(byref status, byref x, byref y, byref fingers, byref dist, byref theta) +#header Sub GetMultiTouch(ByRef status, ByRef x, ByRef y, ByRef fingers, ByRef dist, ByRef theta) Gets the status, position, number of fingers, distance between the fingers and rotation of a multi-finger gesture + diff --git a/doc/files/getmusicposition.txt b/doc/files/getmusicposition.txt index 38c7b7b..39fb1f4 100644 --- a/doc/files/getmusicposition.txt +++ b/doc/files/getmusicposition.txt @@ -1,6 +1,7 @@ #title GetMusicPosition [RCBasic Doc] -#header function GetMusicPosition() +#header Function GetMusicPosition() Returns the position of the music track #ref SetMusicPosition + diff --git a/doc/files/getmusicvolume.txt b/doc/files/getmusicvolume.txt index ec82d6e..db1de6c 100644 --- a/doc/files/getmusicvolume.txt +++ b/doc/files/getmusicvolume.txt @@ -1,4 +1,5 @@ #title GetMusicVolume [RCBasic Doc] -#header function GetMusicVolume() +#header Function GetMusicVolume() Returns the music track's volume + diff --git a/doc/files/getnuman8scenes.txt b/doc/files/getnuman8scenes.txt index bf95065..978ab38 100644 --- a/doc/files/getnuman8scenes.txt +++ b/doc/files/getnuman8scenes.txt @@ -4,3 +4,4 @@ Returns the number of scenes in an an8 project #ref LoadAN8 + diff --git a/doc/files/getparticlebox.txt b/doc/files/getparticlebox.txt index e72a599..8099612 100644 --- a/doc/files/getparticlebox.txt +++ b/doc/files/getparticlebox.txt @@ -1,5 +1,6 @@ -#title getParticleBox [RCBasic Doc] -#header sub getParticleBox( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z) +#title GetParticleBox [RCBasic Doc] +#header Sub GetParticleBox( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z) Gets the bounding box for a particle emitter + diff --git a/doc/files/getparticlecenter.txt b/doc/files/getparticlecenter.txt index 4f9e9d8..8770d84 100644 --- a/doc/files/getparticlecenter.txt +++ b/doc/files/getparticlecenter.txt @@ -1,8 +1,9 @@ -#title getParticleCenter [RCBasic Doc] -#header sub getParticleCenter( actor, ByRef x, ByRef y, ByRef z) +#title GetParticleCenter [RCBasic Doc] +#header Sub GetParticleCenter( actor, ByRef x, ByRef y, ByRef z) Gets the center of a particle emitter Note: applies to Sphere, Cylinder, and Ring emitters #ref SetParticleCenter + diff --git a/doc/files/getparticledirection.txt b/doc/files/getparticledirection.txt index bfda3c8..d45d238 100644 --- a/doc/files/getparticledirection.txt +++ b/doc/files/getparticledirection.txt @@ -1,6 +1,7 @@ -#title getParticleDirection [RCBasic Doc] -#header sub getParticleDirection( actor, ByRef x, ByRef y, ByRef z) +#title GetParticleDirection [RCBasic Doc] +#header Sub GetParticleDirection( actor, ByRef x, ByRef y, ByRef z) Gets the direction of a particle emitter #ref SetParticleDirection + diff --git a/doc/files/getparticlelength.txt b/doc/files/getparticlelength.txt index 9d8a82d..a56af49 100644 --- a/doc/files/getparticlelength.txt +++ b/doc/files/getparticlelength.txt @@ -1,8 +1,9 @@ -#title getParticleLength [RCBasic Doc] -#header function getParticleLength( actor) +#title GetParticleLength [RCBasic Doc] +#header Function GetParticleLength( actor) Returns the length of a cylinder particle emitter Note: Only applies to cylinder particles #ref SetParticleLength + diff --git a/doc/files/getparticlemaxangle.txt b/doc/files/getparticlemaxangle.txt index d252a8e..2e2ebe6 100644 --- a/doc/files/getparticlemaxangle.txt +++ b/doc/files/getparticlemaxangle.txt @@ -1,6 +1,7 @@ -#title getParticleMaxAngle [RCBasic Doc] -#header function getParticleMaxAngle( actor) +#title GetParticleMaxAngle [RCBasic Doc] +#header Function GetParticleMaxAngle( actor) Returns the max angle of particle emission #ref SetParticleMaxAngle + diff --git a/doc/files/getparticlemaxlife.txt b/doc/files/getparticlemaxlife.txt index dc6c069..65cb545 100644 --- a/doc/files/getparticlemaxlife.txt +++ b/doc/files/getparticlemaxlife.txt @@ -1,8 +1,9 @@ -#title getParticleMaxLife [RCBasic Doc] -#header function getParticleMaxLife( actor) +#title GetParticleMaxLife [RCBasic Doc] +#header Function GetParticleMaxLife( actor) Returns the max life of the particle emission Note: Returned time is in milliseconds #ref SetParticleMaxLife + diff --git a/doc/files/getparticlemaxstartcolor.txt b/doc/files/getparticlemaxstartcolor.txt index 0f66081..f0cd1f2 100644 --- a/doc/files/getparticlemaxstartcolor.txt +++ b/doc/files/getparticlemaxstartcolor.txt @@ -1,6 +1,7 @@ -#title getParticleMaxStartColor [RCBasic Doc] -#header function getParticleMaxStartColor( actor) +#title GetParticleMaxStartColor [RCBasic Doc] +#header Function GetParticleMaxStartColor( actor) Returns max starting color for particles #ref SetParticleMaxStartColor + diff --git a/doc/files/getparticlemaxstartsize.txt b/doc/files/getparticlemaxstartsize.txt index 778bf18..f42a6ef 100644 --- a/doc/files/getparticlemaxstartsize.txt +++ b/doc/files/getparticlemaxstartsize.txt @@ -1,6 +1,7 @@ -#title getParticleMaxStartSize [RCBasic Doc] -#header sub getParticleMaxStartSize( actor, ByRef w, ByRef h) +#title GetParticleMaxStartSize [RCBasic Doc] +#header Sub GetParticleMaxStartSize( actor, ByRef w, ByRef h) Gets the max start size for the particles #ref SetParticleMaxStartSize + diff --git a/doc/files/getparticleminlife.txt b/doc/files/getparticleminlife.txt index f126098..96baabd 100644 --- a/doc/files/getparticleminlife.txt +++ b/doc/files/getparticleminlife.txt @@ -1,8 +1,9 @@ -#title getParticleMinLife [RCBasic Doc] -#header function getParticleMinLife( actor) +#title GetParticleMinLife [RCBasic Doc] +#header Function GetParticleMinLife( actor) Get the min life of particles Note: Returned time is in milliseconds #ref SetParticleMinLife + diff --git a/doc/files/getparticleminstartcolor.txt b/doc/files/getparticleminstartcolor.txt index 01ed65a..8874176 100644 --- a/doc/files/getparticleminstartcolor.txt +++ b/doc/files/getparticleminstartcolor.txt @@ -1,6 +1,7 @@ -#title getParticleMinStartColor [RCBasic Doc] -#header function getParticleMinStartColor( actor) +#title GetParticleMinStartColor [RCBasic Doc] +#header Function GetParticleMinStartColor( actor) Returns the min start color for particles #ref SetParticleMinStartColor + diff --git a/doc/files/getparticleminstartsize.txt b/doc/files/getparticleminstartsize.txt index aae8d9f..a2f00a4 100644 --- a/doc/files/getparticleminstartsize.txt +++ b/doc/files/getparticleminstartsize.txt @@ -1,6 +1,7 @@ -#title getParticleMinStartSize [RCBasic Doc] -#header sub getParticleMinStartSize( actor, ByRef w, ByRef h) +#title GetParticleMinStartSize [RCBasic Doc] +#header Sub GetParticleMinStartSize( actor, ByRef w, ByRef h) Gets the min start size for particle emitter #ref SetParticleMinStartSize + diff --git a/doc/files/getparticlenormal.txt b/doc/files/getparticlenormal.txt index 4e8cb4f..cf1f129 100644 --- a/doc/files/getparticlenormal.txt +++ b/doc/files/getparticlenormal.txt @@ -1,8 +1,9 @@ -#title getParticleNormal [RCBasic Doc] -#header sub getParticleNormal( actor, ByRef x, ByRef y, ByRef z) +#title GetParticleNormal [RCBasic Doc] +#header Sub GetParticleNormal( actor, ByRef x, ByRef y, ByRef z) Gets the normal of a particle emitter Note: Only applies to cylinder particle emitter #ref SetParticleNormal + diff --git a/doc/files/getparticlenormaldirectionmod.txt b/doc/files/getparticlenormaldirectionmod.txt index c26062a..45e963d 100644 --- a/doc/files/getparticlenormaldirectionmod.txt +++ b/doc/files/getparticlenormaldirectionmod.txt @@ -1,8 +1,9 @@ -#title getParticleNormalDirectionMod [RCBasic Doc] -#header function getParticleNormalDirectionMod( actor) +#title GetParticleNormalDirectionMod [RCBasic Doc] +#header Function GetParticleNormalDirectionMod( actor) Returns the normal direction modifier for a particle emitter Note: Only applies to mesh particle emitter #ref SetParticleNormalDirectionMod + diff --git a/doc/files/getparticleradius.txt b/doc/files/getparticleradius.txt index f64d1ff..c98f8be 100644 --- a/doc/files/getparticleradius.txt +++ b/doc/files/getparticleradius.txt @@ -1,8 +1,9 @@ -#title getParticleRadius [RCBasic Doc] -#header function getParticleRadius( actor) +#title GetParticleRadius [RCBasic Doc] +#header Function GetParticleRadius( actor) Returns the radius of a particle emitter Note: Only applies to Sphere, Cylinder, and Ring emitters #ref SetParticleRadius + diff --git a/doc/files/getparticleringthickness.txt b/doc/files/getparticleringthickness.txt index 08d6d54..9af94c6 100644 --- a/doc/files/getparticleringthickness.txt +++ b/doc/files/getparticleringthickness.txt @@ -1,8 +1,9 @@ -#title getParticleRingThickness [RCBasic Doc] -#header function getParticleRingThickness( actor) +#title GetParticleRingThickness [RCBasic Doc] +#header Function GetParticleRingThickness( actor) Returns the thickness of a ring emitter Note: Only applies to ring emitter #ref SetParticleRingThickness + diff --git a/doc/files/getparticletype.txt b/doc/files/getparticletype.txt index e93a373..e669c7d 100644 --- a/doc/files/getparticletype.txt +++ b/doc/files/getparticletype.txt @@ -1,5 +1,5 @@ -#title getParticleType [RCBasic Doc] -#header function getParticleType( actor ) +#title GetParticleType [RCBasic Doc] +#header Function GetParticleType( actor ) Returns the particle type @@ -14,3 +14,4 @@ Possible Particle Types #/list #ref CreateParticleActor + diff --git a/doc/files/getphysics3d.txt b/doc/files/getphysics3d.txt new file mode 100644 index 0000000..f6ae363 --- /dev/null +++ b/doc/files/getphysics3d.txt @@ -0,0 +1,9 @@ +#title GetPhysics3D [RCBasic Doc] +#header Function GetPhysics3D( ) + +Return if the physics engine is enabled + +NOTE: While the physics engine is disabled, actor collisions won't be able to be checked. + +#ref SetPhysics3D + diff --git a/doc/files/getpixel.txt b/doc/files/getpixel.txt index 04537fe..a674c7c 100644 --- a/doc/files/getpixel.txt +++ b/doc/files/getpixel.txt @@ -1,4 +1,5 @@ #title GetPixel [RCBasic Doc] -#header function GetPixel(x,y) +#header Function GetPixel(x,y) Returns the color of a pixel + diff --git a/doc/files/getpointpivota.txt b/doc/files/getpointpivota.txt index 33f0bae..de0eeb7 100644 --- a/doc/files/getpointpivota.txt +++ b/doc/files/getpointpivota.txt @@ -1,6 +1,7 @@ -#title getPointPivotA [RCBasic Doc] -#header sub getPointPivotA( constraint_id, ByRef x, ByRef y, ByRef z) +#title GetPointPivotA [RCBasic Doc] +#header Sub GetPointPivotA( constraint_id, ByRef x, ByRef y, ByRef z) Gets the pivot point on the first actor (Body A) of the constraint. This pivot point defines the specific location in the local space of Body A where the point-to-point constraint is anchored. #ref GetPointPivotB SetPointPivotA + diff --git a/doc/files/getpointpivotb.txt b/doc/files/getpointpivotb.txt index 1d82a00..2ac63eb 100644 --- a/doc/files/getpointpivotb.txt +++ b/doc/files/getpointpivotb.txt @@ -1,7 +1,8 @@ -#title getPointPivotB [RCBasic Doc] -#header sub getPointtPivotB( constraint_id, ByRef x, ByRef y, ByRef z) +#title GetPointPivotB [RCBasic Doc] +#header Sub GetPointtPivotB( constraint_id, ByRef x, ByRef y, ByRef z) Gets the pivot point on the first actor (Body B) of the constraint. This pivot point defines the specific location in the local space of Body B where the point-to-point constraint is anchored. #ref GetPointPivotA SetPointPivotB + diff --git a/doc/files/getposteffectproperty.txt b/doc/files/getposteffectproperty.txt new file mode 100644 index 0000000..cf14978 --- /dev/null +++ b/doc/files/getposteffectproperty.txt @@ -0,0 +1,5 @@ +#title GetPostEffectProperty [RCBasic Doc] +#header Function GetPostEffectProperty( c_num, property) + +Returns the value of the property on the current canvas post effect. + diff --git a/doc/files/getposteffecttype.txt b/doc/files/getposteffecttype.txt new file mode 100644 index 0000000..e6b4a53 --- /dev/null +++ b/doc/files/getposteffecttype.txt @@ -0,0 +1,16 @@ +#title GetPostEffectType [RCBasic Doc] +#header Function GetPostEffectType( c_num ) + +Returns the type of post effect set on the given canvas. + +Possible Effect Types +#list ul +#li POST_EFFECT_TYPE_BLOOM +#li POST_EFFECT_TYPE_BLUR +#li POST_EFFECT_TYPE_MOTION_BLUR +#li POST_EFFECT_TYPE_RADIAL_BLUR +#li POST_EFFECT_TYPE_COLORIZE +#li POST_EFFECT_TYPE_INVERT +#li POST_EFFECT_TYPE_MINERAL +#/list + diff --git a/doc/files/getpowerinfo.txt b/doc/files/getpowerinfo.txt index 015951e..477e3a5 100644 --- a/doc/files/getpowerinfo.txt +++ b/doc/files/getpowerinfo.txt @@ -15,3 +15,4 @@ Possible Statuses #li POWERSTATE_CHARGING #li POWERSTATE_CHARGED #/list + diff --git a/doc/files/getprojectionmatrix.txt b/doc/files/getprojectionmatrix.txt index 52703a6..d616f80 100644 --- a/doc/files/getprojectionmatrix.txt +++ b/doc/files/getprojectionmatrix.txt @@ -10,3 +10,4 @@ Possible values for projection_type #/list #ref SetProjectionMatrix + diff --git a/doc/files/getprojectoreffectactor.txt b/doc/files/getprojectoreffectactor.txt new file mode 100644 index 0000000..59499f1 --- /dev/null +++ b/doc/files/getprojectoreffectactor.txt @@ -0,0 +1,9 @@ +#title GetProjectorEffectActor [RCBasic Doc] +#header Function GetProjectorEffectActor(actor, tgt_index) + +Returns the effect actor at tgt_index in a projector + +Refer to the included Projector Demo for an example + +#ref AddProjectorEffectActor + diff --git a/doc/files/getprojectoreffectactorcount.txt b/doc/files/getprojectoreffectactorcount.txt new file mode 100644 index 0000000..ee668fe --- /dev/null +++ b/doc/files/getprojectoreffectactorcount.txt @@ -0,0 +1,5 @@ +#title GetProjectorEffectActorCount [RCBasic Doc] +#header Function GetProjectorEffectActorCount(actor) + +Returns the number of effect actors on a projector + diff --git a/doc/files/getprojectorfov.txt b/doc/files/getprojectorfov.txt index 6504fd2..72ddd4b 100644 --- a/doc/files/getprojectorfov.txt +++ b/doc/files/getprojectorfov.txt @@ -4,3 +4,4 @@ Returns the field of view for a projector #ref SetProjectorFOV + diff --git a/doc/files/getprojectortarget.txt b/doc/files/getprojectortarget.txt index 2b265fb..cf53bb8 100644 --- a/doc/files/getprojectortarget.txt +++ b/doc/files/getprojectortarget.txt @@ -4,3 +4,4 @@ Get the point a projector is looking at #ref SetProjectorTarget + diff --git a/doc/files/getprojectortexture.txt b/doc/files/getprojectortexture.txt new file mode 100644 index 0000000..8e507ea --- /dev/null +++ b/doc/files/getprojectortexture.txt @@ -0,0 +1,7 @@ +#title GetProjectorTexture [RCBasic Doc] +#header Function GetProjectorTexture(actor) + +Returns the image currently being projected by the projector + +#ref SetProjectorTexture + diff --git a/doc/files/getrayhit2d.txt b/doc/files/getrayhit2d.txt index 19fae36..2194436 100644 --- a/doc/files/getrayhit2d.txt +++ b/doc/files/getrayhit2d.txt @@ -1,5 +1,5 @@ #title GetRayHit2D [RCBasic Doc] -#header sub GetRayHit2D( index, ByRef spr_id, ByRef x, ByRef y, ByRef normal_x, ByRef normal_y ) +#header Sub GetRayHit2D( index, ByRef spr_id, ByRef x, ByRef y, ByRef normal_x, ByRef normal_y ) This function will get the collision point and the normal of a ray hit. @@ -10,3 +10,4 @@ NOTES: #/list #ref GetRayHit3D CastRay3D CastRay3D_All CastRay2D CastRay2D_All + diff --git a/doc/files/getrayhit3d.txt b/doc/files/getrayhit3d.txt index 74fc46e..0f60f5c 100644 --- a/doc/files/getrayhit3d.txt +++ b/doc/files/getrayhit3d.txt @@ -1,5 +1,5 @@ #title GetRayHit3D [RCBasic Doc] -#header sub GetRayHit3D( index, ByRef actor_id, ByRef x, ByRef y, ByRef z, ByRef normal_x, ByRef normal_y, ByRef normal_z ) +#header Sub GetRayHit3D( index, ByRef actor_id, ByRef x, ByRef y, ByRef z, ByRef normal_x, ByRef normal_y, ByRef normal_z ) This function will get the collision point and the normal of a ray hit. @@ -10,3 +10,4 @@ NOTES: #/list #ref CastRay3D CastRay3D_All CastRay2D CastRay2D_All GetRayHit2D + diff --git a/doc/files/getrotationtotarget.txt b/doc/files/getrotationtotarget.txt new file mode 100644 index 0000000..49b663c --- /dev/null +++ b/doc/files/getrotationtotarget.txt @@ -0,0 +1,5 @@ +#title GetRotationToTarget [RCBasic Doc] +#header Sub GetRotationToTarget(x, y, z, tgt_x, tgt_y, tgt_z, ByRef rx, ByRef ry, ByRef rz) + +Gets a rotation vector to a target from an origin point + diff --git a/doc/files/getsceneambientcolor.txt b/doc/files/getsceneambientcolor.txt index 590d5cc..611c6f5 100644 --- a/doc/files/getsceneambientcolor.txt +++ b/doc/files/getsceneambientcolor.txt @@ -4,3 +4,4 @@ Returns the ambient light color of the scene #ref SetSceneAmbientColor + diff --git a/doc/files/getscenefog.txt b/doc/files/getscenefog.txt index cf2897d..1bf394f 100644 --- a/doc/files/getscenefog.txt +++ b/doc/files/getscenefog.txt @@ -2,3 +2,4 @@ #header Sub GetSceneFog (ByRef color, ByRef fog_type, ByRef start_val, ByRef end_val, ByRef density, ByRef pixelFog, ByRef rangeFog) + diff --git a/doc/files/getsceneshadowcolor.txt b/doc/files/getsceneshadowcolor.txt index d7bfbf0..af131d7 100644 --- a/doc/files/getsceneshadowcolor.txt +++ b/doc/files/getsceneshadowcolor.txt @@ -4,3 +4,4 @@ Returns the shadow color of the scene #ref SetSceneShadowColor + diff --git a/doc/files/getslideanchora.txt b/doc/files/getslideanchora.txt index 26eee73..9479cd8 100644 --- a/doc/files/getslideanchora.txt +++ b/doc/files/getslideanchora.txt @@ -1,6 +1,7 @@ #title GetSlideAnchorA [RCBasic Doc] -#header sub GetSlideAnchorA( constraint_id, ByRef x, ByRef y, ByRef z) +#header Sub GetSlideAnchorA( constraint_id, ByRef x, ByRef y, ByRef z) Gets the anchor point of the first actor in world space, where the slider constraint is acting on the actor. This point represents the location of the slider's reference frame on body A in the global coordinate system. #ref GetSlideAnchorB + diff --git a/doc/files/getslideanchorb.txt b/doc/files/getslideanchorb.txt index a89932e..b1bbddc 100644 --- a/doc/files/getslideanchorb.txt +++ b/doc/files/getslideanchorb.txt @@ -1,7 +1,8 @@ #title GetSlideAnchorB [RCBasic Doc] -#header sub GetSlideAnchorB( constraint_id, ByRef x, ByRef y, ByRef z) +#header Sub GetSlideAnchorB( constraint_id, ByRef x, ByRef y, ByRef z) Gets the anchor point of the first actor in world space, where the slider constraint is acting on the actor. This point represents the location of the slider's reference frame on body B in the global coordinate system. #ref GetSlideAnchorA + diff --git a/doc/files/getslideangdepth.txt b/doc/files/getslideangdepth.txt index 004427f..d4e8728 100644 --- a/doc/files/getslideangdepth.txt +++ b/doc/files/getslideangdepth.txt @@ -1,4 +1,5 @@ #title GetSlideAngDepth [RCBasic Doc] -#header function GetSlideAngDepth( constraint_id) +#header Function GetSlideAngDepth( constraint_id) Gets the angular depth or the angular deviation from the expected orientation of the two actors (or one actor and the world) constrained by the slider. This "angular depth" refers to how much the actors are misaligned rotationally relative to the constraint’s expected or allowed configuration. + diff --git a/doc/files/getslideangularpos.txt b/doc/files/getslideangularpos.txt index 29a8140..0866000 100644 --- a/doc/files/getslideangularpos.txt +++ b/doc/files/getslideangularpos.txt @@ -1,4 +1,5 @@ -#title getSlideAngularPos [RCBasic Doc] -#header function getSlideAngularPos( constraint_id) +#title GetSlideAngularPos [RCBasic Doc] +#header Function GetSlideAngularPos( constraint_id) Gets the current angular position of an actor relative to the other actor (or the world) around the slider's axis of motion. Specifically, it measures how much an actor has rotated around the axis that is defined for the slider constraint. + diff --git a/doc/files/getslidedampingdirang.txt b/doc/files/getslidedampingdirang.txt index 54f13c8..3655b30 100644 --- a/doc/files/getslidedampingdirang.txt +++ b/doc/files/getslidedampingdirang.txt @@ -1,8 +1,9 @@ -#title getSlideDampingDirAng [RCBasic Doc] -#header function getSlideDampingDirAng( constraint_id) +#title GetSlideDampingDirAng [RCBasic Doc] +#header Function GetSlideDampingDirAng( constraint_id) Returns the angular directional damping value. This damping factor specifically affects angular motion in the direction of movement along the constraint's axes. Note: Only applies to slider constraint #ref SetSlideDampingDirAng + diff --git a/doc/files/getslidedampingdirlin.txt b/doc/files/getslidedampingdirlin.txt index 8092032..e9f15d3 100644 --- a/doc/files/getslidedampingdirlin.txt +++ b/doc/files/getslidedampingdirlin.txt @@ -1,8 +1,9 @@ -#title getSlideDampingDirLin [RCBasic Doc] -#header function getSlideDampingDirLin( constraint_id) +#title GetSlideDampingDirLin [RCBasic Doc] +#header Function GetSlideDampingDirLin( constraint_id) Returns the linear directional damping value for a constraint. This value applies to the linear (translational) motion of an object along the constraint's axis of movement. Note: Only applies to slide constraints #ref SetSlideDampingDirLin + diff --git a/doc/files/getslidedampinglimang.txt b/doc/files/getslidedampinglimang.txt index f839a2b..158521c 100644 --- a/doc/files/getslidedampinglimang.txt +++ b/doc/files/getslidedampinglimang.txt @@ -1,7 +1,8 @@ -#title getSlideDampingLimAng [RCBasic Doc] -#header function getSlideDampingLimAng( constraint_id) +#title GetSlideDampingLimAng [RCBasic Doc] +#header Function GetSlideDampingLimAng( constraint_id) Returns the angular limit damping factor for a constraint. This damping applies specifically to the angular motion of an object when it reaches the limit of its allowed rotational range. #ref SetSlideDampingLimAng + diff --git a/doc/files/getslidedampinglimlin.txt b/doc/files/getslidedampinglimlin.txt index 9dad93d..6f312ab 100644 --- a/doc/files/getslidedampinglimlin.txt +++ b/doc/files/getslidedampinglimlin.txt @@ -1,8 +1,9 @@ -#title getSlideDampingLimLin [RCBasic Doc] -#header function getSlideDampingLimLin( constraint_id) +#title GetSlideDampingLimLin [RCBasic Doc] +#header Function GetSlideDampingLimLin( constraint_id) Returns the linear limit damping factor for a constraint. This damping applies specifically to the linear (translational) motion of an object when it reaches the limit of its allowed range of movement along a specific axis. Note: Only applies to slide constraint #ref SetSlideDampingLimLin + diff --git a/doc/files/getslidedampingorthoang.txt b/doc/files/getslidedampingorthoang.txt index 9bea570..dfc4bb2 100644 --- a/doc/files/getslidedampingorthoang.txt +++ b/doc/files/getslidedampingorthoang.txt @@ -1,6 +1,7 @@ -#title getSlideDampingOrthoAng [RCBasic Doc] -#header function getSlideDampingOrthoAng( constraint_id) +#title GetSlideDampingOrthoAng [RCBasic Doc] +#header Function GetSlideDampingOrthoAng( constraint_id) Returns the orthogonal angular damping factor applied to a constraint. This damping affects angular (rotational) motion that occurs perpendicular to the primary axis of movement defined by the constraint. #ref SetSlideDampingOrthoAng + diff --git a/doc/files/getslidedampingortholin.txt b/doc/files/getslidedampingortholin.txt index c9506cb..1a9e286 100644 --- a/doc/files/getslidedampingortholin.txt +++ b/doc/files/getslidedampingortholin.txt @@ -1,8 +1,9 @@ -#title getSlideDampingOrthoLin [RCBasic Doc] -#header function getSlideDampingOrthoLin( constraint_id) +#title GetSlideDampingOrthoLin [RCBasic Doc] +#header Function GetSlideDampingOrthoLin( constraint_id) Returns the orthogonal linear damping factor for a constraint. This damping affects the linear (translational) motion of an object that occurs perpendicular to the primary direction of movement defined by the constraint. Note: Only applies to slide constraint #ref SetSlideDampingOrthoLin + diff --git a/doc/files/getslidelindepth.txt b/doc/files/getslidelindepth.txt index 7fba322..d89566a 100644 --- a/doc/files/getslidelindepth.txt +++ b/doc/files/getslidelindepth.txt @@ -1,6 +1,7 @@ -#title getSlideLinDepth [RCBasic Doc] -#header function getSlideLinDepth( constraint_id) +#title GetSlideLinDepth [RCBasic Doc] +#header Function GetSlideLinDepth( constraint_id) Returns the linear depth of the slider constraint. This value indicates how much the actors connected by the slider constraint are overlapping or penetrating each other in the linear (translational) direction. The linear depth is a measure of how far the actors are penetrating each other along the linear axis defined by the slider constraint. A positive value indicates that the actors are overlapping, while a value of zero means they are in contact but not penetrating. Negative values typically imply that the actors are separated. + diff --git a/doc/files/getslidelinearpos.txt b/doc/files/getslidelinearpos.txt index f20b0ae..e511fc5 100644 --- a/doc/files/getslidelinearpos.txt +++ b/doc/files/getslidelinearpos.txt @@ -1,6 +1,7 @@ -#title getSlideLinearPos [RCBasic Doc] -#header function getSlideLinearPos( constraint_id) +#title GetSlideLinearPos [RCBasic Doc] +#header Function GetSlideLinearPos( constraint_id) Returns the current linear position of the slider constraint along its defined axis. This position reflects how far the connected actors have moved along the slider's linear axis since the constraint was created or last reset. This value can be positive or negative, depending on the relative positions of the two bodies connected by the slider. + diff --git a/doc/files/getslideloweranglimit.txt b/doc/files/getslideloweranglimit.txt index 5fe004d..aced2b6 100644 --- a/doc/files/getslideloweranglimit.txt +++ b/doc/files/getslideloweranglimit.txt @@ -1,8 +1,9 @@ -#title getSlideLowerAngLimit [RCBasic Doc] -#header function getSlideLowerAngLimit( constraint_id) +#title GetSlideLowerAngLimit [RCBasic Doc] +#header Function GetSlideLowerAngLimit( constraint_id) Returns the lower angular limit of the constraint. This value specifies the minimum angle allowed for the rotation of the connected actors around the axis perpendicular to the sliding direction defined by the slider constraint. The lower angular limit indicates the smallest angle that the actors can rotate about the axis perpendicular to the sliding direction. If the rotation tries to exceed this limit, the physics engine will apply corrective forces to maintain the bodies within the allowed range. #ref GetSlideLowerLinLimit + diff --git a/doc/files/getslidelowerlinlimit.txt b/doc/files/getslidelowerlinlimit.txt index 9a6d38e..3c5fd4b 100644 --- a/doc/files/getslidelowerlinlimit.txt +++ b/doc/files/getslidelowerlinlimit.txt @@ -1,8 +1,9 @@ -#title getSlideLowerLinLimit [RCBasic Doc] -#header function getSlideLowerLinLimit( constraint_id) +#title GetSlideLowerLinLimit [RCBasic Doc] +#header Function GetSlideLowerLinLimit( constraint_id) Returns the lower linear limit for the translational (sliding) motion along the slider's axis. This value specifies the minimum allowable position for the connected actors along the defined axis of the slider constraint. This defines the minimum translation distance along the slider’s axis that the connected actors are allowed to reach. If the actors' relative position along the axis goes below this limit, the constraint will prevent further movement. #ref SetSlideLowerLinLimit + diff --git a/doc/files/getsliderestitutiondirang.txt b/doc/files/getsliderestitutiondirang.txt index c51de77..1232375 100644 --- a/doc/files/getsliderestitutiondirang.txt +++ b/doc/files/getsliderestitutiondirang.txt @@ -1,8 +1,9 @@ -#title getSlideRestitutionDirAng [RCBasic Doc] -#header function getSlideRestitutionDirAng( constraint_id) +#title GetSlideRestitutionDirAng [RCBasic Doc] +#header Function GetSlideRestitutionDirAng( constraint_id) Returns the restitution value for angular motion. The restitution coefficient is a measure of how much energy is conserved in a collision or constraint interaction, specifically for angular movements. When actors collide or interact, their angular momentum and position can change, and the restitution value governs how much of that energy is retained after the interaction. #ref SetSlideRestitutionDirAng + diff --git a/doc/files/getsliderestitutiondirlin.txt b/doc/files/getsliderestitutiondirlin.txt index de1e80b..7adf747 100644 --- a/doc/files/getsliderestitutiondirlin.txt +++ b/doc/files/getsliderestitutiondirlin.txt @@ -1,8 +1,9 @@ -#title getSlideRestitutionDirLin [RCBasic Doc] -#header function getSlideRestitutionDirLin( constraint_id) +#title GetSlideRestitutionDirLin [RCBasic Doc] +#header Function GetSlideRestitutionDirLin( constraint_id) Returns the restitution value for linear motion. This value determines how much energy is conserved in a collision or interaction involving linear movements of the connected actors. When the actors collide or interact, the restitution value dictates how much of their energy is retained after the interaction. #ref SetSlideRestitutionDirLin + diff --git a/doc/files/getsliderestitutionlimang.txt b/doc/files/getsliderestitutionlimang.txt index 6c3e28a..4d0357c 100644 --- a/doc/files/getsliderestitutionlimang.txt +++ b/doc/files/getsliderestitutionlimang.txt @@ -1,8 +1,9 @@ -#title getSlideRestitutionLimAng [RCBasic Doc] -#header function getSlideRestitutionLimAng( constraint_id) +#title GetSlideRestitutionLimAng [RCBasic Doc] +#header Function GetSlideRestitutionLimAng( constraint_id) Returns the restitution value for angular limit. This value determines how much energy is conserved when the angular motion of the connected actors reaches the angular limits of the slider constraint. Essentially, it controls how "bouncy" the rotation is when it hits the angular limit of the constraint. A value of 0.0 means no bounce (perfectly inelastic), while a value of 1.0 allows maximum bounce (perfectly elastic). #ref SetSlideRestitutionLimAng + diff --git a/doc/files/getsliderestitutionlimlin.txt b/doc/files/getsliderestitutionlimlin.txt index 71bedcc..2d3d060 100644 --- a/doc/files/getsliderestitutionlimlin.txt +++ b/doc/files/getsliderestitutionlimlin.txt @@ -1,8 +1,9 @@ -#title getSlideRestitutionLimLin [RCBasic Doc] -#header function getSlideRestitutionLimLin( constraint_id) +#title GetSlideRestitutionLimLin [RCBasic Doc] +#header Function GetSlideRestitutionLimLin( constraint_id) Returns the restitution value for the linear limit of the constraint. This value controls how much energy is conserved (or how "bouncy" the interaction is) when the connected actors reach the linear limits of the slider constraint, which restricts the movement along the sliding axis. Restitution is a measure of how much energy is retained after a collision or interaction. In this context, when the linear movement reaches the limits, restitution controls how much the actors "bounce" back. A restitution value of 0.0 means no bounce (the collision is perfectly inelastic), and 1.0 allows maximum bounce (the collision is perfectly elastic). #ref SetSlideRestitutionLimLin + diff --git a/doc/files/getsliderestitutionorthoang.txt b/doc/files/getsliderestitutionorthoang.txt index f10828c..c24d4c4 100644 --- a/doc/files/getsliderestitutionorthoang.txt +++ b/doc/files/getsliderestitutionorthoang.txt @@ -1,5 +1,5 @@ -#title getSlideRestitutionOrthoAng [RCBasic Doc] -#header function getSlideRestitutionOrthoAng( constraint_id) +#title GetSlideRestitutionOrthoAng [RCBasic Doc] +#header Function GetSlideRestitutionOrthoAng( constraint_id) Returns the restitution value for orthogonal angular motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when rotational movement occurs in a direction orthogonal (perpendicular) to the slider's primary axis of movement. @@ -8,3 +8,4 @@ Orthogonal Angular Motion: In the context of a slider constraint, orthogonal ang Restitution: Restitution is a measure of how much energy is retained in a collision or interaction. A restitution value of 0.0 means no bounce (inelastic collision), and 1.0 means maximum bounce (elastic collision). For orthogonal angular motion, this describes how much bounce occurs after the rotational motion hits the constraints or limits in a perpendicular direction to the slider axis. #ref SetSlideRestitutionOrthoAng + diff --git a/doc/files/getsliderestitutionortholin.txt b/doc/files/getsliderestitutionortholin.txt index 5f04fc6..bd282e3 100644 --- a/doc/files/getsliderestitutionortholin.txt +++ b/doc/files/getsliderestitutionortholin.txt @@ -1,5 +1,5 @@ -#title getSlideRestitutionOrthoLin [RCBasic Doc] -#header function getSlideRestitutionOrthoLin( constraint_id) +#title GetSlideRestitutionOrthoLin [RCBasic Doc] +#header Function GetSlideRestitutionOrthoLin( constraint_id) Returns the restitution value for orthogonal linear motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when linear motion occurs in a direction orthogonal (perpendicular) to the primary sliding axis of the constraint. @@ -8,3 +8,4 @@ Orthogonal Linear Motion: In the context of a slider constraint, orthogonal line Restitution: Restitution is a measure of how much energy is retained or conserved during a collision or interaction. A restitution value of 0.0 indicates no bounce (perfectly inelastic), while 1.0 indicates maximum bounce (perfectly elastic). For orthogonal linear motion, this value describes how much the actors bounce or retain energy when they hit limits or experience movement perpendicular to the slider’s main axis. #ref SetSlideRestitutionOrthoLin + diff --git a/doc/files/getslidesoftnessdirang.txt b/doc/files/getslidesoftnessdirang.txt index 13fc4aa..41a7f4e 100644 --- a/doc/files/getslidesoftnessdirang.txt +++ b/doc/files/getslidesoftnessdirang.txt @@ -1,7 +1,8 @@ -#title getSlideSoftnessDirAng [RCBasic Doc] -#header function getSlideSoftnessDirAng( constraint_id) +#title GetSlideSoftnessDirAng [RCBasic Doc] +#header Function GetSlideSoftnessDirAng( constraint_id) Returns the softness parameter for the angular motion of the constraint. This parameter is used to define how "soft" or "rigid" the limits of angular motion are, particularly when the angular limits are reached. The softness parameter defines how smoothly the constraint responds to limit violations. A higher softness value allows for more gradual movements when limits are approached, while a lower value creates a more rigid response. Softness is particularly useful in simulations to avoid harsh impacts or stiff movements when limits are reached. + diff --git a/doc/files/getslidesoftnessdirlin.txt b/doc/files/getslidesoftnessdirlin.txt index 0e2d685..8f10a61 100644 --- a/doc/files/getslidesoftnessdirlin.txt +++ b/doc/files/getslidesoftnessdirlin.txt @@ -1,6 +1,7 @@ -#title getSlideSoftnessDirLin [RCBasic Doc] -#header function getSlideSoftnessDirLin( constraint_id) +#title GetSlideSoftnessDirLin [RCBasic Doc] +#header Function GetSlideSoftnessDirLin( constraint_id) Returns the softness parameter for the linear motion of the constraint. This parameter influences how the constraint responds when the linear limits of movement are reached along the sliding axis, determining whether the response is soft and gradual or more rigid. In the context of constraints, softness defines how "compliant" or "stiff" the constraint behaves when the limits are approached. A higher softness value makes the constraint respond more softly and gradually as the limit is approached, while a lower value makes the response stiffer and more rigid. + diff --git a/doc/files/getslidesoftnesslimang.txt b/doc/files/getslidesoftnesslimang.txt index 0f7f6bc..50b7571 100644 --- a/doc/files/getslidesoftnesslimang.txt +++ b/doc/files/getslidesoftnesslimang.txt @@ -1,6 +1,7 @@ -#title getSlideSoftnessLimAng [RCBasic Doc] -#header function getSlideSoftnessLimAng( constraint_id) +#title GetSlideSoftnessLimAng [RCBasic Doc] +#header Function GetSlideSoftnessLimAng( constraint_id) Returns the softness parameter for the angular limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors reach their angular rotational limits around the slider's axis of rotation. The softness parameter defines how compliant or stiff the constraint behaves when the motion approaches a limit. A higher softness makes the constraint more flexible, allowing for smoother motion near the limit. A lower softness makes the limit response more rigid and immediate. + diff --git a/doc/files/getslidesoftnesslimlin.txt b/doc/files/getslidesoftnesslimlin.txt index f4c4311..4ec0de6 100644 --- a/doc/files/getslidesoftnesslimlin.txt +++ b/doc/files/getslidesoftnesslimlin.txt @@ -1,6 +1,7 @@ -#title getSlideSoftnessLimLin [RCBasic Doc] -#header function getSlideSoftnessLimLin( constraint_id) +#title GetSlideSoftnessLimLin [RCBasic Doc] +#header Function GetSlideSoftnessLimLin( constraint_id) Returns the softness parameter for the linear limits of the constraint. This parameter influences how "soft" or "rigid" the constraint behaves when the connected actors reach their linear (sliding) limits along the constraint's axis of motion. The softness parameter defines how compliant or stiff the constraint behaves when limits are approached. A higher softness value allows for a more gradual and flexible response as the limit is reached, while a lower softness value results in a stiffer and more rigid response. + diff --git a/doc/files/getslidesoftnessorthoang.txt b/doc/files/getslidesoftnessorthoang.txt index 5b05e05..2da6e86 100644 --- a/doc/files/getslidesoftnessorthoang.txt +++ b/doc/files/getslidesoftnessorthoang.txt @@ -1,6 +1,7 @@ -#title getSlideSoftnessOrthoAng [RCBasic Doc] -#header function getSlideSoftnessOrthoAng( constraint_id) +#title GetSlideSoftnessOrthoAng [RCBasic Doc] +#header Function GetSlideSoftnessOrthoAng( constraint_id) Returns the softness parameter for the orthogonal angular limits of the constraint. This parameter controls how "soft" or "rigid" the constraint behaves when angular rotation is limited along directions orthogonal (perpendicular) to the primary axis of motion. The softness parameter defines how compliant (soft) or stiff (rigid) the constraint behaves when the bodies approach their angular or linear limits. A higher softness value makes the limit more flexible, allowing for gradual motion, while a lower value makes the limit more rigid and restrictive. + diff --git a/doc/files/getslidesoftnessortholin.txt b/doc/files/getslidesoftnessortholin.txt index b6ea51a..b0a35a6 100644 --- a/doc/files/getslidesoftnessortholin.txt +++ b/doc/files/getslidesoftnessortholin.txt @@ -1,6 +1,7 @@ -#title getSlideSoftnessOrthoLin [RCBasic Doc] -#header function getSlideSoftnessOrthoLin( constraint_id) +#title GetSlideSoftnessOrthoLin [RCBasic Doc] +#header Function GetSlideSoftnessOrthoLin( constraint_id) Returns the softness parameter for the orthogonal linear limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors approach their linear movement limits in directions that are orthogonal (perpendicular) to the primary sliding axis. The softness parameter determines how rigid or compliant the constraint is when the actors approach their movement limits. A higher softness value allows for smoother, more flexible movement near the limit, while a lower value results in a more rigid, immediate response. + diff --git a/doc/files/getslidesolveanglimit.txt b/doc/files/getslidesolveanglimit.txt index 6e5a1b9..27108de 100644 --- a/doc/files/getslidesolveanglimit.txt +++ b/doc/files/getslidesolveanglimit.txt @@ -1,4 +1,5 @@ -#title getSlideSolveAngLimit [RCBasic Doc] -#header function getSlideSolveAngLimit( constraint_id) +#title GetSlideSolveAngLimit [RCBasic Doc] +#header Function GetSlideSolveAngLimit( constraint_id) Checks whether the angular position of the constraint has reached or exceeded its defined angular limits. It returns a value indicating if the constraint is at or beyond its lower or upper angular limit around the slider’s axis of rotation. + diff --git a/doc/files/getslidesolvelinlimit.txt b/doc/files/getslidesolvelinlimit.txt index 0a5d15f..942c201 100644 --- a/doc/files/getslidesolvelinlimit.txt +++ b/doc/files/getslidesolvelinlimit.txt @@ -1,4 +1,5 @@ -#title getSlideSolveLinLimit [RCBasic Doc] -#header function getSlideSolveLinLimit( constraint_id) +#title GetSlideSolveLinLimit [RCBasic Doc] +#header Function GetSlideSolveLinLimit( constraint_id) Checks whether the linear position of the constraint has reached or exceeded its defined linear limits. It returns a value indicating if the constraint is at or beyond its lower or upper linear limit along the sliding axis. + diff --git a/doc/files/getslideupperanglimit.txt b/doc/files/getslideupperanglimit.txt index 7fec7a9..529f951 100644 --- a/doc/files/getslideupperanglimit.txt +++ b/doc/files/getslideupperanglimit.txt @@ -1,6 +1,7 @@ -#title getSlideUpperAngLimit [RCBasic Doc] -#header function getSlideUpperAngLimit( constraint_id) +#title GetSlideUpperAngLimit [RCBasic Doc] +#header Function GetSlideUpperAngLimit( constraint_id) Returns the upper limit of the angular movement allowed for the constraint. This function is crucial for determining how much rotational freedom is allowed around the axis of rotation defined by the slider constraint. The upper angular limit specifies the maximum allowed rotation around the rotational axis for the slider constraint. If the relative rotation between the two actors exceeds this angle, corrective forces are applied to maintain the constraint and prevent further rotation. + diff --git a/doc/files/getslideupperlinlimit.txt b/doc/files/getslideupperlinlimit.txt index 6585f0b..8769fc9 100644 --- a/doc/files/getslideupperlinlimit.txt +++ b/doc/files/getslideupperlinlimit.txt @@ -1,6 +1,7 @@ -#title getSlideUpperLinLimit [RCBasic Doc] -#header function getSlideUpperLinLimit( constraint_id) +#title GetSlideUpperLinLimit [RCBasic Doc] +#header Function GetSlideUpperLinLimit( constraint_id) Returns the upper limit for linear movement along the constraint's axis. This is a crucial function for controlling how far the connected actors can slide along that axis before the constraint enforces limits. The upper linear limit specifies the maximum distance that the connected actors can move away from each other along the slider's axis. If the relative movement exceeds this limit, the constraint will apply corrective forces to stop further movement. + diff --git a/doc/files/getslideuseframeoffset.txt b/doc/files/getslideuseframeoffset.txt index 0f1469a..e0f01ba 100644 --- a/doc/files/getslideuseframeoffset.txt +++ b/doc/files/getslideuseframeoffset.txt @@ -1,4 +1,5 @@ -#title getSlideUseFrameOffset [RCBasic Doc] -#header function getSlideUseFrameOffset( constraint_id) +#title GetSlideUseFrameOffset [RCBasic Doc] +#header Function GetSlideUseFrameOffset( constraint_id) Returns a boolean value indicating whether the constraint is using frame offsets for its linear and angular limits. + diff --git a/doc/files/getsoundvolume.txt b/doc/files/getsoundvolume.txt index 8f1a716..13285af 100644 --- a/doc/files/getsoundvolume.txt +++ b/doc/files/getsoundvolume.txt @@ -1,4 +1,5 @@ #title GetSoundVolume [RCBasic Doc] -#header function GetSoundVolume(slot) +#header Function GetSoundVolume(slot) Returns the given sounds volume. + diff --git a/doc/files/getspriteaabb.txt b/doc/files/getspriteaabb.txt index 82854ad..5438f10 100644 --- a/doc/files/getspriteaabb.txt +++ b/doc/files/getspriteaabb.txt @@ -1,4 +1,5 @@ #title GetSpriteAABB [RCBasic Doc] -#header sub GetSpriteAABB( spr_id, ByRef x1, ByRef y1, ByRef x2, ByRef y2 ) +#header Sub GetSpriteAABB( spr_id, ByRef x1, ByRef y1, ByRef x2, ByRef y2 ) Returns the axis aligned bounding box for a sprite + diff --git a/doc/files/getspritealpha.txt b/doc/files/getspritealpha.txt index 2e6b718..c11013d 100644 --- a/doc/files/getspritealpha.txt +++ b/doc/files/getspritealpha.txt @@ -2,3 +2,4 @@ #header Function GetSpriteAlpha(sprite) Returns the alpha value of a sprite + diff --git a/doc/files/getspriteangulardamping.txt b/doc/files/getspriteangulardamping.txt index c11cd26..63d1f0c 100644 --- a/doc/files/getspriteangulardamping.txt +++ b/doc/files/getspriteangulardamping.txt @@ -1,6 +1,7 @@ -#title getSpriteAngularDamping [RCBasic Doc] -#header function getSpriteAngularDamping( spr_id) +#title GetSpriteAngularDamping [RCBasic Doc] +#header Function GetSpriteAngularDamping( spr_id) Returns a sprite's angular damping #ref ApplySpriteAngularDamping + diff --git a/doc/files/getspriteangularvelocity.txt b/doc/files/getspriteangularvelocity.txt index 643b107..7065ae7 100644 --- a/doc/files/getspriteangularvelocity.txt +++ b/doc/files/getspriteangularvelocity.txt @@ -1,4 +1,5 @@ -#title getSpriteAngularVelocity [RCBasic Doc] -#header function getSpriteAngularVelocity( spr_id) +#title GetSpriteAngularVelocity [RCBasic Doc] +#header Function GetSpriteAngularVelocity( spr_id) Returns the angular velocity + diff --git a/doc/files/getspriteanimation.txt b/doc/files/getspriteanimation.txt index f1b0da7..384395a 100644 --- a/doc/files/getspriteanimation.txt +++ b/doc/files/getspriteanimation.txt @@ -4,3 +4,4 @@ Returns the current animation set on a sprite #ref SetSpriteAnimation + diff --git a/doc/files/getspriteanimationframe.txt b/doc/files/getspriteanimationframe.txt index 35d0222..7bc743b 100644 --- a/doc/files/getspriteanimationframe.txt +++ b/doc/files/getspriteanimationframe.txt @@ -2,3 +2,4 @@ #header Function GetSpriteAnimationFrame(sprite, animation, anim_frame) Returns the frame index in the image source that is set to anim_frame in a sprite's animation + diff --git a/doc/files/getspriteanimationlength.txt b/doc/files/getspriteanimationlength.txt index 9e1a1c3..a1593c1 100644 --- a/doc/files/getspriteanimationlength.txt +++ b/doc/files/getspriteanimationlength.txt @@ -2,3 +2,4 @@ #header Function GetSpriteAnimationLength(sprite, animation) Returns the number of frames in a sprite animation + diff --git a/doc/files/getspriteanimationsource.txt b/doc/files/getspriteanimationsource.txt new file mode 100644 index 0000000..872614c --- /dev/null +++ b/doc/files/getspriteanimationsource.txt @@ -0,0 +1,5 @@ +#title GetSpriteAnimationSource [RCBasic Doc] +#header Function GetSpriteAnimationSource(sprite, animation) + +Returns the image associated with the given sprite animation. + diff --git a/doc/files/getspriteanimationspeed.txt b/doc/files/getspriteanimationspeed.txt index 9a73237..4812d47 100644 --- a/doc/files/getspriteanimationspeed.txt +++ b/doc/files/getspriteanimationspeed.txt @@ -2,3 +2,4 @@ #header Function GetSpriteAnimationSpeed(sprite, animation) Returns the frames per second of a sprite animation + diff --git a/doc/files/getspriteboxsize.txt b/doc/files/getspriteboxsize.txt index 0e73d47..630ee84 100644 --- a/doc/files/getspriteboxsize.txt +++ b/doc/files/getspriteboxsize.txt @@ -6,3 +6,4 @@ Returns the size of the collision box on a sprite. NOTE: Returns (-1, -1) if the collision shape is not a box #ref SetSpriteBox + diff --git a/doc/files/getspritecanvasantialiasmode.txt b/doc/files/getspritecanvasantialiasmode.txt index 9a3755d..117ada0 100644 --- a/doc/files/getspritecanvasantialiasmode.txt +++ b/doc/files/getspritecanvasantialiasmode.txt @@ -1,5 +1,5 @@ #title GetSpriteCanvasAntiAliasMode [RCBasic Doc] -#header function GetSpriteCanvasAntiAliasMode( c_num ) +#header Function GetSpriteCanvasAntiAliasMode( c_num ) Returns the anti-alias mode for a sprite canvas @@ -15,3 +15,4 @@ Possible modes #/list #ref SetSpriteCanvasAntiAliasMode + diff --git a/doc/files/getspritecanvasbilinearfilter.txt b/doc/files/getspritecanvasbilinearfilter.txt index c27c47e..6fbb025 100644 --- a/doc/files/getspritecanvasbilinearfilter.txt +++ b/doc/files/getspritecanvasbilinearfilter.txt @@ -1,6 +1,7 @@ #title GetSpriteCanvasBilinearFilter [RCBasic Doc] -#header function GetSpriteCanvasBilinearFilter( c_num ) +#header Function GetSpriteCanvasBilinearFilter( c_num ) Returns the bi-linear filter flag for the sprite canvas #ref SetSpriteCanvasBilinearFilter + diff --git a/doc/files/getspritecanvasblendmode.txt b/doc/files/getspritecanvasblendmode.txt index 6043158..a1622e1 100644 --- a/doc/files/getspritecanvasblendmode.txt +++ b/doc/files/getspritecanvasblendmode.txt @@ -1,5 +1,5 @@ #title GetSpriteCanvasBlendMode [RCBasic Doc] -#header function GetSpriteCanvasBlendMode( c_num ) +#header Function GetSpriteCanvasBlendMode( c_num ) Returns the blend mode used to render sprites on the sprite canvas @@ -18,3 +18,4 @@ Possible Blend Modes #/list #ref SetSpriteCanvasBlendMode SetBlendMode + diff --git a/doc/files/getspritecanvasphysics.txt b/doc/files/getspritecanvasphysics.txt index e495d8b..c165edb 100644 --- a/doc/files/getspritecanvasphysics.txt +++ b/doc/files/getspritecanvasphysics.txt @@ -1,8 +1,9 @@ #title GetSpriteCanvasPhysics [RCBasic Doc] -#header function GetSpriteCanvasPhysics( c_num ) +#header Function GetSpriteCanvasPhysics( c_num ) Returns the physics stage of a sprite canvas Return values can be true or false #ref SetCanvasPhysics2D + diff --git a/doc/files/getspritecanvasrenderpriority.txt b/doc/files/getspritecanvasrenderpriority.txt index 08e309d..fd00a91 100644 --- a/doc/files/getspritecanvasrenderpriority.txt +++ b/doc/files/getspritecanvasrenderpriority.txt @@ -1,5 +1,5 @@ #title GetSpriteCanvasRenderPriority [RCBasic Doc] -#header sub GetSpriteCanvasRenderPriority( c_num, ByRef priority, ByRef order ) +#header Sub GetSpriteCanvasRenderPriority( c_num, ByRef priority, ByRef order ) Gets the order sprites are rendered on a sprite canvas. @@ -27,3 +27,4 @@ Possible order values #ref SetSpriteCanvasRenderPriority + diff --git a/doc/files/getspritecenter.txt b/doc/files/getspritecenter.txt index 435fadd..c0f7a0d 100644 --- a/doc/files/getspritecenter.txt +++ b/doc/files/getspritecenter.txt @@ -1,4 +1,5 @@ -#title getSpriteCenter [RCBasic Doc] -#header sub getSpriteCenter( spr_id, ByRef x, ByRef y) +#title GetSpriteCenter [RCBasic Doc] +#header Sub GetSpriteCenter( spr_id, ByRef x, ByRef y) Returns a sprites center of mass + diff --git a/doc/files/getspritechildindex.txt b/doc/files/getspritechildindex.txt new file mode 100644 index 0000000..5d61381 --- /dev/null +++ b/doc/files/getspritechildindex.txt @@ -0,0 +1,7 @@ +#title GetSpriteChildIndex [RCBasic Doc] +#header Function GetSpriteChildIndex(sprite, child_sprite) + +Returns the index a child_sprite is stored at in a parent sprite + +Returns -1 if child_sprite is not a child of sprite + diff --git a/doc/files/getspritecollisionshape.txt b/doc/files/getspritecollisionshape.txt deleted file mode 100644 index b3c3f28..0000000 --- a/doc/files/getspritecollisionshape.txt +++ /dev/null @@ -1,13 +0,0 @@ -#title GetSpriteCollisionShape [RCBasic Doc] -#header Function GetSpriteCollisionShape(spr_id) - -Returns the collision shape of a sprite - -Shape Types: -#list ul -#li SPRITE_SHAPE_NONE -#li SPRITE_SHAPE_BOX -#li SPRITE_SHAPE_POLYGON -#li SPRITE_SHAPE_CIRCLE -#li SPRITE_SHAPE_CHAIN -#/list diff --git a/doc/files/getspritecolormod.txt b/doc/files/getspritecolormod.txt index ddc5f67..50e230d 100644 --- a/doc/files/getspritecolormod.txt +++ b/doc/files/getspritecolormod.txt @@ -2,3 +2,4 @@ #header Function GetSpriteColorMod(sprite) + diff --git a/doc/files/getspritecurrentanimationframe.txt b/doc/files/getspritecurrentanimationframe.txt index ab019af..9dd6375 100644 --- a/doc/files/getspritecurrentanimationframe.txt +++ b/doc/files/getspritecurrentanimationframe.txt @@ -2,3 +2,4 @@ #header Function GetSpriteCurrentAnimationFrame(sprite) Returns the current frame of a sprite's animation + diff --git a/doc/files/getspritedensity.txt b/doc/files/getspritedensity.txt index 6fb67c7..a42294d 100644 --- a/doc/files/getspritedensity.txt +++ b/doc/files/getspritedensity.txt @@ -1,6 +1,7 @@ #title GetSpriteDensity [RCBasic Doc] -#header function GetSpriteDensity( spr_id ) +#header Function GetSpriteDensity( spr_id ) Returns the density of a sprite. Higher density means a heavier sprite. #ref SetSpriteDensity + diff --git a/doc/files/getspriteframe.txt b/doc/files/getspriteframe.txt index 18a3529..befbaba 100644 --- a/doc/files/getspriteframe.txt +++ b/doc/files/getspriteframe.txt @@ -2,3 +2,4 @@ #header Function GetSpriteFrame(sprite) Returns the current frame in a sprite's source that it's on in its animation + diff --git a/doc/files/getspritefriction.txt b/doc/files/getspritefriction.txt index 567f4a1..eb59c42 100644 --- a/doc/files/getspritefriction.txt +++ b/doc/files/getspritefriction.txt @@ -1,7 +1,8 @@ #title GetSpriteFriction [RCBasic Doc] -#header function GetSpriteFriction( spr_id ) +#header Function GetSpriteFriction( spr_id ) Returns a sprite's friction #ref GetSpriteFriction + diff --git a/doc/files/getspritegravityscale.txt b/doc/files/getspritegravityscale.txt index d3c1edb..7b0b992 100644 --- a/doc/files/getspritegravityscale.txt +++ b/doc/files/getspritegravityscale.txt @@ -1,6 +1,7 @@ -#title getSpriteGravityScale [RCBasic Doc] -#header function getSpriteGravityScale( spr_id) +#title GetSpriteGravityScale [RCBasic Doc] +#header Function GetSpriteGravityScale( spr_id) Returns a sprite's gravity scale #ref SetSpriteGravityScale + diff --git a/doc/files/getspriteinertia.txt b/doc/files/getspriteinertia.txt index 5dbc002..ca0c851 100644 --- a/doc/files/getspriteinertia.txt +++ b/doc/files/getspriteinertia.txt @@ -1,4 +1,5 @@ -#title getSpriteInertia [RCBasic Doc] -#header function getSpriteInertia( spr_id) +#title GetSpriteInertia [RCBasic Doc] +#header Function GetSpriteInertia( spr_id) Returns the rotational inertia of the body about the local origin. + diff --git a/doc/files/getspritelineardamping.txt b/doc/files/getspritelineardamping.txt index 2e7d8ff..7b56c7c 100644 --- a/doc/files/getspritelineardamping.txt +++ b/doc/files/getspritelineardamping.txt @@ -1,6 +1,7 @@ -#title getSpriteLinearDamping [RCBasic Doc] -#header function getSpriteLinearDamping( spr_id) +#title GetSpriteLinearDamping [RCBasic Doc] +#header Function GetSpriteLinearDamping( spr_id) Returns a sprite's linear damping value #ref SetSpriteLinearDamping + diff --git a/doc/files/getspritelinearvelocity.txt b/doc/files/getspritelinearvelocity.txt index 6f95fbb..81498de 100644 --- a/doc/files/getspritelinearvelocity.txt +++ b/doc/files/getspritelinearvelocity.txt @@ -1,6 +1,7 @@ -#title getSpriteLinearVelocity [RCBasic Doc] -#header sub getSpriteLinearVelocity( spr_id, ByRef x, ByRef y) +#title GetSpriteLinearVelocity [RCBasic Doc] +#header Sub GetSpriteLinearVelocity( spr_id, ByRef x, ByRef y) Gets the linear velocity of a sprite #ref SetSpriteLinearVelocity + diff --git a/doc/files/getspritelinearvelocityfromlocalpoint.txt b/doc/files/getspritelinearvelocityfromlocalpoint.txt index 1bc626e..72bf550 100644 --- a/doc/files/getspritelinearvelocityfromlocalpoint.txt +++ b/doc/files/getspritelinearvelocityfromlocalpoint.txt @@ -1,4 +1,5 @@ -#title getSpriteLinearVelocityFromLocalPoint [RCBasic Doc] -#header sub getSpriteLinearVelocityFromLocalPoint( spr_id, pX, pY, ByRef x, ByRef y) +#title GetSpriteLinearVelocityFromLocalPoint [RCBasic Doc] +#header Sub GetSpriteLinearVelocityFromLocalPoint( spr_id, pX, pY, ByRef x, ByRef y) Get the world velocity of a local point. + diff --git a/doc/files/getspritelinearvelocityfromworldpoint.txt b/doc/files/getspritelinearvelocityfromworldpoint.txt index df9ba6e..0191187 100644 --- a/doc/files/getspritelinearvelocityfromworldpoint.txt +++ b/doc/files/getspritelinearvelocityfromworldpoint.txt @@ -1,4 +1,5 @@ -#title getSpriteLinearVelocityFromWorldPoint [RCBasic Doc] -#header sub getSpriteLinearVelocityFromWorldPoint( spr_id, wX, wY, ByRef x, ByRef y) +#title GetSpriteLinearVelocityFromWorldPoint [RCBasic Doc] +#header Sub GetSpriteLinearVelocityFromWorldPoint( spr_id, wX, wY, ByRef x, ByRef y) Get the world linear velocity of a world point attached to this body. + diff --git a/doc/files/getspritelocalpoint.txt b/doc/files/getspritelocalpoint.txt index b217c77..662f525 100644 --- a/doc/files/getspritelocalpoint.txt +++ b/doc/files/getspritelocalpoint.txt @@ -1,4 +1,5 @@ -#title getSpriteLocalPoint [RCBasic Doc] -#header sub getSpriteLocalPoint( spr_id, wX, wY, ByRef x, ByRef y) +#title GetSpriteLocalPoint [RCBasic Doc] +#header Sub GetSpriteLocalPoint( spr_id, wX, wY, ByRef x, ByRef y) Gets a local point relative to the body's origin given a world point. + diff --git a/doc/files/getspritelocalvector.txt b/doc/files/getspritelocalvector.txt index f2a4ad3..6856c35 100644 --- a/doc/files/getspritelocalvector.txt +++ b/doc/files/getspritelocalvector.txt @@ -1,4 +1,5 @@ -#title getSpriteLocalVector [RCBasic Doc] -#header sub getSpriteLocalVector( spr_id, wX, wY, ByRef x, ByRef y) +#title GetSpriteLocalVector [RCBasic Doc] +#header Sub GetSpriteLocalVector( spr_id, wX, wY, ByRef x, ByRef y) Gets a local vector given a world vector. + diff --git a/doc/files/getspritemass.txt b/doc/files/getspritemass.txt index 90de127..7c36469 100644 --- a/doc/files/getspritemass.txt +++ b/doc/files/getspritemass.txt @@ -1,4 +1,5 @@ -#title getSpriteMass [RCBasic Doc] -#header function getSpriteMass( spr_id) +#title GetSpriteMass [RCBasic Doc] +#header Function GetSpriteMass( spr_id) Returns the total mass of the body. + diff --git a/doc/files/getspriteposition.txt b/doc/files/getspriteposition.txt index d0063b9..6465c8a 100644 --- a/doc/files/getspriteposition.txt +++ b/doc/files/getspriteposition.txt @@ -68,3 +68,4 @@ Wend
    #ref TranslateSprite SetSpritePosition + diff --git a/doc/files/getspriteradius.txt b/doc/files/getspriteradius.txt index 612b3b5..a61549f 100644 --- a/doc/files/getspriteradius.txt +++ b/doc/files/getspriteradius.txt @@ -6,3 +6,4 @@ Returns the radius of a sprites collision shape NOTE: Returns 0 if collision shape is not SPRITE_SHAPE_CIRCLE #ref SetSpriteRadius + diff --git a/doc/files/getspriterestitution.txt b/doc/files/getspriterestitution.txt index 24abf7e..598f4ab 100644 --- a/doc/files/getspriterestitution.txt +++ b/doc/files/getspriterestitution.txt @@ -1,6 +1,7 @@ #title GetSpriteRestitution [RCBasic Doc] -#header function GetSpriteRestitution( spr_id ) +#header Function GetSpriteRestitution( spr_id ) Returns the restitution coefficient for a sprite #ref SetSpriteRestitution + diff --git a/doc/files/getspriterestitutionthreshold.txt b/doc/files/getspriterestitutionthreshold.txt index a53a583..846915f 100644 --- a/doc/files/getspriterestitutionthreshold.txt +++ b/doc/files/getspriterestitutionthreshold.txt @@ -1,6 +1,7 @@ #title GetSpriteRestitutionThreshold [RCBasic Doc] -#header function GetSpriteRestitutionThreshold( spr_id ) +#header Function GetSpriteRestitutionThreshold( spr_id ) Returns the restitution velocity threshold for a sprite #ref SetSpriteRestitutionThreshold + diff --git a/doc/files/getspriterotation.txt b/doc/files/getspriterotation.txt index 21a2c8a..1fa823e 100644 --- a/doc/files/getspriterotation.txt +++ b/doc/files/getspriterotation.txt @@ -64,3 +64,4 @@ Wend
    #ref SetSpriteRotation RotateSprite + diff --git a/doc/files/getspritescale.txt b/doc/files/getspritescale.txt index 85c6e63..04790a2 100644 --- a/doc/files/getspritescale.txt +++ b/doc/files/getspritescale.txt @@ -74,3 +74,4 @@ Wend
    #ref ScaleSprite SetSpriteScale + diff --git a/doc/files/getspriteshape.txt b/doc/files/getspriteshape.txt index 643cb69..7b8e06d 100644 --- a/doc/files/getspriteshape.txt +++ b/doc/files/getspriteshape.txt @@ -16,3 +16,4 @@ Possible Shapes #/list #ref SetSpriteShape + diff --git a/doc/files/getspriteshapeoffset.txt b/doc/files/getspriteshapeoffset.txt index ddc24dd..87ffea3 100644 --- a/doc/files/getspriteshapeoffset.txt +++ b/doc/files/getspriteshapeoffset.txt @@ -4,3 +4,4 @@ Gets the relative location the sprite shape is from where it is rendered #ref SetSpriteShapeOffset + diff --git a/doc/files/getspritesize.txt b/doc/files/getspritesize.txt index 72f531f..2e5f92f 100644 --- a/doc/files/getspritesize.txt +++ b/doc/files/getspritesize.txt @@ -52,3 +52,4 @@ Wend
    #ref CreateSprite + diff --git a/doc/files/getspritesource.txt b/doc/files/getspritesource.txt index 16bba50..88575f7 100644 --- a/doc/files/getspritesource.txt +++ b/doc/files/getspritesource.txt @@ -41,3 +41,4 @@ Wend #image "images/frowny2.png" #ref SetSpriteSource CreateSprite + diff --git a/doc/files/getspritetype.txt b/doc/files/getspritetype.txt index c037a26..93f4ff7 100644 --- a/doc/files/getspritetype.txt +++ b/doc/files/getspritetype.txt @@ -75,3 +75,4 @@ Wend
    #ref SetSpriteType + diff --git a/doc/files/getspriteworldcenter.txt b/doc/files/getspriteworldcenter.txt new file mode 100644 index 0000000..41f2b91 --- /dev/null +++ b/doc/files/getspriteworldcenter.txt @@ -0,0 +1,5 @@ +#title GetSpriteWorldCenter [RCBasic Doc] +#header Sub GetSpriteWorldCenter( spr_id, ByRef x, ByRef y ) + +Gets the center of a sprite's shape as world coordinates. + diff --git a/doc/files/getspriteworldpoint.txt b/doc/files/getspriteworldpoint.txt index fd55b93..d6e5b17 100644 --- a/doc/files/getspriteworldpoint.txt +++ b/doc/files/getspriteworldpoint.txt @@ -1,4 +1,5 @@ -#title getSpriteWorldPoint [RCBasic Doc] -#header sub getSpriteWorldPoint( spr_id, lX, lY, ByRef x, ByRef y) +#title GetSpriteWorldPoint [RCBasic Doc] +#header Sub GetSpriteWorldPoint( spr_id, lX, lY, ByRef x, ByRef y) Get the world coordinates of a point given the local coordinates. + diff --git a/doc/files/getspriteworldvector.txt b/doc/files/getspriteworldvector.txt index 746f4ff..7ac65ba 100644 --- a/doc/files/getspriteworldvector.txt +++ b/doc/files/getspriteworldvector.txt @@ -1,4 +1,5 @@ -#title getSpriteWorldVector [RCBasic Doc] -#header sub getSpriteWorldVector( spr_id, lX, lY, ByRef x, ByRef y) +#title GetSpriteWorldVector [RCBasic Doc] +#header Sub GetSpriteWorldVector( spr_id, lX, lY, ByRef x, ByRef y) Get the world coordinates of a vector given the local coordinates. + diff --git a/doc/files/getterraincenter.txt b/doc/files/getterraincenter.txt index 8a363cb..958c0ba 100644 --- a/doc/files/getterraincenter.txt +++ b/doc/files/getterraincenter.txt @@ -1,4 +1,5 @@ #title GetTerrainCenter [RCBasic Doc] -#header sub GetTerrainCenter( actor, ByRef x, ByRef y, ByRef z ) +#header Sub GetTerrainCenter( actor, ByRef x, ByRef y, ByRef z ) Gets the center point of a terrain actor + diff --git a/doc/files/getterrainheight.txt b/doc/files/getterrainheight.txt index d33750a..d090531 100644 --- a/doc/files/getterrainheight.txt +++ b/doc/files/getterrainheight.txt @@ -1,4 +1,5 @@ #title GetTerrainHeight [RCBasic Doc] -#header function GetTerrainHeight( actor, patchX, patchZ ) +#header Function GetTerrainHeight( actor, patchX, patchZ ) Returns the height of a terrain patch + diff --git a/doc/files/getterrainpatchaabb.txt b/doc/files/getterrainpatchaabb.txt index 695cb36..ef787f3 100644 --- a/doc/files/getterrainpatchaabb.txt +++ b/doc/files/getterrainpatchaabb.txt @@ -1,4 +1,5 @@ #title GetTerrainPatchAABB [RCBasic Doc] -#header sub GetTerrainPatchAABB( actor, patchX, patchZ, ByRef minX, ByRef minY, ByRef minZ, ByRef maxX, ByRef maxY, ByRef maxZ ) +#header Sub GetTerrainPatchAABB( actor, patchX, patchZ, ByRef minX, ByRef minY, ByRef minZ, ByRef maxX, ByRef maxY, ByRef maxZ ) Returns the bounding box of a terrain patch + diff --git a/doc/files/getterrainpatchlod.txt b/doc/files/getterrainpatchlod.txt index 5b172f5..c739d9b 100644 --- a/doc/files/getterrainpatchlod.txt +++ b/doc/files/getterrainpatchlod.txt @@ -1,4 +1,5 @@ #title GetTerrainPatchLOD [RCBasic Doc] -#header function GetTerrainPatchLOD( actor, patchX, patchZ ) +#header Function GetTerrainPatchLOD( actor, patchX, patchZ ) Returns the current level of detail for a terrain patch + diff --git a/doc/files/gettextheight.txt b/doc/files/gettextheight.txt deleted file mode 100644 index 2dc67ea..0000000 --- a/doc/files/gettextheight.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title GetTextHeight [RCBasic Doc] -#header function GetTextHeight(txt$) - -Returns the height of the text if rendered with the current font diff --git a/doc/files/gettextsize.txt b/doc/files/gettextsize.txt index e37c9d8..5be5ac0 100644 --- a/doc/files/gettextsize.txt +++ b/doc/files/gettextsize.txt @@ -1,4 +1,5 @@ #title GetTextSize [RCBasic Doc] -#header sub GetTextSize(txt$, byref w, byref h) +#header Sub GetTextSize(txt$, ByRef w, ByRef h) Gets the size of the text if rendered with the current font + diff --git a/doc/files/gettextwidth.txt b/doc/files/gettextwidth.txt deleted file mode 100644 index 65ab5da..0000000 --- a/doc/files/gettextwidth.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title GetTextWidth [RCBasic Doc] -#header function GetTextWidth(txt$) - -Returns the width of the text if rendered with the current font diff --git a/doc/files/gettile.txt b/doc/files/gettile.txt index ad29da9..6479ef7 100644 --- a/doc/files/gettile.txt +++ b/doc/files/gettile.txt @@ -4,3 +4,4 @@ Returns the tile at a specified location on a tilemap Note: (x, y) is a tile position, not an actual coordinate on the map + diff --git a/doc/files/gettileanimationframe.txt b/doc/files/gettileanimationframe.txt index 3f13e14..13f58c1 100644 --- a/doc/files/gettileanimationframe.txt +++ b/doc/files/gettileanimationframe.txt @@ -4,3 +4,4 @@ Returns the tile set at a specified frame in a tiles animation #ref SetTileAnimationFrame + diff --git a/doc/files/gettileanimationlength.txt b/doc/files/gettileanimationlength.txt index 46b8653..d1c20f7 100644 --- a/doc/files/gettileanimationlength.txt +++ b/doc/files/gettileanimationlength.txt @@ -4,3 +4,4 @@ Return the number of frames in a tile's animation #ref SetTileAnimationLength + diff --git a/doc/files/gettileanimationspeed.txt b/doc/files/gettileanimationspeed.txt index 89edb24..1d0d771 100644 --- a/doc/files/gettileanimationspeed.txt +++ b/doc/files/gettileanimationspeed.txt @@ -4,3 +4,4 @@ Returns the fps of a tile's animation #ref SetTileAnimationSpeed + diff --git a/doc/files/gettilemapsize.txt b/doc/files/gettilemapsize.txt index 3c7b91d..2891c5e 100644 --- a/doc/files/gettilemapsize.txt +++ b/doc/files/gettilemapsize.txt @@ -4,3 +4,4 @@ Gets the size of a tile map #ref CreateTileMap SetTileMapSize + diff --git a/doc/files/gettouch.txt b/doc/files/gettouch.txt index 72cc13b..01fd708 100644 --- a/doc/files/gettouch.txt +++ b/doc/files/gettouch.txt @@ -1,4 +1,5 @@ #title GetTouch [RCBasic Doc] -#header sub GetTouch(byref status, byref x, byref y, byref dx, byref dy) +#header Sub GetTouch(ByRef status, ByRef x, ByRef y, ByRef dx, ByRef dy) Gets the position and distance of motion of a touch event + diff --git a/doc/files/gettouchfinger.txt b/doc/files/gettouchfinger.txt index 92a2121..77bf989 100644 --- a/doc/files/gettouchfinger.txt +++ b/doc/files/gettouchfinger.txt @@ -1,4 +1,5 @@ #title GetTouchFinger [RCBasic Doc] -#header sub GetTouchFinger(finger, byref x, byref y, byref pressure) +#header Sub GetTouchFinger(finger, ByRef x, ByRef y, ByRef pressure) Gets the position and pressure of a finger on a touch event + diff --git a/doc/files/getvehicleaxis.txt b/doc/files/getvehicleaxis.txt new file mode 100644 index 0000000..50af0fb --- /dev/null +++ b/doc/files/getvehicleaxis.txt @@ -0,0 +1,14 @@ +#title GetVehicleAxis [RCBasic Doc] +#header Sub GetVehicleAxis( actor, ByRef x, ByRef y, ByRef z ) + +Gets the axis used to define a vehicles orientation. + +#table +#row "Direction", "Axis", "Meaning" +#row "X", "Right Axis", "Wheel axle direction" +#row "Y", "Up Axis", "Suspension direction" +#row "Z", "Forward Axis", "Driving direction" +#/table + +#ref SetWheelAxel SetSuspensionLength SetWheelDirection + diff --git a/doc/files/getvehiclechassisworldtransform.txt b/doc/files/getvehiclechassisworldtransform.txt new file mode 100644 index 0000000..d98582e --- /dev/null +++ b/doc/files/getvehiclechassisworldtransform.txt @@ -0,0 +1,5 @@ +#title GetVehicleChassisWorldTransform [RCBasic Doc] +#header Sub GetVehicleChassisWorldTransform( actor, t_matrix ) + +Stores the world transform of the chassis actor in a vehicle + diff --git a/doc/files/getvehiclecurrentspeed.txt b/doc/files/getvehiclecurrentspeed.txt new file mode 100644 index 0000000..10c48c3 --- /dev/null +++ b/doc/files/getvehiclecurrentspeed.txt @@ -0,0 +1,5 @@ +#title GetVehicleCurrentSpeed [RCBasic Doc] +#header Function GetVehicleCurrentSpeed( actor ) + +Returns the current speed set on the vehicle + diff --git a/doc/files/getvehicleforwardvector.txt b/doc/files/getvehicleforwardvector.txt new file mode 100644 index 0000000..b1bc61c --- /dev/null +++ b/doc/files/getvehicleforwardvector.txt @@ -0,0 +1,5 @@ +#title GetVehicleForwardVector [RCBasic Doc] +#header Sub GetVehicleForwardVector( actor, ByRef x, ByRef y, ByRef z ) + +Gets the forward vector of a vehicle + diff --git a/doc/files/getvehiclepitchcontrol.txt b/doc/files/getvehiclepitchcontrol.txt new file mode 100644 index 0000000..f137115 --- /dev/null +++ b/doc/files/getvehiclepitchcontrol.txt @@ -0,0 +1,7 @@ +#title GetVehiclePitchControl [RCBasic Doc] +#header Function GetVehiclePitchControl( actor ) + +Returns the pitch control for a vehicle + +#ref SetVehiclePitchControl + diff --git a/doc/files/getvideodrawrect.txt b/doc/files/getvideodrawrect.txt index 0f7f377..b3d5dde 100644 --- a/doc/files/getvideodrawrect.txt +++ b/doc/files/getvideodrawrect.txt @@ -1,4 +1,5 @@ #title GetVideoDrawRect [RCBasic Doc] -#header sub GetVideoDrawRect(byref x, byref y, byref w, byref h) +#header Sub GetVideoDrawRect(ByRef x, ByRef y, ByRef w, ByRef h) Gets the position and dimensions of the area video playback is shown at. + diff --git a/doc/files/getvideoposition.txt b/doc/files/getvideoposition.txt index d0b6590..f1dc513 100644 --- a/doc/files/getvideoposition.txt +++ b/doc/files/getvideoposition.txt @@ -1,4 +1,5 @@ #title GetVideoPosition [RCBasic Doc] -#header function GetVideoPosition() +#header Function GetVideoPosition() Returns the current position in the video playback. + diff --git a/doc/files/getvideosize.txt b/doc/files/getvideosize.txt index ccf55ac..b81df31 100644 --- a/doc/files/getvideosize.txt +++ b/doc/files/getvideosize.txt @@ -1,4 +1,5 @@ #title GetVideoSize [RCBasic Doc] -#header sub GetVideoSize(byref w, byref h) +#header Sub GetVideoSize(ByRef w, ByRef h) Gets the size of video's frames + diff --git a/doc/files/getvideostats.txt b/doc/files/getvideostats.txt index f0106c9..df238c0 100644 --- a/doc/files/getvideostats.txt +++ b/doc/files/getvideostats.txt @@ -1,6 +1,7 @@ #title GetVideoStats [RCBasic Doc] -#header sub GetVideoStats(vFile$, byref vLen, byref vfps, byref frame_w, byref frame_h) +#header Sub GetVideoStats(vFile$, ByRef vLen, ByRef vfps, ByRef frame_w, ByRef frame_h) Gets video data from a video file. Note: This function is slow and should not be used during time critical sections in your code. + diff --git a/doc/files/getvideovolume.txt b/doc/files/getvideovolume.txt index 1f043e4..394115a 100644 --- a/doc/files/getvideovolume.txt +++ b/doc/files/getvideovolume.txt @@ -1,8 +1,9 @@ #title GetVideoVolume [RCBasic Doc] -#header function GetVideoVolume( ) +#header Function GetVideoVolume( ) Returns the volume of a video Volume can be in a range of 0 to 128 #ref SetVideoVolume + diff --git a/doc/files/getwheelactoroffsettransform.txt b/doc/files/getwheelactoroffsettransform.txt new file mode 100644 index 0000000..f83b837 --- /dev/null +++ b/doc/files/getwheelactoroffsettransform.txt @@ -0,0 +1,11 @@ +#title GetWheelActorOffsetTransform [RCBasic Doc] +#header Sub GetWheelActorOffsetTransform( actor, wheel, t_matrix ) + +Stores the local offset transform for the wheel actor in t_matrix. + +This is mainly for when the actors local transform does not line up with the axis for the vehicle. + +Refer to the Vehicle demo to see an example of this. + +#ref SetWheelActorOffsetTransform + diff --git a/doc/files/getwheelaxel.txt b/doc/files/getwheelaxel.txt new file mode 100644 index 0000000..aabe640 --- /dev/null +++ b/doc/files/getwheelaxel.txt @@ -0,0 +1,7 @@ +#title GetWheelAxel [RCBasic Doc] +#header Sub GetWheelAxel( actor, wheel, ByRef x, ByRef y, ByRef z ) + +Get the axel direction of a wheel on a vehicle + +#ref SetWheelAxel + diff --git a/doc/files/getwheelbrake.txt b/doc/files/getwheelbrake.txt new file mode 100644 index 0000000..ebffe87 --- /dev/null +++ b/doc/files/getwheelbrake.txt @@ -0,0 +1,7 @@ +#title GetWheelBrake [RCBasic Doc] +#header Function GetWheelBrake( actor, wheel ) + +Returns the brake value of a wheel on a vehicle + +#ref SetWheelBrake + diff --git a/doc/files/getwheelconnectionpoint.txt b/doc/files/getwheelconnectionpoint.txt new file mode 100644 index 0000000..68e644d --- /dev/null +++ b/doc/files/getwheelconnectionpoint.txt @@ -0,0 +1,7 @@ +#title GetWheelConnectionPoint [RCBasic Doc] +#header Sub GetWheelConnectionPoint( actor, wheel, ByRef x, ByRef y, ByRef z) + +Gets the point in local space that a wheel is connected to a vehicle at + +#ref SetWheelConnectionPoint + diff --git a/doc/files/getwheelcount.txt b/doc/files/getwheelcount.txt new file mode 100644 index 0000000..c00daee --- /dev/null +++ b/doc/files/getwheelcount.txt @@ -0,0 +1,7 @@ +#title GetWheelCount [RCBasic Doc] +#header Function GetWheelCount( actor ) + +Returns the number of wheels on a vehicle + +#ref AddVehicleWheel + diff --git a/doc/files/getwheeldampingcompression.txt b/doc/files/getwheeldampingcompression.txt new file mode 100644 index 0000000..b78ef6a --- /dev/null +++ b/doc/files/getwheeldampingcompression.txt @@ -0,0 +1,7 @@ +#title GetWheelDampingCompression [RCBasic Doc] +#header Function GetWheelDampingCompression( actor, wheel ) + +Returns the damping compression of a wheel + +#ref GetWheelDampingRelaxation SetWheelDampingCompression + diff --git a/doc/files/getwheeldampingrelaxation.txt b/doc/files/getwheeldampingrelaxation.txt new file mode 100644 index 0000000..b898fde --- /dev/null +++ b/doc/files/getwheeldampingrelaxation.txt @@ -0,0 +1,7 @@ +#title GetWheelDampingRelaxation [RCBasic Doc] +#header Function GetWheelDampingRelaxation( actor, wheel ) + +Returns the damping relaxation of a wheel + +#ref GetWheelDampingCompression SetWheelDampingRelaxation + diff --git a/doc/files/getwheeldirection.txt b/doc/files/getwheeldirection.txt new file mode 100644 index 0000000..e3c5ee3 --- /dev/null +++ b/doc/files/getwheeldirection.txt @@ -0,0 +1,5 @@ +#title GetWheelDirection [RCBasic Doc] +#header Sub GetWheelDirection( actor, wheel, ByRef x, ByRef y, ByRef z ) + +Gets the direction of a wheel on a vehicle + diff --git a/doc/files/getwheelengineforce.txt b/doc/files/getwheelengineforce.txt new file mode 100644 index 0000000..eff802a --- /dev/null +++ b/doc/files/getwheelengineforce.txt @@ -0,0 +1,7 @@ +#title GetWheelEngineForce [RCBasic Doc] +#header Function GetWheelEngineForce( actor, wheel ) + +Returns the engine force currently applied to a wheel + +#ref SetWheelEngineForce + diff --git a/doc/files/getwheelfrictionslip.txt b/doc/files/getwheelfrictionslip.txt new file mode 100644 index 0000000..c05a873 --- /dev/null +++ b/doc/files/getwheelfrictionslip.txt @@ -0,0 +1,7 @@ +#title GetWheelFrictionSlip [RCBasic Doc] +#header Function GetWheelFrictionSlip( actor, wheel ) + +Returns the friction slip of a wheel + +#ref SetWheelFrictionSlip + diff --git a/doc/files/getwheelinversecontactsuspension.txt b/doc/files/getwheelinversecontactsuspension.txt new file mode 100644 index 0000000..a4eb9d7 --- /dev/null +++ b/doc/files/getwheelinversecontactsuspension.txt @@ -0,0 +1,11 @@ +#title GetWheelInverseContactSuspension [RCBasic Doc] +#header Function GetWheelInverseContactSuspension( actor, wheel ) + +Returns the clipped inverse contact dot suspension. + +This value is a stability factor used to adjust suspension force when the ground contact surface is tilted. + +It prevents suspension forces from exploding when the wheel contacts steep surfaces. + +#ref SetWheelInverseContactSuspension + diff --git a/doc/files/getwheelmaxsuspensiontravel.txt b/doc/files/getwheelmaxsuspensiontravel.txt new file mode 100644 index 0000000..ddb1ac0 --- /dev/null +++ b/doc/files/getwheelmaxsuspensiontravel.txt @@ -0,0 +1,9 @@ +#title GetWheelMaxSuspensionTravel [RCBasic Doc] +#header Function GetWheelMaxSuspensionTravel( actor, wheel ) + +Returns the max suspension travel distance. + +This value is the maximum distance the suspension is allowed to extend or compress from its rest length set with SetSuspensionLength(). + +#ref SetWheelMaxSuspension + diff --git a/doc/files/getwheelradius.txt b/doc/files/getwheelradius.txt new file mode 100644 index 0000000..df74593 --- /dev/null +++ b/doc/files/getwheelradius.txt @@ -0,0 +1,7 @@ +#title GetWheelRadius [RCBasic Doc] +#header Function GetWheelRadius( actor, wheel ) + +You will never guess what this returns + +#ref SetWheelRadius + diff --git a/doc/files/getwheelrollinfluence.txt b/doc/files/getwheelrollinfluence.txt new file mode 100644 index 0000000..1310893 --- /dev/null +++ b/doc/files/getwheelrollinfluence.txt @@ -0,0 +1,11 @@ +#title GetWheelRollInfluence [RCBasic Doc] +#header Function GetWheelRollInfluence( actor, wheel ) + +Returns the roll_influence for a wheel. + +Roll influence controls how much a wheel’s suspension force contributes to the vehicle’s body roll (sideways tipping). + +It’s essentially a stability scaling factor. + +#ref SetWheelRollInfluence + diff --git a/doc/files/getwheelrotation.txt b/doc/files/getwheelrotation.txt new file mode 100644 index 0000000..a4ce98d --- /dev/null +++ b/doc/files/getwheelrotation.txt @@ -0,0 +1,7 @@ +#title GetWheelRotation [RCBasic Doc] +#header Function GetWheelRotation( actor, wheel ) + +Returns a wheel's spin rotation. + +#ref SetWheelRotation + diff --git a/doc/files/getwheelrotationdelta.txt b/doc/files/getwheelrotationdelta.txt new file mode 100644 index 0000000..22d5670 --- /dev/null +++ b/doc/files/getwheelrotationdelta.txt @@ -0,0 +1,7 @@ +#title GetWheelRotationDelta [RCBasic Doc] +#header Function GetWheelRotationDelta( actor, wheel ) + +Returns how much the wheels spin angle changed since the last frame. + +#ref SetWheelRotationDelta + diff --git a/doc/files/getwheelsteeringvalue.txt b/doc/files/getwheelsteeringvalue.txt new file mode 100644 index 0000000..f3a66a3 --- /dev/null +++ b/doc/files/getwheelsteeringvalue.txt @@ -0,0 +1,8 @@ +#title GetWheelSteeringValue [RCBasic Doc] +#header Function GetWheelSteeringValue( actor, wheel ) + +Returns the steering value for a wheel + +#ref SetWheelSteeringValue + + diff --git a/doc/files/getwheelsuspensionlength.txt b/doc/files/getwheelsuspensionlength.txt new file mode 100644 index 0000000..38a2f80 --- /dev/null +++ b/doc/files/getwheelsuspensionlength.txt @@ -0,0 +1,7 @@ +#title GetWheelSuspensionLength [RCBasic Doc] +#header Function GetWheelSuspensionLength( actor, wheel ) + +Returns the suspsension rest length of a wheel + +#ref SetWheelSuspensionLength + diff --git a/doc/files/getwheelsuspensionstiffness.txt b/doc/files/getwheelsuspensionstiffness.txt new file mode 100644 index 0000000..9875c38 --- /dev/null +++ b/doc/files/getwheelsuspensionstiffness.txt @@ -0,0 +1,12 @@ +#title GetWheelSuspensionStiffness [RCBasic Doc] +#header Function GetWheelSuspensionStiffness( actor, wheel ) + +Returns the suspension stiffness of a wheel. + +#list ul +#li Higher stiffness - stronger upward force for the same compression +#li Lower stiffness - softer suspension +#/list + +#ref SetWheelSuspensionStiffness + diff --git a/doc/files/getwheelsuspensionvelocity.txt b/doc/files/getwheelsuspensionvelocity.txt new file mode 100644 index 0000000..6445ac2 --- /dev/null +++ b/doc/files/getwheelsuspensionvelocity.txt @@ -0,0 +1,9 @@ +#title GetWheelSuspensionVelocity [RCBasic Doc] +#header Function GetWheelSuspensionVelocity( actor, wheel ) + +Returns the suspension velocity. + +This value is the speed that the suspension compresses or extends at. + +#ref SetWheelSuspensionVelocity + diff --git a/doc/files/getwheelworldtransform.txt b/doc/files/getwheelworldtransform.txt new file mode 100644 index 0000000..ed03170 --- /dev/null +++ b/doc/files/getwheelworldtransform.txt @@ -0,0 +1,9 @@ +#title GetWheelWorldTransform [RCBasic Doc] +#header Sub GetWheelWorldTransform( actor, wheel, t_matrix ) + +Returns the world transform of a wheel on a vehicle. + +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. + +#ref SetWheelWorldTransform + diff --git a/doc/files/getwindowmaxsize.txt b/doc/files/getwindowmaxsize.txt index fe87b92..4f6c3b9 100644 --- a/doc/files/getwindowmaxsize.txt +++ b/doc/files/getwindowmaxsize.txt @@ -1,4 +1,5 @@ #title GetWindowMaxSize [RCBasic Doc] -#header sub GetWindowMaxSize( byref w, byref h) +#header Sub GetWindowMaxSize( ByRef w, ByRef h) Gets the maximum size of a window. + diff --git a/doc/files/getwindowminsize.txt b/doc/files/getwindowminsize.txt index e06c2b9..270bf92 100644 --- a/doc/files/getwindowminsize.txt +++ b/doc/files/getwindowminsize.txt @@ -1,4 +1,5 @@ #title GetWindowMinSize [RCBasic Doc] -#header sub GetWindowMinSize( byref w, byref h) +#header Sub GetWindowMinSize( ByRef w, ByRef h) Gets the minimum size of the window. + diff --git a/doc/files/getwindowmode.txt b/doc/files/getwindowmode.txt index 2090421..33826d2 100644 --- a/doc/files/getwindowmode.txt +++ b/doc/files/getwindowmode.txt @@ -1,4 +1,5 @@ #title GetWindowMode [RCBasic Doc] -#header function GetWindowMode( ) +#header Function GetWindowMode( ) Returns the flags set on the given window as a bitmask. The mode set with OpenWindow() is part of this mask. + diff --git a/doc/files/getwindowposition.txt b/doc/files/getwindowposition.txt index c822e1e..3d27919 100644 --- a/doc/files/getwindowposition.txt +++ b/doc/files/getwindowposition.txt @@ -1,4 +1,5 @@ #title GetWindowPosition [RCBasic Doc] -#header sub GetWindowPosition( byref x, byref y ) +#header Sub GetWindowPosition( ByRef x, ByRef y ) Gets the window position. + diff --git a/doc/files/getwindowsize.txt b/doc/files/getwindowsize.txt index 13c1221..efe48f7 100644 --- a/doc/files/getwindowsize.txt +++ b/doc/files/getwindowsize.txt @@ -1,4 +1,5 @@ #title GetWindowSize [RCBasic Doc] -#header sub GetWindowSize( byref w, byref h ) +#header Sub GetWindowSize( ByRef w, ByRef h ) Gets the size of the window. + diff --git a/doc/files/getworld2dautoclearforces.txt b/doc/files/getworld2dautoclearforces.txt index 1f345b4..1370e72 100644 --- a/doc/files/getworld2dautoclearforces.txt +++ b/doc/files/getworld2dautoclearforces.txt @@ -1,6 +1,7 @@ #title GetWorld2DAutoClearForces [RCBasic Doc] -#header function GetWorld2DAutoClearForces() +#header Function GetWorld2DAutoClearForces() Returns the auto clear forces flag for the active canvas #ref SetWorld2DAutoClearForces + diff --git a/doc/files/getworld2dpositioniterations.txt b/doc/files/getworld2dpositioniterations.txt index ee7546c..d9ecc4f 100644 --- a/doc/files/getworld2dpositioniterations.txt +++ b/doc/files/getworld2dpositioniterations.txt @@ -1,7 +1,8 @@ #title GetWorld2DPositionIterations [RCBasic Doc] -#header function GetWorld2DPositionIterations() +#header Function GetWorld2DPositionIterations() Returns the number of position iterations for the position constraint solver #ref SetWorld2DPositionIterations + diff --git a/doc/files/getworld2dtimestep.txt b/doc/files/getworld2dtimestep.txt index 12796ad..ee9564b 100644 --- a/doc/files/getworld2dtimestep.txt +++ b/doc/files/getworld2dtimestep.txt @@ -1,6 +1,7 @@ #title GetWorld2DTimeStep [RCBasic Doc] -#header function GetWorld2DTimeStep() +#header Function GetWorld2DTimeStep() Returns the timestep for the active canvas #ref SetWorld2DTimeStep + diff --git a/doc/files/getworld2dvelocityiterations.txt b/doc/files/getworld2dvelocityiterations.txt index fbcf0a7..93e1e79 100644 --- a/doc/files/getworld2dvelocityiterations.txt +++ b/doc/files/getworld2dvelocityiterations.txt @@ -1,6 +1,7 @@ #title GetWorld2DVelocityIterations [RCBasic Doc] -#header function GetWorld2DVelocityIterations() +#header Function GetWorld2DVelocityIterations() Returns the number of velocity iterations for the velocity constraint solver #ref SetWorld2DVelocityIterations + diff --git a/doc/files/getworld3dmaxsubsteps.txt b/doc/files/getworld3dmaxsubsteps.txt index 9b869eb..7f4b989 100644 --- a/doc/files/getworld3dmaxsubsteps.txt +++ b/doc/files/getworld3dmaxsubsteps.txt @@ -1,5 +1,6 @@ #title GetWorld3DMaxSubSteps [RCBasic Doc] -#header function GetWorld3DMaxSubSteps() +#header Function GetWorld3DMaxSubSteps() Returns the maximum substeps in the 3d physics time step + diff --git a/doc/files/getworld3dtimestep.txt b/doc/files/getworld3dtimestep.txt index 3cdd328..c34f152 100644 --- a/doc/files/getworld3dtimestep.txt +++ b/doc/files/getworld3dtimestep.txt @@ -1,4 +1,5 @@ #title GetWorld3DTimeStep [RCBasic Doc] -#header function GetWorld3DTimeStep() +#header Function GetWorld3DTimeStep() Returns the timestep of the 3d physics simulation + diff --git a/doc/files/getworldtoviewportposition.txt b/doc/files/getworldtoviewportposition.txt index bca3501..7ddd74f 100644 --- a/doc/files/getworldtoviewportposition.txt +++ b/doc/files/getworldtoviewportposition.txt @@ -2,3 +2,4 @@ #header Sub GetWorldToViewportPosition(x, y, z, ByRef x, ByRef y) Get the 2D coordinates for the given 3D position on the active canvas + diff --git a/doc/files/globalmousex.txt b/doc/files/globalmousex.txt index 32ca055..7ebd0d8 100644 --- a/doc/files/globalmousex.txt +++ b/doc/files/globalmousex.txt @@ -1,6 +1,7 @@ #title GlobalMouseX [RCBasic Doc] -#header function GlobalMouseX() +#header Function GlobalMouseX() Returns the absolute X position of the mouse on the display #ref GlobalMouseY GetGlobalMouse + diff --git a/doc/files/globalmousey.txt b/doc/files/globalmousey.txt index 29eaaa7..ccafb54 100644 --- a/doc/files/globalmousey.txt +++ b/doc/files/globalmousey.txt @@ -1,6 +1,7 @@ #title GlobalMouseY [RCBasic Doc] -#header function GlobalMouseY() +#header Function GlobalMouseY() Returns the absolute Y position of the mouse on the display #ref GlobalMouseX GetGlobalMouse + diff --git a/doc/files/grabinput.txt b/doc/files/grabinput.txt index cc59462..aabc8b3 100644 --- a/doc/files/grabinput.txt +++ b/doc/files/grabinput.txt @@ -1,4 +1,5 @@ #title GrabInput [RCBasic Doc] -#header sub GrabInput(flag) +#header Sub GrabInput(flag) Sets whether the currently active window will grab user input + diff --git a/doc/files/graphics2.txt b/doc/files/graphics2.txt new file mode 100644 index 0000000..b4b2ac5 --- /dev/null +++ b/doc/files/graphics2.txt @@ -0,0 +1,119 @@ +#title RCBasic Sprites [RCBasic Doc] +#header SPRITES + +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. + +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. +#code +pos_x = 0 +pos_y = 0 +viewport_width = 640 +viewport_height = 480 + +sprite_canvas = OpenCanvasSpriteLayer(pos_x, pos_y, viewport_width, viewport_height) +#/code + +Sprite canvases are opened with OpenCanvasSpriteLayer(). 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. + +Once you have opened a sprite canvas, use the Canvas() function to set the sprite canvas as active. +#code +Canvas(sprite_canvas) +#/code + +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. +#code +spriteSheet = LoadImage("graizor.png") + +frame_width = 32 +frame_height = 32 + +mySprite = CreateSprite(spriteSheet, frame_width, frame_height) +#/code + +Sprites are created with the CreateSprite() 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. +#image "images/sprite_frames.png" + +To animate our sprite, we have to create an animation for it. You can create an animation with the CreateSpriteAnimation() function. +#code +walk_left_animation = CreateSpriteAnimation(mySprite, 4, 12) +SetSpriteAnimationFrame(mySprite, walk_left_animation, 0, 28) +SetSpriteAnimationFrame(mySprite, walk_left_animation, 1, 29) +SetSpriteAnimationFrame(mySprite, walk_left_animation, 2, 30) +SetSpriteAnimationFrame(mySprite, walk_left_animation, 3, 31) +#/code + +CreateSpriteAnimation() takes 3 parameters +#list ul +#li sprite - A sprite created with CreateSprite() +#li animation length - number of frames in the animation +#li animation speed - frames per second for the animation +#/list + +SetSpriteAnimationFrame() takes 4 parameters +#list ul +#li sprite - the sprite the animation is on +#li animation - the animation created with CreateSpriteAnimation() +#li animation frame - the animation frame number NOTE: first frame is 0 +#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 +#/list + + +Now to play the animation, we just set the animation on the sprite. +#code +SetSpriteAnimation(mySprite, walk_left_animation, -1) +#/code + +SetSpriteAnimation() 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. + +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 SetSpriteSolid() function. +#code +SetSpriteSolid(mySprite, TRUE) +#/code + +To have the sprite fall, we need to set gravity for our sprite canvas. We do that with SetGravity2D(). +#code +SetGravity2D(0, 30) +#/code + +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. +#code +ground = CreateSprite(-1, 640, 100) +SetSpriteSolid(ground, TRUE) +SetSpritePosition(ground, 0, 380) +SetSpriteType(ground, SPRITE_TYPE_STATIC) +#/code + +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. + +On the next 2 lines we are setting the ground as solid and setting the grounds position to the bottom of our screen. + +The last line is setting the ground sprite as static. This sets the ground as an unmovable object. + +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. +#code +paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1) +SetCanvasZ(paint_canvas, 1) +#/code + +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. + +SetCanvasZ() 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. +#code +SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red +RectFill(0, 380, 640, 100) 'Draws a filled rectangle with the current draw color +#/code + +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. + +The last thing we will do is make our sprite move when we press a key. +#code +If Key(K_RIGHT) Then + SetSpriteLinearVelocity(mySprite, 30, 0) +End If +#/code + +Key() returns true if the key code parameter is pressed. You can see a list of all the key codes in the Key Codes section in the Appendix. + +We use SetSpriteLinearVelocity() 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. + +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. diff --git a/doc/files/graphics3.txt b/doc/files/graphics3.txt new file mode 100644 index 0000000..3b13b61 --- /dev/null +++ b/doc/files/graphics3.txt @@ -0,0 +1,125 @@ +#title RCBasic Sprites [RCBasic Doc] +#header 3D Graphics + +This last section will cover how 3D graphics work in RCBasic. We can render the scene with a 3D canvas which is opened with OpenCanvas3D() +#code +viewport_width = 640 +viewport_height = 480 +scene_canvas = OpenCanvas3D(0, 0, viewport_width, viewport_height, 1) +#/code + +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. + +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. +#code +hero_mesh = LoadMesh("char.ms3d") ' Load a 3D model from a file +hero = CreateAnimatedActor(hero_mesh) ' Create an animated object in our scene from the 3D model +#/code + +We use LoadMesh() 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. + +After we load the model, we use CreateAnimatedActor() 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. + +#code +RUN_ANIMATION = CreateActorAnimation(hero, 13, 36, 30) +#/code + +CreateActorAnimation() takes 4 parameters. +#list ul +#li actor - the actor we created with CreateAnimatedActor() +#list ul +#li NOTE: We can only create animations for animated actors +#/list +#li start frame - The first frame of the animation +#li end frame - The last frame of the animation +#li speed - The frames per second of the animtion +#/list + +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. +#code +SetActorAnimation(hero, RUN_ANIMATION, -1) +#/code + +SetActorAnimation() 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. + +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. +#code +hero_material = GetActorMaterial(hero, 0) + +SetMaterialLighting(hero_material, FALSE) + +hero_texture = LoadImage("hero.png") +SetMaterialTexture(hero_material, 0, hero_texture) +#/code + +First, we get a reference to our actors material with GetActorMaterial(). We use this reference to set properties for the actor's material. The material determines how the actor is rendered. + +Next, we disable lighting for the material. This means that lighting will not determine how light or dark the texture will be rendered at. + +Finally, we load an image and set it to the first texture slot on the material with SetMaterialTexture(). + +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. +#code +SetActorSolid(cube, TRUE) +SetGravity3D(0, -10, 0) +#/code + +SetActorSolid() functions just like SetSpriteSolid() does. SetGravity3D() is like SetGravity2D() but it adds a 3rd dimension to it. + +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. +#code +plane_mesh = CreatePlaneMesh(1000, 1000, 100, 100, 100, 100) +plane = CreateOctreeActor(plane_mesh) +#/code + +CreatePlaneMesh() is used to create a plane mesh rather than use LoadMesh() to load it from an external file like we did earlier. + +CreateOctreeActor() will create an octree actor rather than an animated actor. + +Next we will set a solid color material for our plane rather than load another texture. +#code +plane_material = CreateMaterial() +SetMaterialType(plane_material, FX_MATERIAL_TYPE_PLASTIC) +SetActorMaterial(plane, 0, plane_material) +#/code + +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 CreateMaterial() 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. + +Then we just set our material type with SetMaterialType() and set the material on the actor with SetActorMaterial(). + +Now lets set our physics properties for our plane. +#code +SetActorSolid(plane, TRUE) +SetActorShape(plane, ACTOR_SHAPE_TRIMESH, 0) +#/code + +Yet again, we are using SetActorSolid() to set our actor solid. We use SetActorShape() 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. + +Just like what we did with our sprites in the last lesson, lets have the actor move when a key is pressed. +#code +If Key(K_RIGHT) Then + SetActorLinearVelocityLocal(hero, 0, 0, 20) +End If +#/code + +This looks very similiar to our code for moving the sprite in the last lesson. SetActorLinearVelocityLocal() has a little bit longer name. It has a companion function called SetActorLinearVelocityWorld() which applies a transform based on world instead of local space. + +Before moving on, I want to quickly explain the difference between local transforms and world transforms. +#list 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 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. +#/list + +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(). +#code +Canvas(scene_canvas) + +SetCameraPosition(0, 30, -100) 'Set the camera position +SetCameraRotation(20, 0, 0) 'Set the camera rotation +#/code + +SetCameraPosition() and SetCameraRotation() 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. + +Refer to the Intro to 3D demo for the complete code for this lesson. + +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 forum. diff --git a/doc/files/gyroname.txt b/doc/files/gyroname.txt index def7938..1c44750 100644 --- a/doc/files/gyroname.txt +++ b/doc/files/gyroname.txt @@ -1,4 +1,5 @@ #title GyroName$ [RCBasic Doc] -#header function GyroName$(gyro_num) +#header Function GyroName$(gyro_num) Returns the name of the gyroscope. + diff --git a/doc/files/hasclipboardtext.txt b/doc/files/hasclipboardtext.txt index 13647b7..86036dd 100644 --- a/doc/files/hasclipboardtext.txt +++ b/doc/files/hasclipboardtext.txt @@ -1,4 +1,5 @@ #title HasClipboardText [RCBasic Doc] -#header function HasClipboardText() +#header Function HasClipboardText() Returns whether or not there is text in the clipboard. + diff --git a/doc/files/hex.txt b/doc/files/hex.txt index f7382e4..0efba92 100644 --- a/doc/files/hex.txt +++ b/doc/files/hex.txt @@ -1,4 +1,5 @@ #title Hex$ [RCBasic Doc] -#header function Hex$(n) +#header Function Hex$(n) Returns a hexadecimal representation of a number. + diff --git a/doc/files/hexval.txt b/doc/files/hexval.txt index 59e7935..a9aeb72 100644 --- a/doc/files/hexval.txt +++ b/doc/files/hexval.txt @@ -1,4 +1,5 @@ #title HexVal [RCBasic Doc] -#header function HexVal(n$) +#header Function HexVal(n$) Returns the integer value of a hexadecimal string. + diff --git a/doc/files/hidemouse.txt b/doc/files/hidemouse.txt index 7979f54..1ec771d 100644 --- a/doc/files/hidemouse.txt +++ b/doc/files/hidemouse.txt @@ -1,4 +1,5 @@ #title HideMouse [RCBasic Doc] -#header sub HideMouse() +#header Sub HideMouse() Makes the mouse cursor invisible. + diff --git a/doc/files/hidewindow.txt b/doc/files/hidewindow.txt index 8b92349..2581099 100644 --- a/doc/files/hidewindow.txt +++ b/doc/files/hidewindow.txt @@ -1,6 +1,7 @@ #title HideWindow [RCBasic Doc] -#header sub HideWindow( ) +#header Sub HideWindow( ) Sets the window invisible. #ref ShowWindow WindowIsVisible + diff --git a/doc/files/imageexists.txt b/doc/files/imageexists.txt index 2f62b66..057699a 100644 --- a/doc/files/imageexists.txt +++ b/doc/files/imageexists.txt @@ -1,4 +1,5 @@ #title ImageExists [RCBasic Doc] -#header function ImageExists(img) +#header Function ImageExists(img) Returns true if img is associated with an allocated image in memory + diff --git a/doc/files/incrementmatrixcolumns.txt b/doc/files/incrementmatrixcolumns.txt index e4d1124..d63bf54 100644 --- a/doc/files/incrementmatrixcolumns.txt +++ b/doc/files/incrementmatrixcolumns.txt @@ -1,4 +1,5 @@ #title IncrementMatrixColumns [RCBasic Doc] -#header sub IncrementMatrixColumns(mA, mB, c, num_cols, value) +#header Sub IncrementMatrixColumns(mA, mB, c, num_cols, value) Increments all the values in a specified number of columns in matrix mA, starting from column c. The result is stored in matrix mB + diff --git a/doc/files/incrementmatrixrows.txt b/doc/files/incrementmatrixrows.txt index e7634d8..82ff006 100644 --- a/doc/files/incrementmatrixrows.txt +++ b/doc/files/incrementmatrixrows.txt @@ -1,4 +1,5 @@ #title IncrementMatrixRows [RCBasic Doc] -#header sub IncrementMatrixRows(mA, mB, r, num_rows, value) +#header Sub IncrementMatrixRows(mA, mB, r, num_rows, value) Increments all the values in a specified number of rows in matrix mA, starting from row r. The result is stored in matrix mB + diff --git a/doc/files/inkey.txt b/doc/files/inkey.txt index 65f8d0d..4916cf7 100644 --- a/doc/files/inkey.txt +++ b/doc/files/inkey.txt @@ -1,4 +1,5 @@ #title InKey [RCBasic Doc] -#header function InKey() +#header Function InKey() Returns the character value of the key that was pressed. + diff --git a/doc/files/input.txt b/doc/files/input.txt index 87f735c..4c27adb 100644 --- a/doc/files/input.txt +++ b/doc/files/input.txt @@ -1,4 +1,5 @@ #title Input$ [RCBasic Doc] -#header function Input$(prompt$) +#header Function Input$(prompt$) Returns user input from the console + diff --git a/doc/files/insert.txt b/doc/files/insert.txt index b79be67..1683840 100644 --- a/doc/files/insert.txt +++ b/doc/files/insert.txt @@ -1,4 +1,5 @@ #title Insert$ [RCBasic Doc] -#header function Insert$(src$, tgt$, pos) +#header Function Insert$(src$, tgt$, pos) Returns a string containing str_to_insert$ inserted into src$ at a given position + diff --git a/doc/files/insertmatrixcolumns.txt b/doc/files/insertmatrixcolumns.txt index ce15daa..8ed4ced 100644 --- a/doc/files/insertmatrixcolumns.txt +++ b/doc/files/insertmatrixcolumns.txt @@ -1,4 +1,5 @@ #title InsertMatrixColumns [RCBasic Doc] -#header function InsertMatrixColumns(mA, c, num_cols) +#header Function InsertMatrixColumns(mA, c, num_cols) Insert a number of empty columns into matrix mA starting at the specified column. + diff --git a/doc/files/insertmatrixrows.txt b/doc/files/insertmatrixrows.txt index a2c82d9..eb3aafc 100644 --- a/doc/files/insertmatrixrows.txt +++ b/doc/files/insertmatrixrows.txt @@ -1,4 +1,5 @@ #title InsertMatrixRows [RCBasic Doc] -#header function InsertMatrixRows(mA, r, num_rows) +#header Function InsertMatrixRows(mA, r, num_rows) Insert a number of empty rows into matrix mA starting at the specified row. + diff --git a/doc/files/instr.txt b/doc/files/instr.txt index 0494250..6d18298 100644 --- a/doc/files/instr.txt +++ b/doc/files/instr.txt @@ -1,4 +1,5 @@ #title InStr [RCBasic Doc] -#header function InStr(src$, substr$) +#header Function InStr(src$, Substr$) Returns the position in src$ where substr$ is found. If not found it will return -1. + diff --git a/doc/files/int.txt b/doc/files/int.txt index 42a718e..336ab40 100644 --- a/doc/files/int.txt +++ b/doc/files/int.txt @@ -1,4 +1,5 @@ #title Int [RCBasic Doc] -#header function Int(n) +#header Function Int(n) Returns a number converted to an integer. + diff --git a/doc/files/integrateactorvelocities.txt b/doc/files/integrateactorvelocities.txt index 3ed735d..ade7028 100644 --- a/doc/files/integrateactorvelocities.txt +++ b/doc/files/integrateactorvelocities.txt @@ -1,6 +1,7 @@ -#title integrateActorVelocities [RCBasic Doc] -#header sub integrateActorVelocities( actor, v_step) +#title IntegrateActorVelocities [RCBasic Doc] +#header Sub IntegrateActorVelocities( actor, v_step) Updates the linear and angular velocities of an actor based on the forces and torques applied to it over a time step. Note: This is more manual control than most devs will probably need + diff --git a/doc/files/interpolate.txt b/doc/files/interpolate.txt index 149e3b0..5f6a734 100644 --- a/doc/files/interpolate.txt +++ b/doc/files/interpolate.txt @@ -2,3 +2,4 @@ #header Function Interpolate(min_a, max_a, mid_a, min_b, max_b) This function returns a value interpolated based on the comparison between a mid value in a range of given min and max values + diff --git a/doc/files/interpolatevector.txt b/doc/files/interpolatevector.txt new file mode 100644 index 0000000..5be6d4f --- /dev/null +++ b/doc/files/interpolatevector.txt @@ -0,0 +1,5 @@ +#title InterpolateVector [RCBasic Doc] +#header Sub InterpolateVector(x1, y1, z1, x2, y2, z2, distance, ByRef ix, ByRef iy, ByRef iz) + +Gets an interpolated vector a given distance along a line starting at (x1, y1, z1) and ending at (x2, y2, z2) + diff --git a/doc/files/interpolatevectorq.txt b/doc/files/interpolatevectorq.txt new file mode 100644 index 0000000..fa8d140 --- /dev/null +++ b/doc/files/interpolatevectorq.txt @@ -0,0 +1,5 @@ +#title InterpolateVectorQ [RCBasic Doc] +#header Sub InterpolateVectorQ(x1, y1, z1, x2, y2, z2, x3, y3, z3, distance, ByRef ix, ByRef iy, ByRef iz) + +Gets a quadratic interpolated vector based on a distance between 3 vectors + diff --git a/doc/files/invertmatrix.txt b/doc/files/invertmatrix.txt index a5a2c40..6817169 100644 --- a/doc/files/invertmatrix.txt +++ b/doc/files/invertmatrix.txt @@ -1,4 +1,5 @@ #title InvertMatrix [RCBasic Doc] -#header function InvertMatrix(mA, mB) +#header Function InvertMatrix(mA, mB) Stores the inverse matrix of mA in mB + diff --git a/doc/files/isequalmatrix.txt b/doc/files/isequalmatrix.txt index 8a45e97..9a93032 100644 --- a/doc/files/isequalmatrix.txt +++ b/doc/files/isequalmatrix.txt @@ -1,4 +1,5 @@ #title IsEqualMatrix [RCBasic Doc] -#header function IsEqualMatrix(mA, mB, tolerance) +#header Function IsEqualMatrix(mA, mB, tolerance) Returns true if matrix mA is within tolerance of matrix mB + diff --git a/doc/files/joinmatrixcolumns.txt b/doc/files/joinmatrixcolumns.txt index 5d2266b..a525147 100644 --- a/doc/files/joinmatrixcolumns.txt +++ b/doc/files/joinmatrixcolumns.txt @@ -1,4 +1,5 @@ #title JoinMatrixColumns [RCBasic Doc] -#header sub JoinMatrixColumns(mA, mB, mC) +#header Sub JoinMatrixColumns(mA, mB, mC) Appends the columns in matrix mB below matrix mA. + diff --git a/doc/files/joinmatrixrows.txt b/doc/files/joinmatrixrows.txt index b75bbca..031bc6c 100644 --- a/doc/files/joinmatrixrows.txt +++ b/doc/files/joinmatrixrows.txt @@ -1,4 +1,5 @@ #title JoinMatrixRows [RCBasic Doc] -#header sub JoinMatrixRows(mA, mB, mC) +#header Sub JoinMatrixRows(mA, mB, mC) Appends the rows in matrix mB onto the right of matrix mA. + diff --git a/doc/files/jointexists.txt b/doc/files/jointexists.txt index 5e3b601..bae5363 100644 --- a/doc/files/jointexists.txt +++ b/doc/files/jointexists.txt @@ -1,4 +1,5 @@ #title JointExists [RCBasic Doc] -#header function JointExists( joint_id ) +#header Function JointExists( joint_id ) + diff --git a/doc/files/jointislimitenabled.txt b/doc/files/jointislimitenabled.txt index 1d744cc..c657066 100644 --- a/doc/files/jointislimitenabled.txt +++ b/doc/files/jointislimitenabled.txt @@ -1,5 +1,5 @@ -#title jointIsLimitEnabled [RCBasic Doc] -#header function jointIsLimitEnabled( joint_id) +#title JointIsLimitEnabled [RCBasic Doc] +#header Function JointIsLimitEnabled( joint_id) Returns whether or not the joint limit is enabled @@ -11,3 +11,4 @@ Used with #/list #ref EnableJointLimit SetJointLimits + diff --git a/doc/files/jointmotorisenabled.txt b/doc/files/jointmotorisenabled.txt index 991e120..36240eb 100644 --- a/doc/files/jointmotorisenabled.txt +++ b/doc/files/jointmotorisenabled.txt @@ -1,5 +1,5 @@ -#title jointMotorIsEnabled [RCBasic Doc] -#header function jointMotorIsEnabled( joint_id) +#title JointMotorIsEnabled [RCBasic Doc] +#header Function JointMotorIsEnabled( joint_id) Returns whether or not the joint motor is enabled @@ -11,3 +11,4 @@ Used with #/list #ref EnableJointMotor + diff --git a/doc/files/joyaxis.txt b/doc/files/joyaxis.txt index 7234801..364fe4d 100644 --- a/doc/files/joyaxis.txt +++ b/doc/files/joyaxis.txt @@ -1,4 +1,5 @@ #title JoyAxis [RCBasic Doc] -#header function JoyAxis(joy_num, joy_axis) +#header Function JoyAxis(joy_num, joy_axis) Returns the value of an axis on a joystick. + diff --git a/doc/files/joybutton.txt b/doc/files/joybutton.txt index 7aacab7..53d6553 100644 --- a/doc/files/joybutton.txt +++ b/doc/files/joybutton.txt @@ -1,4 +1,5 @@ #title JoyButton [RCBasic Doc] -#header function JoyButton(joy_num, joy_button) +#header Function JoyButton(joy_num, joy_button) Returns true if the given button was pressed and false otherwise. + diff --git a/doc/files/joyhat.txt b/doc/files/joyhat.txt index 5276fd1..aaccba1 100644 --- a/doc/files/joyhat.txt +++ b/doc/files/joyhat.txt @@ -1,5 +1,5 @@ #title JoyHat [RCBasic Doc] -#header function JoyHat(joy_num, joy_hat) +#header Function JoyHat(joy_num, joy_hat) Returns the position of the Hat. @@ -15,3 +15,4 @@ Possible Hat Positions #li HAT_LEFTUP #li HAT_LEFTDOWN #/list + diff --git a/doc/files/joyname.txt b/doc/files/joyname.txt index ba4df21..aa7f97f 100644 --- a/doc/files/joyname.txt +++ b/doc/files/joyname.txt @@ -1,4 +1,5 @@ #title JoyName$ [RCBasic Doc] -#header function JoyName$(joy_num) +#header Function JoyName$(joy_num) Returns the joystick name. + diff --git a/doc/files/joyrumbleplay.txt b/doc/files/joyrumbleplay.txt index c015106..e8c4e7c 100644 --- a/doc/files/joyrumbleplay.txt +++ b/doc/files/joyrumbleplay.txt @@ -1,5 +1,5 @@ #title JoyRumblePlay [RCBasic Doc] -#header sub JoyRumblePlay(joy_num, strength, duration) +#header Sub JoyRumblePlay(joy_num, strength, duration) Rumbles a joystick at a specified strength for the specifed duration. @@ -7,3 +7,4 @@ Rumbles a joystick at a specified strength for the specifed duration. #li Strength - A value between 0 and 1 #li Duration - Value is in milliseconds #/list + diff --git a/doc/files/joyrumblestop.txt b/doc/files/joyrumblestop.txt index 5096027..5e044fe 100644 --- a/doc/files/joyrumblestop.txt +++ b/doc/files/joyrumblestop.txt @@ -1,4 +1,5 @@ #title JoyRumbleStop [RCBasic Doc] -#header sub JoyRumbleStop(joy_num) +#header Sub JoyRumbleStop(joy_num) Stops the rumble on a joystick + diff --git a/doc/files/joystickisconnected.txt b/doc/files/joystickisconnected.txt index 7b7db7a..c7691c7 100644 --- a/doc/files/joystickisconnected.txt +++ b/doc/files/joystickisconnected.txt @@ -1,4 +1,5 @@ #title JoystickIsConnected [RCBasic Doc] -#header function JoystickIsConnected(joy_num) +#header Function JoystickIsConnected(joy_num) Returns true if joystick is connected, or false if it isn't. + diff --git a/doc/files/joystickishaptic.txt b/doc/files/joystickishaptic.txt index 96948a6..ac62831 100644 --- a/doc/files/joystickishaptic.txt +++ b/doc/files/joystickishaptic.txt @@ -1,4 +1,5 @@ #title JoystickIsHaptic [RCBasic Doc] -#header function JoystickIsHaptic(joy_num) +#header Function JoystickIsHaptic(joy_num) Returns true if joystick has the ability to rumble. + diff --git a/doc/files/key.txt b/doc/files/key.txt index 970bd9e..6250513 100644 --- a/doc/files/key.txt +++ b/doc/files/key.txt @@ -1,4 +1,5 @@ #title Key [RCBasic Doc] -#header function Key(key_code) +#header Function Key(key_code) Returns true if the given key was pressed and false otherwise. + diff --git a/doc/files/lcase.txt b/doc/files/lcase.txt index 240b219..2d1f7dd 100644 --- a/doc/files/lcase.txt +++ b/doc/files/lcase.txt @@ -1,4 +1,5 @@ #title LCase$ [RCBasic Doc] -#header function LCase$(src$) +#header Function LCase$(src$) Returns src$ converted to a completely lower-case string + diff --git a/doc/files/left.txt b/doc/files/left.txt index e6cc52e..8133d2e 100644 --- a/doc/files/left.txt +++ b/doc/files/left.txt @@ -1,4 +1,5 @@ #title Left$ [RCBasic Doc] -#header function Left$(src$, n) +#header Function Left$(src$, n) Returns a substring n characters in length from the left side of the given string. + diff --git a/doc/files/len.txt b/doc/files/len.txt index edac124..76558ed 100644 --- a/doc/files/len.txt +++ b/doc/files/len.txt @@ -1,8 +1,9 @@ #title Len [RCBasic Doc] -#header function Len(src$) +#header Function Len(src$) Returns the number of characters in the given string Note: This function is the exact same as Length() #ref Length + diff --git a/doc/files/length.txt b/doc/files/length.txt index aedb7b1..b75bf29 100644 --- a/doc/files/length.txt +++ b/doc/files/length.txt @@ -1,8 +1,9 @@ #title Length [RCBasic Doc] -#header function Length(src$) +#header Function Length(src$) Returns the number of characters in the given string Note: This function is the exact same as Len() #ref Length + diff --git a/doc/files/lightiscastingshadow.txt b/doc/files/lightiscastingshadow.txt index 41e92ff..342ba88 100644 --- a/doc/files/lightiscastingshadow.txt +++ b/doc/files/lightiscastingshadow.txt @@ -1,6 +1,7 @@ -#title lightIsCastingShadow [RCBasic Doc] -#header function lightIsCastingShadow( actor ) +#title LightIsCastingShadow [RCBasic Doc] +#header Function LightIsCastingShadow( actor ) Returns true if shadow casting is enabled for the given light #ref SetLightShadowCast + diff --git a/doc/files/line.txt b/doc/files/line.txt index bf6c840..38b6971 100644 --- a/doc/files/line.txt +++ b/doc/files/line.txt @@ -1,4 +1,5 @@ #title Line [RCBasic Doc] -#header sub Line(x1, y1, x2, y2) +#header Sub Line(x1, y1, x2, y2) Draws a line + diff --git a/doc/files/line3d.txt b/doc/files/line3d.txt index a9ce8a9..cc7e19f 100644 --- a/doc/files/line3d.txt +++ b/doc/files/line3d.txt @@ -1,4 +1,5 @@ #title Line3D [RCBasic Doc] -#header sub Line3D(x1, y1, z1, x2, y2, z2) +#header Sub Line3D(x1, y1, z1, x2, y2, z2) Draws a line in 3D space + diff --git a/doc/files/loadan8.txt b/doc/files/loadan8.txt index 634043e..08656ec 100644 --- a/doc/files/loadan8.txt +++ b/doc/files/loadan8.txt @@ -4,3 +4,4 @@ Loads an an8 project and returns an id that can be used in LoadMeshFromAN8() #ref LoadMeshFromAN8 + diff --git a/doc/files/loadfont.txt b/doc/files/loadfont.txt index 3b94b01..4070449 100644 --- a/doc/files/loadfont.txt +++ b/doc/files/loadfont.txt @@ -1,4 +1,5 @@ #title LoadFont [RCBasic Doc] -#header function LoadFont(fnt_file$, font_size) +#header Function LoadFont(fnt_file$, font_size) Returns a font id for a font with glyphs of font_size + diff --git a/doc/files/loadimage.txt b/doc/files/loadimage.txt index e196891..1e9fd67 100644 --- a/doc/files/loadimage.txt +++ b/doc/files/loadimage.txt @@ -1,4 +1,5 @@ #title LoadImage [RCBasic Doc] -#header function LoadImage( img$ ) +#header Function LoadImage( img$ ) Returns an image id for an image loaded into memory + diff --git a/doc/files/loadimageex.txt b/doc/files/loadimageex.txt index 548970b..8a2132f 100644 --- a/doc/files/loadimageex.txt +++ b/doc/files/loadimageex.txt @@ -1,4 +1,5 @@ #title LoadImageEx [RCBasic Doc] -#header function LoadImageEx(img$, colkey) +#header Function LoadImageEx(img$, colkey) Returns an image id for an image loaded into memory + diff --git a/doc/files/loadmesh.txt b/doc/files/loadmesh.txt index 528026b..d19b821 100644 --- a/doc/files/loadmesh.txt +++ b/doc/files/loadmesh.txt @@ -1,5 +1,5 @@ #title LoadMesh [RCBasic Doc] -#header function LoadMesh( mesh_file$ ) +#header Function LoadMesh( mesh_file$ ) Returns a mesh id for the loaded mesh @@ -34,3 +34,4 @@ Supported formats #/list #ref LoadMeshFromArchive + diff --git a/doc/files/loadmeshfroman8.txt b/doc/files/loadmeshfroman8.txt index 952142b..b8328e8 100644 --- a/doc/files/loadmeshfroman8.txt +++ b/doc/files/loadmeshfroman8.txt @@ -6,3 +6,4 @@ Loads the figures in an anim8or scene as a mesh Note: This only loads figures from a scene and it loads meshes not anim8or objects #ref LoadAN8 LoadMesh LoadMeshFromArchive + diff --git a/doc/files/loadmeshfromarchive.txt b/doc/files/loadmeshfromarchive.txt index 709103e..c7c1adb 100644 --- a/doc/files/loadmeshfromarchive.txt +++ b/doc/files/loadmeshfromarchive.txt @@ -1,5 +1,5 @@ #title LoadMeshFromArchive [RCBasic Doc] -#header function LoadMeshFromArchive( archive$, mesh_file$ ) +#header Function LoadMeshFromArchive( archive$, mesh_file$ ) Returns a mesh id for the loaded mesh from an archive (*.zip, *.pak, etc.) @@ -34,3 +34,4 @@ Supported formats #/list #ref LoadMesh + diff --git a/doc/files/loadmusic.txt b/doc/files/loadmusic.txt index ffb8ddc..9e723be 100644 --- a/doc/files/loadmusic.txt +++ b/doc/files/loadmusic.txt @@ -1,4 +1,5 @@ #title LoadMusic [RCBasic Doc] -#header sub LoadMusic(music_file$) +#header Sub LoadMusic(music_file$) Loads a music track + diff --git a/doc/files/loadsound.txt b/doc/files/loadsound.txt index 539ae23..b3d3788 100644 --- a/doc/files/loadsound.txt +++ b/doc/files/loadsound.txt @@ -1,4 +1,5 @@ #title LoadSound [RCBasic Doc] -#header function LoadSound(snd_file$) +#header Function LoadSound(snd_file$) Returns an id for a loaded audio track + diff --git a/doc/files/loadvideo.txt b/doc/files/loadvideo.txt index 122d0d1..00b8ac7 100644 --- a/doc/files/loadvideo.txt +++ b/doc/files/loadvideo.txt @@ -1,4 +1,5 @@ #title LoadVideo [RCBasic Doc] -#header sub LoadVideo(vid$) +#header Sub LoadVideo(vid$) Loads a video track + diff --git a/doc/files/log.txt b/doc/files/log.txt index 1cf5563..b000636 100644 --- a/doc/files/log.txt +++ b/doc/files/log.txt @@ -1,4 +1,5 @@ #title Log [RCBasic Doc] -#header function Log(n) +#header Function Log(n) Returns the logarithm of a number. + diff --git a/doc/files/loopactoranimation.txt b/doc/files/loopactoranimation.txt deleted file mode 100644 index e4343a2..0000000 --- a/doc/files/loopactoranimation.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title LoopActorAnimation [RCBasic Doc] -#header sub LoopActorAnimation( actor, flag ) - -Enables or disables actor animation loop diff --git a/doc/files/ltrim.txt b/doc/files/ltrim.txt index c6cdb3c..b17fe6b 100644 --- a/doc/files/ltrim.txt +++ b/doc/files/ltrim.txt @@ -1,6 +1,7 @@ #title LTrim$ [RCBasic Doc] -#header function LTrim$(src$) +#header Function LTrim$(src$) Returns src$ with all the spaces before the first non-space character removed. #ref RTrim Trim + diff --git a/doc/files/makedir.txt b/doc/files/makedir.txt index 98c60c8..4e7d333 100644 --- a/doc/files/makedir.txt +++ b/doc/files/makedir.txt @@ -1,4 +1,5 @@ #title MakeDir [RCBasic Doc] -#header function MakeDir(p$) +#header Function MakeDir(p$) Creates a new directory. + diff --git a/doc/files/makeplanartexturemap.txt b/doc/files/makeplanartexturemap.txt index 00ac2c0..8086611 100644 --- a/doc/files/makeplanartexturemap.txt +++ b/doc/files/makeplanartexturemap.txt @@ -5,3 +5,4 @@ Makes a planar texture map for the mesh. 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 + diff --git a/doc/files/materialexists.txt b/doc/files/materialexists.txt index f18ad2c..5f0ba6a 100644 --- a/doc/files/materialexists.txt +++ b/doc/files/materialexists.txt @@ -1,4 +1,5 @@ #title MaterialExists [RCBasic Doc] -#header function MaterialExists( material ) +#header Function MaterialExists( material ) Returns true if the material id is an existing material + diff --git a/doc/files/materialisaplhablend.txt b/doc/files/materialisaplhablend.txt index 01037bf..7af66ee 100644 --- a/doc/files/materialisaplhablend.txt +++ b/doc/files/materialisaplhablend.txt @@ -1,4 +1,5 @@ #title MaterialIsAplhaBlend [RCBasic Doc] -#header function MaterialIsAplhaBlend( material_id) +#header Function MaterialIsAplhaBlend( material_id) Returns true if alpha blending is enabled for a material + diff --git a/doc/files/materialisgouraudshaded.txt b/doc/files/materialisgouraudshaded.txt index be61944..9985570 100644 --- a/doc/files/materialisgouraudshaded.txt +++ b/doc/files/materialisgouraudshaded.txt @@ -1,4 +1,5 @@ #title MaterialIsGouraudShaded [RCBasic Doc] -#header function MaterialIsGouraudShaded( material_id ) +#header Function MaterialIsGouraudShaded( material_id ) Returns true if material is set to goraud shading + diff --git a/doc/files/materialislit.txt b/doc/files/materialislit.txt index 42ad3c8..175f316 100644 --- a/doc/files/materialislit.txt +++ b/doc/files/materialislit.txt @@ -1,6 +1,7 @@ #title MaterialIsLit [RCBasic Doc] -#header function MaterialIsLit( material_id ) +#header Function MaterialIsLit( material_id ) Returns true if a material is affected by lights in the scene #ref SetMaterialLighting + diff --git a/doc/files/materialisnormalized.txt b/doc/files/materialisnormalized.txt index 8fa2590..63f8daf 100644 --- a/doc/files/materialisnormalized.txt +++ b/doc/files/materialisnormalized.txt @@ -1,4 +1,5 @@ #title MaterialIsNormalized [RCBasic Doc] -#header function MaterialIsNormalized( material_id ) +#header Function MaterialIsNormalized( material_id ) Returns true if material has normalized normals + diff --git a/doc/files/materialispointcloud.txt b/doc/files/materialispointcloud.txt index 5796a38..f9e25f2 100644 --- a/doc/files/materialispointcloud.txt +++ b/doc/files/materialispointcloud.txt @@ -1,4 +1,5 @@ #title MaterialIsPointCloud [RCBasic Doc] -#header function MaterialIsPointCloud( material_id ) +#header Function MaterialIsPointCloud( material_id ) Returns true if material is set to render with point cloud + diff --git a/doc/files/materialistransparent.txt b/doc/files/materialistransparent.txt index 5e2d102..fb37764 100644 --- a/doc/files/materialistransparent.txt +++ b/doc/files/materialistransparent.txt @@ -1,4 +1,5 @@ #title MaterialIsTransparent [RCBasic Doc] -#header function MaterialIsTransparent( material_id) +#header Function MaterialIsTransparent( material_id) Returns true if material is transparent + diff --git a/doc/files/materialiswireframe.txt b/doc/files/materialiswireframe.txt index 391e01b..8968b4c 100644 --- a/doc/files/materialiswireframe.txt +++ b/doc/files/materialiswireframe.txt @@ -1,4 +1,5 @@ #title MaterialIsWireframe [RCBasic Doc] -#header function MaterialIsWireframe( material_id ) +#header Function MaterialIsWireframe( material_id ) Returns true if the material is rendered with non-filled triangles + diff --git a/doc/files/matrixexists.txt b/doc/files/matrixexists.txt new file mode 100644 index 0000000..15a89ac --- /dev/null +++ b/doc/files/matrixexists.txt @@ -0,0 +1,5 @@ +#title MatrixExists [RCBasic Doc] +#header Function MatrixExists( mA ) + +Returns TRUE if a matrix exists and FALSE if not. + diff --git a/doc/files/matrixfrombuffer.txt b/doc/files/matrixfrombuffer.txt index a65d2a3..28558f5 100644 --- a/doc/files/matrixfrombuffer.txt +++ b/doc/files/matrixfrombuffer.txt @@ -1,6 +1,7 @@ #title MatrixFromBuffer [RCBasic Doc] -#header sub MatrixFromBuffer(mA, r, c, ByRef buffer) +#header Sub MatrixFromBuffer(mA, r, c, ByRef buffer) Creates a matrix from an array. NOTE: buffer must have the same number of dimensions as the desired matrix for the structure to remain intact. + diff --git a/doc/files/matrixvalue.txt b/doc/files/matrixvalue.txt index a6240ad..567b49b 100644 --- a/doc/files/matrixvalue.txt +++ b/doc/files/matrixvalue.txt @@ -1,4 +1,5 @@ #title MatrixValue [RCBasic Doc] -#header function MatrixValue(mA, r, c) +#header Function MatrixValue(mA, r, c) Returns the value stored at the given row and column in the matrix + diff --git a/doc/files/max.txt b/doc/files/max.txt index 31553d6..3bda3a9 100644 --- a/doc/files/max.txt +++ b/doc/files/max.txt @@ -1,6 +1,7 @@ #title Max [RCBasic Doc] -#header function Max(a, b) +#header Function Max(a, b) Returns the highest of two numbers. #ref Min + diff --git a/doc/files/maximizewindow.txt b/doc/files/maximizewindow.txt index 112c9e6..f9e3a1b 100644 --- a/doc/files/maximizewindow.txt +++ b/doc/files/maximizewindow.txt @@ -1,4 +1,5 @@ #title MaximizeWindow [RCBasic Doc] -#header sub MaximizeWindow() +#header Sub MaximizeWindow() Maximizes the window + diff --git a/doc/files/messagebox.txt b/doc/files/messagebox.txt index 0097a88..c079141 100644 --- a/doc/files/messagebox.txt +++ b/doc/files/messagebox.txt @@ -1,4 +1,5 @@ #title MessageBox [RCBasic Doc] -#header function MessageBox(title$, msg$) +#header Function MessageBox(title$, msg$) Displays a message box + diff --git a/doc/files/mid.txt b/doc/files/mid.txt index 353ca46..940e30e 100644 --- a/doc/files/mid.txt +++ b/doc/files/mid.txt @@ -1,4 +1,5 @@ #title Mid$ [RCBasic Doc] -#header function Mid$(src$, start, n) +#header Function Mid$(src$, start, n) Returns a substring n characters long starting at start pos. + diff --git a/doc/files/min.txt b/doc/files/min.txt index a734025..1f0ff34 100644 --- a/doc/files/min.txt +++ b/doc/files/min.txt @@ -1,7 +1,8 @@ #title Min [RCBasic Doc] -#header function Min(a, b) +#header Function Min(a, b) Returns the lowest of two numbers. #ref Max + diff --git a/doc/files/minimizewindow.txt b/doc/files/minimizewindow.txt index 3bbbc5a..0c2d62c 100644 --- a/doc/files/minimizewindow.txt +++ b/doc/files/minimizewindow.txt @@ -1,4 +1,5 @@ #title MinimizeWindow [RCBasic Doc] -#header sub MinimizeWindow() +#header Sub MinimizeWindow() Minimizes the window + diff --git a/doc/files/mousebutton.txt b/doc/files/mousebutton.txt index 01f12e8..5b4a8f5 100644 --- a/doc/files/mousebutton.txt +++ b/doc/files/mousebutton.txt @@ -1,4 +1,5 @@ #title MouseButton [RCBasic Doc] -#header function MouseButton(mb) +#header Function MouseButton(mb) Returns true if mouse button is pressed + diff --git a/doc/files/mouseisvisible.txt b/doc/files/mouseisvisible.txt index bedf245..fbda1c7 100644 --- a/doc/files/mouseisvisible.txt +++ b/doc/files/mouseisvisible.txt @@ -1,6 +1,7 @@ #title MouseIsVisible [RCBasic Doc] -#header function MouseIsVisible() +#header Function MouseIsVisible() Returns true if mouse cursor is shown #ref ShowMouse HideMouse + diff --git a/doc/files/mousewheelx.txt b/doc/files/mousewheelx.txt index 2f86834..e375748 100644 --- a/doc/files/mousewheelx.txt +++ b/doc/files/mousewheelx.txt @@ -1,4 +1,5 @@ #title MouseWheelX [RCBasic Doc] -#header function MouseWheelX() +#header Function MouseWheelX() Returns the value of the x axis on the mouse wheel + diff --git a/doc/files/mousewheely.txt b/doc/files/mousewheely.txt index d7af7ae..72cba23 100644 --- a/doc/files/mousewheely.txt +++ b/doc/files/mousewheely.txt @@ -1,4 +1,5 @@ #title MouseWheelY [RCBasic Doc] -#header function MouseWheelY() +#header Function MouseWheelY() Returns the value of the y axis on the mouse wheel + diff --git a/doc/files/mousex.txt b/doc/files/mousex.txt index 4fc5a2b..948ddc9 100644 --- a/doc/files/mousex.txt +++ b/doc/files/mousex.txt @@ -1,4 +1,5 @@ #title MouseX [RCBasic Doc] -#header function MouseX() +#header Function MouseX() Returns the mouse x position + diff --git a/doc/files/mousey.txt b/doc/files/mousey.txt index a919394..86f3991 100644 --- a/doc/files/mousey.txt +++ b/doc/files/mousey.txt @@ -1,4 +1,5 @@ #title MouseY [RCBasic Doc] -#header function MouseY() +#header Function MouseY() Returns the mouse y position + diff --git a/doc/files/movefile.txt b/doc/files/movefile.txt index c4bffa3..4dc4325 100644 --- a/doc/files/movefile.txt +++ b/doc/files/movefile.txt @@ -1,6 +1,7 @@ #title MoveFile [RCBasic Doc] -#header function MoveFile(src$, dst$) +#header Function MoveFile(src$, dst$) Moves a file on the system. Returns true if the file was able to be moved and false if it wasn't + diff --git a/doc/files/multiplymatrix.txt b/doc/files/multiplymatrix.txt index fd14713..0e15f92 100644 --- a/doc/files/multiplymatrix.txt +++ b/doc/files/multiplymatrix.txt @@ -1,4 +1,5 @@ #title MultiplyMatrix [RCBasic Doc] -#header function MultiplyMatrix(mA, mB, mC) +#header Function MultiplyMatrix(mA, mB, mC) Multiply matrix mA and mB and store the result in mC + diff --git a/doc/files/musicexists.txt b/doc/files/musicexists.txt index f6ec489..10a6a89 100644 --- a/doc/files/musicexists.txt +++ b/doc/files/musicexists.txt @@ -1,4 +1,5 @@ #title MusicExists [RCBasic Doc] -#header function MusicExists() +#header Function MusicExists() Returns true if there is a music track loaded + diff --git a/doc/files/musicisplaying.txt b/doc/files/musicisplaying.txt index dd79f4e..35be8ca 100644 --- a/doc/files/musicisplaying.txt +++ b/doc/files/musicisplaying.txt @@ -1,4 +1,5 @@ #title MusicIsPlaying [RCBasic Doc] -#header function MusicIsPlaying() +#header Function MusicIsPlaying() Returns true if the music track is currently playing + diff --git a/doc/files/normalizevector.txt b/doc/files/normalizevector.txt new file mode 100644 index 0000000..4cab41a --- /dev/null +++ b/doc/files/normalizevector.txt @@ -0,0 +1,5 @@ +#title NormalizeVector [RCBasic Doc] +#header Sub NormalizeVector(x, y, z, ByRef nx, ByRef ny, ByRef nz) + +Returns a normalized vector from (x,y,z) + diff --git a/doc/files/numaccels.txt b/doc/files/numaccels.txt index 43a105a..32a4b2c 100644 --- a/doc/files/numaccels.txt +++ b/doc/files/numaccels.txt @@ -1,4 +1,5 @@ #title NumAccels [RCBasic Doc] -#header function NumAccels() +#header Function NumAccels() Returns the number of accelerometer sensors detected + diff --git a/doc/files/numactoranimationloops.txt b/doc/files/numactoranimationloops.txt index 2a55245..5346a94 100644 --- a/doc/files/numactoranimationloops.txt +++ b/doc/files/numactoranimationloops.txt @@ -1,5 +1,6 @@ #title NumActorAnimationLoops [RCBasic Doc] -#header function NumActorAnimationLoops(actor) +#header Function NumActorAnimationLoops(actor) Returns the total number of loops the actor is set to repeat the animation for + diff --git a/doc/files/numberarraycopy.txt b/doc/files/numberarraycopy.txt index 720d28a..22a2c33 100644 --- a/doc/files/numberarraycopy.txt +++ b/doc/files/numberarraycopy.txt @@ -1,5 +1,5 @@ #title NumberArrayCopy [RCBasic Doc] -#header sub NumberArrayCopy(ByRef src, ByRef dst) +#header Sub NumberArrayCopy(ByRef src, ByRef dst) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArrayCopy + diff --git a/doc/files/numberarraydim.txt b/doc/files/numberarraydim.txt index 30253df..0bd7231 100644 --- a/doc/files/numberarraydim.txt +++ b/doc/files/numberarraydim.txt @@ -1,5 +1,5 @@ #title NumberArrayDim [RCBasic Doc] -#header function NumberArrayDim(Byref id) +#header Function NumberArrayDim(ByRef id) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArrayDim + diff --git a/doc/files/numberarrayfill.txt b/doc/files/numberarrayfill.txt index 5c87a7e..1c56965 100644 --- a/doc/files/numberarrayfill.txt +++ b/doc/files/numberarrayfill.txt @@ -1,8 +1,9 @@ #title NumberArrayFill [RCBasic Doc] -#header sub NumberArrayFill(ByRef src, fdata) +#header Sub NumberArrayFill(ByRef src, fdata) This function is exists to be internally called by the runtime but should not be called directly. Use ArrayFill() #ref ArrayFill + diff --git a/doc/files/numberarraysize.txt b/doc/files/numberarraysize.txt index 01f5990..aa042eb 100644 --- a/doc/files/numberarraysize.txt +++ b/doc/files/numberarraysize.txt @@ -1,5 +1,5 @@ #title NumberArraySize [RCBasic Doc] -#header function NumberArraySize(Byref id, array_dim) +#header Function NumberArraySize(ByRef id, array_dim) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArraySize + diff --git a/doc/files/numcommands.txt b/doc/files/numcommands.txt index 85cf745..b934c50 100644 --- a/doc/files/numcommands.txt +++ b/doc/files/numcommands.txt @@ -1,5 +1,6 @@ #title NumCommands [RCBasic Doc] -#header function NumCommands() +#header Function NumCommands() Returns the number of command line arguments passed to the program on start + diff --git a/doc/files/numcpus.txt b/doc/files/numcpus.txt index 557269e..e92a378 100644 --- a/doc/files/numcpus.txt +++ b/doc/files/numcpus.txt @@ -1,6 +1,7 @@ #title NumCPUs [RCBasic Doc] -#header function NumCPUs() +#header Function NumCPUs() Returns the number of CPUs (ie. cores) available + diff --git a/doc/files/numfingers.txt b/doc/files/numfingers.txt index d270146..da49e82 100644 --- a/doc/files/numfingers.txt +++ b/doc/files/numfingers.txt @@ -1,4 +1,5 @@ #title NumFingers [RCBasic Doc] -#header function NumFingers() +#header Function NumFingers() Returns the number of fingers detected in the current touch event + diff --git a/doc/files/numgyros.txt b/doc/files/numgyros.txt index f2d2eb6..8d5b5de 100644 --- a/doc/files/numgyros.txt +++ b/doc/files/numgyros.txt @@ -1,4 +1,5 @@ #title NumGyros [RCBasic Doc] -#header function NumGyros() +#header Function NumGyros() Returns the number Gyros detected in the current touch event + diff --git a/doc/files/numjoyaxes.txt b/doc/files/numjoyaxes.txt index 757d235..71e5ab5 100644 --- a/doc/files/numjoyaxes.txt +++ b/doc/files/numjoyaxes.txt @@ -1,6 +1,7 @@ #title NumJoyAxes [RCBasic Doc] -#header function NumJoyAxes(joy_num) +#header Function NumJoyAxes(joy_num) Returns the number of axes detected on a joystick Axes are normally either the analog sticks or trigger buttons but can be anything with multiple values between no activation and max activation + diff --git a/doc/files/numjoybuttons.txt b/doc/files/numjoybuttons.txt index a1c10d8..e4f0e42 100644 --- a/doc/files/numjoybuttons.txt +++ b/doc/files/numjoybuttons.txt @@ -1,4 +1,5 @@ #title NumJoyButtons [RCBasic Doc] -#header function NumJoyButtons(joy_num) +#header Function NumJoyButtons(joy_num) Returns the number of buttons on a joystick + diff --git a/doc/files/numjoyhats.txt b/doc/files/numjoyhats.txt index 29cc237..bd48f74 100644 --- a/doc/files/numjoyhats.txt +++ b/doc/files/numjoyhats.txt @@ -1,4 +1,5 @@ #title NumJoyHats [RCBasic Doc] -#header function NumJoyHats(joy_num) +#header Function NumJoyHats(joy_num) Returns the number of hats on a joystick + diff --git a/doc/files/numjoysticks.txt b/doc/files/numjoysticks.txt index 3285626..bc95e53 100644 --- a/doc/files/numjoysticks.txt +++ b/doc/files/numjoysticks.txt @@ -1,4 +1,5 @@ #title NumJoysticks [RCBasic Doc] -#header function NumJoysticks() +#header Function NumJoysticks() Returns the number of joysticks detected + diff --git a/doc/files/numjoytrackballs.txt b/doc/files/numjoytrackballs.txt index 9c62b54..e72e374 100644 --- a/doc/files/numjoytrackballs.txt +++ b/doc/files/numjoytrackballs.txt @@ -1,4 +1,5 @@ #title NumJoyTrackBalls [RCBasic Doc] -#header function NumJoyTrackBalls(joy_num) +#header Function NumJoyTrackBalls(joy_num) Returns the number of trackballs detected on a joystick + diff --git a/doc/files/nummaterialconstants.txt b/doc/files/nummaterialconstants.txt index 87b574c..77b7a2a 100644 --- a/doc/files/nummaterialconstants.txt +++ b/doc/files/nummaterialconstants.txt @@ -2,3 +2,4 @@ #header Function NumMaterialConstants(material_type) Returns the number of shader uniforms for an FX material + diff --git a/doc/files/numsoundchannels.txt b/doc/files/numsoundchannels.txt index 8f09479..3224d13 100644 --- a/doc/files/numsoundchannels.txt +++ b/doc/files/numsoundchannels.txt @@ -1,4 +1,5 @@ #title NumSoundChannels [RCBasic Doc] -#header function NumSoundChannels() +#header Function NumSoundChannels() Returns the number of sound channels available + diff --git a/doc/files/numspriteanimationloops.txt b/doc/files/numspriteanimationloops.txt index 60b408f..9c798e1 100644 --- a/doc/files/numspriteanimationloops.txt +++ b/doc/files/numspriteanimationloops.txt @@ -4,3 +4,4 @@ Returns the number of animation loops the actor has set #ref SetSpriteAnimationLoops SetSpriteAnimation + diff --git a/doc/files/opencanvas.txt b/doc/files/opencanvas.txt index 7a6c65a..e67be43 100644 --- a/doc/files/opencanvas.txt +++ b/doc/files/opencanvas.txt @@ -1,5 +1,5 @@ #title OpenCanvas [RCBasic Doc] -#header function OpenCanvas( w, h, viewport_x, viewport_y, viewport_w, viewport_h, mode) +#header Function OpenCanvas( w, h, viewport_x, viewport_y, viewport_w, viewport_h, mode) Returns a canvas for 2D drawing and text rendering @@ -11,3 +11,4 @@ Returns a canvas for 2D drawing and text rendering #/list #ref OpenCanvas3D OpenCanvasSpriteLayer + diff --git a/doc/files/opencanvas3d.txt b/doc/files/opencanvas3d.txt index a8ab92b..0cdeaad 100644 --- a/doc/files/opencanvas3d.txt +++ b/doc/files/opencanvas3d.txt @@ -1,5 +1,5 @@ #title OpenCanvas3D [RCBasic Doc] -#header function OpenCanvas3D( viewport_x, viewport_y, viewport_w, viewport_h, mode) +#header Function OpenCanvas3D( viewport_x, viewport_y, viewport_w, viewport_h, mode) Returns a 3D Canvas for viewing the scene. @@ -10,3 +10,4 @@ Note: Each 3D canvas has its own camera so you need to make sure you have the ca Note: 2D drawing commands do not work on 3D canvases. You need to open a 2D canvas for drawing images. #ref OpenCanvas OpenCanvasSpriteLayer + diff --git a/doc/files/opencanvasspritelayer.txt b/doc/files/opencanvasspritelayer.txt index 0ba5a75..4b40709 100644 --- a/doc/files/opencanvasspritelayer.txt +++ b/doc/files/opencanvasspritelayer.txt @@ -1,5 +1,5 @@ #title OpenCanvasSpriteLayer [RCBasic Doc] -#header function OpenCanvasSpriteLayer(viewport_x, viewport_y, viewport_w, viewport_h) +#header Function OpenCanvasSpriteLayer(viewport_x, viewport_y, viewport_w, viewport_h) Returns a sprite layer. These canvases are used for rendering sprites with the integrated physics engine. @@ -8,3 +8,4 @@ Returns -1 if canvas could not be created. Note: Sprite Layer must be active when creating sprites. #ref OpenCanvas OpenCanvas3D + diff --git a/doc/files/openfile.txt b/doc/files/openfile.txt index a63d51f..cc65aa5 100644 --- a/doc/files/openfile.txt +++ b/doc/files/openfile.txt @@ -1,5 +1,5 @@ #title OpenFile [RCBasic Doc] -#header function OpenFile(fileName$, mode) +#header Function OpenFile(fileName$, mode) Returns an ID for an open file to read or write. @@ -24,3 +24,4 @@ Possible Binary Modes #li BINARY_OUTPUT_PLUS - Opens a file for both reading and writing. If the file already exist it will be overwritten. #li BINARY_APPEND_PLUS - Opens a file for reading and appending binary data to the end of the file. #/list + diff --git a/doc/files/openspritecanvas.txt b/doc/files/openspritecanvas.txt deleted file mode 100644 index b88914e..0000000 --- a/doc/files/openspritecanvas.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title OpenSpriteCanvas [RCBasic Doc] -#header function OpenSpriteCanvas(w, h, viewport_x, viewport_y, viewport_w, viewport_h) - - diff --git a/doc/files/openurl.txt b/doc/files/openurl.txt index debc20e..ea3cff6 100644 --- a/doc/files/openurl.txt +++ b/doc/files/openurl.txt @@ -1,4 +1,5 @@ #title OpenURL [RCBasic Doc] -#header function OpenURL(url$) +#header Function OpenURL(url$) Opens a URL in the internet browser + diff --git a/doc/files/openwindow.txt b/doc/files/openwindow.txt index c37f5c7..6c5b169 100644 --- a/doc/files/openwindow.txt +++ b/doc/files/openwindow.txt @@ -6,3 +6,4 @@ Opens a graphics window Returns true if window was opened and false if a window could not be opened #ref OpenWindowEx + diff --git a/doc/files/openwindowex.txt b/doc/files/openwindowex.txt index 5c19c1b..465208f 100644 --- a/doc/files/openwindowex.txt +++ b/doc/files/openwindowex.txt @@ -1,5 +1,5 @@ #title OpenWindowEx [RCBasic Doc] -#header function OpenWindowEx(title$, x, y, w, h, mode, aa, stencil_buffer, vsync) +#header Function OpenWindowEx(title$, x, y, w, h, mode, aa, stencil_buffer, vsync) Opens a graphics window @@ -22,3 +22,4 @@ Returns true if window was opened and false if a window could not be opened #/list #ref OpenWindow WindowMode + diff --git a/doc/files/orbit.txt b/doc/files/orbit.txt index 060ba7b..dcd38dd 100644 --- a/doc/files/orbit.txt +++ b/doc/files/orbit.txt @@ -1,6 +1,7 @@ #title OrBit [RCBasic Doc] -#header function OrBit(a, b) +#header Function OrBit(a, b) Returns the value of the bitwise OR operation on the operands A and B #ref XOrBit AndBit + diff --git a/doc/files/os.txt b/doc/files/os.txt index bd56b8b..554dc73 100644 --- a/doc/files/os.txt +++ b/doc/files/os.txt @@ -1,5 +1,5 @@ #title OS$ [RCBasic Doc] -#header function OS$() +#header Function OS$() Returns the runtimes native operating system. @@ -14,3 +14,4 @@ Possible Return Values #/list Note: This specifically returns the OS$ the runtime was built for so if you have a windows executable running under wine this function will return "WINDOWS" + diff --git a/doc/files/particleisusingeverymeshvertex.txt b/doc/files/particleisusingeverymeshvertex.txt index 4a8a5e8..b673c1b 100644 --- a/doc/files/particleisusingeverymeshvertex.txt +++ b/doc/files/particleisusingeverymeshvertex.txt @@ -1,7 +1,8 @@ -#title particleIsUsingEveryMeshVertex [RCBasic Doc] -#header function particleIsUsingEveryMeshVertex( actor) +#title ParticleIsUsingEveryMeshVertex [RCBasic Doc] +#header Function ParticleIsUsingEveryMeshVertex( actor) Returns true if emitter emits min<->max particles for every vertex or to pick min<->max vertices. #ref useParticleEveryMeshVertex + diff --git a/doc/files/particleisusingnormaldirection.txt b/doc/files/particleisusingnormaldirection.txt index 339c504..8383f8b 100644 --- a/doc/files/particleisusingnormaldirection.txt +++ b/doc/files/particleisusingnormaldirection.txt @@ -1,6 +1,7 @@ -#title particleIsUsingNormalDirection [RCBasic Doc] -#header function particleIsUsingNormalDirection( actor) +#title ParticleIsUsingNormalDirection [RCBasic Doc] +#header Function ParticleIsUsingNormalDirection( actor) Returns true if particle emitter is using vertex normal for direction, or direction specified. #ref useParticleNormalDirection + diff --git a/doc/files/particleisusingoutlineonly.txt b/doc/files/particleisusingoutlineonly.txt index 1d1fd92..2779e6b 100644 --- a/doc/files/particleisusingoutlineonly.txt +++ b/doc/files/particleisusingoutlineonly.txt @@ -1,5 +1,5 @@ -#title particleIsUsingOutlineOnly [RCBasic Doc] -#header function particleIsUsingOutlineOnly( actor) +#title ParticleIsUsingOutlineOnly [RCBasic Doc] +#header Function ParticleIsUsingOutlineOnly( actor) Returns true if not using draw points inside the cylinder @@ -7,3 +7,4 @@ Note: Only applies to cylinder emitter #ref useParticleOutlineOnly + diff --git a/doc/files/pausemusic.txt b/doc/files/pausemusic.txt index 575b954..ce6446e 100644 --- a/doc/files/pausemusic.txt +++ b/doc/files/pausemusic.txt @@ -1,6 +1,7 @@ #title PauseMusic [RCBasic Doc] -#header sub PauseMusic() +#header Sub PauseMusic() Pauses the currently loaded music track. Unlike StopMusic(), paused music can be resumed from its current position. #ref ResumeMusic StopMusic + diff --git a/doc/files/pausesound.txt b/doc/files/pausesound.txt index f23cd3f..5d9e6c9 100644 --- a/doc/files/pausesound.txt +++ b/doc/files/pausesound.txt @@ -1,4 +1,5 @@ #title PauseSound [RCBasic Doc] -#header sub PauseSound(channel) +#header Sub PauseSound(channel) Pauses a sound at its current position. + diff --git a/doc/files/pausevideo.txt b/doc/files/pausevideo.txt index 735af3c..cb0c550 100644 --- a/doc/files/pausevideo.txt +++ b/doc/files/pausevideo.txt @@ -1,4 +1,5 @@ #title PauseVideo [RCBasic Doc] -#header sub PauseVideo() +#header Sub PauseVideo() Pauses the currently loaded video track + diff --git a/doc/files/pipeline_begin.txt b/doc/files/pipeline_begin.txt new file mode 100644 index 0000000..87f9bd1 --- /dev/null +++ b/doc/files/pipeline_begin.txt @@ -0,0 +1,5 @@ +#title Pipeline_Begin [RCBasic Doc] +#header Sub Pipeline_Begin() + +Begins a custom rendering process. + diff --git a/doc/files/pipeline_end.txt b/doc/files/pipeline_end.txt new file mode 100644 index 0000000..fb4fe76 --- /dev/null +++ b/doc/files/pipeline_end.txt @@ -0,0 +1,5 @@ +#title Pipeline_End [RCBasic Doc] +#header Sub Pipeline_End() + +Ends a custom rendering process. + diff --git a/doc/files/pipeline_render.txt b/doc/files/pipeline_render.txt new file mode 100644 index 0000000..21b00a3 --- /dev/null +++ b/doc/files/pipeline_render.txt @@ -0,0 +1,7 @@ +#title Pipeline_Render [RCBasic Doc] +#header Sub Pipeline_Render() + +Render the active canvas. + +NOTE: Must be used between Pipeline_Begin() and Pipeline_End(). + diff --git a/doc/files/playmusic.txt b/doc/files/playmusic.txt index 121969f..fa4435b 100644 --- a/doc/files/playmusic.txt +++ b/doc/files/playmusic.txt @@ -1,5 +1,5 @@ #title PlayMusic [RCBasic Doc] -#header sub PlayMusic(mLoops) +#header Sub PlayMusic(mLoops) Plays music for set number of loops. @@ -8,3 +8,4 @@ Note: If you only want to play the music once, set this to 0. Note: Set this to -1 to play infinitely. #ref StopMusic + diff --git a/doc/files/playsound.txt b/doc/files/playsound.txt index e059fd0..683ec1b 100644 --- a/doc/files/playsound.txt +++ b/doc/files/playsound.txt @@ -1,4 +1,5 @@ #title PlaySound [RCBasic Doc] -#header sub PlaySound(slot, channel, loops) +#header Sub PlaySound(slot, channel, loops) Plays a sound on the given channel for the given number of loops. + diff --git a/doc/files/playsoundtimed.txt b/doc/files/playsoundtimed.txt index 87fa8ca..656e56d 100644 --- a/doc/files/playsoundtimed.txt +++ b/doc/files/playsoundtimed.txt @@ -1,4 +1,5 @@ #title PlaySoundTimed [RCBasic Doc] -#header sub PlaySoundTimed(slot, channel, loops, ms) +#header Sub PlaySoundTimed(slot, channel, loops, ms) Plays sound for a given number of loops until the given number of milliseconds is reached. + diff --git a/doc/files/playvideo.txt b/doc/files/playvideo.txt index a8e5604..e8b0e3e 100644 --- a/doc/files/playvideo.txt +++ b/doc/files/playvideo.txt @@ -1,5 +1,5 @@ #title PlayVideo [RCBasic Doc] -#header sub PlayVideo(vLoops) +#header Sub PlayVideo(vLoops) Plays the currently loaded video for a set number of loops. @@ -8,3 +8,4 @@ Note: Set this to 0 to play the video once. Note: Set this to -1 to the video infinitely. #ref StopVideo + diff --git a/doc/files/pointinquad.txt b/doc/files/pointinquad.txt index 32c7678..7ec3036 100644 --- a/doc/files/pointinquad.txt +++ b/doc/files/pointinquad.txt @@ -1,4 +1,5 @@ #title PointInQuad [RCBasic Doc] -#header function PointInQuad(px, py, x1, y1, x2, y2, x3, y3, x4, y4) +#header Function PointInQuad(px, py, x1, y1, x2, y2, x3, y3, x4, y4) Returns true if the point (px, py) is in the quad (x1, y1) to (x4, y4) + diff --git a/doc/files/pointintri.txt b/doc/files/pointintri.txt index b4878da..f309291 100644 --- a/doc/files/pointintri.txt +++ b/doc/files/pointintri.txt @@ -1,4 +1,5 @@ #title PointInTri [RCBasic Doc] -#header function PointInTri(px, py, x1, y1, x2, y2, x3, y3) +#header Function PointInTri(px, py, x1, y1, x2, y2, x3, y3) Returns true if the point (px, py) is in the quad (x1, y1) to (x3, y3) + diff --git a/doc/files/poly.txt b/doc/files/poly.txt index b3601ed..51347e9 100644 --- a/doc/files/poly.txt +++ b/doc/files/poly.txt @@ -1,5 +1,5 @@ #title Poly [RCBasic Doc] -#header sub Poly(n, byref x, byref y) +#header Sub Poly(n, ByRef x, ByRef y) Draws a polygon @@ -16,3 +16,4 @@ x[2] = 10 : y[1] = 90 Poly(3, x, y) 'Draws a triangle #/code + diff --git a/doc/files/pop_n.txt b/doc/files/pop_n.txt index c4a67bd..37797b7 100644 --- a/doc/files/pop_n.txt +++ b/doc/files/pop_n.txt @@ -1,6 +1,7 @@ #title Pop_N [RCBasic Doc] -#header function Pop_N( num_stack ) +#header Function Pop_N( num_stack ) Removes the top number off a number stack and returns it #ref Push_N + diff --git a/doc/files/pop_s.txt b/doc/files/pop_s.txt index 86bf546..adf3ab3 100644 --- a/doc/files/pop_s.txt +++ b/doc/files/pop_s.txt @@ -1,7 +1,8 @@ #title Pop_S$ [RCBasic Doc] -#header function Pop_S$( str_stack ) +#header Function Pop_S$( str_stack ) Removes the top string off a string stack and returns it #ref Push_S + diff --git a/doc/files/posteffectisactive.txt b/doc/files/posteffectisactive.txt new file mode 100644 index 0000000..9b5c93d --- /dev/null +++ b/doc/files/posteffectisactive.txt @@ -0,0 +1,7 @@ +#title PostEffectIsActive [RCBasic Doc] +#header Function PostEffectIsActive( c_num ) + +Returns TRUE if an effect is active on the canvas and FALSE if not. + +#ref SetPostEffectActive + diff --git a/doc/files/prefpath.txt b/doc/files/prefpath.txt index 417b467..27e8391 100644 --- a/doc/files/prefpath.txt +++ b/doc/files/prefpath.txt @@ -1,4 +1,5 @@ #title PrefPath$ [RCBasic Doc] -#header function PrefPath$(org_name$, app_name$) +#header Function PrefPath$(org_name$, app_name$) Returns the preferred path for storing files. + diff --git a/doc/files/preupdate.txt b/doc/files/preupdate.txt index 8c9a5c1..67a4f27 100644 --- a/doc/files/preupdate.txt +++ b/doc/files/preupdate.txt @@ -6,3 +6,4 @@ Processes physics for sprites and actors. This is useful if you need to know the post solve positions and rotations prior to drawing them. #ref Update + diff --git a/doc/files/pset.txt b/doc/files/pset.txt index ac27150..8ff0c67 100644 --- a/doc/files/pset.txt +++ b/doc/files/pset.txt @@ -1,4 +1,5 @@ #title Pset [RCBasic Doc] -#header sub Pset(x,y) +#header Sub Pset(x,y) Draws a pixel + diff --git a/doc/files/push_n.txt b/doc/files/push_n.txt index 9b32151..85afbd6 100644 --- a/doc/files/push_n.txt +++ b/doc/files/push_n.txt @@ -1,8 +1,9 @@ #title Push_N [RCBasic Doc] -#header sub Push_N( num_stack, n ) +#header Sub Push_N( num_stack, n ) Pushes a number onto a number stack #ref Pop_N + diff --git a/doc/files/push_s.txt b/doc/files/push_s.txt index 17004a0..226c729 100644 --- a/doc/files/push_s.txt +++ b/doc/files/push_s.txt @@ -1,7 +1,8 @@ #title Push_S [RCBasic Doc] -#header sub Push_S( str_stack, s$ ) +#header Sub Push_S( str_stack, s$ ) Pushes a string onto a string stack #ref Pop_S + diff --git a/doc/files/queryaudiospec.txt b/doc/files/queryaudiospec.txt index edd5606..f2b51a5 100644 --- a/doc/files/queryaudiospec.txt +++ b/doc/files/queryaudiospec.txt @@ -1,4 +1,5 @@ #title QueryAudioSpec [RCBasic Doc] -#header function QueryAudioSpec(ByRef freq, ByRef format, ByRef channels) +#header Function QueryAudioSpec(ByRef freq, ByRef format, ByRef channels) Gets the frequency, output format, and number of channels for the audio device being used. + diff --git a/doc/files/radians.txt b/doc/files/radians.txt index 5573725..9744505 100644 --- a/doc/files/radians.txt +++ b/doc/files/radians.txt @@ -1,4 +1,5 @@ #title Radians [RCBasic Doc] -#header function Radians(d) +#header Function Radians(d) Returns an angle converted from degrees to radians + diff --git a/doc/files/raisewindow.txt b/doc/files/raisewindow.txt index 7ed4d2b..4e9152a 100644 --- a/doc/files/raisewindow.txt +++ b/doc/files/raisewindow.txt @@ -1,4 +1,5 @@ #title RaiseWindow [RCBasic Doc] -#header sub RaiseWindow( ) +#header Sub RaiseWindow( ) Places the current window on top of the other windows. + diff --git a/doc/files/rand.txt b/doc/files/rand.txt index 9db4f9b..b3be6b4 100644 --- a/doc/files/rand.txt +++ b/doc/files/rand.txt @@ -1,4 +1,5 @@ #title Rand [RCBasic Doc] -#header function Rand(n) +#header Function Rand(n) Returns a random number between 0 and n. + diff --git a/doc/files/randomize.txt b/doc/files/randomize.txt index a6ac4f6..376fb37 100644 --- a/doc/files/randomize.txt +++ b/doc/files/randomize.txt @@ -1,4 +1,5 @@ #title Randomize [RCBasic Doc] -#header function Randomize(n) +#header Function Randomize(n) Seeds the random number generator + diff --git a/doc/files/randomizematrix.txt b/doc/files/randomizematrix.txt index abc73bc..46ed95c 100644 --- a/doc/files/randomizematrix.txt +++ b/doc/files/randomizematrix.txt @@ -1,4 +1,5 @@ #title RandomizeMatrix [RCBasic Doc] -#header sub RandomizeMatrix(mA, vmin, vmax) +#header Sub RandomizeMatrix(mA, vmin, vmax) Stores random values between vmin and vmax in the matrix mA + diff --git a/doc/files/readbyte.txt b/doc/files/readbyte.txt index e3cbda4..ccd7e1b 100644 --- a/doc/files/readbyte.txt +++ b/doc/files/readbyte.txt @@ -1,4 +1,5 @@ #title ReadByte [RCBasic Doc] -#header function ReadByte(stream) +#header Function ReadByte(stream) Reads a byte from a file. + diff --git a/doc/files/readbytebuffer.txt b/doc/files/readbytebuffer.txt index ab58c7a..6c65fe3 100644 --- a/doc/files/readbytebuffer.txt +++ b/doc/files/readbytebuffer.txt @@ -1,5 +1,5 @@ #title ReadByteBuffer [RCBasic Doc] -#header function ReadByteBuffer(stream, ByRef buf, buf_size) +#header Function ReadByteBuffer(stream, ByRef buf, buf_size) Reads a number of bytes from a file stream to an array. @@ -10,3 +10,4 @@ Reads a number of bytes from a file stream to an array. #/list #ref ReadByte + diff --git a/doc/files/readinput_gettext.txt b/doc/files/readinput_gettext.txt index 1139505..dea4711 100644 --- a/doc/files/readinput_gettext.txt +++ b/doc/files/readinput_gettext.txt @@ -1,4 +1,5 @@ #title ReadInput_GetText$ [RCBasic Doc] -#header function ReadInput_GetText$() +#header Function ReadInput_GetText$() + diff --git a/doc/files/readinput_settext.txt b/doc/files/readinput_settext.txt index c6a3bd3..eac308c 100644 --- a/doc/files/readinput_settext.txt +++ b/doc/files/readinput_settext.txt @@ -1,4 +1,5 @@ #title ReadInput_SetText [RCBasic Doc] -#header sub ReadInput_SetText(txt$) +#header Sub ReadInput_SetText(txt$) Sets the text in the ReadInput buffer. + diff --git a/doc/files/readinput_start.txt b/doc/files/readinput_start.txt index 865b75c..7dbb115 100644 --- a/doc/files/readinput_start.txt +++ b/doc/files/readinput_start.txt @@ -1,4 +1,5 @@ #title ReadInput_Start [RCBasic Doc] -#header sub ReadInput_Start() +#header Sub ReadInput_Start() Start reading input from the keyboard. + diff --git a/doc/files/readinput_stop.txt b/doc/files/readinput_stop.txt index b896369..14e81c2 100644 --- a/doc/files/readinput_stop.txt +++ b/doc/files/readinput_stop.txt @@ -1,4 +1,5 @@ #title ReadInput_Stop [RCBasic Doc] -#header sub ReadInput_Stop() +#header Sub ReadInput_Stop() Stops reading input from the keyboard. + diff --git a/doc/files/readinput_text.txt b/doc/files/readinput_text.txt deleted file mode 100644 index 4a5bd2e..0000000 --- a/doc/files/readinput_text.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title ReadInput_Text$ [RCBasic Doc] -#header function ReadInput_Text$() - -Returns the text read from the keyboard. diff --git a/doc/files/readinput_togglebackspace.txt b/doc/files/readinput_togglebackspace.txt index cc017bc..d5da9b3 100644 --- a/doc/files/readinput_togglebackspace.txt +++ b/doc/files/readinput_togglebackspace.txt @@ -1,4 +1,5 @@ #title ReadInput_ToggleBackspace [RCBasic Doc] -#header sub ReadInput_ToggleBackspace(flag) +#header Sub ReadInput_ToggleBackspace(flag) Determines whether the backspace is applied during ReadInput events. + diff --git a/doc/files/readline.txt b/doc/files/readline.txt index a2fd4b2..ed3c517 100644 --- a/doc/files/readline.txt +++ b/doc/files/readline.txt @@ -1,4 +1,5 @@ #title ReadLine$ [RCBasic Doc] -#header function ReadLine$(stream) +#header Function ReadLine$(stream) Returns the current line in the file. + diff --git a/doc/files/recalculatecompositeaabb.txt b/doc/files/recalculatecompositeaabb.txt new file mode 100644 index 0000000..91eeb9a --- /dev/null +++ b/doc/files/recalculatecompositeaabb.txt @@ -0,0 +1,5 @@ +#title RecalculateCompositeAABB [RCBasic Doc] +#header Sub RecalculateCompositeAABB(actor) + +Recalculates the bounding box for a composite actor + diff --git a/doc/files/recalculatemeshboundingbox.txt b/doc/files/recalculatemeshboundingbox.txt index 7a219c8..18d61ec 100644 --- a/doc/files/recalculatemeshboundingbox.txt +++ b/doc/files/recalculatemeshboundingbox.txt @@ -4,3 +4,4 @@ Sets the bounding box for a mesh based of its current data #ref GetMeshBoundingBox SetMeshBoundingBox + diff --git a/doc/files/recalculatemeshnormals.txt b/doc/files/recalculatemeshnormals.txt index a8ac15e..1bedb77 100644 --- a/doc/files/recalculatemeshnormals.txt +++ b/doc/files/recalculatemeshnormals.txt @@ -2,3 +2,4 @@ #header Sub ReCalculateMeshNormals( mesh ) Calculates the facing direction of the normals in a mesh + diff --git a/doc/files/rect.txt b/doc/files/rect.txt index d9ff719..960d71b 100644 --- a/doc/files/rect.txt +++ b/doc/files/rect.txt @@ -1,4 +1,5 @@ #title Rect [RCBasic Doc] -#header sub Rect(x, y, w, h) +#header Sub Rect(x, y, w, h) Draws a rectangle to the current canvas. + diff --git a/doc/files/rectfill.txt b/doc/files/rectfill.txt index 13f6ec0..45073a1 100644 --- a/doc/files/rectfill.txt +++ b/doc/files/rectfill.txt @@ -1,4 +1,5 @@ #title RectFill [RCBasic Doc] -#header sub RectFill(x, y, w, h) +#header Sub RectFill(x, y, w, h) Draws a filled rectangle on the current canvas. + diff --git a/doc/files/removeactorshadow.txt b/doc/files/removeactorshadow.txt index 5802d7f..ef11b9a 100644 --- a/doc/files/removeactorshadow.txt +++ b/doc/files/removeactorshadow.txt @@ -1,6 +1,7 @@ #title RemoveActorShadow [RCBasic Doc] -#header sub RemoveActorShadow( actor ) +#header Sub RemoveActorShadow( actor ) Stops shadow casting on an actor #ref AddActorShadow + diff --git a/doc/files/removecompositechild.txt b/doc/files/removecompositechild.txt new file mode 100644 index 0000000..f96cd75 --- /dev/null +++ b/doc/files/removecompositechild.txt @@ -0,0 +1,9 @@ +#title RemoveCompositeChild [RCBasic Doc] +#header Sub RemoveCompositeChild(actor, child_index) + +Removes the actor stored as a child at the given index in a composite actor + +NOTE: This will change the index of all the remaining child actors + +#ref AddCompositeChild + diff --git a/doc/files/removedir.txt b/doc/files/removedir.txt index 0c202c2..2e706c8 100644 --- a/doc/files/removedir.txt +++ b/doc/files/removedir.txt @@ -1,4 +1,5 @@ #title RemoveDir [RCBasic Doc] -#header function RemoveDir(p$) +#header Function RemoveDir(p$) Removes a directory. + diff --git a/doc/files/removefile.txt b/doc/files/removefile.txt index eae2249..1085af4 100644 --- a/doc/files/removefile.txt +++ b/doc/files/removefile.txt @@ -1,4 +1,5 @@ #title RemoveFile [RCBasic Doc] -#header function RemoveFile(fileName$) +#header Function RemoveFile(fileName$) Removes a file. + diff --git a/doc/files/removeprojectoreffectactor.txt b/doc/files/removeprojectoreffectactor.txt new file mode 100644 index 0000000..49642af --- /dev/null +++ b/doc/files/removeprojectoreffectactor.txt @@ -0,0 +1,11 @@ +#title RemoveProjectorEffectActor [RCBasic Doc] +#header Sub RemoveProjectorEffectActor(actor, tgt_index) + +Removes an effect actor from a projector. + +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. + +Refer to the included Projector Demo for an example + +#ref AddProjectorEffectActor + diff --git a/doc/files/removescenesky.txt b/doc/files/removescenesky.txt index 58061fd..94d95b2 100644 --- a/doc/files/removescenesky.txt +++ b/doc/files/removescenesky.txt @@ -1,6 +1,7 @@ #title RemoveSceneSky [RCBasic Doc] -#header sub RemoveSceneSky( ) +#header Sub RemoveSceneSky( ) Removes the sky from the current 3D scene #ref AddSceneSkyBox AddSceneSkyDome AddSceneSkyDomeEx + diff --git a/doc/files/removespritechild.txt b/doc/files/removespritechild.txt new file mode 100644 index 0000000..cf04f04 --- /dev/null +++ b/doc/files/removespritechild.txt @@ -0,0 +1,7 @@ +#title RemoveSpriteChild [RCBasic Doc] +#header Sub RemoveSpriteChild(sprite, child_index) + +Removes the child at the given index from the parent sprite + +#ref AddSpriteChild + diff --git a/doc/files/renamefile.txt b/doc/files/renamefile.txt index 66f49e6..7ce3dbf 100644 --- a/doc/files/renamefile.txt +++ b/doc/files/renamefile.txt @@ -1,4 +1,5 @@ #title RenameFile [RCBasic Doc] -#header function RenameFile(src$, dst$) +#header Function RenameFile(src$, dst$) Renames src$ file to dst$ file. + diff --git a/doc/files/replace.txt b/doc/files/replace.txt index 3f86bc7..ecd1095 100644 --- a/doc/files/replace.txt +++ b/doc/files/replace.txt @@ -1,4 +1,5 @@ #title Replace$ [RCBasic Doc] -#header function Replace$(src$, tgt$, rpc$) +#header Function Replace$(src$, tgt$, rpc$) Replaces all occurrences of tgt$ with rpc$. + diff --git a/doc/files/replacesubstr.txt b/doc/files/replacesubstr.txt index c84ae31..61bf8fb 100644 --- a/doc/files/replacesubstr.txt +++ b/doc/files/replacesubstr.txt @@ -1,4 +1,5 @@ #title ReplaceSubstr$ [RCBasic Doc] -#header function ReplaceSubstr$(src$, rpc$, pos) +#header Function ReplaceSubstr$(src$, rpc$, pos) Overwrites the characters at the given position in src$ with rpc$. + diff --git a/doc/files/resetvehiclesuspension.txt b/doc/files/resetvehiclesuspension.txt new file mode 100644 index 0000000..de92095 --- /dev/null +++ b/doc/files/resetvehiclesuspension.txt @@ -0,0 +1,5 @@ +#title ResetVehicleSuspension [RCBasic Doc] +#header Sub ResetVehicleSuspension( actor ) + +Sets the suspension of a vehicle back to its base length. + diff --git a/doc/files/restorewindow.txt b/doc/files/restorewindow.txt index 5419b9c..f199a2e 100644 --- a/doc/files/restorewindow.txt +++ b/doc/files/restorewindow.txt @@ -1,4 +1,5 @@ #title RestoreWindow [RCBasic Doc] -#header sub RestoreWindow( ) +#header Sub RestoreWindow( ) Restores the window if minimized + diff --git a/doc/files/resumemusic.txt b/doc/files/resumemusic.txt index adb9e0f..974d527 100644 --- a/doc/files/resumemusic.txt +++ b/doc/files/resumemusic.txt @@ -1,4 +1,5 @@ #title ResumeMusic [RCBasic Doc] -#header sub ResumeMusic() +#header Sub ResumeMusic() Resumes playing music. + diff --git a/doc/files/resumesound.txt b/doc/files/resumesound.txt index d36255d..bd347df 100644 --- a/doc/files/resumesound.txt +++ b/doc/files/resumesound.txt @@ -1,6 +1,7 @@ #title ResumeSound [RCBasic Doc] -#header sub ResumeSound(channel) +#header Sub ResumeSound(channel) Resumes playing sound on the given channel. #ref PauseSound + diff --git a/doc/files/resumevideo.txt b/doc/files/resumevideo.txt index 4c6e534..c6d6b88 100644 --- a/doc/files/resumevideo.txt +++ b/doc/files/resumevideo.txt @@ -1,6 +1,7 @@ #title ResumeVideo [RCBasic Doc] -#header sub ResumeVideo() +#header Sub ResumeVideo() Resumes the video #ref PauseVideo + diff --git a/doc/files/reverse.txt b/doc/files/reverse.txt index 973346b..5eba392 100644 --- a/doc/files/reverse.txt +++ b/doc/files/reverse.txt @@ -1,4 +1,5 @@ #title Reverse$ [RCBasic Doc] -#header function Reverse$(src$) +#header Function Reverse$(src$) Returns src$ with the characters in reverse order. + diff --git a/doc/files/rewindmusic.txt b/doc/files/rewindmusic.txt index 7873e4d..b81ea52 100644 --- a/doc/files/rewindmusic.txt +++ b/doc/files/rewindmusic.txt @@ -1,4 +1,5 @@ #title RewindMusic [RCBasic Doc] -#header sub RewindMusic() +#header Sub RewindMusic() Rewinds the music track. + diff --git a/doc/files/rgb.txt b/doc/files/rgb.txt index 26ad391..37ceeac 100644 --- a/doc/files/rgb.txt +++ b/doc/files/rgb.txt @@ -1,4 +1,5 @@ #title RGB [RCBasic Doc] -#header function RGB(r,g,b) +#header Function RGB(r,g,b) Returns a 32-bit color value. + diff --git a/doc/files/rgba.txt b/doc/files/rgba.txt index 5b0f46c..6b2758a 100644 --- a/doc/files/rgba.txt +++ b/doc/files/rgba.txt @@ -1,4 +1,5 @@ #title RGBA [RCBasic Doc] -#header function RGBA(r,g,b,a) +#header Function RGBA(r,g,b,a) Returns a 32-bit color value. + diff --git a/doc/files/right.txt b/doc/files/right.txt index c27c1e7..01af8f2 100644 --- a/doc/files/right.txt +++ b/doc/files/right.txt @@ -1,4 +1,5 @@ #title Right$ [RCBasic Doc] -#header function Right$(src$, n) +#header Function Right$(src$, n) Returns n number of characters from the right side of src$. + diff --git a/doc/files/rotateactor.txt b/doc/files/rotateactor.txt index bea4d34..503aff2 100644 --- a/doc/files/rotateactor.txt +++ b/doc/files/rotateactor.txt @@ -1,6 +1,7 @@ #title RotateActor [RCBasic Doc] -#header sub RotateActor( actor, x, y, z ) +#header Sub RotateActor( actor, x, y, z ) Rotates and actor a given number of degrees from its current orientation #ref SetActorRotation GetActorRotation + diff --git a/doc/files/rotatecamera.txt b/doc/files/rotatecamera.txt index d4ce338..33294a4 100644 --- a/doc/files/rotatecamera.txt +++ b/doc/files/rotatecamera.txt @@ -1,6 +1,7 @@ #title RotateCamera [RCBasic Doc] -#header sub RotateCamera( x, y, z) +#header Sub RotateCamera( x, y, z) Rotates the camera a given number of degrees from its current orientation #ref SetCameraRotation GetCameraRotation + diff --git a/doc/files/rotatesprite.txt b/doc/files/rotatesprite.txt index 7eebdfa..5b84d50 100644 --- a/doc/files/rotatesprite.txt +++ b/doc/files/rotatesprite.txt @@ -48,3 +48,4 @@ Wend #image "images/theEye.png" #ref SetSpriteRotation GetSpriteRotation + diff --git a/doc/files/round.txt b/doc/files/round.txt index 2ede955..18824e1 100644 --- a/doc/files/round.txt +++ b/doc/files/round.txt @@ -1,4 +1,5 @@ #title Round [RCBasic Doc] -#header function Round(n) +#header Function Round(n) Rounds n to the nearest whole number. + diff --git a/doc/files/rtrim.txt b/doc/files/rtrim.txt index e184ddc..86a83b2 100644 --- a/doc/files/rtrim.txt +++ b/doc/files/rtrim.txt @@ -1,4 +1,5 @@ #title Rtrim$ [RCBasic Doc] -#header function Rtrim$(src$) +#header Function Rtrim$(src$) Returns src$ with all the spaces after the last non-space character removed. + diff --git a/doc/files/runtime.txt b/doc/files/runtime.txt index 0e834dd..b287b4c 100644 --- a/doc/files/runtime.txt +++ b/doc/files/runtime.txt @@ -1,4 +1,5 @@ #title Runtime$ [RCBasic Doc] -#header function Runtime$() +#header Function Runtime$() Returns the path to the RCBasic runtime that launched the current program + diff --git a/doc/files/runtime_utility_message.txt b/doc/files/runtime_utility_message.txt index 6d9adb7..0f2b578 100644 --- a/doc/files/runtime_utility_message.txt +++ b/doc/files/runtime_utility_message.txt @@ -1,6 +1,7 @@ #title Runtime_Utility_Message$ [RCBasic Doc] -#header function Runtime_Utility_Message$(arg$) +#header Function Runtime_Utility_Message$(arg$) Passes arg$ to the rc_intern_runtime_utility() function in the rc_media.h file. The function returns a string. Note: On IOS there a file in the project called rcbasic_ios_native.h which is already setup for you to add your C++ code. + diff --git a/doc/files/savebmp.txt b/doc/files/savebmp.txt new file mode 100644 index 0000000..f3b1722 --- /dev/null +++ b/doc/files/savebmp.txt @@ -0,0 +1,34 @@ +#title SaveBMP [RCBasic Doc] +#header Function SaveBMP(img, file$) + +Save an image to a *.bmp file + +#code +title$ = "Sprite Test" +w = 640 +h = 480 +fullscreen = FALSE +vsync = FALSE + +OpenWindow( title$, w, h, fullscreen, vsync ) + +my_canvas = OpenCanvas(w, h, 0, 0, w, h, 1) + +Canvas(my_canvas) + +SetColor(RGB(255,0, 0)) +CircleFill(50, 50, 25) + +SetColor(RGB(0, 255, 0)) +CircleFill(590, 50, 25) + +SetColor(RGB(0, 0, 255)) +CircleFill(590, 430, 25) + +img = CanvasClip(0, 0, 640, 480) +SaveBMP(img, "test.bmp") + +Update() +WaitKey() +#/code + diff --git a/doc/files/scalarmatrix.txt b/doc/files/scalarmatrix.txt index a68839f..87d85d7 100644 --- a/doc/files/scalarmatrix.txt +++ b/doc/files/scalarmatrix.txt @@ -1,4 +1,5 @@ #title ScalarMatrix [RCBasic Doc] -#header sub ScalarMatrix(mA, mB, s_value) +#header Sub ScalarMatrix(mA, mB, s_value) Multiplies values in matrix mA by scalar value and stores the results in mB + diff --git a/doc/files/scalarmatrixcolumns.txt b/doc/files/scalarmatrixcolumns.txt index 1385975..666b541 100644 --- a/doc/files/scalarmatrixcolumns.txt +++ b/doc/files/scalarmatrixcolumns.txt @@ -1,4 +1,5 @@ #title ScalarMatrixColumns [RCBasic Doc] -#header function ScalarMatrixColumns(mA, mB, c, num_cols, s_value) +#header Function ScalarMatrixColumns(mA, mB, c, num_cols, s_value) Multiplies values in the specified columns of matrix mA by scalar value and stores the results in mB + diff --git a/doc/files/scalarmatrixrows.txt b/doc/files/scalarmatrixrows.txt index c2ce85b..ed31dd0 100644 --- a/doc/files/scalarmatrixrows.txt +++ b/doc/files/scalarmatrixrows.txt @@ -1,4 +1,5 @@ #title ScalarMatrixRows [RCBasic Doc] -#header function ScalarMatrixRows(mA, mB, r, num_rows, s_value) +#header Function ScalarMatrixRows(mA, mB, r, num_rows, s_value) Multiplies values in the specified rows of matrix mA by scalar value and stores the results in mB + diff --git a/doc/files/scaleactor.txt b/doc/files/scaleactor.txt index 7889025..0028885 100644 --- a/doc/files/scaleactor.txt +++ b/doc/files/scaleactor.txt @@ -1,6 +1,7 @@ #title ScaleActor [RCBasic Doc] -#header sub ScaleActor( actor, x, y, z ) +#header Sub ScaleActor( actor, x, y, z ) Multiplies the actor's current scale by the vector given #ref SetActorScale + diff --git a/doc/files/scalesprite.txt b/doc/files/scalesprite.txt index bf23b2e..2253761 100644 --- a/doc/files/scalesprite.txt +++ b/doc/files/scalesprite.txt @@ -4,3 +4,4 @@ Sets the scale of a sprite relative to its current scale #ref SetSpriteScale GetSpriteScale + diff --git a/doc/files/scaleterraintexture.txt b/doc/files/scaleterraintexture.txt index ac4b9d4..5d4af5f 100644 --- a/doc/files/scaleterraintexture.txt +++ b/doc/files/scaleterraintexture.txt @@ -1,5 +1,5 @@ #title ScaleTerrainTexture [RCBasic Doc] -#header sub ScaleTerrainTexture( actor, scale, scale2 ) +#header Sub ScaleTerrainTexture( actor, scale, scale2 ) Scales the base texture, similar to makePlanarTextureMapping. @@ -7,3 +7,4 @@ Scales the base texture, similar to makePlanarTextureMapping. #li scale - The scaling amount. Values above 1.0 increase the number of time the texture is drawn on the terrain. Values below 0 will decrease the number of times the texture is drawn on the terrain. Using negative values will flip the texture, as well as still scaling it. #li scale2 - If set to 0 (default value), this will set the second texture coordinate set to the same values as in the first set. If this is another value than zero, it will scale the second texture coordinate set by this value. #/list + diff --git a/doc/files/seek.txt b/doc/files/seek.txt index d702020..488e245 100644 --- a/doc/files/seek.txt +++ b/doc/files/seek.txt @@ -1,6 +1,7 @@ #title Seek [RCBasic Doc] -#header function Seek(stream, pos) +#header Function Seek(stream, pos) Sets the position within a file to read from or write to. #ref Tell + diff --git a/doc/files/setactorangularfactor.txt b/doc/files/setactorangularfactor.txt index f24d283..792fd7f 100644 --- a/doc/files/setactorangularfactor.txt +++ b/doc/files/setactorangularfactor.txt @@ -1,5 +1,5 @@ #title SetActorAngularFactor [RCBasic Doc] -#header sub SetActorAngularFactor( actor, x, y, z) +#header Sub SetActorAngularFactor( actor, x, y, z) Sets an actor's angular factor. @@ -7,3 +7,4 @@ The angular factor determines how the actor responds to angular velocity or torq #ref GetActorAngularFactor SetActorAngularFactor SetActorLinearFactor + diff --git a/doc/files/setactorangularvelocitylocal.txt b/doc/files/setactorangularvelocitylocal.txt index 1038b4a..32b4034 100644 --- a/doc/files/setactorangularvelocitylocal.txt +++ b/doc/files/setactorangularvelocitylocal.txt @@ -1,6 +1,7 @@ -#title setActorAngularVelocityLocal [RCBasic Doc] -#header sub setActorAngularVelocityLocal( actor, x, y, z) +#title SetActorAngularVelocityLocal [RCBasic Doc] +#header Sub SetActorAngularVelocityLocal( actor, x, y, z) Sets an actor's Angular Velocity #ref GetActorAngularVelocityWorld GetActorAngularVelocityLocal SetActorAngularVelocityWorld + diff --git a/doc/files/setactorangularvelocityworld.txt b/doc/files/setactorangularvelocityworld.txt index 25b406e..925fb7d 100644 --- a/doc/files/setactorangularvelocityworld.txt +++ b/doc/files/setactorangularvelocityworld.txt @@ -1,7 +1,8 @@ -#title setActorAngularVelocityWorld [RCBasic Doc] -#header sub setActorAngularVelocityWorld( actor, x, y, z) +#title SetActorAngularVelocityWorld [RCBasic Doc] +#header Sub SetActorAngularVelocityWorld( actor, x, y, z) Sets an actor's Angular Velocity #ref GetActorAngularVelocityWorld GetActorAngularVelocityLocal SetActorAngularVelocityLocal + diff --git a/doc/files/setactoranimation.txt b/doc/files/setactoranimation.txt index 721398b..cc6a4ab 100644 --- a/doc/files/setactoranimation.txt +++ b/doc/files/setactoranimation.txt @@ -1,5 +1,5 @@ #title SetActorAnimation [RCBasic Doc] -#header sub SetActorAnimation( actor, animation, num_loops) +#header Sub SetActorAnimation( actor, animation, num_loops) Sets the current animation for an actor to start playing @@ -10,3 +10,4 @@ Notes on num_loops #/list #ref CreateActorAnimation + diff --git a/doc/files/setactoranimationframes.txt b/doc/files/setactoranimationframes.txt index 4339f60..d313433 100644 --- a/doc/files/setactoranimationframes.txt +++ b/doc/files/setactoranimationframes.txt @@ -1,6 +1,7 @@ #title SetActorAnimationFrames [RCBasic Doc] -#header sub SetActorAnimationFrames(actor, animation, start_frame, end_frame) +#header Sub SetActorAnimationFrames(actor, animation, start_frame, end_frame) Changes the frames that plays in an actor's animation #ref CreateActorAnimation + diff --git a/doc/files/setactoranimationspeed.txt b/doc/files/setactoranimationspeed.txt index e5e785c..d027baa 100644 --- a/doc/files/setactoranimationspeed.txt +++ b/doc/files/setactoranimationspeed.txt @@ -1,6 +1,7 @@ #title SetActorAnimationSpeed [RCBasic Doc] -#header sub SetActorAnimationSpeed( actor, animation, speed ) +#header Sub SetActorAnimationSpeed( actor, animation, speed ) Set the FPS of an actor animation #ref GetActorAnimationSpeed + diff --git a/doc/files/setactorautoculling.txt b/doc/files/setactorautoculling.txt index ce727d7..7bfdd10 100644 --- a/doc/files/setactorautoculling.txt +++ b/doc/files/setactorautoculling.txt @@ -1,5 +1,5 @@ #title SetActorAutoCulling [RCBasic Doc] -#header sub SetActorAutoCulling( actor, cull_type ) +#header Sub SetActorAutoCulling( actor, cull_type ) Sets the automatic culling state for an actor @@ -13,3 +13,4 @@ Possible Culling States #/list #ref GetActorAutoCulling + diff --git a/doc/files/setactorcollisionshape.txt b/doc/files/setactorcollisionshape.txt deleted file mode 100644 index e2863e6..0000000 --- a/doc/files/setactorcollisionshape.txt +++ /dev/null @@ -1,18 +0,0 @@ -#title SetActorCollisionShape [RCBasic Doc] -#header sub SetActorCollisionShape( actor, shape_type, mass) - -Sets the actor's collision shape - -Shape Types: -#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 GetActorCollisionShape diff --git a/doc/files/setactordamping.txt b/doc/files/setactordamping.txt index 40737d5..984b491 100644 --- a/doc/files/setactordamping.txt +++ b/doc/files/setactordamping.txt @@ -1,6 +1,7 @@ -#title setActorDamping [RCBasic Doc] -#header sub setActorDamping( actor, lin_damping, ang_damping) +#title SetActorDamping [RCBasic Doc] +#header Sub SetActorDamping( actor, lin_damping, ang_damping) Sets the linear and angular damping for an actor #ref GetActorLinearDamping GetActorAngularDamping + diff --git a/doc/files/setactorframe.txt b/doc/files/setactorframe.txt index b38a8a0..eb9ec9c 100644 --- a/doc/files/setactorframe.txt +++ b/doc/files/setactorframe.txt @@ -1,5 +1,5 @@ #title SetActorFrame [RCBasic Doc] -#header sub SetActorFrame( actor, frame ) +#header Sub SetActorFrame( actor, frame ) Sets the current frame of an actor @@ -7,3 +7,4 @@ Note: This function will set the actor's animation to 0 which is a default 1 fra #ref GetActorFrame + diff --git a/doc/files/setactorgravity.txt b/doc/files/setactorgravity.txt index 67bbb97..e409194 100644 --- a/doc/files/setactorgravity.txt +++ b/doc/files/setactorgravity.txt @@ -1,6 +1,7 @@ #title SetActorGravity [RCBasic Doc] -#header sub SetActorGravity( actor, x, y, z ) +#header Sub SetActorGravity( actor, x, y, z ) Sets the gravity vector of an actor. #ref SetGravity3D + diff --git a/doc/files/setactorimpactmesh.txt b/doc/files/setactorimpactmesh.txt new file mode 100644 index 0000000..5027f11 --- /dev/null +++ b/doc/files/setactorimpactmesh.txt @@ -0,0 +1,7 @@ +#title SetActorImpactMesh [RCBasic Doc] +#header Sub SetActorImpactMesh( actor, mesh, mass ) + +Sets the collision mesh for an actor with a shape type of ACTOR_SHAPE_IMPACT_MESH + +#ref SetActorShape + diff --git a/doc/files/setactorinverseinertiadiaglocal.txt b/doc/files/setactorinverseinertiadiaglocal.txt index cc428ef..ae1bd09 100644 --- a/doc/files/setactorinverseinertiadiaglocal.txt +++ b/doc/files/setactorinverseinertiadiaglocal.txt @@ -1,6 +1,7 @@ #title SetActorInverseInertiaDiagLocal [RCBasic Doc] -#header sub SetActorInverseInertiaDiagLocal( actor, x, y, z) +#header Sub SetActorInverseInertiaDiagLocal( actor, x, y, z) Sets the inverse of the inertia tensor's diagonal components in an actor's local space. This is used to compute how the actor reacts to rotational forces (torques) applied to it. #ref GetActorInverseInertiaDiagLocal + diff --git a/doc/files/setactorlinearfactor.txt b/doc/files/setactorlinearfactor.txt index 836a22f..222b046 100644 --- a/doc/files/setactorlinearfactor.txt +++ b/doc/files/setactorlinearfactor.txt @@ -1,5 +1,5 @@ #title SetActorLinearFactor [RCBasic Doc] -#header sub SetActorLinearFactor( actor, x, y, z) +#header Sub SetActorLinearFactor( actor, x, y, z) Sets an actor's linear factor. @@ -7,3 +7,4 @@ The linear factor determines how the actor responds to linear velocity or force. #ref GetActorLinearFactor SetActorAngularFactor GetActorAngularFactor + diff --git a/doc/files/setactorlinearvelocitylocal.txt b/doc/files/setactorlinearvelocitylocal.txt index a662ba8..6be9196 100644 --- a/doc/files/setactorlinearvelocitylocal.txt +++ b/doc/files/setactorlinearvelocitylocal.txt @@ -1,6 +1,7 @@ -#title setActorLinearVelocityLocal [RCBasic Doc] -#header sub setActorLinearVelocityLocal( actor, x, y, z) +#title SetActorLinearVelocityLocal [RCBasic Doc] +#header Sub SetActorLinearVelocityLocal( actor, x, y, z) Sets actor's linear velocity #ref GetActorLinearVelocityLocal SetActorLinearVelocityWorld + diff --git a/doc/files/setactorlinearvelocityworld.txt b/doc/files/setactorlinearvelocityworld.txt index eaf790a..8a00d1c 100644 --- a/doc/files/setactorlinearvelocityworld.txt +++ b/doc/files/setactorlinearvelocityworld.txt @@ -1,7 +1,8 @@ -#title setActorLinearVelocityWorld [RCBasic Doc] -#header sub setActorLinearVelocityWorld( actor, x, y, z) +#title SetActorLinearVelocityWorld [RCBasic Doc] +#header Sub SetActorLinearVelocityWorld( actor, x, y, z) Sets actor's linear velocity #ref SetActorLinearVelocityLocal GetActorLinearVelocityWorld + diff --git a/doc/files/setactormassproperties.txt b/doc/files/setactormassproperties.txt index 8ed0140..cd45f17 100644 --- a/doc/files/setactormassproperties.txt +++ b/doc/files/setactormassproperties.txt @@ -1,5 +1,5 @@ -#title setActorMassProperties [RCBasic Doc] -#header sub setActorMassProperties( actor, mass, inertia_x, inertia_y, inertia_z) +#title SetActorMassProperties [RCBasic Doc] +#header Sub SetActorMassProperties( actor, mass, inertia_x, inertia_y, inertia_z) Set the mass and local inertia of an actor. This is crucial for defining how the actor behaves under the influence of forces and torques, especially when it comes to simulating realistic motion and rotation. @@ -15,3 +15,4 @@ Inertial #/list #ref GetActorLocalInertia GetActorInverseMass + diff --git a/doc/files/setactormaterial.txt b/doc/files/setactormaterial.txt index 29ce970..b47119a 100644 --- a/doc/files/setactormaterial.txt +++ b/doc/files/setactormaterial.txt @@ -1,8 +1,9 @@ -#title setActorMaterial [RCBasic Doc] -#header sub setActorMaterial( actor, material_num, material_id) +#title SetActorMaterial [RCBasic Doc] +#header Sub SetActorMaterial( actor, material_num, material_id) Sets a material on an actor Note: Generally you just want to set material zero but actors can have multiple materials depending on the model format #ref GetActorMaterial + diff --git a/doc/files/setactormaterialflag.txt b/doc/files/setactormaterialflag.txt index 96ebeff..3ce37dd 100644 --- a/doc/files/setactormaterialflag.txt +++ b/doc/files/setactormaterialflag.txt @@ -1,5 +1,5 @@ -#title setActorMaterialFlag [RCBasic Doc] -#header sub setActorMaterialFlag( actor, flag, flag_value) +#title SetActorMaterialFlag [RCBasic Doc] +#header Sub SetActorMaterialFlag( actor, flag, flag_value) Sets the value of an actor's material flag. @@ -30,3 +30,4 @@ Possible values for flag: #/list #ref GetActorMaterialFlag GetActorMaterial + diff --git a/doc/files/setactormaterialtype.txt b/doc/files/setactormaterialtype.txt index d947537..0b70db1 100644 --- a/doc/files/setactormaterialtype.txt +++ b/doc/files/setactormaterialtype.txt @@ -1,5 +1,5 @@ -#title setActorMaterialType [RCBasic Doc] -#header sub setActorMaterialType( actor, material_type) +#title SetActorMaterialType [RCBasic Doc] +#header Sub SetActorMaterialType( actor, material_type) Sets the material type of an actor material @@ -46,3 +46,4 @@ Possible material types #/list #ref GetActorMaterialType GetActorMaterial + diff --git a/doc/files/setactormd2animation.txt b/doc/files/setactormd2animation.txt index b90d1fe..69d678a 100644 --- a/doc/files/setactormd2animation.txt +++ b/doc/files/setactormd2animation.txt @@ -1,5 +1,5 @@ #title SetActorMD2Animation [RCBasic Doc] -#header sub SetActorMD2Animation( actor, anim ) +#header Sub SetActorMD2Animation( actor, anim ) Sets the current animation for an *.md2 model @@ -29,3 +29,4 @@ Possible Animations #/list #ref SetActorMD2AnimationByName + diff --git a/doc/files/setactormd2animationbyname.txt b/doc/files/setactormd2animationbyname.txt index 46e598d..fd0b89b 100644 --- a/doc/files/setactormd2animationbyname.txt +++ b/doc/files/setactormd2animationbyname.txt @@ -1,7 +1,8 @@ #title SetActorMD2AnimationByName [RCBasic Doc] -#header sub SetActorMD2AnimationByName( actor, anim_name$ ) +#header Sub SetActorMD2AnimationByName( actor, anim_name$ ) Sets the current animation for an *.md2 model #ref SetActorMD2Animation + diff --git a/doc/files/setactorposition.txt b/doc/files/setactorposition.txt index 5ca46d9..3df2661 100644 --- a/doc/files/setactorposition.txt +++ b/doc/files/setactorposition.txt @@ -1,6 +1,7 @@ #title SetActorPosition [RCBasic Doc] -#header sub SetActorPosition( actor, x, y, z ) +#header Sub SetActorPosition( actor, x, y, z ) Sets the absolute position of an actor #ref TranslateActorLocal TranslateActorWorld GetActorPosition + diff --git a/doc/files/setactorrotation.txt b/doc/files/setactorrotation.txt index b0db8eb..c8fa85d 100644 --- a/doc/files/setactorrotation.txt +++ b/doc/files/setactorrotation.txt @@ -1,6 +1,7 @@ #title SetActorRotation [RCBasic Doc] -#header sub SetActorRotation( actor, x, y, z ) +#header Sub SetActorRotation( actor, x, y, z ) Sets the rotation of an actor around each axis #ref RotateActor GetActorRotation + diff --git a/doc/files/setactorscale.txt b/doc/files/setactorscale.txt index f76d172..fb7edd5 100644 --- a/doc/files/setactorscale.txt +++ b/doc/files/setactorscale.txt @@ -1,6 +1,7 @@ #title SetActorScale [RCBasic Doc] -#header sub SetActorScale( actor, x, y, z ) +#header Sub SetActorScale( actor, x, y, z ) Sets the scale of an actor #ref ScaleActor GetActorScale + diff --git a/doc/files/setactorshape.txt b/doc/files/setactorshape.txt index de7bffb..3dff83c 100644 --- a/doc/files/setactorshape.txt +++ b/doc/files/setactorshape.txt @@ -1,5 +1,5 @@ #title SetActorShape [RCBasic Doc] -#header sub SetActorShape( actor, shape_type, mass) +#header Sub SetActorShape( actor, shape_type, mass) Sets the shape of an actor @@ -13,6 +13,11 @@ Possible Actor Shapes #li ACTOR_SHAPE_CONE #li ACTOR_SHAPE_CONVEXHULL #li ACTOR_SHAPE_TRIMESH +#li ACTOR_SHAPE_COMPOSITE +#li ACTOR_SHAPE_IMPACT_MESH #/list -#ref GetActorShape +NOTE: ACTOR_SHAPE_COMPOSITE is not a shape you can set. It is a shape that is automatically set on composite actors. + +#ref SetActorShapeEx GetActorShape + diff --git a/doc/files/setactorshapeex.txt b/doc/files/setactorshapeex.txt index 87c68f2..9078660 100644 --- a/doc/files/setactorshapeex.txt +++ b/doc/files/setactorshapeex.txt @@ -1,6 +1,7 @@ #title SetActorShapeEx [RCBasic Doc] -#header sub SetActorShapeEx( actor, shape_type, mass, radius) +#header Sub SetActorShapeEx( actor, shape_type, mass, radius) Sets actor shape and radius for capsule, cone, and sphere shapes #ref SetActorShape + diff --git a/doc/files/setactorsleepstate.txt b/doc/files/setactorsleepstate.txt index 6fdf632..675a963 100644 --- a/doc/files/setactorsleepstate.txt +++ b/doc/files/setactorsleepstate.txt @@ -1,4 +1,5 @@ #title SetActorSleepState [RCBasic Doc] -#header sub SetActorSleepState(actor, state) +#header Sub SetActorSleepState(actor, state) + diff --git a/doc/files/setactorsleepthresholds.txt b/doc/files/setactorsleepthresholds.txt index d6d9fed..b098327 100644 --- a/doc/files/setactorsleepthresholds.txt +++ b/doc/files/setactorsleepthresholds.txt @@ -1,6 +1,7 @@ -#title setActorSleepThresholds [RCBasic Doc] -#header sub setActorSleepThresholds( actor, linear, angular) +#title SetActorSleepThresholds [RCBasic Doc] +#header Sub SetActorSleepThresholds( actor, linear, angular) Sets the linear and angular deactivation thresholds for an actor #ref GetActorLinearSleepThreshold GetActorAngularSleepThreshold + diff --git a/doc/files/setactorsolid.txt b/doc/files/setactorsolid.txt index b0d24c7..c52de8a 100644 --- a/doc/files/setactorsolid.txt +++ b/doc/files/setactorsolid.txt @@ -1,8 +1,9 @@ #title SetActorSolid [RCBasic Doc] -#header sub SetActorSolid(actor, flag) +#header Sub SetActorSolid(actor, flag) Sets whether an actor has physics and collision response applied to it Note: Collision detection will still work for non solid actors #ref ActorIsSolid + diff --git a/doc/files/setactortexture.txt b/doc/files/setactortexture.txt index d80baf8..f7dff68 100644 --- a/doc/files/setactortexture.txt +++ b/doc/files/setactortexture.txt @@ -1,6 +1,7 @@ -#title setActorTexture [RCBasic Doc] -#header sub setActorTexture( actor, layer, image_id) +#title SetActorTexture [RCBasic Doc] +#header Sub SetActorTexture( actor, layer, image_id) Sets the texture for an actor's default material Note: Generally you want to use texture layer 0 + diff --git a/doc/files/setactorvisible.txt b/doc/files/setactorvisible.txt index fb889ba..c5d4809 100644 --- a/doc/files/setactorvisible.txt +++ b/doc/files/setactorvisible.txt @@ -1,6 +1,7 @@ #title SetActorVisible [RCBasic Doc] -#header sub SetActorVisible( actor, flag ) +#header Sub SetActorVisible( actor, flag ) Sets whether the actor is visible in the scene #ref ActorIsVisible + diff --git a/doc/files/setantialiasmode.txt b/doc/files/setantialiasmode.txt index 7c4cf91..ed02d81 100644 --- a/doc/files/setantialiasmode.txt +++ b/doc/files/setantialiasmode.txt @@ -1,5 +1,5 @@ #title SetAntiAliasMode [RCBasic Doc] -#header sub SetAntiAliasMode( aa_mode ) +#header Sub SetAntiAliasMode( aa_mode ) Sets the anti-alias mode for draw image commands @@ -15,3 +15,4 @@ Possible modes #/list #ref GetAntiAliasMode + diff --git a/doc/files/setbilinearfilter.txt b/doc/files/setbilinearfilter.txt index 9722876..1f73d37 100644 --- a/doc/files/setbilinearfilter.txt +++ b/doc/files/setbilinearfilter.txt @@ -1,4 +1,5 @@ -#title setBilinearFilter [RCBasic Doc] -#header sub setBilinearFilter( flag ) +#title SetBilinearFilter [RCBasic Doc] +#header Sub SetBilinearFilter( flag ) Enables or disables the bilinear filter for drawing 2D images + diff --git a/doc/files/setbillboardsize.txt b/doc/files/setbillboardsize.txt new file mode 100644 index 0000000..2cb6e74 --- /dev/null +++ b/doc/files/setbillboardsize.txt @@ -0,0 +1,6 @@ +#title SetBillboardSize [RCBasic Doc] +#header Sub SetBillboardSize(actor, w, h) + +Sets the size of a billboard. + + diff --git a/doc/files/setblendmode.txt b/doc/files/setblendmode.txt index 66d69a8..09b8448 100644 --- a/doc/files/setblendmode.txt +++ b/doc/files/setblendmode.txt @@ -1,5 +1,5 @@ #title SetBlendMode [RCBasic Doc] -#header sub SetBlendMode( blend_mode ) +#header Sub SetBlendMode( blend_mode ) Sets the current blend mode @@ -21,3 +21,4 @@ Possible Blend Modes #ref SetBlendMode + diff --git a/doc/files/setcameraaspectratio.txt b/doc/files/setcameraaspectratio.txt index f18b53b..273a745 100644 --- a/doc/files/setcameraaspectratio.txt +++ b/doc/files/setcameraaspectratio.txt @@ -1,6 +1,7 @@ #title SetCameraAspectRatio [RCBasic Doc] -#header sub SetCameraAspectRatio( aspect ) +#header Sub SetCameraAspectRatio( aspect ) Sets the aspect ratio for the active canvas camera #ref GetCameraAspectRatio + diff --git a/doc/files/setcamerafarvalue.txt b/doc/files/setcamerafarvalue.txt index a8d0231..6551434 100644 --- a/doc/files/setcamerafarvalue.txt +++ b/doc/files/setcamerafarvalue.txt @@ -1,6 +1,7 @@ #title SetCameraFarValue [RCBasic Doc] -#header sub SetCameraFarValue( zf ) +#header Sub SetCameraFarValue( zf ) Sets the distance to the camera far plane #ref GetCameraFarValue + diff --git a/doc/files/setcamerafov.txt b/doc/files/setcamerafov.txt index 19caf7d..2873641 100644 --- a/doc/files/setcamerafov.txt +++ b/doc/files/setcamerafov.txt @@ -1,6 +1,7 @@ #title SetCameraFOV [RCBasic Doc] -#header sub SetCameraFOV( fov ) +#header Sub SetCameraFOV( fov ) Sets the camera's field of view #ref GetCameraFOV + diff --git a/doc/files/setcameranearvalue.txt b/doc/files/setcameranearvalue.txt index d70f896..592fdce 100644 --- a/doc/files/setcameranearvalue.txt +++ b/doc/files/setcameranearvalue.txt @@ -1,6 +1,7 @@ #title SetCameraNearValue [RCBasic Doc] -#header sub SetCameraNearValue( zn ) +#header Sub SetCameraNearValue( zn ) Sets the distance of the camera near plane #ref GetCameraNearValue + diff --git a/doc/files/setcameraposition.txt b/doc/files/setcameraposition.txt index 96eb8db..9e25209 100644 --- a/doc/files/setcameraposition.txt +++ b/doc/files/setcameraposition.txt @@ -1,6 +1,7 @@ #title SetCameraPosition [RCBasic Doc] -#header sub SetCameraPosition( x, y, z) +#header Sub SetCameraPosition( x, y, z) Sets the absolute position of the camera in the scene #ref TranslateCamera GetCameraPosition + diff --git a/doc/files/setcameraprojectionmatrix.txt b/doc/files/setcameraprojectionmatrix.txt deleted file mode 100644 index dd73637..0000000 --- a/doc/files/setcameraprojectionmatrix.txt +++ /dev/null @@ -1,12 +0,0 @@ -#title SetCameraProjectionMatrix [RCBasic Doc] -#header Sub SetCameraProjectionMatrix(matA, projection_type) - -Sets the camera projection matrix for the active canvas - -Possible values for projection_type -#list ul -#li PROJECTION_TYPE_ORTHOGRAPHIC -#li PROJECTION_TYPE_PERSPECTIVE -#/list - -#ref GetCameraProjectionMatrix diff --git a/doc/files/setcamerarotation.txt b/doc/files/setcamerarotation.txt index 9cbc9f3..2ac2c91 100644 --- a/doc/files/setcamerarotation.txt +++ b/doc/files/setcamerarotation.txt @@ -1,6 +1,7 @@ #title SetCameraRotation [RCBasic Doc] -#header sub SetCameraRotation( x, y, z) +#header Sub SetCameraRotation( x, y, z) Sets the rotation of the camera around each axis #ref RotateCamera GetCameraRotation + diff --git a/doc/files/setcanvasalpha.txt b/doc/files/setcanvasalpha.txt index 80b4aef..f4f9920 100644 --- a/doc/files/setcanvasalpha.txt +++ b/doc/files/setcanvasalpha.txt @@ -1,4 +1,5 @@ #title SetCanvasAlpha [RCBasic Doc] -#header sub SetCanvasAlpha(c_num, a) +#header Sub SetCanvasAlpha(c_num, a) Sets the alpha blending value for a canvas + diff --git a/doc/files/setcanvascolormod.txt b/doc/files/setcanvascolormod.txt index c03eaba..3e5ed48 100644 --- a/doc/files/setcanvascolormod.txt +++ b/doc/files/setcanvascolormod.txt @@ -1,4 +1,5 @@ #title SetCanvasColorMod [RCBasic Doc] -#header sub SetCanvasColorMod(c_num, c) +#header Sub SetCanvasColorMod(c_num, c) Sets the color modulation value for a canvas + diff --git a/doc/files/setcanvasoffset.txt b/doc/files/setcanvasoffset.txt index 57fa5fa..77bcec0 100644 --- a/doc/files/setcanvasoffset.txt +++ b/doc/files/setcanvasoffset.txt @@ -1,8 +1,9 @@ #title SetCanvasOffset [RCBasic Doc] -#header sub SetCanvasOffset(c_num, x, y) +#header Sub SetCanvasOffset(c_num, x, y) Sets the offset of a canvas The canvas offset is what part of the canvas is visible during rendering. #ref GetCanvasOffset + diff --git a/doc/files/setcanvasphysics2d.txt b/doc/files/setcanvasphysics2d.txt index 3396833..536b5bc 100644 --- a/doc/files/setcanvasphysics2d.txt +++ b/doc/files/setcanvasphysics2d.txt @@ -1,4 +1,5 @@ #title SetCanvasPhysics2D [RCBasic Doc] -#header sub SetCanvasPhysics2D(c_num, state) +#header Sub SetCanvasPhysics2D(c_num, state) + diff --git a/doc/files/setcanvasviewport.txt b/doc/files/setcanvasviewport.txt index 8b7afa6..1560d1e 100644 --- a/doc/files/setcanvasviewport.txt +++ b/doc/files/setcanvasviewport.txt @@ -1,7 +1,8 @@ #title SetCanvasViewport [RCBasic Doc] -#header sub SetCanvasViewport(cnum, x, y, w, h) +#header Sub SetCanvasViewport(cnum, x, y, w, h) Sets the position and size of a canvas viewport #ref GetCanvasViewport + diff --git a/doc/files/setcanvasvisible.txt b/doc/files/setcanvasvisible.txt index 7d88749..b1fd015 100644 --- a/doc/files/setcanvasvisible.txt +++ b/doc/files/setcanvasvisible.txt @@ -1,6 +1,7 @@ #title SetCanvasVisible [RCBasic Doc] -#header sub SetCanvasVisible(c_num, flag) +#header Sub SetCanvasVisible(c_num, flag) Sets whether a canvas is shown or not. #ref CanvasIsVisible + diff --git a/doc/files/setcanvasz.txt b/doc/files/setcanvasz.txt index 77d9ef4..f7f773a 100644 --- a/doc/files/setcanvasz.txt +++ b/doc/files/setcanvasz.txt @@ -1,8 +1,9 @@ #title SetCanvasZ [RCBasic Doc] -#header sub SetCanvasZ(c_num, z) +#header Sub SetCanvasZ(c_num, z) Sets the Canvas Z Order. Note: Canvases with a higher Z order are drawn first and those with lower values will be drawn on top #ref SetCanvasZ + diff --git a/doc/files/setchanneldistance.txt b/doc/files/setchanneldistance.txt index 1936dd3..9a3d6a6 100644 --- a/doc/files/setchanneldistance.txt +++ b/doc/files/setchanneldistance.txt @@ -1,6 +1,7 @@ #title SetChannelDistance [RCBasic Doc] -#header function SetChannelDistance(channel, dist_value) +#header Function SetChannelDistance(channel, dist_value) Set a volume adjustment effect due to distance. distance must be a value between 0 and 255. Returns 0 on error. NOTE: Setting distance to 0 will cancel the effect + diff --git a/doc/files/setchannelpanning.txt b/doc/files/setchannelpanning.txt index 64788b9..dae5474 100644 --- a/doc/files/setchannelpanning.txt +++ b/doc/files/setchannelpanning.txt @@ -1,7 +1,8 @@ #title SetChannelPanning [RCBasic Doc] -#header function SetChannelPanning(channel, left_value, right_value) +#header Function SetChannelPanning(channel, left_value, right_value) Set Panning effect for channel. left_value and right_value must be a value between 0 and 255. Returns 0 on error. NOTE: Setting both left and right to 255 will cancel the pan effect + diff --git a/doc/files/setchannelspaceposition.txt b/doc/files/setchannelspaceposition.txt index 670c73d..90a52de 100644 --- a/doc/files/setchannelspaceposition.txt +++ b/doc/files/setchannelspaceposition.txt @@ -1,8 +1,9 @@ #title SetChannelSpacePosition [RCBasic Doc] -#header function SetChannelSpacePosition(channel, angle, distance) +#header Function SetChannelSpacePosition(channel, angle, distance) Simulates audio in 3D space Angle 0 is in front of the listener and increases clockwise #ref SetChannelDistance SetChannelPanning + diff --git a/doc/files/setchannelvolume.txt b/doc/files/setchannelvolume.txt index 98670a2..9fc0fb1 100644 --- a/doc/files/setchannelvolume.txt +++ b/doc/files/setchannelvolume.txt @@ -1,4 +1,5 @@ #title SetChannelVolume [RCBasic Doc] -#header sub SetChannelVolume(channel, vol) +#header Sub SetChannelVolume(channel, vol) Sets the volume of the audio on a channel + diff --git a/doc/files/setclearcolor.txt b/doc/files/setclearcolor.txt index aa84c34..a40e3a2 100644 --- a/doc/files/setclearcolor.txt +++ b/doc/files/setclearcolor.txt @@ -1,6 +1,7 @@ #title SetClearColor [RCBasic Doc] -#header sub SetClearColor(c) +#header Sub SetClearColor(c) Sets the color that a canvas is cleared to on ClearCanvas() #ref ClearCanvas + diff --git a/doc/files/setclipboardtext.txt b/doc/files/setclipboardtext.txt index 2a338f1..4707dbb 100644 --- a/doc/files/setclipboardtext.txt +++ b/doc/files/setclipboardtext.txt @@ -1,4 +1,5 @@ #title SetClipboardText [RCBasic Doc] -#header sub SetClipboardText(txt$) +#header Sub SetClipboardText(txt$) Sets the clipboard text. + diff --git a/doc/files/setcolor.txt b/doc/files/setcolor.txt index 0896c08..46cd6fa 100644 --- a/doc/files/setcolor.txt +++ b/doc/files/setcolor.txt @@ -1,4 +1,5 @@ #title SetColor [RCBasic Doc] -#header sub SetColor(c) +#header Sub SetColor(c) Sets the current draw color + diff --git a/doc/files/setconedamping.txt b/doc/files/setconedamping.txt index 81032dd..a35af1c 100644 --- a/doc/files/setconedamping.txt +++ b/doc/files/setconedamping.txt @@ -1,4 +1,5 @@ -#title setConeDamping [RCBasic Doc] -#header sub setConeDamping( constraint_id, damping) +#title SetConeDamping [RCBasic Doc] +#header Sub SetConeDamping( constraint_id, damping) Returns the damping factor applied to the constraint. Damping is used to reduce the amount of oscillation or unwanted movement (such as excessive rotation or swinging) around the constrained actor's axes. + diff --git a/doc/files/setconefixthresh.txt b/doc/files/setconefixthresh.txt index 5b6a06a..9759f8f 100644 --- a/doc/files/setconefixthresh.txt +++ b/doc/files/setconefixthresh.txt @@ -1,5 +1,5 @@ -#title setConeFixThresh [RCBasic Doc] -#header sub setConeFixThresh( constraint_id, fixThresh) +#title SetConeFixThresh [RCBasic Doc] +#header Sub SetConeFixThresh( constraint_id, fixThresh) Sets the fix threshold value associated with that constraint. This threshold is used to control how the constraint behaves when the angle of the rotation between the actors approaches the limits defined by the cone twist constraint. @@ -7,3 +7,4 @@ The fix threshold defines a limit or tolerance for how closely the angle between #ref GetConeFixThresh + diff --git a/doc/files/setconelimit.txt b/doc/files/setconelimit.txt index 74ee324..8eb6662 100644 --- a/doc/files/setconelimit.txt +++ b/doc/files/setconelimit.txt @@ -1,5 +1,5 @@ -#title setConeLimit [RCBasic Doc] -#header sub setConeLimit( constraint_id, swingSpan1, swingSpan2, twistSpan, softness, bias_factor, relaxation_factor) +#title SetConeLimit [RCBasic Doc] +#header Sub SetConeLimit( constraint_id, swingSpan1, swingSpan2, twistSpan, softness, bias_factor, relaxation_factor) Sets the angular limits for the rotation of the constrained actors. These limits specify how much twisting and swinging is permitted between the two actors connected by the constraint, ensuring the motion stays within a desired range. @@ -10,3 +10,4 @@ Sets the angular limits for the rotation of the constrained actors. These limits Relaxation Factor: This affects how fast the constraint will "relax" after reaching its limit, allowing it to stabilize after hitting the constraint. #ref GetConeLimit + diff --git a/doc/files/setconstraintangularonly.txt b/doc/files/setconstraintangularonly.txt index 9ba0fae..c651398 100644 --- a/doc/files/setconstraintangularonly.txt +++ b/doc/files/setconstraintangularonly.txt @@ -1,6 +1,7 @@ -#title setConstraintAngularOnly [RCBasic Doc] -#header sub setConstraintAngularOnly( constraint_id, flag) +#title SetConstraintAngularOnly [RCBasic Doc] +#header Sub SetConstraintAngularOnly( constraint_id, flag) Sets the hinge constraint to limit only angular motion while allowing unrestricted linear (translational) motion. #ref GetConstraintAngularOnly + diff --git a/doc/files/setconstraintbreakingimpulsethreshold.txt b/doc/files/setconstraintbreakingimpulsethreshold.txt index a546aa4..b13b6c9 100644 --- a/doc/files/setconstraintbreakingimpulsethreshold.txt +++ b/doc/files/setconstraintbreakingimpulsethreshold.txt @@ -1,7 +1,8 @@ -#title setConstraintBreakingImpulseThreshold [RCBasic Doc] -#header sub setConstraintBreakingImpulseThreshold( constraint_id, threshold) +#title SetConstraintBreakingImpulseThreshold [RCBasic Doc] +#header Sub SetConstraintBreakingImpulseThreshold( constraint_id, threshold) Sets the breaking impulse threshold for a given constraint. The breaking impulse threshold defines the maximum force (impulse) a constraint can withstand before it "breaks," meaning that the constraint will be deactivated and no longer enforce its rules. #ref GetConstraintBreakingImpulseThreshold + diff --git a/doc/files/setconstraintframes.txt b/doc/files/setconstraintframes.txt index 0a260b4..93dfae1 100644 --- a/doc/files/setconstraintframes.txt +++ b/doc/files/setconstraintframes.txt @@ -1,6 +1,7 @@ -#title setConstraintFrames [RCBasic Doc] -#header sub setConstraintFrames( constraint_id, frameA_matrix, frameB_matrix) +#title SetConstraintFrames [RCBasic Doc] +#header Sub SetConstraintFrames( constraint_id, frameA_matrix, frameB_matrix) Defines the reference frames for the constraint. This function establishes how the constraint is oriented in the local coordinate systems of the connected actors. The reference frames define the orientation and position of the constraint relative to each of the connected actors. Each actor can have its own local coordinate system, and the frames help establish how the constraint interacts with these systems. + diff --git a/doc/files/setconstraintsolveriterations.txt b/doc/files/setconstraintsolveriterations.txt index b714f72..f2ac595 100644 --- a/doc/files/setconstraintsolveriterations.txt +++ b/doc/files/setconstraintsolveriterations.txt @@ -1,4 +1,5 @@ -#title setConstraintSolverIterations [RCBasic Doc] -#header sub setConstraintSolverIterations( constraint_id, num) +#title SetConstraintSolverIterations [RCBasic Doc] +#header Sub SetConstraintSolverIterations( constraint_id, num) Sets the value for the number of solver iterations that have been overridden for a specific constraint or actor. Solver iterations refer to the number of times the physics engine solves for constraint forces during each simulation step. + diff --git a/doc/files/setenv.txt b/doc/files/setenv.txt index 7c62e28..9415f0f 100644 --- a/doc/files/setenv.txt +++ b/doc/files/setenv.txt @@ -1,6 +1,7 @@ #title SetEnv [RCBasic Doc] -#header sub SetEnv(var$, value$) +#header Sub SetEnv(var$, value$) Sets the value of an environment variable #ref Env$ + diff --git a/doc/files/setfont.txt b/doc/files/setfont.txt index 19fcfb9..6e157b6 100644 --- a/doc/files/setfont.txt +++ b/doc/files/setfont.txt @@ -1,6 +1,7 @@ #title SetFont [RCBasic Doc] -#header sub SetFont(fnt_id) +#header Sub SetFont(fnt_id) Sets the active font for text rendering #ref DrawText + diff --git a/doc/files/setfps.txt b/doc/files/setfps.txt index 7ff289e..fc2b15d 100644 --- a/doc/files/setfps.txt +++ b/doc/files/setfps.txt @@ -2,3 +2,4 @@ #header Sub SetFPS(fps_val) + diff --git a/doc/files/setgravity2d.txt b/doc/files/setgravity2d.txt index c3a667d..0ef216a 100644 --- a/doc/files/setgravity2d.txt +++ b/doc/files/setgravity2d.txt @@ -1,6 +1,7 @@ #title SetGravity2D [RCBasic Doc] -#header sub SetGravity2D(x, y) +#header Sub SetGravity2D(x, y) Use this function for setting the global gravity vector. A sprite canvas layer must be active. #ref GetGravity2D + diff --git a/doc/files/setgravity3d.txt b/doc/files/setgravity3d.txt index ea6372b..c2876d9 100644 --- a/doc/files/setgravity3d.txt +++ b/doc/files/setgravity3d.txt @@ -1,4 +1,5 @@ #title SetGravity3D [RCBasic Doc] -#header sub SetGravity3D(x, y, z) +#header Sub SetGravity3D(x, y, z) Sets the world gravity + diff --git a/doc/files/sethingeaxis.txt b/doc/files/sethingeaxis.txt index ae9a408..0b00777 100644 --- a/doc/files/sethingeaxis.txt +++ b/doc/files/sethingeaxis.txt @@ -1,7 +1,8 @@ -#title setHingeAxis [RCBasic Doc] -#header sub setHingeAxis( constraint_id, x, y, z) +#title SetHingeAxis [RCBasic Doc] +#header Sub SetHingeAxis( constraint_id, x, y, z) Defines the axis of rotation around which the hinge constraint allows the connected actors to rotate. This function is essential for establishing how the two actors will interact in terms of rotational motion. The axis of rotation defines the direction in which the hinge can rotate. For example, if you want a door to swing open, you would set the axis to be perpendicular to the plane of the door and aligned with the hinge line. + diff --git a/doc/files/sethingelimit.txt b/doc/files/sethingelimit.txt index ac0c24f..dbcf5ba 100644 --- a/doc/files/sethingelimit.txt +++ b/doc/files/sethingelimit.txt @@ -1,5 +1,5 @@ -#title setHingeLimit [RCBasic Doc] -#header sub setHingeLimit( constraint_id, low, high, softness, bias_factor, relaxation_factor) +#title SetHingeLimit [RCBasic Doc] +#header Sub SetHingeLimit( constraint_id, low, high, softness, bias_factor, relaxation_factor) Defines the angular limits of the hinge's rotation. A hinge constraint allows two actors (or one actor and the world) to rotate around a single axis, similar to a door hinge. This function restricts how far this rotation can go by setting minimum and maximum angles. @@ -14,3 +14,4 @@ By default, if no limits are applied, the hinge can rotate freely around the axi #/list #ref GetHingeLimitBiasFactor GetHingeLimitRelaxationFactor GetHingeLimitSign GetHingeSolveLimit + diff --git a/doc/files/setidentitymatrix.txt b/doc/files/setidentitymatrix.txt index c6b8898..071eef6 100644 --- a/doc/files/setidentitymatrix.txt +++ b/doc/files/setidentitymatrix.txt @@ -1,6 +1,7 @@ #title SetIdentityMatrix [RCBasic Doc] -#header sub SetIdentityMatrix(mA, n) +#header Sub SetIdentityMatrix(mA, n) Sets matrix mA to an identity matrix of n rows and n columns. For most transform operations (ie. translate, rotate, and scale) it is recommended to start from and identity matrix + diff --git a/doc/files/setimagealpha.txt b/doc/files/setimagealpha.txt index e147dc8..b7da269 100644 --- a/doc/files/setimagealpha.txt +++ b/doc/files/setimagealpha.txt @@ -1,6 +1,7 @@ #title SetImageAlpha [RCBasic Doc] -#header sub SetImageAlpha(slot, a) +#header Sub SetImageAlpha(slot, a) Sets the alpha blending value for an image. This value only applies in 2D drawing commands. #ref GetImageAlpha + diff --git a/doc/files/setimagecolormod.txt b/doc/files/setimagecolormod.txt index 3bdeb4a..5ca9988 100644 --- a/doc/files/setimagecolormod.txt +++ b/doc/files/setimagecolormod.txt @@ -1,4 +1,5 @@ #title SetImageColorMod [RCBasic Doc] -#header sub SetImageColorMod(img_id, c) +#header Sub SetImageColorMod(img_id, c) Sets the color modulation vlaue for an image + diff --git a/doc/files/setjointangularoffset.txt b/doc/files/setjointangularoffset.txt index 3526c80..a06fa99 100644 --- a/doc/files/setjointangularoffset.txt +++ b/doc/files/setjointangularoffset.txt @@ -1,8 +1,9 @@ -#title setJointAngularOffset [RCBasic Doc] -#header sub setJointAngularOffset( joint_id, angleOffset) +#title SetJointAngularOffset [RCBasic Doc] +#header Sub SetJointAngularOffset( joint_id, angleOffset) Set the target angular offset Used with Motor Joint #ref GetJointAngularOffset + diff --git a/doc/files/setjointcorrectionfactor.txt b/doc/files/setjointcorrectionfactor.txt index acc09d6..fd2ccd0 100644 --- a/doc/files/setjointcorrectionfactor.txt +++ b/doc/files/setjointcorrectionfactor.txt @@ -1,8 +1,9 @@ -#title setJointCorrectionFactor [RCBasic Doc] -#header sub setJointCorrectionFactor( joint_id, factor) +#title SetJointCorrectionFactor [RCBasic Doc] +#header Sub SetJointCorrectionFactor( joint_id, factor) Sets how quickly the joint corrects deviations from its target position and rotation. This correction factor determines the responsiveness of the motor joint in achieving the desired linear and angular offsets between two connected bodies. Used with Motor Joints #ref GetJointCorrectionFactor + diff --git a/doc/files/setjointdamping.txt b/doc/files/setjointdamping.txt index 1c72164..1f07dd2 100644 --- a/doc/files/setjointdamping.txt +++ b/doc/files/setjointdamping.txt @@ -1,5 +1,5 @@ -#title setJointDamping [RCBasic Doc] -#header sub setJointDamping( joint_id, damping) +#title SetJointDamping [RCBasic Doc] +#header Sub SetJointDamping( joint_id, damping) Sets the damping value for a joint @@ -11,3 +11,4 @@ Used with #/list #ref GetJointDamping + diff --git a/doc/files/setjointlength.txt b/doc/files/setjointlength.txt index fcffa10..b8ba032 100644 --- a/doc/files/setjointlength.txt +++ b/doc/files/setjointlength.txt @@ -1,8 +1,9 @@ -#title setJointLength [RCBasic Doc] -#header sub setJointLength( joint_id, jlen) +#title SetJointLength [RCBasic Doc] +#header Sub SetJointLength( joint_id, jlen) Set the fixed distance between two connected bodies. This distance acts as a "target length" that the joint will try to maintain, applying forces to keep the bodies at that separation. Used with distance Joints #ref GetJointLength + diff --git a/doc/files/setjointlimits.txt b/doc/files/setjointlimits.txt index 5abb74a..87d0822 100644 --- a/doc/files/setjointlimits.txt +++ b/doc/files/setjointlimits.txt @@ -1,5 +1,5 @@ -#title setJointLimits [RCBasic Doc] -#header sub setJointLimits( joint_id, lower_limit, upper_limit) +#title SetJointLimits [RCBasic Doc] +#header Sub SetJointLimits( joint_id, lower_limit, upper_limit) Sets the minimum and maximum limits, restricting how far or how much rotation the connected bodies can move relative to each other. @@ -11,3 +11,4 @@ Used with #/list #ref GetJointLowerLimit GetJointUpperLimit + diff --git a/doc/files/setjointlinearoffset.txt b/doc/files/setjointlinearoffset.txt index 876b534..bed67e9 100644 --- a/doc/files/setjointlinearoffset.txt +++ b/doc/files/setjointlinearoffset.txt @@ -1,8 +1,9 @@ -#title setJointLinearOffset [RCBasic Doc] -#header sub setJointLinearOffset( joint_id, x, y) +#title SetJointLinearOffset [RCBasic Doc] +#header Sub SetJointLinearOffset( joint_id, x, y) Specify a target position offset for the connected bodies relative to each other. Used with Motor Joints #ref GetJointLinearOffset + diff --git a/doc/files/setjointmaxforce.txt b/doc/files/setjointmaxforce.txt index c19b8fd..948650f 100644 --- a/doc/files/setjointmaxforce.txt +++ b/doc/files/setjointmaxforce.txt @@ -1,5 +1,5 @@ -#title setJointMaxForce [RCBasic Doc] -#header sub setJointMaxForce( joint_id, force) +#title SetJointMaxForce [RCBasic Doc] +#header Sub SetJointMaxForce( joint_id, force) Sets an upper limit on the amount of force the joint can apply to the connected bodies, helping to control how much resistance or power the joint provides. @@ -8,3 +8,4 @@ Used with #li Motor Joint #li Friction Joint #/list + diff --git a/doc/files/setjointmaxlength.txt b/doc/files/setjointmaxlength.txt index 5abf701..24125b0 100644 --- a/doc/files/setjointmaxlength.txt +++ b/doc/files/setjointmaxlength.txt @@ -1,8 +1,9 @@ -#title setJointMaxLength [RCBasic Doc] -#header sub setJointMaxLength( joint_id, jlen) +#title SetJointMaxLength [RCBasic Doc] +#header Sub SetJointMaxLength( joint_id, jlen) Set the maximum allowable length between two connected bodies Used with Distance Joint #ref SetJointMinLength + diff --git a/doc/files/setjointmaxmotorforce.txt b/doc/files/setjointmaxmotorforce.txt index 806e70c..fc56ed0 100644 --- a/doc/files/setjointmaxmotorforce.txt +++ b/doc/files/setjointmaxmotorforce.txt @@ -1,8 +1,9 @@ -#title setJointMaxMotorForce [RCBasic Doc] -#header sub setJointMaxMotorForce( joint_id, force) +#title SetJointMaxMotorForce [RCBasic Doc] +#header Sub SetJointMaxMotorForce( joint_id, force) Limits the maximum linear force that the motor can apply to achieve the target speed set by SetMotorSpeed. This allows you to control the power or strength of the motor along the joint’s axis. Used with Prismatic Joints #ref GetJointMaxMotorForce + diff --git a/doc/files/setjointmaxmotortorque.txt b/doc/files/setjointmaxmotortorque.txt index 37923dd..d09b186 100644 --- a/doc/files/setjointmaxmotortorque.txt +++ b/doc/files/setjointmaxmotortorque.txt @@ -1,5 +1,5 @@ -#title setJointMaxMotorTorque [RCBasic Doc] -#header sub setJointMaxMotorTorque( joint_id, torque) +#title SetJointMaxMotorTorque [RCBasic Doc] +#header Sub SetJointMaxMotorTorque( joint_id, torque) Limits the maximum torque (rotational force) that the motor can apply to achieve the target motor speed set by SetMotorSpeed. This allows you to control how much power the motorized joint has. @@ -10,3 +10,4 @@ Used with #/list #ref GetJointMaxMotorTorque + diff --git a/doc/files/setjointmaxtorque.txt b/doc/files/setjointmaxtorque.txt index c071c7b..9fada4e 100644 --- a/doc/files/setjointmaxtorque.txt +++ b/doc/files/setjointmaxtorque.txt @@ -1,5 +1,5 @@ -#title setJointMaxTorque [RCBasic Doc] -#header sub setJointMaxTorque( joint_id, torque) +#title SetJointMaxTorque [RCBasic Doc] +#header Sub SetJointMaxTorque( joint_id, torque) Sets an upper limit on the amount of torque (rotational force) the joint can apply, controlling how much rotational resistance or power the joint provides. @@ -10,3 +10,4 @@ Used with #/list #ref GetJointMaxTorque + diff --git a/doc/files/setjointminlength.txt b/doc/files/setjointminlength.txt index 7ea77e7..e343a05 100644 --- a/doc/files/setjointminlength.txt +++ b/doc/files/setjointminlength.txt @@ -1,8 +1,9 @@ -#title setJointMinLength [RCBasic Doc] -#header sub setJointMinLength( joint_id, jlen) +#title SetJointMinLength [RCBasic Doc] +#header Sub SetJointMinLength( joint_id, jlen) Set the minimum allowable length between two connected bodies Used with Distance Joint #ref SetJointMaxLength + diff --git a/doc/files/setjointmotorspeed.txt b/doc/files/setjointmotorspeed.txt index 7ddbc14..3439fb9 100644 --- a/doc/files/setjointmotorspeed.txt +++ b/doc/files/setjointmotorspeed.txt @@ -1,5 +1,5 @@ -#title setJointMotorSpeed [RCBasic Doc] -#header sub setJointMotorSpeed( joint_id, speed) +#title SetJointMotorSpeed [RCBasic Doc] +#header Sub SetJointMotorSpeed( joint_id, speed) Used on joints that support motors, such as revolute joints and prismatic joints, to control the speed at which the motor applies force to achieve movement. @@ -11,3 +11,4 @@ Used with #/list #ref GetJointMotorSpeed + diff --git a/doc/files/setjointorigin.txt b/doc/files/setjointorigin.txt index ed28eb7..8901929 100644 --- a/doc/files/setjointorigin.txt +++ b/doc/files/setjointorigin.txt @@ -1,6 +1,7 @@ -#title setJointOrigin [RCBasic Doc] -#header sub setJointOrigin( joint_id, x, y) +#title SetJointOrigin [RCBasic Doc] +#header Sub SetJointOrigin( joint_id, x, y) Shift the world origin. This is particularly useful in large simulations where objects might move far from the initial origin, potentially causing precision issues in floating-point calculations. Used with Pulley Joint + diff --git a/doc/files/setjointratio.txt b/doc/files/setjointratio.txt index 449f53c..7c2c737 100644 --- a/doc/files/setjointratio.txt +++ b/doc/files/setjointratio.txt @@ -1,8 +1,9 @@ -#title setJointRatio [RCBasic Doc] -#header sub setJointRatio( joint_id, j_ratio) +#title SetJointRatio [RCBasic Doc] +#header Sub SetJointRatio( joint_id, j_ratio) Determines how much one joint’s movement affects the other, enabling complex, synchronized motion. Used with Gear Joints #ref GetJointRatio + diff --git a/doc/files/setjointstiffness.txt b/doc/files/setjointstiffness.txt index 58cbdd3..36f40a6 100644 --- a/doc/files/setjointstiffness.txt +++ b/doc/files/setjointstiffness.txt @@ -1,5 +1,5 @@ -#title setJointStiffness [RCBasic Doc] -#header sub setJointStiffness( joint_id, stiffness) +#title SetJointStiffness [RCBasic Doc] +#header Sub SetJointStiffness( joint_id, stiffness) Sets how rigid a joint is @@ -11,3 +11,4 @@ Used with: #/list #ref GetJointStiffness + diff --git a/doc/files/setlightambientcolor.txt b/doc/files/setlightambientcolor.txt index ea60d05..4d95beb 100644 --- a/doc/files/setlightambientcolor.txt +++ b/doc/files/setlightambientcolor.txt @@ -1,4 +1,5 @@ #title SetLightAmbientColor [RCBasic Doc] -#header sub SetLightAmbientColor( actor, color ) +#header Sub SetLightAmbientColor( actor, color ) Sets the ambient color for a light + diff --git a/doc/files/setlightattenuation.txt b/doc/files/setlightattenuation.txt index 5c1f9ba..51be436 100644 --- a/doc/files/setlightattenuation.txt +++ b/doc/files/setlightattenuation.txt @@ -1,4 +1,5 @@ #title SetLightAttenuation [RCBasic Doc] -#header sub SetLightAttenuation( actor, l_constant, l_linear, l_quadratic ) +#header Sub SetLightAttenuation( actor, l_constant, l_linear, l_quadratic ) Sets the light strength fading over distance. Overrident by setting radius. + diff --git a/doc/files/setlightdiffusecolor.txt b/doc/files/setlightdiffusecolor.txt index cf3ab36..7ec91b1 100644 --- a/doc/files/setlightdiffusecolor.txt +++ b/doc/files/setlightdiffusecolor.txt @@ -1,4 +1,5 @@ #title SetLightDiffuseColor [RCBasic Doc] -#header sub SetLightDiffuseColor( actor, color ) +#header Sub SetLightDiffuseColor( actor, color ) Sets a light's diffuse color + diff --git a/doc/files/setlightfalloff.txt b/doc/files/setlightfalloff.txt index 3a1c116..51d266c 100644 --- a/doc/files/setlightfalloff.txt +++ b/doc/files/setlightfalloff.txt @@ -1,6 +1,7 @@ #title SetLightFalloff [RCBasic Doc] -#header sub SetLightFalloff( actor, falloff ) +#header Sub SetLightFalloff( actor, falloff ) Sets the strength decrease between the inner and outer cone of a light Note: Only applies to spot lights + diff --git a/doc/files/setlightinnercone.txt b/doc/files/setlightinnercone.txt index a00f77e..ef059da 100644 --- a/doc/files/setlightinnercone.txt +++ b/doc/files/setlightinnercone.txt @@ -1,4 +1,5 @@ #title SetLightInnerCone [RCBasic Doc] -#header sub SetLightInnerCone( actor, angle ) +#header Sub SetLightInnerCone( actor, angle ) Sets the inner cone of a spot light + diff --git a/doc/files/setlightoutercone.txt b/doc/files/setlightoutercone.txt index efbe80c..bfb2874 100644 --- a/doc/files/setlightoutercone.txt +++ b/doc/files/setlightoutercone.txt @@ -1,5 +1,6 @@ #title SetLightOuterCone [RCBasic Doc] -#header sub SetLightOuterCone( actor, angle) +#header Sub SetLightOuterCone( actor, angle) Sets the outer cone of a spot light + diff --git a/doc/files/setlightradius.txt b/doc/files/setlightradius.txt index df66c2c..ffd5b32 100644 --- a/doc/files/setlightradius.txt +++ b/doc/files/setlightradius.txt @@ -1,6 +1,7 @@ #title SetLightRadius [RCBasic Doc] -#header sub SetLightRadius( actor, radius ) +#header Sub SetLightRadius( actor, radius ) Sets the radius of a light #ref GetLightRadius + diff --git a/doc/files/setlightshadowcast.txt b/doc/files/setlightshadowcast.txt index 78fc4ab..b8571ac 100644 --- a/doc/files/setlightshadowcast.txt +++ b/doc/files/setlightshadowcast.txt @@ -1,6 +1,7 @@ -#title setLightShadowCast [RCBasic Doc] -#header sub setLightShadowCast( actor, flag ) +#title SetLightShadowCast [RCBasic Doc] +#header Sub SetLightShadowCast( actor, flag ) Sets whether a light will cast shadows on actors that have shadows enabled #ref AddActorShadow + diff --git a/doc/files/setlightspecularcolor.txt b/doc/files/setlightspecularcolor.txt index 2c4f4ff..e6f02b0 100644 --- a/doc/files/setlightspecularcolor.txt +++ b/doc/files/setlightspecularcolor.txt @@ -1,4 +1,5 @@ #title SetLightSpecularColor [RCBasic Doc] -#header sub SetLightSpecularColor( actor, color ) +#header Sub SetLightSpecularColor( actor, color ) Sets the specular color of a light + diff --git a/doc/files/setlighttype.txt b/doc/files/setlighttype.txt index 2cf10be..543971e 100644 --- a/doc/files/setlighttype.txt +++ b/doc/files/setlighttype.txt @@ -1,5 +1,5 @@ -#title setLightType [RCBasic Doc] -#header sub setLightType( actor, light_type ) +#title SetLightType [RCBasic Doc] +#header Sub SetLightType( actor, light_type ) Sets the type of light @@ -12,3 +12,4 @@ Possible Light Types #ref SetLightType + diff --git a/doc/files/setmaterialambientcolor.txt b/doc/files/setmaterialambientcolor.txt index d1bd02f..d8e71a6 100644 --- a/doc/files/setmaterialambientcolor.txt +++ b/doc/files/setmaterialambientcolor.txt @@ -1,4 +1,5 @@ -#title setMaterialAmbientColor [RCBasic Doc] -#header sub setMaterialAmbientColor( material_id, color) +#title SetMaterialAmbientColor [RCBasic Doc] +#header Sub SetMaterialAmbientColor( material_id, color) Sets the ambient color of a material + diff --git a/doc/files/setmaterialantialiasing.txt b/doc/files/setmaterialantialiasing.txt index d33fb3a..2d6d4d9 100644 --- a/doc/files/setmaterialantialiasing.txt +++ b/doc/files/setmaterialantialiasing.txt @@ -1,5 +1,5 @@ -#title setMaterialAntiAliasing [RCBasic Doc] -#header sub setMaterialAntiAliasing( material_id, aa) +#title SetMaterialAntiAliasing [RCBasic Doc] +#header Sub SetMaterialAntiAliasing( material_id, aa) Sets the anti-aliasing mode for the material @@ -15,3 +15,4 @@ Possible modes returned #/list #ref GetMaterialAntiAliasing + diff --git a/doc/files/setmaterialbackfaceculling.txt b/doc/files/setmaterialbackfaceculling.txt index 5d4e682..3bf217b 100644 --- a/doc/files/setmaterialbackfaceculling.txt +++ b/doc/files/setmaterialbackfaceculling.txt @@ -1,6 +1,7 @@ -#title setMaterialBackfaceCulling [RCBasic Doc] -#header sub setMaterialBackfaceCulling( material_id, flag) +#title SetMaterialBackfaceCulling [RCBasic Doc] +#header Sub SetMaterialBackfaceCulling( material_id, flag) Enables or disables material backface culling #ref GetMaterialBackfaceCulling + diff --git a/doc/files/setmaterialblendfactor.txt b/doc/files/setmaterialblendfactor.txt index 78dc552..82bd24e 100644 --- a/doc/files/setmaterialblendfactor.txt +++ b/doc/files/setmaterialblendfactor.txt @@ -1,6 +1,7 @@ -#title setMaterialBlendFactor [RCBasic Doc] -#header sub setMaterialBlendFactor( material_id, bf) +#title SetMaterialBlendFactor [RCBasic Doc] +#header Sub SetMaterialBlendFactor( material_id, bf) Sets the blend factor for a material + diff --git a/doc/files/setmaterialblendmode.txt b/doc/files/setmaterialblendmode.txt index 15f7c6c..f970b03 100644 --- a/doc/files/setmaterialblendmode.txt +++ b/doc/files/setmaterialblendmode.txt @@ -1,5 +1,5 @@ -#title setMaterialBlendMode [RCBasic Doc] -#header sub setMaterialBlendMode( material_id, blend_mode) +#title SetMaterialBlendMode [RCBasic Doc] +#header Sub SetMaterialBlendMode( material_id, blend_mode) Sets a material's blend mode @@ -19,3 +19,4 @@ Possible Blend Modes #ref SetMaterialBlendMode + diff --git a/doc/files/setmaterialcolormask.txt b/doc/files/setmaterialcolormask.txt index 9192bb0..3304b84 100644 --- a/doc/files/setmaterialcolormask.txt +++ b/doc/files/setmaterialcolormask.txt @@ -1,6 +1,7 @@ -#title setMaterialColorMask [RCBasic Doc] -#header sub setMaterialColorMask( material_id, color_mask) +#title SetMaterialColorMask [RCBasic Doc] +#header Sub SetMaterialColorMask( material_id, color_mask) Sets a color mask for a material #ref GetMaterialColorMask + diff --git a/doc/files/setmaterialcolormode.txt b/doc/files/setmaterialcolormode.txt index 689374e..8905d31 100644 --- a/doc/files/setmaterialcolormode.txt +++ b/doc/files/setmaterialcolormode.txt @@ -1,5 +1,5 @@ -#title setMaterialColorMode [RCBasic Doc] -#header sub setMaterialColorMode( material_id, color_mode) +#title SetMaterialColorMode [RCBasic Doc] +#header Sub SetMaterialColorMode( material_id, color_mode) Sets the color mode of a material @@ -14,3 +14,4 @@ Possible modes #/list #ref GetMaterialColorMode + diff --git a/doc/files/setmaterialconstant.txt b/doc/files/setmaterialconstant.txt index 3060eee..5d7541c 100644 --- a/doc/files/setmaterialconstant.txt +++ b/doc/files/setmaterialconstant.txt @@ -114,3 +114,4 @@ Possible Constants #ref GetMaterialConstant + diff --git a/doc/files/setmaterialdiffusecolor.txt b/doc/files/setmaterialdiffusecolor.txt index fa00546..1b4a22e 100644 --- a/doc/files/setmaterialdiffusecolor.txt +++ b/doc/files/setmaterialdiffusecolor.txt @@ -1,4 +1,5 @@ -#title setMaterialDiffuseColor [RCBasic Doc] -#header sub setMaterialDiffuseColor( material_id, color) +#title SetMaterialDiffuseColor [RCBasic Doc] +#header Sub SetMaterialDiffuseColor( material_id, color) Set's a material's diffuse color + diff --git a/doc/files/setmaterialemissivecolor.txt b/doc/files/setmaterialemissivecolor.txt index ce348a8..3c86708 100644 --- a/doc/files/setmaterialemissivecolor.txt +++ b/doc/files/setmaterialemissivecolor.txt @@ -1,4 +1,5 @@ -#title setMaterialEmissiveColor [RCBasic Doc] -#header sub setMaterialEmissiveColor( material_id, color) +#title SetMaterialEmissiveColor [RCBasic Doc] +#header Sub SetMaterialEmissiveColor( material_id, color) Set's a material's emissive color + diff --git a/doc/files/setmaterialflag.txt b/doc/files/setmaterialflag.txt index 197b44b..55a5a70 100644 --- a/doc/files/setmaterialflag.txt +++ b/doc/files/setmaterialflag.txt @@ -1,5 +1,5 @@ -#title setMaterialFlag [RCBasic Doc] -#header sub setMaterialFlag( material_id, material_flag, f_value) +#title SetMaterialFlag [RCBasic Doc] +#header Sub SetMaterialFlag( material_id, material_flag, f_value) Sets the value of the specified material flag @@ -28,3 +28,4 @@ Possible values for flag: #/list #ref GetMaterialFlag GetActorMaterialFlag + diff --git a/doc/files/setmaterialfog.txt b/doc/files/setmaterialfog.txt index c829adb..2ff5f24 100644 --- a/doc/files/setmaterialfog.txt +++ b/doc/files/setmaterialfog.txt @@ -1,4 +1,5 @@ -#title setMaterialFog [RCBasic Doc] -#header sub setMaterialFog( material_id, flag) +#title SetMaterialFog [RCBasic Doc] +#header Sub SetMaterialFog( material_id, flag) Enables or disables fog + diff --git a/doc/files/setmaterialfrontfaceculling.txt b/doc/files/setmaterialfrontfaceculling.txt index b2229bd..1817bde 100644 --- a/doc/files/setmaterialfrontfaceculling.txt +++ b/doc/files/setmaterialfrontfaceculling.txt @@ -1,4 +1,5 @@ -#title setMaterialFrontfaceCulling [RCBasic Doc] -#header sub setMaterialFrontFaceCulling( material_id, flag) +#title SetMaterialFrontfaceCulling [RCBasic Doc] +#header Sub SetMaterialFrontFaceCulling( material_id, flag) Enables or disables front face culling + diff --git a/doc/files/setmaterialgouraudshading.txt b/doc/files/setmaterialgouraudshading.txt index 17d3ccd..b6e6a55 100644 --- a/doc/files/setmaterialgouraudshading.txt +++ b/doc/files/setmaterialgouraudshading.txt @@ -1,6 +1,7 @@ -#title setMaterialGouraudShading [RCBasic Doc] -#header sub setMaterialGouraudShading( material_id, flag) +#title SetMaterialGouraudShading [RCBasic Doc] +#header Sub SetMaterialGouraudShading( material_id, flag) Sets whether material will use gourad shading or flat shading True for goraud, False for flat + diff --git a/doc/files/setmateriallighting.txt b/doc/files/setmateriallighting.txt index e5f1fa2..94215c3 100644 --- a/doc/files/setmateriallighting.txt +++ b/doc/files/setmateriallighting.txt @@ -1,4 +1,5 @@ -#title setMaterialLighting [RCBasic Doc] -#header sub setMaterialLighting( material_id, flag) +#title SetMaterialLighting [RCBasic Doc] +#header Sub SetMaterialLighting( material_id, flag) Sets whether material will be lighted or not + diff --git a/doc/files/setmaterialnormalize.txt b/doc/files/setmaterialnormalize.txt index 4a76e85..36e7060 100644 --- a/doc/files/setmaterialnormalize.txt +++ b/doc/files/setmaterialnormalize.txt @@ -1,4 +1,5 @@ -#title setMaterialNormalize [RCBasic Doc] -#header sub setMaterialNormalize( material_id, flag) +#title SetMaterialNormalize [RCBasic Doc] +#header Sub SetMaterialNormalize( material_id, flag) Sets whether normals should be normalized + diff --git a/doc/files/setmaterialpointcloud.txt b/doc/files/setmaterialpointcloud.txt index 84cac48..88d7292 100644 --- a/doc/files/setmaterialpointcloud.txt +++ b/doc/files/setmaterialpointcloud.txt @@ -1,4 +1,5 @@ -#title setMaterialPointCloud [RCBasic Doc] -#header sub setMaterialPointCloud( material_id, flag) +#title SetMaterialPointCloud [RCBasic Doc] +#header Sub SetMaterialPointCloud( material_id, flag) Sets whether material is drawn as a point cloud or filled triangles + diff --git a/doc/files/setmaterialshininess.txt b/doc/files/setmaterialshininess.txt index 47266f3..997e3d9 100644 --- a/doc/files/setmaterialshininess.txt +++ b/doc/files/setmaterialshininess.txt @@ -1,6 +1,7 @@ -#title setMaterialShininess [RCBasic Doc] -#header sub setMaterialShininess( material_id, shininess) +#title SetMaterialShininess [RCBasic Doc] +#header Sub SetMaterialShininess( material_id, shininess) Sets the size of specular highlights Values range from 0 to 128 + diff --git a/doc/files/setmaterialspecularcolor.txt b/doc/files/setmaterialspecularcolor.txt index ee0bb31..6eb9a1f 100644 --- a/doc/files/setmaterialspecularcolor.txt +++ b/doc/files/setmaterialspecularcolor.txt @@ -1,4 +1,5 @@ -#title setMaterialSpecularColor [RCBasic Doc] -#header sub setMaterialSpecularColor( material_id, color) +#title SetMaterialSpecularColor [RCBasic Doc] +#header Sub SetMaterialSpecularColor( material_id, color) Sets the specular color of a material + diff --git a/doc/files/setmaterialtexture.txt b/doc/files/setmaterialtexture.txt index cff7695..ed28b38 100644 --- a/doc/files/setmaterialtexture.txt +++ b/doc/files/setmaterialtexture.txt @@ -1,6 +1,7 @@ -#title setMaterialTexture [RCBasic Doc] -#header sub setMaterialTexture( material_id, level, img_id) +#title SetMaterialTexture [RCBasic Doc] +#header Sub SetMaterialTexture( material_id, level, img_id) Sets the texture on a specified texture level of a material Note: Generally you want to just set level 0 + diff --git a/doc/files/setmaterialtexturecanvas.txt b/doc/files/setmaterialtexturecanvas.txt index 8f4424c..f3da0c9 100644 --- a/doc/files/setmaterialtexturecanvas.txt +++ b/doc/files/setmaterialtexturecanvas.txt @@ -1,5 +1,6 @@ -#title setMaterialTextureCanvas [RCBasic Doc] -#header sub setMaterialTextureCanvas( material_id, level, canvas_id) +#title SetMaterialTextureCanvas [RCBasic Doc] +#header Sub SetMaterialTextureCanvas( material_id, level, canvas_id) Sets a material's texture source as a canvas. + diff --git a/doc/files/setmaterialthickness.txt b/doc/files/setmaterialthickness.txt index 798efab..4afbb31 100644 --- a/doc/files/setmaterialthickness.txt +++ b/doc/files/setmaterialthickness.txt @@ -1,4 +1,5 @@ -#title setMaterialThickness [RCBasic Doc] -#header sub setMaterialThickness( material_id, thickness) +#title SetMaterialThickness [RCBasic Doc] +#header Sub SetMaterialThickness( material_id, thickness) Sets the thickness of non 3d elements + diff --git a/doc/files/setmaterialtype.txt b/doc/files/setmaterialtype.txt index 025fa46..2d4fd69 100644 --- a/doc/files/setmaterialtype.txt +++ b/doc/files/setmaterialtype.txt @@ -1,5 +1,5 @@ #title SetMaterialType [RCBasic Doc] -#header sub SetMaterialType( material_id, mat_type) +#header Sub SetMaterialType( material_id, mat_type) Sets the material type @@ -44,3 +44,4 @@ Possible material types #/list #ref GetMaterialType + diff --git a/doc/files/setmaterialwireframe.txt b/doc/files/setmaterialwireframe.txt index 191516f..da68fd7 100644 --- a/doc/files/setmaterialwireframe.txt +++ b/doc/files/setmaterialwireframe.txt @@ -1,4 +1,5 @@ -#title setMaterialWireframe [RCBasic Doc] -#header sub setMaterialWireframe( material_id, flag) +#title SetMaterialWireframe [RCBasic Doc] +#header Sub SetMaterialWireframe( material_id, flag) Sets whether a material is draw as unfilled triangles or filled triangles + diff --git a/doc/files/setmatrixrotation.txt b/doc/files/setmatrixrotation.txt index 77bef19..35ffad9 100644 --- a/doc/files/setmatrixrotation.txt +++ b/doc/files/setmatrixrotation.txt @@ -1,4 +1,5 @@ #title SetMatrixRotation [RCBasic Doc] -#header sub SetMatrixRotation( mA, x, y, z ) +#header Sub SetMatrixRotation( mA, x, y, z ) Sets the rotation vector of a matrix + diff --git a/doc/files/setmatrixscale.txt b/doc/files/setmatrixscale.txt index 07db979..3256d22 100644 --- a/doc/files/setmatrixscale.txt +++ b/doc/files/setmatrixscale.txt @@ -1,4 +1,5 @@ #title SetMatrixScale [RCBasic Doc] -#header sub SetMatrixScale( mA, x, y, z ) +#header Sub SetMatrixScale( mA, x, y, z ) Sets the scale vector of a matrix + diff --git a/doc/files/setmatrixtranslation.txt b/doc/files/setmatrixtranslation.txt index c127048..35a4af2 100644 --- a/doc/files/setmatrixtranslation.txt +++ b/doc/files/setmatrixtranslation.txt @@ -1,4 +1,5 @@ #title SetMatrixTranslation [RCBasic Doc] -#header sub SetMatrixTranslation( mA, x, y, z ) +#header Sub SetMatrixTranslation( mA, x, y, z ) Sets the translation vector of a matrix + diff --git a/doc/files/setmatrixvalue.txt b/doc/files/setmatrixvalue.txt index 6eb5d4f..b32f86c 100644 --- a/doc/files/setmatrixvalue.txt +++ b/doc/files/setmatrixvalue.txt @@ -1,4 +1,5 @@ #title SetMatrixValue [RCBasic Doc] -#header sub SetMatrixValue(mA, r, c, v) +#header Sub SetMatrixValue(mA, r, c, v) Sets the value of a cell in a matrix + diff --git a/doc/files/setmaxparticlespersecond.txt b/doc/files/setmaxparticlespersecond.txt index 3dc47d4..5bf88f6 100644 --- a/doc/files/setmaxparticlespersecond.txt +++ b/doc/files/setmaxparticlespersecond.txt @@ -1,7 +1,8 @@ -#title setMaxParticlesPerSecond [RCBasic Doc] -#header sub setMaxParticlesPerSecond( actor, maxParticlesPerSecond) +#title SetMaxParticlesPerSecond [RCBasic Doc] +#header Sub SetMaxParticlesPerSecond( actor, maxParticlesPerSecond) Sets the max number of particles emitted per second #ref GetMaxParticlesPerSecond GetMinParticlesPerSecond SetMinParticlesPerSecond + diff --git a/doc/files/setmeshboundingbox.txt b/doc/files/setmeshboundingbox.txt index 1cce5a8..bb1d4c6 100644 --- a/doc/files/setmeshboundingbox.txt +++ b/doc/files/setmeshboundingbox.txt @@ -6,3 +6,4 @@ 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/setmeshbuffer.txt b/doc/files/setmeshbuffer.txt new file mode 100644 index 0000000..e15a04b --- /dev/null +++ b/doc/files/setmeshbuffer.txt @@ -0,0 +1,7 @@ +#title SetMeshBuffer [RCBasic Doc] +#header Function SetMeshBuffer( mesh_id, buffer_num, vertex_count, ByRef vertex_data, ByRef normal_data, ByRef uv_data, index_count, ByRef index_data ) + +Sets the contents of a mesh buffer. Buffer_num must already exists in mesh. + +Returns TRUE if successful and FALSE if not + diff --git a/doc/files/setminparticlespersecond.txt b/doc/files/setminparticlespersecond.txt index cf33b9a..c95995c 100644 --- a/doc/files/setminparticlespersecond.txt +++ b/doc/files/setminparticlespersecond.txt @@ -1,7 +1,8 @@ -#title setMinParticlesPerSecond [RCBasic Doc] -#header sub setMinParticlesPerSecond( actor, minParticlesPerSecond) +#title SetMinParticlesPerSecond [RCBasic Doc] +#header Sub SetMinParticlesPerSecond( actor, minParticlesPerSecond) Sets the max number of particles emitted per second #ref SetMaxParticlesPerSecond GetMinParticlesPerSecond SetMaxParticlesPerSecond + diff --git a/doc/files/setmouserelative.txt b/doc/files/setmouserelative.txt index 1638c8b..f8e9ae2 100644 --- a/doc/files/setmouserelative.txt +++ b/doc/files/setmouserelative.txt @@ -1,4 +1,5 @@ #title SetMouseRelative [RCBasic Doc] -#header sub SetMouseRelative(flag) +#header Sub SetMouseRelative(flag) Constrains the mouse to the window + diff --git a/doc/files/setmousezone.txt b/doc/files/setmousezone.txt index 06ec454..3c43586 100644 --- a/doc/files/setmousezone.txt +++ b/doc/files/setmousezone.txt @@ -1,4 +1,5 @@ #title SetMouseZone [RCBasic Doc] -#header sub SetMouseZone(x, y, w, h) +#header Sub SetMouseZone(x, y, w, h) Constrains the mouse to a specified area of the window + diff --git a/doc/files/setmusicposition.txt b/doc/files/setmusicposition.txt index c06dd89..7298a50 100644 --- a/doc/files/setmusicposition.txt +++ b/doc/files/setmusicposition.txt @@ -1,4 +1,5 @@ #title SetMusicPosition [RCBasic Doc] -#header sub SetMusicPosition(pos) +#header Sub SetMusicPosition(pos) Sets the position of the loaded music track + diff --git a/doc/files/setmusicvolume.txt b/doc/files/setmusicvolume.txt index 777769e..17490af 100644 --- a/doc/files/setmusicvolume.txt +++ b/doc/files/setmusicvolume.txt @@ -1,4 +1,5 @@ #title SetMusicVolume [RCBasic Doc] -#header sub SetMusicVolume(vol) +#header Sub SetMusicVolume(vol) Sets the volume of the loaded music track + diff --git a/doc/files/setparticlebox.txt b/doc/files/setparticlebox.txt index 35215ec..60e6e53 100644 --- a/doc/files/setparticlebox.txt +++ b/doc/files/setparticlebox.txt @@ -1,5 +1,6 @@ -#title setParticleBox [RCBasic Doc] -#header sub setParticleBox( actor, min_x, min_y, min_z, max_x, max_y, max_z) +#title SetParticleBox [RCBasic Doc] +#header Sub SetParticleBox( actor, min_x, min_y, min_z, max_x, max_y, max_z) Sets the bounding box for a particle emitter + diff --git a/doc/files/setparticlecenter.txt b/doc/files/setparticlecenter.txt index 3859c9e..9b6b4a3 100644 --- a/doc/files/setparticlecenter.txt +++ b/doc/files/setparticlecenter.txt @@ -1,5 +1,5 @@ -#title setParticleCenter [RCBasic Doc] -#header sub setParticleCenter( actor, x, y, z) +#title SetParticleCenter [RCBasic Doc] +#header Sub SetParticleCenter( actor, x, y, z) Sets the center of a particle emitter @@ -7,3 +7,4 @@ Note: applies to Sphere, Cylinder, and Ring emitters #ref GetParticleCenter + diff --git a/doc/files/setparticledirection.txt b/doc/files/setparticledirection.txt index 42c79b9..0118a38 100644 --- a/doc/files/setparticledirection.txt +++ b/doc/files/setparticledirection.txt @@ -1,7 +1,8 @@ -#title setParticleDirection [RCBasic Doc] -#header sub setParticleDirection( actor, x, y, z) +#title SetParticleDirection [RCBasic Doc] +#header Sub SetParticleDirection( actor, x, y, z) Sets the direction of a particle emitter #ref GetParticleDirection + diff --git a/doc/files/setparticlelength.txt b/doc/files/setparticlelength.txt index 1eb5940..2a638b4 100644 --- a/doc/files/setparticlelength.txt +++ b/doc/files/setparticlelength.txt @@ -1,5 +1,5 @@ -#title setParticleLength [RCBasic Doc] -#header sub setParticleLength( actor, p_len) +#title SetParticleLength [RCBasic Doc] +#header Sub SetParticleLength( actor, p_len) Sets the length of a cylinder particle emitter @@ -7,3 +7,4 @@ Note: Only applies to cylinder particles #ref GetParticleLength + diff --git a/doc/files/setparticlemaxangle.txt b/doc/files/setparticlemaxangle.txt index eb3a012..d01a792 100644 --- a/doc/files/setparticlemaxangle.txt +++ b/doc/files/setparticlemaxangle.txt @@ -1,6 +1,7 @@ -#title setParticleMaxAngle [RCBasic Doc] -#header sub setParticleMaxAngle( actor, maxAngle) +#title SetParticleMaxAngle [RCBasic Doc] +#header Sub SetParticleMaxAngle( actor, maxAngle) Sets the max angle of particle emission #ref GetParticleMaxAngle + diff --git a/doc/files/setparticlemaxlife.txt b/doc/files/setparticlemaxlife.txt index 488b93f..0aa97d6 100644 --- a/doc/files/setparticlemaxlife.txt +++ b/doc/files/setparticlemaxlife.txt @@ -1,5 +1,5 @@ -#title setParticleMaxLife [RCBasic Doc] -#header sub setParticleMaxLife( actor, maxLife) +#title SetParticleMaxLife [RCBasic Doc] +#header Sub SetParticleMaxLife( actor, maxLife) Sets the max life of the particle emission @@ -7,3 +7,4 @@ Note: maxLife is in milliseconds #ref GetParticleMaxLife + diff --git a/doc/files/setparticlemaxstartcolor.txt b/doc/files/setparticlemaxstartcolor.txt index 4296f0e..a4a8dd0 100644 --- a/doc/files/setparticlemaxstartcolor.txt +++ b/doc/files/setparticlemaxstartcolor.txt @@ -1,6 +1,7 @@ -#title setParticleMaxStartColor [RCBasic Doc] -#header sub setParticleMaxStartColor( actor, color) +#title SetParticleMaxStartColor [RCBasic Doc] +#header Sub SetParticleMaxStartColor( actor, color) Sets max starting color for particles #ref SetParticleMaxStartColor + diff --git a/doc/files/setparticlemaxstartsize.txt b/doc/files/setparticlemaxstartsize.txt index 996c988..d08d13a 100644 --- a/doc/files/setparticlemaxstartsize.txt +++ b/doc/files/setparticlemaxstartsize.txt @@ -1,6 +1,7 @@ -#title setParticleMaxStartSize [RCBasic Doc] -#header sub setParticleMaxStartSize( actor, w, h) +#title SetParticleMaxStartSize [RCBasic Doc] +#header Sub SetParticleMaxStartSize( actor, w, h) Sets the max start size for the particles #ref SetParticleMaxStartSize + diff --git a/doc/files/setparticlemesh.txt b/doc/files/setparticlemesh.txt index 28d9a13..b241a1d 100644 --- a/doc/files/setparticlemesh.txt +++ b/doc/files/setparticlemesh.txt @@ -1,6 +1,7 @@ -#title setParticleMesh [RCBasic Doc] -#header sub setParticleMesh( actor, mesh) +#title SetParticleMesh [RCBasic Doc] +#header Sub SetParticleMesh( actor, mesh) Sets the mesh for a mesh particle emitter Note: Only applies to mesh emitter + diff --git a/doc/files/setparticleminlife.txt b/doc/files/setparticleminlife.txt index 6331569..75b341a 100644 --- a/doc/files/setparticleminlife.txt +++ b/doc/files/setparticleminlife.txt @@ -1,5 +1,5 @@ -#title setParticleMinLife [RCBasic Doc] -#header sub setParticleMinLife( actor, minLife) +#title SetParticleMinLife [RCBasic Doc] +#header Sub SetParticleMinLife( actor, minLife) Set the min life of particles @@ -7,3 +7,4 @@ Note: minLife is in milliseconds #ref SetParticleMinLife + diff --git a/doc/files/setparticleminstartcolor.txt b/doc/files/setparticleminstartcolor.txt index 6c16274..65010e1 100644 --- a/doc/files/setparticleminstartcolor.txt +++ b/doc/files/setparticleminstartcolor.txt @@ -1,7 +1,8 @@ -#title setParticleMinStartColor [RCBasic Doc] -#header sub setParticleMinStartColor( actor, color) +#title SetParticleMinStartColor [RCBasic Doc] +#header Sub SetParticleMinStartColor( actor, color) Sets the min start color for particles #ref GetParticleMinStartColor + diff --git a/doc/files/setparticleminstartsize.txt b/doc/files/setparticleminstartsize.txt index 50eb0f6..7052450 100644 --- a/doc/files/setparticleminstartsize.txt +++ b/doc/files/setparticleminstartsize.txt @@ -1,7 +1,8 @@ -#title setParticleMinStartSize [RCBasic Doc] -#header sub setParticleMinStartSize( actor, w, h) +#title SetParticleMinStartSize [RCBasic Doc] +#header Sub SetParticleMinStartSize( actor, w, h) Sets the min start size for particle emitter #ref GetParticleMinStartSize + diff --git a/doc/files/setparticlenormal.txt b/doc/files/setparticlenormal.txt index a33d0e5..3d3a25a 100644 --- a/doc/files/setparticlenormal.txt +++ b/doc/files/setparticlenormal.txt @@ -1,5 +1,5 @@ -#title setParticleNormal [RCBasic Doc] -#header sub setParticleNormal( actor, x, y, z) +#title SetParticleNormal [RCBasic Doc] +#header Sub SetParticleNormal( actor, x, y, z) Sets the normal of a particle emitter @@ -7,3 +7,4 @@ Note: Only applies to cylinder particle emitter #ref GetParticleNormal + diff --git a/doc/files/setparticlenormaldirectionmod.txt b/doc/files/setparticlenormaldirectionmod.txt index 43eb58d..ace244f 100644 --- a/doc/files/setparticlenormaldirectionmod.txt +++ b/doc/files/setparticlenormaldirectionmod.txt @@ -1,5 +1,5 @@ -#title setParticleNormalDirectionMod [RCBasic Doc] -#header sub setParticleNormalDirectionMod( actor, nd_mod) +#title SetParticleNormalDirectionMod [RCBasic Doc] +#header Sub SetParticleNormalDirectionMod( actor, nd_mod) Sets the normal direction modifier for a particle emitter @@ -7,3 +7,4 @@ Note: Only applies to mesh particle emitter #ref GetParticleNormalDirectionMod + diff --git a/doc/files/setparticleradius.txt b/doc/files/setparticleradius.txt index 78c148a..f381f65 100644 --- a/doc/files/setparticleradius.txt +++ b/doc/files/setparticleradius.txt @@ -1,5 +1,5 @@ -#title setParticleRadius [RCBasic Doc] -#header sub setParticleRadius( actor, radius) +#title SetParticleRadius [RCBasic Doc] +#header Sub SetParticleRadius( actor, radius) Sets the radius of a particle emitter @@ -7,3 +7,4 @@ Note: Only applies to Sphere, Cylinder, and Ring emitters #ref SetParticleRadius + diff --git a/doc/files/setparticleringthickness.txt b/doc/files/setparticleringthickness.txt index c08615b..bdac22c 100644 --- a/doc/files/setparticleringthickness.txt +++ b/doc/files/setparticleringthickness.txt @@ -1,5 +1,5 @@ -#title setParticleRingThickness [RCBasic Doc] -#header sub setParticleRingThickness( actor, ringThickness) +#title SetParticleRingThickness [RCBasic Doc] +#header Sub SetParticleRingThickness( actor, ringThickness) Sets the thickness of a ring emitter @@ -7,3 +7,4 @@ Note: Only applies to ring emitter #ref GetParticleRingThickness + diff --git a/doc/files/setphysics3d.txt b/doc/files/setphysics3d.txt new file mode 100644 index 0000000..2df0951 --- /dev/null +++ b/doc/files/setphysics3d.txt @@ -0,0 +1,9 @@ +#title SetPhysics3D [RCBasic Doc] +#header Sub SetPhysics3D( flag ) + +Enables or disables the physics engine. + +NOTE: While the physics engine is disabled, actor collisions won't be able to be checked. + +#ref GetPhysics3D + diff --git a/doc/files/setpointpivota.txt b/doc/files/setpointpivota.txt index ab8b377..f0c5d2e 100644 --- a/doc/files/setpointpivota.txt +++ b/doc/files/setpointpivota.txt @@ -1,6 +1,7 @@ -#title setPointPivotA [RCBasic Doc] -#header sub setPointPivotA( constraint_id, x, y, z) +#title SetPointPivotA [RCBasic Doc] +#header Sub SetPointPivotA( constraint_id, x, y, z) Sets the pivot point on the first actor (Body A) of the constraint. This pivot point defines the specific location in the local space of Body A where the point-to-point constraint is anchored. #ref GetPointPivotA SetPointPivotB + diff --git a/doc/files/setpointpivotb.txt b/doc/files/setpointpivotb.txt index 275a6b8..e52858c 100644 --- a/doc/files/setpointpivotb.txt +++ b/doc/files/setpointpivotb.txt @@ -1,7 +1,8 @@ -#title setPointPivotB [RCBasic Doc] -#header sub setPointPivotB( constraint_id, x, y, z) +#title SetPointPivotB [RCBasic Doc] +#header Sub SetPointPivotB( constraint_id, x, y, z) Sets the pivot point on the second actor (Body B) of the constraint. This pivot point defines the specific location in the local space of Body B where the point-to-point constraint is anchored. #ref GetPointPivotA SetPointPivotB + diff --git a/doc/files/setposteffect.txt b/doc/files/setposteffect.txt new file mode 100644 index 0000000..a3e09b7 --- /dev/null +++ b/doc/files/setposteffect.txt @@ -0,0 +1,48 @@ +#title SetPostEffect [RCBasic Doc] +#header Function SetPostEffect( c_num, effect_type ) + +Sets a post effect on an canvas. + +Returns TRUE if successful and FALSE if not. + +NOTE: Post Effects only apply to 3D canvases. + +Possible Effects and there properties: +#list ul +#li POST_EFFECT_TYPE_BLOOM + #list ul + #li POST_EFFECT_PROPERTY_STRENGTH + #li POST_EFFECT_PROPERTY_DISTANCE + #li POST_EFFECT_PROPERTY_MULTIPLIER + #/list +#li POST_EFFECT_TYPE_BLUR + #list ul + #li POST_EFFECT_PROPERTY_DISTANCE + #/list +#li POST_EFFECT_TYPE_MOTION_BLUR + #list ul + #li POST_EFFECT_PROPERTY_STRENGTH + #/list +#li POST_EFFECT_TYPE_RADIAL_BLUR + #list ul + #li POST_EFFECT_PROPERTY_STRENGTH + #li POST_EFFECT_PROPERTY_DISTANCE + #/list +#li POST_EFFECT_TYPE_COLORIZE + #list ul + #li POST_EFFECT_PROPERTY_STRENGTH + #li POST_EFFECT_PROPERTY_SATURATION + #li POST_EFFECT_PROPERTY_COLOR + #/list +#li POST_EFFECT_TYPE_INVERT + #list ul + #li NONE + #/list +#li POST_EFFECT_TYPE_MINERAL + #list ul + #li POST_EFFECT_PROPERTY_STRENGTH + #/list +#/list + +#ref ClearPostEffect + diff --git a/doc/files/setposteffectactive.txt b/doc/files/setposteffectactive.txt new file mode 100644 index 0000000..b0a3fe4 --- /dev/null +++ b/doc/files/setposteffectactive.txt @@ -0,0 +1,7 @@ +#title SetPostEffectActive [RCBasic Doc] +#header Sub SetPostEffectActive( c_num, flag ) + +Enables or Disables currently set effect + +#ref PostEffectIsActive + diff --git a/doc/files/setposteffectproperty.txt b/doc/files/setposteffectproperty.txt new file mode 100644 index 0000000..c050fe3 --- /dev/null +++ b/doc/files/setposteffectproperty.txt @@ -0,0 +1,18 @@ +#title SetPostEffectProperty [RCBasic Doc] +#header Sub SetPostEffectProperty( c_num, property, property_value ) + +Sets the value of a post effect property for a canvas. + +Possible Properties: +#list ul +#li POST_EFFECT_PROPERTY_STRENGTH +#li POST_EFFECT_PROPERTY_DISTANCE +#li POST_EFFECT_PROPERTY_MULTIPLIER +#li POST_EFFECT_PROPERTY_SATURATION +#li POST_EFFECT_PROPERTY_COLOR +#/list + +Reference SetPostEffect() for which properties apply to each effect + +#ref GetPostEffectProperty SetPostEffect + diff --git a/doc/files/setprojectionmatrix.txt b/doc/files/setprojectionmatrix.txt index fe36659..dd49bc9 100644 --- a/doc/files/setprojectionmatrix.txt +++ b/doc/files/setprojectionmatrix.txt @@ -10,3 +10,4 @@ Possible values for projection_type #/list #ref GetProjectionMatrix + diff --git a/doc/files/setprojectorfov.txt b/doc/files/setprojectorfov.txt index f76e05d..834025d 100644 --- a/doc/files/setprojectorfov.txt +++ b/doc/files/setprojectorfov.txt @@ -4,3 +4,4 @@ Set the field of view for a projector #ref GetProjectorFOV + diff --git a/doc/files/setprojectortarget.txt b/doc/files/setprojectortarget.txt index 6dd807b..cc13dc8 100644 --- a/doc/files/setprojectortarget.txt +++ b/doc/files/setprojectortarget.txt @@ -2,3 +2,4 @@ #header Sub SetProjectorTarget(actor, x, y, z) Set the point a projector is pointed at + diff --git a/doc/files/setprojectortexture.txt b/doc/files/setprojectortexture.txt new file mode 100644 index 0000000..78f8d3d --- /dev/null +++ b/doc/files/setprojectortexture.txt @@ -0,0 +1,7 @@ +#title SetProjectorTexture [RCBasic Doc] +#header Sub SetProjectorTexture(actor, img_id) + +Sets the texture that is projected by a projector. + +#ref CreateProjectorActor + diff --git a/doc/files/setrendercirclepoints.txt b/doc/files/setrendercirclepoints.txt new file mode 100644 index 0000000..3891771 --- /dev/null +++ b/doc/files/setrendercirclepoints.txt @@ -0,0 +1,7 @@ +#title SetRenderCirclePoints [RCBasic Doc] +#header Sub SetRenderCirclePoints(num_points) + +Sets the number of points used to draw circles with Circle, CircleFill, Ellipse, and EllipseFill + +#ref Circle CircleFill Ellipse EllipseFill + diff --git a/doc/files/setsceneambientcolor.txt b/doc/files/setsceneambientcolor.txt index 2f7b618..23c761a 100644 --- a/doc/files/setsceneambientcolor.txt +++ b/doc/files/setsceneambientcolor.txt @@ -4,3 +4,4 @@ Sets the ambient light color of the scene #ref GetSceneAmbientColor + diff --git a/doc/files/setscenefog.txt b/doc/files/setscenefog.txt index e1a9dec..2207c60 100644 --- a/doc/files/setscenefog.txt +++ b/doc/files/setscenefog.txt @@ -2,3 +2,4 @@ #header Sub SetSceneFog (color, fog_type, start_val, end_val, density, pixelFog, rangeFog) + diff --git a/doc/files/setsceneshadowcolor.txt b/doc/files/setsceneshadowcolor.txt index d8a5d65..7aa9f27 100644 --- a/doc/files/setsceneshadowcolor.txt +++ b/doc/files/setsceneshadowcolor.txt @@ -4,3 +4,4 @@ Sets the shadow color of the scene #ref GetSceneShadowColor + diff --git a/doc/files/setslidedampingdirang.txt b/doc/files/setslidedampingdirang.txt index ff4580b..94c0971 100644 --- a/doc/files/setslidedampingdirang.txt +++ b/doc/files/setslidedampingdirang.txt @@ -1,6 +1,7 @@ -#title setSlideDampingDirAng [RCBasic Doc] -#header sub setSlideDampingDirAng( constraint_id, n) +#title SetSlideDampingDirAng [RCBasic Doc] +#header Sub SetSlideDampingDirAng( constraint_id, n) Sets the angular directional damping value. This damping factor specifically affects angular motion in the direction of movement along the constraint's axes. + diff --git a/doc/files/setslidedampingdirlin.txt b/doc/files/setslidedampingdirlin.txt index 2949b56..f96c163 100644 --- a/doc/files/setslidedampingdirlin.txt +++ b/doc/files/setslidedampingdirlin.txt @@ -1,5 +1,6 @@ -#title setSlideDampingDirLin [RCBasic Doc] -#header sub setSlideDampingDirLin( constraint_id, n) +#title SetSlideDampingDirLin [RCBasic Doc] +#header Sub SetSlideDampingDirLin( constraint_id, n) Sets the linear directional damping value for a constraint. This value applies to the linear (translational) motion of an object along the constraint's axis of movement. + diff --git a/doc/files/setslidedampinglimang.txt b/doc/files/setslidedampinglimang.txt index 868cd93..baf1fa3 100644 --- a/doc/files/setslidedampinglimang.txt +++ b/doc/files/setslidedampinglimang.txt @@ -1,8 +1,9 @@ -#title setSlideDampingLimAng [RCBasic Doc] -#header sub setSlideDampingLimAng( constraint_id, n) +#title SetSlideDampingLimAng [RCBasic Doc] +#header Sub SetSlideDampingLimAng( constraint_id, n) Sets the angular limit damping factor for a constraint. This damping applies specifically to the angular motion of an object when it reaches the limit of its allowed rotational range. #ref GetSlideDampingLimAng + diff --git a/doc/files/setslidedampinglimlin.txt b/doc/files/setslidedampinglimlin.txt index 783dfb7..89bece7 100644 --- a/doc/files/setslidedampinglimlin.txt +++ b/doc/files/setslidedampinglimlin.txt @@ -1,7 +1,8 @@ -#title setSlideDampingLimLin [RCBasic Doc] -#header sub setSlideDampingLimLin( constraint_id, n) +#title SetSlideDampingLimLin [RCBasic Doc] +#header Sub SetSlideDampingLimLin( constraint_id, n) Sets the linear limit damping factor for a constraint. This damping applies specifically to the linear (translational) motion of an object when it reaches the limit of its allowed range of movement along a specific axis. #ref GetSlideDampingLimLin + diff --git a/doc/files/setslidedampingorthoang.txt b/doc/files/setslidedampingorthoang.txt index 0c41854..bebc33c 100644 --- a/doc/files/setslidedampingorthoang.txt +++ b/doc/files/setslidedampingorthoang.txt @@ -1,6 +1,7 @@ -#title setSlideDampingOrthoAng [RCBasic Doc] -#header sub setSlideDampingOrthoAng( constraint_id, n) +#title SetSlideDampingOrthoAng [RCBasic Doc] +#header Sub SetSlideDampingOrthoAng( constraint_id, n) Sets the orthogonal angular damping factor applied to a constraint. This damping affects angular (rotational) motion that occurs perpendicular to the primary axis of movement defined by the constraint. #ref GetSlideDampingOrthoAng + diff --git a/doc/files/setslidedampingortholin.txt b/doc/files/setslidedampingortholin.txt index d1b741c..d378a5c 100644 --- a/doc/files/setslidedampingortholin.txt +++ b/doc/files/setslidedampingortholin.txt @@ -1,6 +1,7 @@ -#title setSlideDampingOrthoLin [RCBasic Doc] -#header sub setSlideDampingOrthoLin( constraint_id, n) +#title SetSlideDampingOrthoLin [RCBasic Doc] +#header Sub SetSlideDampingOrthoLin( constraint_id, n) Sets the orthogonal linear damping factor for a constraint. This damping affects the linear (translational) motion of an object that occurs perpendicular to the primary direction of movement defined by the constraint. #ref GetSlideDampingOrthoLin + diff --git a/doc/files/setslideloweranglimit.txt b/doc/files/setslideloweranglimit.txt index 656e6b5..8ab5b8d 100644 --- a/doc/files/setslideloweranglimit.txt +++ b/doc/files/setslideloweranglimit.txt @@ -1,8 +1,9 @@ #title SetSlideLowerAngLimit [RCBasic Doc] -#header sub SetSlideLowerAngLimit( constraint_id, n) +#header Sub SetSlideLowerAngLimit( constraint_id, n) Sets the lower angular limit of the constraint. This value specifies the minimum angle allowed for the rotation of the connected actors around the axis perpendicular to the sliding direction defined by the slider constraint. The lower angular limit indicates the smallest angle that the actors can rotate about the axis perpendicular to the sliding direction. If the rotation tries to exceed this limit, the physics engine will apply corrective forces to maintain the bodies within the allowed range. #ref GetSlideLowerAngLimit + diff --git a/doc/files/setslidelowerlinlimit.txt b/doc/files/setslidelowerlinlimit.txt index 84f67f5..d566688 100644 --- a/doc/files/setslidelowerlinlimit.txt +++ b/doc/files/setslidelowerlinlimit.txt @@ -1,8 +1,9 @@ -#title setSlideLowerLinLimit [RCBasic Doc] -#header sub setSlideLowerLinLimit( constraint_id, n) +#title SetSlideLowerLinLimit [RCBasic Doc] +#header Sub SetSlideLowerLinLimit( constraint_id, n) Sets the lower linear limit for the translational (sliding) motion along the slider's axis. This value specifies the minimum allowable position for the connected actors along the defined axis of the slider constraint. This defines the minimum translation distance along the slider’s axis that the connected actors are allowed to reach. If the actors' relative position along the axis goes below this limit, the constraint will prevent further movement. #ref GetSlideLowerLinLimit + diff --git a/doc/files/setsliderestitutiondirang.txt b/doc/files/setsliderestitutiondirang.txt index 4fa9e21..5f825cd 100644 --- a/doc/files/setsliderestitutiondirang.txt +++ b/doc/files/setsliderestitutiondirang.txt @@ -1,8 +1,9 @@ -#title setSlideRestitutionDirAng [RCBasic Doc] -#header sub setSlideRestitutionDirAng( constraint_id, n) +#title SetSlideRestitutionDirAng [RCBasic Doc] +#header Sub SetSlideRestitutionDirAng( constraint_id, n) Sets the restitution value for angular motion. The restitution coefficient is a measure of how much energy is conserved in a collision or constraint interaction, specifically for angular movements. When actors collide or interact, their angular momentum and position can change, and the restitution value governs how much of that energy is retained after the interaction. #ref GetSlideRestitutionDirAng + diff --git a/doc/files/setsliderestitutiondirlin.txt b/doc/files/setsliderestitutiondirlin.txt index 28e1eee..48ce6d4 100644 --- a/doc/files/setsliderestitutiondirlin.txt +++ b/doc/files/setsliderestitutiondirlin.txt @@ -1,8 +1,9 @@ -#title setSlideRestitutionDirLin [RCBasic Doc] -#header sub setSlideRestitutionDirLin( constraint_id, n) +#title SetSlideRestitutionDirLin [RCBasic Doc] +#header Sub SetSlideRestitutionDirLin( constraint_id, n) Sets the restitution value for linear motion. This value determines how much energy is conserved in a collision or interaction involving linear movements of the connected actors. When the actors collide or interact, the restitution value dictates how much of their energy is retained after the interaction. #ref SetSlideRestitutionDirLin + diff --git a/doc/files/setsliderestitutionlimang.txt b/doc/files/setsliderestitutionlimang.txt index f819d63..5355554 100644 --- a/doc/files/setsliderestitutionlimang.txt +++ b/doc/files/setsliderestitutionlimang.txt @@ -1,8 +1,9 @@ -#title setSlideRestitutionLimAng [RCBasic Doc] -#header sub setSlideRestitutionLimAng( constraint_id, n) +#title SetSlideRestitutionLimAng [RCBasic Doc] +#header Sub SetSlideRestitutionLimAng( constraint_id, n) Sets the restitution value for angular limit. This value determines how much energy is conserved when the angular motion of the connected actors reaches the angular limits of the slider constraint. Essentially, it controls how "bouncy" the rotation is when it hits the angular limit of the constraint. A value of 0.0 means no bounce (perfectly inelastic), while a value of 1.0 allows maximum bounce (perfectly elastic). #ref GetSlideRestitutionLimAng + diff --git a/doc/files/setsliderestitutionlimlin.txt b/doc/files/setsliderestitutionlimlin.txt index 7d58d50..2b4eaf7 100644 --- a/doc/files/setsliderestitutionlimlin.txt +++ b/doc/files/setsliderestitutionlimlin.txt @@ -1,8 +1,9 @@ -#title setSlideRestitutionLimLin [RCBasic Doc] -#header sub setSlideRestitutionLimLin( constraint_id, n) +#title SetSlideRestitutionLimLin [RCBasic Doc] +#header Sub SetSlideRestitutionLimLin( constraint_id, n) Sets the restitution value for the linear limit of the constraint. This value controls how much energy is conserved (or how "bouncy" the interaction is) when the connected actors reach the linear limits of the slider constraint, which restricts the movement along the sliding axis. Restitution is a measure of how much energy is retained after a collision or interaction. In this context, when the linear movement reaches the limits, restitution controls how much the actors "bounce" back. A restitution value of 0.0 means no bounce (the collision is perfectly inelastic), and 1.0 allows maximum bounce (the collision is perfectly elastic). #ref GetSlideRestitutionLimLin + diff --git a/doc/files/setsliderestitutionorthoang.txt b/doc/files/setsliderestitutionorthoang.txt index 30b7767..7d304e6 100644 --- a/doc/files/setsliderestitutionorthoang.txt +++ b/doc/files/setsliderestitutionorthoang.txt @@ -1,5 +1,5 @@ -#title setSlideRestitutionOrthoAng [RCBasic Doc] -#header sub setSlideRestitutionOrthoAng( constraint_id, n) +#title SetSlideRestitutionOrthoAng [RCBasic Doc] +#header Sub SetSlideRestitutionOrthoAng( constraint_id, n) Sets the restitution value for orthogonal angular motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when rotational movement occurs in a direction orthogonal (perpendicular) to the slider's primary axis of movement. @@ -8,3 +8,4 @@ Orthogonal Angular Motion: In the context of a slider constraint, orthogonal ang Restitution: Restitution is a measure of how much energy is retained in a collision or interaction. A restitution value of 0.0 means no bounce (inelastic collision), and 1.0 means maximum bounce (elastic collision). For orthogonal angular motion, this describes how much bounce occurs after the rotational motion hits the constraints or limits in a perpendicular direction to the slider axis. #ref GetSlideRestitutionOrthoAng + diff --git a/doc/files/setsliderestitutionortholin.txt b/doc/files/setsliderestitutionortholin.txt index 3cd9aa8..14b78ce 100644 --- a/doc/files/setsliderestitutionortholin.txt +++ b/doc/files/setsliderestitutionortholin.txt @@ -1,5 +1,5 @@ -#title setSlideRestitutionOrthoLin [RCBasic Doc] -#header sub setSlideRestitutionOrthoLin( constraint_id, n) +#title SetSlideRestitutionOrthoLin [RCBasic Doc] +#header Sub SetSlideRestitutionOrthoLin( constraint_id, n) Sets the restitution value for orthogonal linear motion. This value determines how much energy is conserved (or how "bouncy" the interaction is) when linear motion occurs in a direction orthogonal (perpendicular) to the primary sliding axis of the constraint. @@ -8,3 +8,4 @@ Orthogonal Linear Motion: In the context of a slider constraint, orthogonal line Restitution: Restitution is a measure of how much energy is retained or conserved during a collision or interaction. A restitution value of 0.0 indicates no bounce (perfectly inelastic), while 1.0 indicates maximum bounce (perfectly elastic). For orthogonal linear motion, this value describes how much the actors bounce or retain energy when they hit limits or experience movement perpendicular to the slider’s main axis. #ref GetSlideRestitutionOrthoLin + diff --git a/doc/files/setslidesoftnessdirang.txt b/doc/files/setslidesoftnessdirang.txt index 8daf00e..f37a669 100644 --- a/doc/files/setslidesoftnessdirang.txt +++ b/doc/files/setslidesoftnessdirang.txt @@ -1,8 +1,9 @@ -#title setSlideSoftnessDirAng [RCBasic Doc] -#header sub setSlideSoftnessDirAng( constraint_id, n) +#title SetSlideSoftnessDirAng [RCBasic Doc] +#header Sub SetSlideSoftnessDirAng( constraint_id, n) Sets the softness parameter for the angular motion of the constraint. This parameter is used to define how "soft" or "rigid" the limits of angular motion are, particularly when the angular limits are reached. The softness parameter defines how smoothly the constraint responds to limit violations. A higher softness value allows for more gradual movements when limits are approached, while a lower value creates a more rigid response. Softness is particularly useful in simulations to avoid harsh impacts or stiff movements when limits are reached. #ref GetSlideSoftnessDirAng + diff --git a/doc/files/setslidesoftnessdirlin.txt b/doc/files/setslidesoftnessdirlin.txt index e82c723..c20595f 100644 --- a/doc/files/setslidesoftnessdirlin.txt +++ b/doc/files/setslidesoftnessdirlin.txt @@ -1,8 +1,9 @@ -#title setConstraintSoftnessDirLin [RCBasic Doc] -#header sub setConstraintSoftnessDirLin( constraint_id, n) +#title SetConstraintSoftnessDirLin [RCBasic Doc] +#header Sub SetConstraintSoftnessDirLin( constraint_id, n) Sets the softness parameter for the linear motion of the constraint. This parameter influences how the constraint responds when the linear limits of movement are reached along the sliding axis, determining whether the response is soft and gradual or more rigid. In the context of constraints, softness defines how "compliant" or "stiff" the constraint behaves when the limits are approached. A higher softness value makes the constraint respond more softly and gradually as the limit is approached, while a lower value makes the response stiffer and more rigid. #ref GetSlideSoftnessDirLin + diff --git a/doc/files/setslidesoftnesslimang.txt b/doc/files/setslidesoftnesslimang.txt index d806c20..84d150a 100644 --- a/doc/files/setslidesoftnesslimang.txt +++ b/doc/files/setslidesoftnesslimang.txt @@ -1,8 +1,9 @@ -#title setSlideSoftnessLimAng [RCBasic Doc] -#header sub setSlideSoftnessLimAng( constraint_id, n) +#title SetSlideSoftnessLimAng [RCBasic Doc] +#header Sub SetSlideSoftnessLimAng( constraint_id, n) Sets the softness parameter for the angular limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors reach their angular rotational limits around the slider's axis of rotation. The softness parameter defines how compliant or stiff the constraint behaves when the motion approaches a limit. A higher softness makes the constraint more flexible, allowing for smoother motion near the limit. A lower softness makes the limit response more rigid and immediate. #ref GetSlideSoftnessLimAng + diff --git a/doc/files/setslidesoftnesslimlin.txt b/doc/files/setslidesoftnesslimlin.txt index 7461c5b..8e77bca 100644 --- a/doc/files/setslidesoftnesslimlin.txt +++ b/doc/files/setslidesoftnesslimlin.txt @@ -1,8 +1,9 @@ -#title setSlideSoftnessLimLin [RCBasic Doc] -#header sub setSlideSoftnessLimLin( constraint_id, n) +#title SetSlideSoftnessLimLin [RCBasic Doc] +#header Sub SetSlideSoftnessLimLin( constraint_id, n) Sets the softness parameter for the linear limits of the constraint. This parameter influences how "soft" or "rigid" the constraint behaves when the connected actors reach their linear (sliding) limits along the constraint's axis of motion. The softness parameter defines how compliant or stiff the constraint behaves when limits are approached. A higher softness value allows for a more gradual and flexible response as the limit is reached, while a lower softness value results in a stiffer and more rigid response. #ref GetSlideSoftnessLimLin + diff --git a/doc/files/setslidesoftnessorthoang.txt b/doc/files/setslidesoftnessorthoang.txt index bc33d25..f79a39b 100644 --- a/doc/files/setslidesoftnessorthoang.txt +++ b/doc/files/setslidesoftnessorthoang.txt @@ -1,8 +1,9 @@ -#title setSlideSoftnessOrthoAng [RCBasic Doc] -#header sub setSlideSoftnessOrthoAng( constraint_id, n) +#title SetSlideSoftnessOrthoAng [RCBasic Doc] +#header Sub SetSlideSoftnessOrthoAng( constraint_id, n) Sets the softness parameter for the orthogonal angular limits of the constraint. This parameter controls how "soft" or "rigid" the constraint behaves when angular rotation is limited along directions orthogonal (perpendicular) to the primary axis of motion. The softness parameter defines how compliant (soft) or stiff (rigid) the constraint behaves when the bodies approach their angular or linear limits. A higher softness value makes the limit more flexible, allowing for gradual motion, while a lower value makes the limit more rigid and restrictive. #ref GetSlideSoftnessOrthoAng + diff --git a/doc/files/setslidesoftnessortholin.txt b/doc/files/setslidesoftnessortholin.txt index f2f2ad8..56c448b 100644 --- a/doc/files/setslidesoftnessortholin.txt +++ b/doc/files/setslidesoftnessortholin.txt @@ -1,8 +1,9 @@ -#title setConstraintSoftnessOrthoLin [RCBasic Doc] -#header sub setSlideSoftnessOrthoLin( constraint_id, n) +#title SetConstraintSoftnessOrthoLin [RCBasic Doc] +#header Sub SetSlideSoftnessOrthoLin( constraint_id, n) Sets the softness parameter for the orthogonal linear limits of the constraint. This parameter affects how "soft" or "rigid" the constraint behaves when the connected actors approach their linear movement limits in directions that are orthogonal (perpendicular) to the primary sliding axis. The softness parameter determines how rigid or compliant the constraint is when the actors approach their movement limits. A higher softness value allows for smoother, more flexible movement near the limit, while a lower value results in a more rigid, immediate response. #ref GetSlideSoftnessOrthoLin + diff --git a/doc/files/setslideupperanglimit.txt b/doc/files/setslideupperanglimit.txt index 469d8da..b56a994 100644 --- a/doc/files/setslideupperanglimit.txt +++ b/doc/files/setslideupperanglimit.txt @@ -1,6 +1,7 @@ -#title setSlideUpperAngLimit [RCBasic Doc] -#header sub setSlideUpperAngLimit( constraint_id, n) +#title SetSlideUpperAngLimit [RCBasic Doc] +#header Sub SetSlideUpperAngLimit( constraint_id, n) Sets the upper limit of the angular movement allowed for the constraint. This function is crucial for determining how much rotational freedom is allowed around the axis of rotation defined by the slider constraint. The upper angular limit specifies the maximum allowed rotation around the rotational axis for the slider constraint. If the relative rotation between the two actors exceeds this angle, corrective forces are applied to maintain the constraint and prevent further rotation. + diff --git a/doc/files/setslideupperlinlimit.txt b/doc/files/setslideupperlinlimit.txt index 42d58c1..46db592 100644 --- a/doc/files/setslideupperlinlimit.txt +++ b/doc/files/setslideupperlinlimit.txt @@ -1,6 +1,7 @@ -#title setSlideUpperLinLimit [RCBasic Doc] -#header sub setSlideUpperLinLimit( constraint_id, n) +#title SetSlideUpperLinLimit [RCBasic Doc] +#header Sub SetSlideUpperLinLimit( constraint_id, n) Sets the upper limit for linear movement along the constraint's axis. This is a crucial function for controlling how far the connected actors can slide along that axis before the constraint enforces limits. The upper linear limit specifies the maximum distance that the connected actors can move away from each other along the slider's axis. If the relative movement exceeds this limit, the constraint will apply corrective forces to stop further movement. + diff --git a/doc/files/setsoundchannels.txt b/doc/files/setsoundchannels.txt index 9300d13..2321690 100644 --- a/doc/files/setsoundchannels.txt +++ b/doc/files/setsoundchannels.txt @@ -1,4 +1,5 @@ #title SetSoundChannels [RCBasic Doc] -#header sub SetSoundChannels(max_channels) +#header Sub SetSoundChannels(max_channels) Sets the maximum number of sound channels. + diff --git a/doc/files/setsoundvolume.txt b/doc/files/setsoundvolume.txt index fafb922..e7874a4 100644 --- a/doc/files/setsoundvolume.txt +++ b/doc/files/setsoundvolume.txt @@ -1,4 +1,5 @@ #title SetSoundVolume [RCBasic Doc] -#header sub SetSoundVolume(snd, vol) +#header Sub SetSoundVolume(snd, vol) Sets the volume of a sound + diff --git a/doc/files/setspritealpha.txt b/doc/files/setspritealpha.txt index e720a69..0d4dba0 100644 --- a/doc/files/setspritealpha.txt +++ b/doc/files/setspritealpha.txt @@ -2,3 +2,4 @@ #header Sub SetSpriteAlpha(sprite, alpha) Sets the alpha value of a sprite + diff --git a/doc/files/setspriteangulardamping.txt b/doc/files/setspriteangulardamping.txt index 72d034e..cee6e32 100644 --- a/doc/files/setspriteangulardamping.txt +++ b/doc/files/setspriteangulardamping.txt @@ -1,6 +1,7 @@ -#title setSpriteAngularDamping [RCBasic Doc] -#header sub setSpriteAngularDamping( spr_id, angularDamping) +#title SetSpriteAngularDamping [RCBasic Doc] +#header Sub SetSpriteAngularDamping( spr_id, angularDamping) Sets a sprite's angular damping #ref GetSpriteAngularDamping + diff --git a/doc/files/setspriteangularvelocity.txt b/doc/files/setspriteangularvelocity.txt index 0ceda48..38adc2d 100644 --- a/doc/files/setspriteangularvelocity.txt +++ b/doc/files/setspriteangularvelocity.txt @@ -1,6 +1,7 @@ -#title setSpriteAngularVelocity [RCBasic Doc] -#header sub setSpriteAngularVelocity( spr_id, av) +#title SetSpriteAngularVelocity [RCBasic Doc] +#header Sub SetSpriteAngularVelocity( spr_id, av) Sets the angular velocity of a sprite #ref GetSpriteAngularVelocity + diff --git a/doc/files/setspriteanimation.txt b/doc/files/setspriteanimation.txt index 6eee1d3..4a6f9ee 100644 --- a/doc/files/setspriteanimation.txt +++ b/doc/files/setspriteanimation.txt @@ -6,3 +6,4 @@ Sets the current animation for a sprite Note: Once an animation is set, it will automatically start #ref GetSpriteAnimation + diff --git a/doc/files/setspriteanimationframe.txt b/doc/files/setspriteanimationframe.txt index 825a242..e2d83a8 100644 --- a/doc/files/setspriteanimationframe.txt +++ b/doc/files/setspriteanimationframe.txt @@ -4,3 +4,4 @@ Sets a frame in a sprite animation #ref GetSpriteAnimationFrame + diff --git a/doc/files/setspriteanimationlength.txt b/doc/files/setspriteanimationlength.txt index 7af2d54..bb99116 100644 --- a/doc/files/setspriteanimationlength.txt +++ b/doc/files/setspriteanimationlength.txt @@ -4,3 +4,4 @@ Sets the number of frames in a sprite animation #ref GetSpriteAnimationLength + diff --git a/doc/files/setspriteanimationloops.txt b/doc/files/setspriteanimationloops.txt deleted file mode 100644 index ccbae78..0000000 --- a/doc/files/setspriteanimationloops.txt +++ /dev/null @@ -1,6 +0,0 @@ -#title SetSpriteAnimationLoops [RCBasic Doc] -#header Sub SetSpriteAnimationLoops(sprite, num_loops) - -Sets the number of animation loops for the sprite - -#ref NumSpriteAnimationLoops diff --git a/doc/files/setspriteanimationspeed.txt b/doc/files/setspriteanimationspeed.txt index 116738c..d3d9e74 100644 --- a/doc/files/setspriteanimationspeed.txt +++ b/doc/files/setspriteanimationspeed.txt @@ -2,3 +2,4 @@ #header Sub SetSpriteAnimationSpeed(sprite, animation, speed) Sets the speed in frames per second for a sprite animation + diff --git a/doc/files/setspriteawake.txt b/doc/files/setspriteawake.txt index b665762..594aace 100644 --- a/doc/files/setspriteawake.txt +++ b/doc/files/setspriteawake.txt @@ -1,4 +1,5 @@ -#title setSpriteAwake [RCBasic Doc] -#header sub setSpriteAwake( spr_id, flag) +#title SetSpriteAwake [RCBasic Doc] +#header Sub SetSpriteAwake( spr_id, flag) Sets a sprite's sleep state + diff --git a/doc/files/setspritebox.txt b/doc/files/setspritebox.txt index 984fbfd..e7a4f21 100644 --- a/doc/files/setspritebox.txt +++ b/doc/files/setspritebox.txt @@ -4,3 +4,4 @@ Sets the width and Height of a sprite collision box NOTE: Sprite collision shape must be SPRITE_SHAPE_BOX + diff --git a/doc/files/setspritebullet.txt b/doc/files/setspritebullet.txt index cc9ee69..7e5c976 100644 --- a/doc/files/setspritebullet.txt +++ b/doc/files/setspritebullet.txt @@ -1,8 +1,9 @@ -#title setSpriteBullet [RCBasic Doc] -#header sub setSpriteBullet( spr_id, flag) +#title SetSpriteBullet [RCBasic Doc] +#header Sub SetSpriteBullet( spr_id, flag) Sets whether body has continuous collision detection Note: Useful for fast moving objects #ref SpriteIsBullet + diff --git a/doc/files/setspritecanvasantialiasmode.txt b/doc/files/setspritecanvasantialiasmode.txt index d53756a..4e5e264 100644 --- a/doc/files/setspritecanvasantialiasmode.txt +++ b/doc/files/setspritecanvasantialiasmode.txt @@ -1,5 +1,5 @@ #title SetSpriteCanvasAntiAliasMode [RCBasic Doc] -#header sub SetSpriteCanvasAntiAliasMode( c_num, aa_mode ) +#header Sub SetSpriteCanvasAntiAliasMode( c_num, aa_mode ) Sets the anti-alias mode for a sprite canvas @@ -15,3 +15,4 @@ Possible modes #/list #ref GetSpriteCanvasAntiAliasMode + diff --git a/doc/files/setspritecanvasbilinearfilter.txt b/doc/files/setspritecanvasbilinearfilter.txt index ce60e15..cfa9894 100644 --- a/doc/files/setspritecanvasbilinearfilter.txt +++ b/doc/files/setspritecanvasbilinearfilter.txt @@ -1,6 +1,7 @@ #title SetSpriteCanvasBilinearFilter [RCBasic Doc] -#header sub SetSpriteCanvasBilinearFilter( c_num, flag ) +#header Sub SetSpriteCanvasBilinearFilter( c_num, flag ) Enables or disables bi-linear filter for the sprite canvas #ref GetSpriteCanvasBilinearFilter + diff --git a/doc/files/setspritecanvasblendmode.txt b/doc/files/setspritecanvasblendmode.txt index bbfddbb..47f325b 100644 --- a/doc/files/setspritecanvasblendmode.txt +++ b/doc/files/setspritecanvasblendmode.txt @@ -1,5 +1,5 @@ #title SetSpriteCanvasBlendMode [RCBasic Doc] -#header sub SetSpriteCanvasBlendMode( c_num, blend_mode ) +#header Sub SetSpriteCanvasBlendMode( c_num, blend_mode ) Sets the blend mode used to render sprites on the given sprite canvas @@ -20,3 +20,4 @@ Possible Blend Modes #ref SetCanvasBlendMode GetSpriteCanvasBlendMode + diff --git a/doc/files/setspritecanvasrenderpriority.txt b/doc/files/setspritecanvasrenderpriority.txt index a2c0d48..ecab5ca 100644 --- a/doc/files/setspritecanvasrenderpriority.txt +++ b/doc/files/setspritecanvasrenderpriority.txt @@ -1,5 +1,5 @@ #title SetSpriteCanvasRenderPriority [RCBasic Doc] -#header function SetSpriteCanvasRenderPriority( c_num, priority, order ) +#header Function SetSpriteCanvasRenderPriority( c_num, priority, order ) Sets the order sprites are rendered on a sprite canvas. @@ -29,3 +29,4 @@ Possible order values #ref GetSpriteCanvasRenderPriority + diff --git a/doc/files/setspritechain.txt b/doc/files/setspritechain.txt index e8dd437..b7cda05 100644 --- a/doc/files/setspritechain.txt +++ b/doc/files/setspritechain.txt @@ -5,3 +5,4 @@ Sets the points in a collision chain NOTE: Sprite collision shape must be SPRITE_SHAPE_CHAIN + diff --git a/doc/files/setspritechainloop.txt b/doc/files/setspritechainloop.txt index 5ce62a0..e4e5cb9 100644 --- a/doc/files/setspritechainloop.txt +++ b/doc/files/setspritechainloop.txt @@ -8,3 +8,4 @@ NOTE: Since it is a loop, the shape will be a closed NOTE: Sprite collision shape must be SPRITE_SHAPE_CHAIN + diff --git a/doc/files/setspritecollisionshape.txt b/doc/files/setspritecollisionshape.txt deleted file mode 100644 index a64fd99..0000000 --- a/doc/files/setspritecollisionshape.txt +++ /dev/null @@ -1,15 +0,0 @@ -#title SetSpriteCollisionShape [RCBasic Doc] -#header Sub SetSpriteCollisionShape(spr_id, shape) - -Sets the collision shape of a sprite - -Shape Types: -#list ul -#li SPRITE_SHAPE_NONE -#li SPRITE_SHAPE_BOX -#li SPRITE_SHAPE_POLYGON -#li SPRITE_SHAPE_CIRCLE -#li SPRITE_SHAPE_CHAIN -#/list - -#ref SetSpriteBox SetSpriteRadius SetSpriteChain SetSpriteChainLoop SetSpritePolygon diff --git a/doc/files/setspritecolormod.txt b/doc/files/setspritecolormod.txt index b19be19..1be08e3 100644 --- a/doc/files/setspritecolormod.txt +++ b/doc/files/setspritecolormod.txt @@ -3,3 +3,4 @@ Sets the color modulation of a sprite. + diff --git a/doc/files/setspritedensity.txt b/doc/files/setspritedensity.txt index fcbff6a..780e163 100644 --- a/doc/files/setspritedensity.txt +++ b/doc/files/setspritedensity.txt @@ -1,5 +1,5 @@ #title SetSpriteDensity [RCBasic Doc] -#header sub SetSpriteDensity( spr_id, density ) +#header Sub SetSpriteDensity( spr_id, density ) Sets the density of a sprite. Higher density means a heavier sprite. @@ -7,3 +7,4 @@ Density is used to calculate mass for a sprite. #ref GetSpriteDensity + diff --git a/doc/files/setspritefixedrotation.txt b/doc/files/setspritefixedrotation.txt index ada3364..f51b37f 100644 --- a/doc/files/setspritefixedrotation.txt +++ b/doc/files/setspritefixedrotation.txt @@ -1,6 +1,7 @@ -#title setSpriteFixedRotation [RCBasic Doc] -#header sub setSpriteFixedRotation( spr_id, flag ) +#title SetSpriteFixedRotation [RCBasic Doc] +#header Sub SetSpriteFixedRotation( spr_id, flag ) Prevents sprite from being rotated by any forces applied to it #ref spriteIsFixedRotation + diff --git a/doc/files/setspriteframe.txt b/doc/files/setspriteframe.txt index 96633de..2329990 100644 --- a/doc/files/setspriteframe.txt +++ b/doc/files/setspriteframe.txt @@ -2,3 +2,4 @@ #header Sub SetSpriteFrame(sprite, frame) Sets a sprite to a frame in its frame sheet + diff --git a/doc/files/setspritefriction.txt b/doc/files/setspritefriction.txt index c3f5f8c..54894e5 100644 --- a/doc/files/setspritefriction.txt +++ b/doc/files/setspritefriction.txt @@ -1,6 +1,7 @@ #title SetSpriteFriction [RCBasic Doc] -#header sub SetSpriteFriction( spr_id, friction ) +#header Sub SetSpriteFriction( spr_id, friction ) Sets a sprite's friction #ref GetSpriteFriction + diff --git a/doc/files/setspritegravityscale.txt b/doc/files/setspritegravityscale.txt index 1cad17c..785df94 100644 --- a/doc/files/setspritegravityscale.txt +++ b/doc/files/setspritegravityscale.txt @@ -1,6 +1,7 @@ -#title setSpriteGravityScale [RCBasic Doc] -#header sub setSpriteGravityScale( spr_id, g_scale) +#title SetSpriteGravityScale [RCBasic Doc] +#header Sub SetSpriteGravityScale( spr_id, g_scale) Sets the affect of gravity on a sprite #ref GetSpriteGravityScale + diff --git a/doc/files/setspritelayerpriority.txt b/doc/files/setspritelayerpriority.txt deleted file mode 100644 index bc80793..0000000 --- a/doc/files/setspritelayerpriority.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title SetSpriteLayerPriority [RCBasic Doc] -#header Function SetSpriteLayerPriority( c_num, priority, order ) - - diff --git a/doc/files/setspritelineardamping.txt b/doc/files/setspritelineardamping.txt index b1f2db8..974b8c4 100644 --- a/doc/files/setspritelineardamping.txt +++ b/doc/files/setspritelineardamping.txt @@ -1,6 +1,7 @@ -#title setSpriteLinearDamping [RCBasic Doc] -#header sub setSpriteLinearDamping( spr_id, linearDamping) +#title SetSpriteLinearDamping [RCBasic Doc] +#header Sub SetSpriteLinearDamping( spr_id, linearDamping) Sets the linear damping of a sprite #ref GetSpriteLinearDamping + diff --git a/doc/files/setspritelinearvelocity.txt b/doc/files/setspritelinearvelocity.txt index b519c20..16c10ec 100644 --- a/doc/files/setspritelinearvelocity.txt +++ b/doc/files/setspritelinearvelocity.txt @@ -1,6 +1,7 @@ -#title setSpriteLinearVelocity [RCBasic Doc] -#header sub setSpriteLinearVelocity( spr_id, x, y) +#title SetSpriteLinearVelocity [RCBasic Doc] +#header Sub SetSpriteLinearVelocity( spr_id, x, y) Sets a sprite's linear velocity #ref GetSpriteLinearVelocity + diff --git a/doc/files/setspritepolygon.txt b/doc/files/setspritepolygon.txt index c836ede..c2cd966 100644 --- a/doc/files/setspritepolygon.txt +++ b/doc/files/setspritepolygon.txt @@ -2,3 +2,4 @@ #header Sub SetSpritePolygon(spr_id, ByRef vx, ByRef vy, v_count) Sets the points in a polygon sprite shape + diff --git a/doc/files/setspriteposition.txt b/doc/files/setspriteposition.txt index 4296279..7ba2241 100644 --- a/doc/files/setspriteposition.txt +++ b/doc/files/setspriteposition.txt @@ -43,3 +43,4 @@ Note: This is canvas position and not screen position #image "images/theEye.png" #ref OpenCanvasSpriteLayer CreateSprite + diff --git a/doc/files/setspriteradius.txt b/doc/files/setspriteradius.txt index fc9df2c..d2f560b 100644 --- a/doc/files/setspriteradius.txt +++ b/doc/files/setspriteradius.txt @@ -6,3 +6,4 @@ Sets the radius of a sprites collision shape NOTE: Does nothing if collision shape is not SPRITE_SHAPE_CIRCLE #ref GetSpriteRadius + diff --git a/doc/files/setspriterestitution.txt b/doc/files/setspriterestitution.txt index c907b2e..43702b2 100644 --- a/doc/files/setspriterestitution.txt +++ b/doc/files/setspriterestitution.txt @@ -1,7 +1,8 @@ #title SetSpriteRestitution [RCBasic Doc] -#header sub SetSpriteRestitution( spr_id, restitution ) +#header Sub SetSpriteRestitution( spr_id, restitution ) Sets the restitution coefficient for a sprite #ref GetSpriteRestitution + diff --git a/doc/files/setspriterestitutionthreshold.txt b/doc/files/setspriterestitutionthreshold.txt index 02e539d..31428f4 100644 --- a/doc/files/setspriterestitutionthreshold.txt +++ b/doc/files/setspriterestitutionthreshold.txt @@ -1,6 +1,7 @@ #title SetSpriteRestitutionThreshold [RCBasic Doc] -#header sub SetSpriteRestitutionThreshold( spr_id, threshold ) +#header Sub SetSpriteRestitutionThreshold( spr_id, threshold ) Sets the restitution threshold for a sprite. #ref GetSpriteRestitutionThreshold + diff --git a/doc/files/setspriterotation.txt b/doc/files/setspriterotation.txt index 842bbd2..6f20fd1 100644 --- a/doc/files/setspriterotation.txt +++ b/doc/files/setspriterotation.txt @@ -41,3 +41,4 @@ Wend #ref GetSpriteRotation RotateSprite + diff --git a/doc/files/setspritescale.txt b/doc/files/setspritescale.txt index 4b022c2..95cbab8 100644 --- a/doc/files/setspritescale.txt +++ b/doc/files/setspritescale.txt @@ -41,3 +41,4 @@ Wend #image "images/theEye.png" #ref ScaleSprite GetSpriteScale + diff --git a/doc/files/setspriteshape.txt b/doc/files/setspriteshape.txt index 4615020..bbb7f5f 100644 --- a/doc/files/setspriteshape.txt +++ b/doc/files/setspriteshape.txt @@ -17,3 +17,4 @@ Possible Shapes #ref GetSpriteShape + diff --git a/doc/files/setspriteshapeoffset.txt b/doc/files/setspriteshapeoffset.txt index 4becc11..ca47750 100644 --- a/doc/files/setspriteshapeoffset.txt +++ b/doc/files/setspriteshapeoffset.txt @@ -5,3 +5,4 @@ Sets the relative location the sprite shape is from where it is rendered #ref GetSpriteShapeOffset + diff --git a/doc/files/setspritesleepallowed.txt b/doc/files/setspritesleepallowed.txt index d79be31..771fd18 100644 --- a/doc/files/setspritesleepallowed.txt +++ b/doc/files/setspritesleepallowed.txt @@ -1,6 +1,7 @@ -#title setSpriteSleepAllowed [RCBasic Doc] -#header sub setSpriteSleepAllowed( spr_id, flag) +#title SetSpriteSleepAllowed [RCBasic Doc] +#header Sub SetSpriteSleepAllowed( spr_id, flag) Sets whether the sprite is allowed to go to sleep when it's at rest #ref SetSpriteAwake SpriteIsAwake SpriteIsSleepAllowed + diff --git a/doc/files/setspritesolid.txt b/doc/files/setspritesolid.txt index ffab8c6..ee657c5 100644 --- a/doc/files/setspritesolid.txt +++ b/doc/files/setspritesolid.txt @@ -47,3 +47,4 @@ Wend #ref SpriteIsSolid + diff --git a/doc/files/setspritesource.txt b/doc/files/setspritesource.txt index 8b6b529..cbfc392 100644 --- a/doc/files/setspritesource.txt +++ b/doc/files/setspritesource.txt @@ -40,3 +40,4 @@ Wend #image "images/frowny2.png" #ref GetSpriteSource + diff --git a/doc/files/setspritetype.txt b/doc/files/setspritetype.txt index 20ae6a2..3600a69 100644 --- a/doc/files/setspritetype.txt +++ b/doc/files/setspritetype.txt @@ -149,3 +149,4 @@ Wend #image "images/theEye.png" #ref GetSpriteType + diff --git a/doc/files/setspritevisible.txt b/doc/files/setspritevisible.txt index ee5e2c6..9b4d7e2 100644 --- a/doc/files/setspritevisible.txt +++ b/doc/files/setspritevisible.txt @@ -39,3 +39,4 @@ Wend #image "images/theEye.png" #ref SetSpriteVisible + diff --git a/doc/files/setspritez.txt b/doc/files/setspritez.txt index 95ed333..b947541 100644 --- a/doc/files/setspritez.txt +++ b/doc/files/setspritez.txt @@ -58,3 +58,4 @@ Wend #ref SpriteZ + diff --git a/doc/files/setterraincameramovementdelta.txt b/doc/files/setterraincameramovementdelta.txt index a58e436..71717e6 100644 --- a/doc/files/setterraincameramovementdelta.txt +++ b/doc/files/setterraincameramovementdelta.txt @@ -1,7 +1,8 @@ #title SetTerrainCameraMovementDelta [RCBasic Doc] -#header sub SetTerrainCameraMovementDelta( actor, delta ) +#header Sub SetTerrainCameraMovementDelta( actor, delta ) Sets the movement camera threshold. It is used to determine when to recalculate indices for the actor. The default value is 10. + diff --git a/doc/files/setterraincamerarotationdelta.txt b/doc/files/setterraincamerarotationdelta.txt index 90bde83..edb5be0 100644 --- a/doc/files/setterraincamerarotationdelta.txt +++ b/doc/files/setterraincamerarotationdelta.txt @@ -1,7 +1,8 @@ #title SetTerrainCameraRotationDelta [RCBasic Doc] -#header sub SetTerrainCameraRotationDelta( actor, delta ) +#header Sub SetTerrainCameraRotationDelta( actor, delta ) Sets the rotation camera threshold. It is used to determine when to recalculate indices for the scene node. The default value is 1. + diff --git a/doc/files/setterrainloddistance.txt b/doc/files/setterrainloddistance.txt index 3dfaadd..011b56f 100644 --- a/doc/files/setterrainloddistance.txt +++ b/doc/files/setterrainloddistance.txt @@ -1,4 +1,5 @@ #title SetTerrainLODDistance [RCBasic Doc] -#header sub SetTerrainLODDistance( actor, LOD, distance ) +#header Sub SetTerrainLODDistance( actor, LOD, distance ) Override the default generation of distance thresholds. + diff --git a/doc/files/setterrainpatchlod.txt b/doc/files/setterrainpatchlod.txt index f880bfa..79eefb8 100644 --- a/doc/files/setterrainpatchlod.txt +++ b/doc/files/setterrainpatchlod.txt @@ -1,4 +1,5 @@ #title SetTerrainPatchLOD [RCBasic Doc] -#header sub SetTerrainPatchLOD( actor, patchX, patchZ, LOD ) +#header Sub SetTerrainPatchLOD( actor, patchX, patchZ, LOD ) Manually sets the LOD of a patch. + diff --git a/doc/files/settile.txt b/doc/files/settile.txt index 7714702..6062df9 100644 --- a/doc/files/settile.txt +++ b/doc/files/settile.txt @@ -3,3 +3,4 @@ Places a tile on a tilemap + diff --git a/doc/files/settileanimationframe.txt b/doc/files/settileanimationframe.txt index c222a2a..905c573 100644 --- a/doc/files/settileanimationframe.txt +++ b/doc/files/settileanimationframe.txt @@ -10,3 +10,4 @@ Parameters: #li anim_frame - The specific index in the animation #li tile - The tile to set this frame to #/list + diff --git a/doc/files/settileanimationlength.txt b/doc/files/settileanimationlength.txt index 82b841d..419f37d 100644 --- a/doc/files/settileanimationlength.txt +++ b/doc/files/settileanimationlength.txt @@ -4,3 +4,4 @@ Sets the number of frames in a tile's animation #ref GetTileAnimationLength + diff --git a/doc/files/settileanimationspeed.txt b/doc/files/settileanimationspeed.txt index b767b1a..87d3396 100644 --- a/doc/files/settileanimationspeed.txt +++ b/doc/files/settileanimationspeed.txt @@ -4,3 +4,4 @@ Sets the speed of a tile's animation #ref GetTileAnimationSpeed + diff --git a/doc/files/settilemapsize.txt b/doc/files/settilemapsize.txt index c1e7e3e..5847022 100644 --- a/doc/files/settilemapsize.txt +++ b/doc/files/settilemapsize.txt @@ -4,3 +4,4 @@ Resize a tile map #ref CreateTileMap GetTileMapSize + diff --git a/doc/files/setup.txt b/doc/files/setup.txt index f8fe786..8c74d52 100644 --- a/doc/files/setup.txt +++ b/doc/files/setup.txt @@ -1,42 +1,28 @@ #title RCBasic Setup [RCBasic Doc] #header SETTING UP RCBASIC -RCBasic comes with 2 command-line tools for creating programs. The first is rcbasic_build which takes your sourcecode in your *.bas file and compiles it into a *.cbc file. The *.cbc file contains intermediate bytecode which can be ran with the rcbasic (rcbasic.exe on windows) application. - -NOTE: On Windows, you need to include all the 32-bit dlls with the 32-bit executable and all the 64-bit dlls with the 64-bit executable. The rcbasic package tool will automatically do all of this for you as well as package for other systems as well. - -

    RUN PROGRAMS FROM GEANY

    - -LINUX -In the installer directory there is a folder called geany_files. Inside the folder there is a file named filetypes.rcbasic. You can override the geany *.bas configuration by replacing the freeBasic configuration with this file. Just copy this file to the geany filedefs path, which on most linux distibutions should be (/home/.config/geany/filedefs), and rename the file to filetypes.freebasic. - -Once you have rcbasic set up with geany you just need to create a new file and save it as *.bas. Then you can compile your program by going to Build->Compile. Once your program is compiled you can run it by going to Build->Execute. - -NOTE: If you want to use a different file extension for rcbasic programs you can still use this file and just set it up for a different extension. Refer to the geany documentation on how to set up different file types. - - -WINDOWS -Geany comes preconfigured with rcbasic on windows. Just run the start_editor.bat file and create a new *.bas file. Select the File->New with Template option in the menu to start with a simple template program. Once you have created a new *.bas file goto Build->Compile to compile your program to a *.cbc file. Then goto Build->Execute to run your program. +To get started with RCBasic, just go into the directory where RCBasic is extracted to and start up RCBasic Studio. You are now ready to start coding. +RCBasic also comes with a 2D level editor called Nirvana and a 3D level editor called Serenity. If you are on linux there is a start up script for each one in the main folder where RCBasic is extracted. On Windows, just go into each folder and start up the exe for the editor you want to use.

    USING RCBASIC FROM THE COMMAND-LINE

    RCBasic will be added to path on install on linux. On Windows you will need to add the rcbasic folder to your path. Either (rcbasic/rcbasic_32) or (rcbasic/rcbasic_64) depending on your operating system. Once rcbasic is in your path you can simple pass a source file to rcbasic_build to create a *.cbc file. #code -rcbasic_build myprogram.bas +rcbasic_build4 myprogram.bas #/code Once you have a *.cbc file you can pass it to rcbasic to run it. #code -rcbasic myprogram.cbc +rcbasic4 myprogram.cbc #/code Both tools also except the --version argument which will simply output the version of rcbasic you are using. #code -rcbasic_build --version -rcbasic -version +rcbasic_build4 --version +rcbasic4 -version #/code diff --git a/doc/files/setvehiclepitchcontrol.txt b/doc/files/setvehiclepitchcontrol.txt new file mode 100644 index 0000000..90a9f8c --- /dev/null +++ b/doc/files/setvehiclepitchcontrol.txt @@ -0,0 +1,9 @@ +#title SetVehiclePitchControl [RCBasic Doc] +#header Sub SetVehiclePitchControl( actor, pitch ) + +Sets a vehicles pitch control. + +Pitch control is a tuning parameter that adds an extra torque to the chassis based on engine force to control how much the vehicle tilts forward or backward under acceleration and braking. + +#ref GetVehiclePitchControl + diff --git a/doc/files/setvideodrawrect.txt b/doc/files/setvideodrawrect.txt index 9c7b6d0..06e6582 100644 --- a/doc/files/setvideodrawrect.txt +++ b/doc/files/setvideodrawrect.txt @@ -1,6 +1,7 @@ #title SetVideoDrawRect [RCBasic Doc] -#header sub SetVideoDrawRect(x, y, w, h) +#header Sub SetVideoDrawRect(x, y, w, h) Sets the area on the current canvas where the video will be displayed. Note: This is a function that was more useful in older versions of RCBasic. Currently its better to use canvas controls for this. + diff --git a/doc/files/setvideoposition.txt b/doc/files/setvideoposition.txt index 53d0f61..ea720e7 100644 --- a/doc/files/setvideoposition.txt +++ b/doc/files/setvideoposition.txt @@ -1,6 +1,7 @@ #title SetVideoPosition [RCBasic Doc] -#header sub SetVideoPosition(pos) +#header Sub SetVideoPosition(pos) Sets the position within the current video in milliseconds #ref GetVideoPosition + diff --git a/doc/files/setvideovolume.txt b/doc/files/setvideovolume.txt index 3615e0d..ab1e560 100644 --- a/doc/files/setvideovolume.txt +++ b/doc/files/setvideovolume.txt @@ -1,4 +1,5 @@ #title SetVideoVolume [RCBasic Doc] -#header sub SetVideoVolume( vol ) +#header Sub SetVideoVolume( vol ) Sets the volume of the video track + diff --git a/doc/files/setwheelactoroffsettransform.txt b/doc/files/setwheelactoroffsettransform.txt new file mode 100644 index 0000000..c01c9cc --- /dev/null +++ b/doc/files/setwheelactoroffsettransform.txt @@ -0,0 +1,9 @@ +#title SetWheelActorOffsetTransform [RCBasic Doc] +#header Sub SetWheelActorOffsetTransform( actor, wheel, t_matrix ) + +Sets an local offset transform for the wheel actor. This is mainly for when the actors local transform does not line up with the axis for the vehicle. + +Refer to the Vehicle demo to see an example of this. + +#ref GetWheelActorOffsetTransform + diff --git a/doc/files/setwheelaxel.txt b/doc/files/setwheelaxel.txt new file mode 100644 index 0000000..2141458 --- /dev/null +++ b/doc/files/setwheelaxel.txt @@ -0,0 +1,9 @@ +#title SetWheelAxel [RCBasic Doc] +#header Sub SetWheelAxel( actor, wheel, x, y, z ) + +Sets the wheel axel direction. + +The axel is the axis the wheel rotates around. + +#ref GetWheelAxel + diff --git a/doc/files/setwheelbrake.txt b/doc/files/setwheelbrake.txt new file mode 100644 index 0000000..a689427 --- /dev/null +++ b/doc/files/setwheelbrake.txt @@ -0,0 +1,7 @@ +#title SetWheelBrake [RCBasic Doc] +#header Sub SetWheelBrake( actor, wheel, brake ) + +Sets the brake value for a wheel + +#ref GetWheelBrake + diff --git a/doc/files/setwheelconnectionpoint.txt b/doc/files/setwheelconnectionpoint.txt new file mode 100644 index 0000000..0a0b124 --- /dev/null +++ b/doc/files/setwheelconnectionpoint.txt @@ -0,0 +1,7 @@ +#title SetWheelConnectionPoint [RCBasic Doc] +#header Sub SetWheelConnectionPoint( actor, wheel, x, y, z ) + +Sets the point in local space where the wheel connects to the chassis + +#ref GetWheelConnectionPoint + diff --git a/doc/files/setwheeldampingcompression.txt b/doc/files/setwheeldampingcompression.txt new file mode 100644 index 0000000..6e5159e --- /dev/null +++ b/doc/files/setwheeldampingcompression.txt @@ -0,0 +1,8 @@ +#title SetWheelDampingCompression [RCBasic Doc] +#header Sub SetWheelDampingCompression( actor, wheel, dcomp_value ) + +Sets a wheels damping compression + +#ref SetWheelDampingRelaxation GetWheelDampingCompression + + diff --git a/doc/files/setwheeldampingrelaxation.txt b/doc/files/setwheeldampingrelaxation.txt new file mode 100644 index 0000000..8dd526c --- /dev/null +++ b/doc/files/setwheeldampingrelaxation.txt @@ -0,0 +1,7 @@ +#title SetWheelDampingRelaxation [RCBasic Doc] +#header Sub SetWheelDampingRelaxation( actor, wheel, drel_value ) + +Sets a wheels damping relaxation + +#ref GetWheelDampingRelaxation SetWheelDampingCompression + diff --git a/doc/files/setwheeldirection.txt b/doc/files/setwheeldirection.txt new file mode 100644 index 0000000..f581398 --- /dev/null +++ b/doc/files/setwheeldirection.txt @@ -0,0 +1,10 @@ +#title SetWheelDirection [RCBasic Doc] +#header Sub SetWheelDirection( actor, wheel, x, y, z ) + +Sets a wheel's direction + +This direction is the direction the suspension of the wheel extends to and not the direction the wheel rolls. +Basically, if the suspension is pointing straight down then the direction would be (0, -1, 0). + +#ref GetWheelDirection + diff --git a/doc/files/setwheelfrictionslip.txt b/doc/files/setwheelfrictionslip.txt new file mode 100644 index 0000000..40c29d0 --- /dev/null +++ b/doc/files/setwheelfrictionslip.txt @@ -0,0 +1,14 @@ +#title SetWheelFrictionSlip [RCBasic Doc] +#header Sub SetWheelFrictionSlip( actor, wheel, fslip_value ) + +Sets the friction slip value for a wheel. + +This value determines how much grip a wheel has before it starts sliding + +#list ul +#li Lower value - more slippery +#li Higher value - more firm grip +#/list + +#ref GetWheelFrictionSlip + diff --git a/doc/files/setwheelinversecontactsuspension.txt b/doc/files/setwheelinversecontactsuspension.txt new file mode 100644 index 0000000..386c5f4 --- /dev/null +++ b/doc/files/setwheelinversecontactsuspension.txt @@ -0,0 +1,11 @@ +#title SetWheelInverseContactSuspension [RCBasic Doc] +#header Sub SetWheelInverseContactSuspension( actor, wheel, c_value ) + +Sets the clipped inverse contact dot suspension. + +This value is a stability factor used to adjust suspension force when the ground contact surface is tilted. + +It prevents suspension forces from exploding when the wheel contacts steep surfaces. + +#ref GetWheelInverseContactSuspension + diff --git a/doc/files/setwheelmaxsuspensiontravel.txt b/doc/files/setwheelmaxsuspensiontravel.txt new file mode 100644 index 0000000..b0b8054 --- /dev/null +++ b/doc/files/setwheelmaxsuspensiontravel.txt @@ -0,0 +1,9 @@ +#title SetWheelMaxSuspensionTravel [RCBasic Doc] +#header Sub SetWheelMaxSuspensionTravel( actor, wheel, max_travel ) + +Sets the max suspension travel distance. + +This value is the maximum distance the suspension is allowed to extend or compress from its rest length set with SetSuspensionLength(). + +#ref GetWheelMaxSuspension + diff --git a/doc/files/setwheelradius.txt b/doc/files/setwheelradius.txt new file mode 100644 index 0000000..59369e3 --- /dev/null +++ b/doc/files/setwheelradius.txt @@ -0,0 +1,7 @@ +#title SetWheelRadius [RCBasic Doc] +#header Sub SetWheelRadius( actor, wheel, radius ) + +Sets the radius of a wheel + +#ref GetWheelRadius + diff --git a/doc/files/setwheelrollinfluence.txt b/doc/files/setwheelrollinfluence.txt new file mode 100644 index 0000000..9c3fc8e --- /dev/null +++ b/doc/files/setwheelrollinfluence.txt @@ -0,0 +1,11 @@ +#title SetWheelRollInfluence [RCBasic Doc] +#header Sub SetWheelRollInfluence( actor, wheel, roll_influence ) + +Sets the roll_influence for a wheel. + +Roll influence controls how much a wheel’s suspension force contributes to the vehicle’s body roll (sideways tipping). + +It’s essentially a stability scaling factor. + +#ref GetWheelRollInfluence + diff --git a/doc/files/setwheelrotation.txt b/doc/files/setwheelrotation.txt new file mode 100644 index 0000000..07a4f7a --- /dev/null +++ b/doc/files/setwheelrotation.txt @@ -0,0 +1,7 @@ +#title SetWheelRotation [RCBasic Doc] +#header Sub SetWheelRotation( actor, wheel, rot ) + +Sets a wheel's spin rotation. + +#ref GetWheelRotation + diff --git a/doc/files/setwheelsteeringvalue.txt b/doc/files/setwheelsteeringvalue.txt new file mode 100644 index 0000000..aade507 --- /dev/null +++ b/doc/files/setwheelsteeringvalue.txt @@ -0,0 +1,7 @@ +#title SetWheelSteeringValue [RCBasic Doc] +#header Sub SetWheelSteeringValue( actor, wheel, steering ) + +Sets the steering value for a wheel + +#ref GetWheelSteeringValue + diff --git a/doc/files/setwheelsuspensionlength.txt b/doc/files/setwheelsuspensionlength.txt new file mode 100644 index 0000000..bb24c98 --- /dev/null +++ b/doc/files/setwheelsuspensionlength.txt @@ -0,0 +1,7 @@ +#title SetWheelSuspensionLength [RCBasic Doc] +#header Sub SetWheelSuspensionLength( actor, wheel, s_length ) + +Sets the suspsension rest length of a wheel + +#ref GetWheelSuspensionLength + diff --git a/doc/files/setwheelsuspensionstiffness.txt b/doc/files/setwheelsuspensionstiffness.txt new file mode 100644 index 0000000..14be229 --- /dev/null +++ b/doc/files/setwheelsuspensionstiffness.txt @@ -0,0 +1,12 @@ +#title SetWheelSuspensionStiffness [RCBasic Doc] +#header Sub SetWheelSuspensionStiffness( actor, wheel, stiffness ) + +Sets the suspension stiffness of a wheel. + +#list ul +#li Higher stiffness - stronger upward force for the same compression +#li Lower stiffness - softer suspension +#/list + +#ref GetWheelSuspensionStiffness + diff --git a/doc/files/setwheelsuspensionvelocity.txt b/doc/files/setwheelsuspensionvelocity.txt new file mode 100644 index 0000000..2149689 --- /dev/null +++ b/doc/files/setwheelsuspensionvelocity.txt @@ -0,0 +1,9 @@ +#title SetWheelSuspensionVelocity [RCBasic Doc] +#header Sub SetWheelSuspensionVelocity( actor, wheel, velocity ) + +Sets the suspension velocity. + +This value is the speed that the suspension compresses or extends at. + +#ref GetWheelSuspensionVelocity + diff --git a/doc/files/setwindowalwaysontop.txt b/doc/files/setwindowalwaysontop.txt index 444102d..c472084 100644 --- a/doc/files/setwindowalwaysontop.txt +++ b/doc/files/setwindowalwaysontop.txt @@ -1,4 +1,5 @@ #title SetWindowAlwaysOnTop [RCBasic Doc] -#header sub SetWindowAlwaysOnTop( flag ) +#header Sub SetWindowAlwaysOnTop( flag ) Sets the window as the highest priority on the display. + diff --git a/doc/files/setwindowautoclose.txt b/doc/files/setwindowautoclose.txt index 56dcf92..b5058ce 100644 --- a/doc/files/setwindowautoclose.txt +++ b/doc/files/setwindowautoclose.txt @@ -1,4 +1,5 @@ #title SetWindowAutoClose [RCBasic Doc] -#header sub SetWindowAutoClose( exit_on_close ) +#header Sub SetWindowAutoClose( exit_on_close ) Sets whether the close button on the window closes it. + diff --git a/doc/files/setwindowbordered.txt b/doc/files/setwindowbordered.txt index d01da10..90c4431 100644 --- a/doc/files/setwindowbordered.txt +++ b/doc/files/setwindowbordered.txt @@ -1,6 +1,7 @@ #title SetWindowBordered [RCBasic Doc] -#header sub SetWindowBordered( flag) +#header Sub SetWindowBordered( flag) Sets whether the window has a border or not. #ref WindowIsBordered + diff --git a/doc/files/setwindowfullscreen.txt b/doc/files/setwindowfullscreen.txt index b89ffd2..d5d4a51 100644 --- a/doc/files/setwindowfullscreen.txt +++ b/doc/files/setwindowfullscreen.txt @@ -1,4 +1,5 @@ #title SetWindowFullscreen [RCBasic Doc] -#header sub SetWindowFullscreen( flag) +#header Sub SetWindowFullscreen( flag) You will never guess what this does + diff --git a/doc/files/setwindowicon.txt b/doc/files/setwindowicon.txt index 12ba367..f8a39c9 100644 --- a/doc/files/setwindowicon.txt +++ b/doc/files/setwindowicon.txt @@ -1,4 +1,5 @@ #title SetWindowIcon [RCBasic Doc] -#header sub SetWindowIcon( img ) +#header Sub SetWindowIcon( img ) Sets the icon that is displayed on the window border + diff --git a/doc/files/setwindowmaxsize.txt b/doc/files/setwindowmaxsize.txt index 13f6edc..7d54f29 100644 --- a/doc/files/setwindowmaxsize.txt +++ b/doc/files/setwindowmaxsize.txt @@ -1,4 +1,5 @@ #title SetWindowMaxSize [RCBasic Doc] -#header sub SetWindowMaxSize( w, h) +#header Sub SetWindowMaxSize( w, h) Sets the max size for a resizable window + diff --git a/doc/files/setwindowminsize.txt b/doc/files/setwindowminsize.txt index 06988b5..c8acdff 100644 --- a/doc/files/setwindowminsize.txt +++ b/doc/files/setwindowminsize.txt @@ -1,4 +1,5 @@ #title SetWindowMinSize [RCBasic Doc] -#header sub SetWindowMinSize( w, h) +#header Sub SetWindowMinSize( w, h) Sets the min size for a resizable window + diff --git a/doc/files/setwindowposition.txt b/doc/files/setwindowposition.txt index a8ee5f2..30750ec 100644 --- a/doc/files/setwindowposition.txt +++ b/doc/files/setwindowposition.txt @@ -1,4 +1,5 @@ #title SetWindowPosition [RCBasic Doc] -#header sub SetWindowPosition( x, y ) +#header Sub SetWindowPosition( x, y ) Sets the position of the window on the display + diff --git a/doc/files/setwindowresizable.txt b/doc/files/setwindowresizable.txt index cf1f85c..553aa1d 100644 --- a/doc/files/setwindowresizable.txt +++ b/doc/files/setwindowresizable.txt @@ -1,4 +1,5 @@ #title SetWindowResizable [RCBasic Doc] -#header sub SetWindowResizable( flag ) +#header Sub SetWindowResizable( flag ) Sets whether or not a window is resizable + diff --git a/doc/files/setwindowsize.txt b/doc/files/setwindowsize.txt index aae9525..b83f3e4 100644 --- a/doc/files/setwindowsize.txt +++ b/doc/files/setwindowsize.txt @@ -1,4 +1,5 @@ #title SetWindowSize [RCBasic Doc] -#header sub SetWindowSize( w, h ) +#header Sub SetWindowSize( w, h ) Sets the size of a window + diff --git a/doc/files/setwindowtitle.txt b/doc/files/setwindowtitle.txt index 78e294c..ffe6e2e 100644 --- a/doc/files/setwindowtitle.txt +++ b/doc/files/setwindowtitle.txt @@ -1,4 +1,5 @@ #title SetWindowTitle [RCBasic Doc] -#header sub SetWindowTitle( title$ ) +#header Sub SetWindowTitle( title$ ) Sets the title of the window + diff --git a/doc/files/setwindowvsync.txt b/doc/files/setwindowvsync.txt index 92ed922..db10200 100644 --- a/doc/files/setwindowvsync.txt +++ b/doc/files/setwindowvsync.txt @@ -1,4 +1,5 @@ #title SetWindowVSync [RCBasic Doc] -#header sub SetWindowVSync( flag ) +#header Sub SetWindowVSync( flag ) + diff --git a/doc/files/setworld2dautoclearforces.txt b/doc/files/setworld2dautoclearforces.txt index f48ac1b..4819f33 100644 --- a/doc/files/setworld2dautoclearforces.txt +++ b/doc/files/setworld2dautoclearforces.txt @@ -1,6 +1,7 @@ #title SetWorld2DAutoClearForces [RCBasic Doc] -#header sub SetWorld2DAutoClearForces( flag ) +#header Sub SetWorld2DAutoClearForces( flag ) Sets the auto clear forces flag for the active canvas #ref GetWorld2DAutoClearForces + diff --git a/doc/files/setworld2dpositioniterations.txt b/doc/files/setworld2dpositioniterations.txt index abec6f0..8898806 100644 --- a/doc/files/setworld2dpositioniterations.txt +++ b/doc/files/setworld2dpositioniterations.txt @@ -1,6 +1,7 @@ #title SetWorld2DPositionIterations [RCBasic Doc] -#header sub SetWorld2DPositionIterations( p ) +#header Sub SetWorld2DPositionIterations( p ) Sets the number of position iterations for the position constraint solver #ref GetWorld2DPositionIterations + diff --git a/doc/files/setworld2dtimestep.txt b/doc/files/setworld2dtimestep.txt index dce5140..d7745b5 100644 --- a/doc/files/setworld2dtimestep.txt +++ b/doc/files/setworld2dtimestep.txt @@ -1,6 +1,7 @@ #title SetWorld2DTimeStep [RCBasic Doc] -#header sub SetWorld2DTimeStep( ts ) +#header Sub SetWorld2DTimeStep( ts ) Sets the timestep for the active canvas #ref GetWorld2DTimeStep + diff --git a/doc/files/setworld2dvelocityiterations.txt b/doc/files/setworld2dvelocityiterations.txt index 4a43ebd..bacc56e 100644 --- a/doc/files/setworld2dvelocityiterations.txt +++ b/doc/files/setworld2dvelocityiterations.txt @@ -1,6 +1,7 @@ #title SetWorld2DVelocityIterations [RCBasic Doc] -#header sub SetWorld2DVelocityIterations( v ) +#header Sub SetWorld2DVelocityIterations( v ) Sets the number of velocity iterations for the velocity constraint solver #ref GetWorld2DVelocityIterations + diff --git a/doc/files/setworld3dmaxsubsteps.txt b/doc/files/setworld3dmaxsubsteps.txt index 4b6d41e..dbc58ae 100644 --- a/doc/files/setworld3dmaxsubsteps.txt +++ b/doc/files/setworld3dmaxsubsteps.txt @@ -1,8 +1,9 @@ #title SetWorld3DMaxSubSteps [RCBasic Doc] -#header sub SetWorld3DMaxSubSteps( steps ) +#header Sub SetWorld3DMaxSubSteps( steps ) Sets the max sub steps to break the simulation up into maxSubSteps - The maximum number of substeps to perform if the time step is larger than the fixedTimeStep. When simulating in real-time, if a frame takes longer than expected (e.g., a frame is delayed), you can break the simulation into several smaller substeps to ensure the simulation is accurate. #ref SetWorld3DMaxTimeStep + diff --git a/doc/files/setworld3dtimestep.txt b/doc/files/setworld3dtimestep.txt index 6169c85..ba6e4db 100644 --- a/doc/files/setworld3dtimestep.txt +++ b/doc/files/setworld3dtimestep.txt @@ -1,8 +1,9 @@ #title SetWorld3DTimeStep [RCBasic Doc] -#header sub SetWorld3DTimeStep( ts ) +#header Sub SetWorld3DTimeStep( ts ) Sets the fixed time step for the physics simulation fixedTimeStep - The fixed time step size, which is the interval at which the physics simulation runs internally. It is often set to 1/60th of a second (0.0166667 seconds) by default, meaning the physics engine updates 60 times per second. #ref SetWorld3DMaxSubSteps + diff --git a/doc/files/showmouse.txt b/doc/files/showmouse.txt index fc6c9f2..0947cbe 100644 --- a/doc/files/showmouse.txt +++ b/doc/files/showmouse.txt @@ -1,4 +1,5 @@ #title ShowMouse [RCBasic Doc] -#header sub ShowMouse() +#header Sub ShowMouse() Sets the mouse cursor visible + diff --git a/doc/files/showwindow.txt b/doc/files/showwindow.txt index 2e15a70..af6cb77 100644 --- a/doc/files/showwindow.txt +++ b/doc/files/showwindow.txt @@ -1,4 +1,5 @@ #title ShowWindow [RCBasic Doc] -#header sub ShowWindow( ) +#header Sub ShowWindow( ) Sets the window visible + diff --git a/doc/files/sign.txt b/doc/files/sign.txt index 4d9b649..f26dee9 100644 --- a/doc/files/sign.txt +++ b/doc/files/sign.txt @@ -1,8 +1,9 @@ #title Sign [RCBasic Doc] -#header function Sign(n) +#header Function Sign(n) Returns the sign of a number n < 0 returns -1 n = 0 returns 0 n > 0 returns 1 + diff --git a/doc/files/sin.txt b/doc/files/sin.txt index 99fcd02..3e37150 100644 --- a/doc/files/sin.txt +++ b/doc/files/sin.txt @@ -1,4 +1,5 @@ #title Sin [RCBasic Doc] -#header function Sin(n) +#header Function Sin(n) Returns the sine of angle n + diff --git a/doc/files/size.txt b/doc/files/size.txt index b4c4518..3055e1d 100644 --- a/doc/files/size.txt +++ b/doc/files/size.txt @@ -1,8 +1,9 @@ #title Size [RCBasic Doc] -#header function Size(s$) +#header Function Size(s$) Returns the size in bytes of a string The size will not always be the same as the length. For instance, a lot of unicode characters are represented by more than one byte. #ref Len Length + diff --git a/doc/files/solvematrix.txt b/doc/files/solvematrix.txt index 9b8bd93..44246dc 100644 --- a/doc/files/solvematrix.txt +++ b/doc/files/solvematrix.txt @@ -1,6 +1,7 @@ #title SolveMatrix [RCBasic Doc] -#header function SolveMatrix(mA, mB, mC) +#header Function SolveMatrix(mA, mB, mC) Solve the system that has mA as coefficient and mB as the hand side of the equation. Stores the result in mC. Returns true if it was able to be solved and false if not. + diff --git a/doc/files/sortspritelayer.txt b/doc/files/sortspritelayer.txt deleted file mode 100644 index b3c807b..0000000 --- a/doc/files/sortspritelayer.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title SortSpriteLayer [RCBasic Doc] -#header Function SortSpriteLayer( c_num, sort_option ) - - diff --git a/doc/files/soundexists.txt b/doc/files/soundexists.txt index 43304d5..c3838b6 100644 --- a/doc/files/soundexists.txt +++ b/doc/files/soundexists.txt @@ -1,4 +1,5 @@ #title SoundExists [RCBasic Doc] -#header function SoundExists(snd) +#header Function SoundExists(snd) Returns true if the snd id given is associated with an allocated audio track in memory + diff --git a/doc/files/soundisenabled.txt b/doc/files/soundisenabled.txt index d9716eb..c2f4d67 100644 --- a/doc/files/soundisenabled.txt +++ b/doc/files/soundisenabled.txt @@ -1,4 +1,5 @@ #title SoundIsEnabled [RCBasic Doc] -#header function SoundIsEnabled() +#header Function SoundIsEnabled() Returns true if the audio subsystem has been initialized. + diff --git a/doc/files/spriteanimationisplaying.txt b/doc/files/spriteanimationisplaying.txt index b1132af..61fe1e6 100644 --- a/doc/files/spriteanimationisplaying.txt +++ b/doc/files/spriteanimationisplaying.txt @@ -2,3 +2,4 @@ #header Function SpriteAnimationIsPlaying(sprite) Returns true if there is an animation playing on the sprite + diff --git a/doc/files/spriteexists.txt b/doc/files/spriteexists.txt index bc1d54b..cc01732 100644 --- a/doc/files/spriteexists.txt +++ b/doc/files/spriteexists.txt @@ -2,3 +2,4 @@ #header Function SpriteExists(sprite) Returns true if the sprite id is a valid sprite id + diff --git a/doc/files/spriteheight.txt b/doc/files/spriteheight.txt index 92dbbe3..f44d197 100644 --- a/doc/files/spriteheight.txt +++ b/doc/files/spriteheight.txt @@ -51,3 +51,4 @@ Wend #ref SpriteWidth GetSpriteSize + diff --git a/doc/files/spriteisawake.txt b/doc/files/spriteisawake.txt index d67101f..8daffe1 100644 --- a/doc/files/spriteisawake.txt +++ b/doc/files/spriteisawake.txt @@ -1,6 +1,7 @@ -#title spriteIsAwake [RCBasic Doc] -#header function spriteIsAwake( spr_id) +#title SpriteIsAwake [RCBasic Doc] +#header Function SpriteIsAwake( spr_id) Wakes a sleeping sprite #ref SetSpriteAwake SpriteIsSleepAllowed SetSpriteSleepAllowed + diff --git a/doc/files/spriteisbullet.txt b/doc/files/spriteisbullet.txt index 992041c..bb71e29 100644 --- a/doc/files/spriteisbullet.txt +++ b/doc/files/spriteisbullet.txt @@ -1,8 +1,9 @@ -#title spriteIsBullet [RCBasic Doc] -#header function spriteIsBullet( spr_id) +#title SpriteIsBullet [RCBasic Doc] +#header Function SpriteIsBullet( spr_id) Returns whether body has continuous collision detection Note: Useful for fast moving objects #ref SetSpriteBullet + diff --git a/doc/files/spriteisfixedrotation.txt b/doc/files/spriteisfixedrotation.txt index 82a8830..5b5a05e 100644 --- a/doc/files/spriteisfixedrotation.txt +++ b/doc/files/spriteisfixedrotation.txt @@ -1,6 +1,7 @@ -#title spriteIsFixedRotation [RCBasic Doc] -#header function spriteIsFixedRotation( spr_id) +#title SpriteIsFixedRotation [RCBasic Doc] +#header Function SpriteIsFixedRotation( spr_id) Returns whether fixed rotation is set on the sprite #ref SetSpriteFixedRotation + diff --git a/doc/files/spriteissolid.txt b/doc/files/spriteissolid.txt index f11e968..d806142 100644 --- a/doc/files/spriteissolid.txt +++ b/doc/files/spriteissolid.txt @@ -51,3 +51,4 @@ Wend #image "images/theEye.png" #ref SetSpriteSolid + diff --git a/doc/files/spriteisvisible.txt b/doc/files/spriteisvisible.txt index ea784c1..9695f69 100644 --- a/doc/files/spriteisvisible.txt +++ b/doc/files/spriteisvisible.txt @@ -47,3 +47,4 @@ Wend #image "images/theEye.png" #ref SetSpriteVisible + diff --git a/doc/files/spritesleepallowed.txt b/doc/files/spritesleepallowed.txt index 4e2bcb3..cc36188 100644 --- a/doc/files/spritesleepallowed.txt +++ b/doc/files/spritesleepallowed.txt @@ -1,6 +1,7 @@ -#title spriteSleepAllowed [RCBasic Doc] -#header function spriteSleepAllowed( spr_id) +#title SpriteSleepAllowed [RCBasic Doc] +#header Function SpriteSleepAllowed( spr_id) Whether the body is allowed to go to sleep when it's at rest #ref SetSpriteSleepAllowed SpriteIsAwake SetSpriteAwake + diff --git a/doc/files/spritewidth.txt b/doc/files/spritewidth.txt index 0de5f6a..619511d 100644 --- a/doc/files/spritewidth.txt +++ b/doc/files/spritewidth.txt @@ -50,3 +50,4 @@ Wend
    #ref SpriteHeight GetSpriteSize + diff --git a/doc/files/spritex.txt b/doc/files/spritex.txt index da1d886..3d15cba 100644 --- a/doc/files/spritex.txt +++ b/doc/files/spritex.txt @@ -68,3 +68,4 @@ Wend #ref SpriteY SetSpritePosition GetSpritePosition + diff --git a/doc/files/spritey.txt b/doc/files/spritey.txt index 1e4de30..d6bd6a1 100644 --- a/doc/files/spritey.txt +++ b/doc/files/spritey.txt @@ -66,3 +66,4 @@ Wend
    #ref SpriteX SetSpritePosition GetSpritePosition SpriteX + diff --git a/doc/files/spritez.txt b/doc/files/spritez.txt index a771676..06ab537 100644 --- a/doc/files/spritez.txt +++ b/doc/files/spritez.txt @@ -70,3 +70,4 @@ Wend
    #ref SetSpriteZ + diff --git a/doc/files/sqrt.txt b/doc/files/sqrt.txt index 2665f91..4679add 100644 --- a/doc/files/sqrt.txt +++ b/doc/files/sqrt.txt @@ -1,4 +1,5 @@ #title Sqrt [RCBasic Doc] -#header function Sqrt(n) +#header Function Sqrt(n) Returns the square root of n + diff --git a/doc/files/squarematrix.txt b/doc/files/squarematrix.txt index 7f92595..6a6e630 100644 --- a/doc/files/squarematrix.txt +++ b/doc/files/squarematrix.txt @@ -1,4 +1,5 @@ #title SquareMatrix [RCBasic Doc] -#header function SquareMatrix(mA, mB) +#header Function SquareMatrix(mA, mB) Stores the square of matrix mA in the matrix mB + diff --git a/doc/files/stack_n_exists.txt b/doc/files/stack_n_exists.txt new file mode 100644 index 0000000..11a56d1 --- /dev/null +++ b/doc/files/stack_n_exists.txt @@ -0,0 +1,5 @@ +#title Stack_N_Exists [RCBasic Doc] +#header Function Stack_N_Exists( num_stack ) + +Returns TRUE if the given number stack exists and FALSE if not. + diff --git a/doc/files/stack_s_exists.txt b/doc/files/stack_s_exists.txt new file mode 100644 index 0000000..e662466 --- /dev/null +++ b/doc/files/stack_s_exists.txt @@ -0,0 +1,5 @@ +#title Stack_S_Exists [RCBasic Doc] +#header Function Stack_S_Exists( str_stack ) + +Returns TRUE if the given string stack exists and FALSE if not. + diff --git a/doc/files/stack_size_n.txt b/doc/files/stack_size_n.txt index 834e08b..f27cf6a 100644 --- a/doc/files/stack_size_n.txt +++ b/doc/files/stack_size_n.txt @@ -1,4 +1,5 @@ #title Stack_Size_N [RCBasic Doc] -#header function Stack_Size_N( num_stack ) +#header Function Stack_Size_N( num_stack ) Returns the number of elements on a number stack + diff --git a/doc/files/stack_size_s.txt b/doc/files/stack_size_s.txt index 2f4651e..31e53d7 100644 --- a/doc/files/stack_size_s.txt +++ b/doc/files/stack_size_s.txt @@ -1,4 +1,5 @@ #title Stack_Size_S [RCBasic Doc] -#header function Stack_Size_S( str_stack ) +#header Function Stack_Size_S( str_stack ) Returns the number of elements on a string stack + diff --git a/doc/files/startactortransition.txt b/doc/files/startactortransition.txt deleted file mode 100644 index 821ffb9..0000000 --- a/doc/files/startactortransition.txt +++ /dev/null @@ -1,15 +0,0 @@ -#title StartActorTransition [RCBasic Doc] -#header sub StartActorTransition( actor, frame, transition_time ) - -Starts an actor transition from its current frame in an animation to a specified frame - -#list ul -#li frame - The frame to transition to -#li transition_time - The amount of time to transition - #list ul - #li The shorter the time is, the faster the transition will be - #li Time is in seconds - #/list -#/list - -#ref StopActorTransition ActorIsInTransition diff --git a/doc/files/startparticleemitter.txt b/doc/files/startparticleemitter.txt index 4153fab..8eadf79 100644 --- a/doc/files/startparticleemitter.txt +++ b/doc/files/startparticleemitter.txt @@ -1,6 +1,7 @@ -#title startParticleEmitter [RCBasic Doc] -#header sub startParticleEmitter( actor) +#title StartParticleEmitter [RCBasic Doc] +#header Sub StartParticleEmitter( actor) Starts particle emission for a particle actor #ref StopParticleEmitter + diff --git a/doc/files/steam_addachievement.txt b/doc/files/steam_addachievement.txt index 5d6649c..3156c05 100644 --- a/doc/files/steam_addachievement.txt +++ b/doc/files/steam_addachievement.txt @@ -1,8 +1,9 @@ #title Steam_AddAchievement [RCBasic Doc] -#header sub Steam_AddAchievement( ach_id$, ach_name$ ) +#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 index dd3a2c6..5a6c1a5 100644 --- a/doc/files/steam_clearachievements.txt +++ b/doc/files/steam_clearachievements.txt @@ -1,6 +1,7 @@ #title Steam_ClearAchievements [RCBasic Doc] -#header sub Steam_ClearAchievements() +#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 index 2ab16b7..c2f697c 100644 --- a/doc/files/steam_finalizeachievements.txt +++ b/doc/files/steam_finalizeachievements.txt @@ -1,6 +1,7 @@ #title Steam_FinalizeAchievements [RCBasic Doc] -#header sub Steam_FinalizeAchievements() +#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 index ce07c23..b25ee9c 100644 --- a/doc/files/steam_getid.txt +++ b/doc/files/steam_getid.txt @@ -1,6 +1,7 @@ #title Steam_GetID$ [RCBasic Doc] -#header function Steam_GetID$() +#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 index 5fa79dd..dc60943 100644 --- a/doc/files/steam_triggerachievement.txt +++ b/doc/files/steam_triggerachievement.txt @@ -1,5 +1,5 @@ #title Steam_TriggerAchievement [RCBasic Doc] -#header function Steam_TriggerAchievement( ach_name$ ) +#header Function Steam_TriggerAchievement( ach_name$ ) Unlocks a steam achievement in the current application. @@ -7,3 +7,4 @@ 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/stopactortransition.txt b/doc/files/stopactortransition.txt deleted file mode 100644 index f277c23..0000000 --- a/doc/files/stopactortransition.txt +++ /dev/null @@ -1,6 +0,0 @@ -#title StopActorTransition [RCBasic Doc] -#header sub StopActorTransition( actor ) - -Stops a transition that was started with StartActorTransition - -#ref StartActorTransition ActorIsInTransition diff --git a/doc/files/stopmusic.txt b/doc/files/stopmusic.txt index 2154dfb..1653efb 100644 --- a/doc/files/stopmusic.txt +++ b/doc/files/stopmusic.txt @@ -1,6 +1,7 @@ #title StopMusic [RCBasic Doc] -#header sub StopMusic() +#header Sub StopMusic() Stops playing the loaded music track and resets the music position to 0 #ref PlayMusic PauseMusic + diff --git a/doc/files/stopparticleemitter.txt b/doc/files/stopparticleemitter.txt index eb23fce..44581a2 100644 --- a/doc/files/stopparticleemitter.txt +++ b/doc/files/stopparticleemitter.txt @@ -1,6 +1,7 @@ -#title stopParticleEmitter [RCBasic Doc] -#header sub stopParticleEmitter( actor) +#title StopParticleEmitter [RCBasic Doc] +#header Sub StopParticleEmitter( actor) Stops particle emission for a particle actor #ref StartParticleEmitter + diff --git a/doc/files/stopsound.txt b/doc/files/stopsound.txt index 0a12cd1..203a32d 100644 --- a/doc/files/stopsound.txt +++ b/doc/files/stopsound.txt @@ -1,4 +1,5 @@ #title StopSound [RCBasic Doc] -#header sub StopSound(channel) +#header Sub StopSound(channel) Stops playing sound on the specified channel + diff --git a/doc/files/stopvideo.txt b/doc/files/stopvideo.txt index d641926..49376bd 100644 --- a/doc/files/stopvideo.txt +++ b/doc/files/stopvideo.txt @@ -1,6 +1,7 @@ #title StopVideo [RCBasic Doc] -#header sub StopVideo() +#header Sub StopVideo() Stops playing the loaded video track and resets the video position to 0 #ref PlayVideo PauseVideo + diff --git a/doc/files/str.txt b/doc/files/str.txt index 340112a..06b9386 100644 --- a/doc/files/str.txt +++ b/doc/files/str.txt @@ -1,4 +1,5 @@ #title Str$ [RCBasic Doc] -#header function Str$(n) +#header Function Str$(n) Returns a number converted to a string + diff --git a/doc/files/str_f.txt b/doc/files/str_f.txt index 2ed2984..7942d28 100644 --- a/doc/files/str_f.txt +++ b/doc/files/str_f.txt @@ -1,8 +1,9 @@ #title Str_F$ [RCBasic Doc] -#header function Str_F$(n) +#header Function Str_F$(n) Returns a number converted to a string in fixed notation The number will be returned with 6 decimal places of precision. #ref Str$ Str_S$ + diff --git a/doc/files/str_s.txt b/doc/files/str_s.txt index a33ce20..44a282c 100644 --- a/doc/files/str_s.txt +++ b/doc/files/str_s.txt @@ -1,7 +1,8 @@ #title Str_S$ [RCBasic Doc] -#header function Str_S$(n) +#header Function Str_S$(n) Returns a number converted to a string in scientific notation #ref Str$ Str_F$ + diff --git a/doc/files/stringarraycopy.txt b/doc/files/stringarraycopy.txt index ffb1c87..093dc4d 100644 --- a/doc/files/stringarraycopy.txt +++ b/doc/files/stringarraycopy.txt @@ -1,5 +1,5 @@ #title StringArrayCopy [RCBasic Doc] -#header sub StringArrayCopy(ByRef src$, ByRef dst$) +#header Sub StringArrayCopy(ByRef src$, ByRef dst$) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArrayCopy + diff --git a/doc/files/stringarraydim.txt b/doc/files/stringarraydim.txt index fba6904..0926cde 100644 --- a/doc/files/stringarraydim.txt +++ b/doc/files/stringarraydim.txt @@ -1,5 +1,5 @@ #title StringArrayDim [RCBasic Doc] -#header function StringArrayDim(Byref id$) +#header Function StringArrayDim(ByRef id$) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArrayDim + diff --git a/doc/files/stringarrayfill.txt b/doc/files/stringarrayfill.txt index 09bd05c..7ffff5e 100644 --- a/doc/files/stringarrayfill.txt +++ b/doc/files/stringarrayfill.txt @@ -1,5 +1,5 @@ #title StringArrayFill [RCBasic Doc] -#header sub StringArrayFill(ByRef src$, fdata$) +#header Sub StringArrayFill(ByRef src$, fdata$) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArrayFill + diff --git a/doc/files/stringarraysize.txt b/doc/files/stringarraysize.txt index 6df1733..2b6d0ec 100644 --- a/doc/files/stringarraysize.txt +++ b/doc/files/stringarraysize.txt @@ -1,5 +1,5 @@ #title StringArraySize [RCBasic Doc] -#header function StringArraySize(Byref id$, array_dim) +#header Function StringArraySize(ByRef id$, array_dim) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArraySize + diff --git a/doc/files/stringfill.txt b/doc/files/stringfill.txt index 5fc2972..cd360ce 100644 --- a/doc/files/stringfill.txt +++ b/doc/files/stringfill.txt @@ -1,4 +1,5 @@ #title StringFill$ [RCBasic Doc] -#header function StringFill$(src$, n) +#header Function StringFill$(src$, n) Returns a string filled with src$ repeated n times + diff --git a/doc/files/stringfrombuffer.txt b/doc/files/stringfrombuffer.txt index 4092010..ae9bc2f 100644 --- a/doc/files/stringfrombuffer.txt +++ b/doc/files/stringfrombuffer.txt @@ -1,4 +1,5 @@ #title StringFromBuffer$ [RCBasic Doc] -#header function StringFromBuffer$(ByRef buffer, buffer_size) +#header Function StringFromBuffer$(ByRef buffer, buffer_size) Returns a string generated from the character values stored in the buffer + diff --git a/doc/files/subtractmatrix.txt b/doc/files/subtractmatrix.txt index ece702d..c0deed7 100644 --- a/doc/files/subtractmatrix.txt +++ b/doc/files/subtractmatrix.txt @@ -1,4 +1,5 @@ #title SubtractMatrix [RCBasic Doc] -#header function SubtractMatrix(mA, mB, mC) +#header Function SubtractMatrix(mA, mB, mC) Stores matrix mA minus matrix mB in matrix mC + diff --git a/doc/files/swapmatrix.txt b/doc/files/swapmatrix.txt index 1a51c51..402aef5 100644 --- a/doc/files/swapmatrix.txt +++ b/doc/files/swapmatrix.txt @@ -1,4 +1,5 @@ #title SwapMatrix [RCBasic Doc] -#header sub SwapMatrix(mA, mB) +#header Sub SwapMatrix(mA, mB) Swaps the contents of 2 matrices + diff --git a/doc/files/swapmatrixcolumn.txt b/doc/files/swapmatrixcolumn.txt index 4292fdc..ddbad45 100644 --- a/doc/files/swapmatrixcolumn.txt +++ b/doc/files/swapmatrixcolumn.txt @@ -1,4 +1,5 @@ #title SwapMatrixColumn [RCBasic Doc] -#header function SwapMatrixColumn(mA, C1, C2) +#header Function SwapMatrixColumn(mA, C1, C2) Swaps the contents of 2 columns in a matrix + diff --git a/doc/files/swapmatrixrow.txt b/doc/files/swapmatrixrow.txt index f039a6a..3bec6db 100644 --- a/doc/files/swapmatrixrow.txt +++ b/doc/files/swapmatrixrow.txt @@ -1,4 +1,5 @@ #title SwapMatrixRow [RCBasic Doc] -#header function SwapMatrixRow(mA, R1, R2) +#header Function SwapMatrixRow(mA, R1, R2) Swaps the contents of 2 rows in a matrix + diff --git a/doc/files/system.txt b/doc/files/system.txt index 40d03b5..d9577f5 100644 --- a/doc/files/system.txt +++ b/doc/files/system.txt @@ -1,4 +1,5 @@ #title System [RCBasic Doc] -#header function System(cmd$) +#header Function System(cmd$) Runs an operating system command + diff --git a/doc/files/systemram.txt b/doc/files/systemram.txt index d3dbd87..496873b 100644 --- a/doc/files/systemram.txt +++ b/doc/files/systemram.txt @@ -1,4 +1,5 @@ #title SystemRam [RCBasic Doc] -#header function SystemRam() +#header Function SystemRam() Returns the amount of RAM available + diff --git a/doc/files/systemreturnstdout.txt b/doc/files/systemreturnstdout.txt index 6c907da..2018100 100644 --- a/doc/files/systemreturnstdout.txt +++ b/doc/files/systemreturnstdout.txt @@ -1,6 +1,7 @@ #title SystemReturnStdOut$ [RCBasic Doc] -#header function SystemReturnStdOut$(cmd$) +#header Function SystemReturnStdOut$(cmd$) Runs an operating system command and returns the output #ref System + diff --git a/doc/files/tally.txt b/doc/files/tally.txt index 0a4f2b4..449faf5 100644 --- a/doc/files/tally.txt +++ b/doc/files/tally.txt @@ -1,4 +1,5 @@ #title Tally [RCBasic Doc] -#header function Tally(src$, substr$) +#header Function Tally(src$, Substr$) Returns the number of instances of substr$ in the src$ string + diff --git a/doc/files/tan.txt b/doc/files/tan.txt index 8228f51..fed4692 100644 --- a/doc/files/tan.txt +++ b/doc/files/tan.txt @@ -1,4 +1,5 @@ #title Tan [RCBasic Doc] -#header function Tan(n) +#header Function Tan(n) Returns the tangent of n + diff --git a/doc/files/tcp_acceptsocket.txt b/doc/files/tcp_acceptsocket.txt index 250726b..304d5e5 100644 --- a/doc/files/tcp_acceptsocket.txt +++ b/doc/files/tcp_acceptsocket.txt @@ -1,4 +1,5 @@ #title TCP_AcceptSocket [RCBasic Doc] -#header function TCP_AcceptSocket(server) +#header Function TCP_AcceptSocket(server) Attempts to accept a connection from a server socket. If successful it will return a client socket id. If it fails it will return -1. + diff --git a/doc/files/tcp_closesocket.txt b/doc/files/tcp_closesocket.txt index 7a04842..dd911d5 100644 --- a/doc/files/tcp_closesocket.txt +++ b/doc/files/tcp_closesocket.txt @@ -1,4 +1,5 @@ #title TCP_CloseSocket [RCBasic Doc] -#header sub TCP_CloseSocket(socket) +#header Sub TCP_CloseSocket(socket) Closes a socket + diff --git a/doc/files/tcp_getdata.txt b/doc/files/tcp_getdata.txt index 2f165e7..4c45098 100644 --- a/doc/files/tcp_getdata.txt +++ b/doc/files/tcp_getdata.txt @@ -1,4 +1,5 @@ #title TCP_GetData [RCBasic Doc] -#header function TCP_GetData(socket, numBytes, ByRef sData$) +#header Function TCP_GetData(socket, numBytes, ByRef sData$) Reads a given number of bytes from a socket + diff --git a/doc/files/tcp_opensocket.txt b/doc/files/tcp_opensocket.txt index 1d170bf..54a38b8 100644 --- a/doc/files/tcp_opensocket.txt +++ b/doc/files/tcp_opensocket.txt @@ -1,4 +1,5 @@ #title TCP_OpenSocket [RCBasic Doc] -#header function TCP_OpenSocket(host$, port) +#header Function TCP_OpenSocket(host$, port) Opens a socket to talk to host$ on the given port + diff --git a/doc/files/tcp_remotehost.txt b/doc/files/tcp_remotehost.txt index bc1dcdc..2803b57 100644 --- a/doc/files/tcp_remotehost.txt +++ b/doc/files/tcp_remotehost.txt @@ -1,4 +1,5 @@ #title TCP_RemoteHost [RCBasic Doc] -#header function TCP_RemoteHost(socket) +#header Function TCP_RemoteHost(socket) Returns the destination host address + diff --git a/doc/files/tcp_remoteport.txt b/doc/files/tcp_remoteport.txt index ed804cc..f764b88 100644 --- a/doc/files/tcp_remoteport.txt +++ b/doc/files/tcp_remoteport.txt @@ -1,4 +1,5 @@ #title TCP_RemotePort [RCBasic Doc] -#header function TCP_RemotePort(socket) +#header Function TCP_RemotePort(socket) Returns the port the socket is connecting on + diff --git a/doc/files/tcp_senddata.txt b/doc/files/tcp_senddata.txt index 63b506d..0ce3821 100644 --- a/doc/files/tcp_senddata.txt +++ b/doc/files/tcp_senddata.txt @@ -1,4 +1,5 @@ #title TCP_SendData [RCBasic Doc] -#header sub TCP_SendData(socket, sData$) +#header Sub TCP_SendData(socket, sData$) Send data through the given socket. + diff --git a/doc/files/tcp_socketready.txt b/doc/files/tcp_socketready.txt index 2aaef60..4614aec 100644 --- a/doc/files/tcp_socketready.txt +++ b/doc/files/tcp_socketready.txt @@ -1,4 +1,5 @@ #title TCP_SocketReady [RCBasic Doc] -#header function TCP_SocketReady(socket) +#header Function TCP_SocketReady(socket) Returns 0 for no activity and non zero for activity. You need to call CheckSockets() at some point before this otherwise it will always return 0. + diff --git a/doc/files/tell.txt b/doc/files/tell.txt index 4184850..f8da0fd 100644 --- a/doc/files/tell.txt +++ b/doc/files/tell.txt @@ -1,4 +1,5 @@ #title Tell [RCBasic Doc] -#header function Tell(stream) +#header Function Tell(stream) Returns the current position within the file stream + diff --git a/doc/files/textheight.txt b/doc/files/textheight.txt index 1741a1f..9e025ed 100644 --- a/doc/files/textheight.txt +++ b/doc/files/textheight.txt @@ -1,7 +1,8 @@ #title TextHeight [RCBasic Doc] -#header function TextHeight(txt$) +#header Function TextHeight(txt$) The height of text rendered with the active font #ref TextWidth GetTextSize + diff --git a/doc/files/textwidth.txt b/doc/files/textwidth.txt index 9865276..f58b57d 100644 --- a/doc/files/textwidth.txt +++ b/doc/files/textwidth.txt @@ -1,6 +1,7 @@ #title TextWidth [RCBasic Doc] -#header function TextWidth(txt$) +#header Function TextWidth(txt$) The width of text rendered with the active font #ref TextHeight GetTextSize + diff --git a/doc/files/ticks.txt b/doc/files/ticks.txt index 14825a1..d0d9dd7 100644 --- a/doc/files/ticks.txt +++ b/doc/files/ticks.txt @@ -1,4 +1,5 @@ #title Ticks [RCBasic Doc] -#header function Ticks() +#header Function Ticks() Returns the number of CPU ticks since the start of a program + diff --git a/doc/files/tilemapexists.txt b/doc/files/tilemapexists.txt index 0460330..8be968b 100644 --- a/doc/files/tilemapexists.txt +++ b/doc/files/tilemapexists.txt @@ -4,3 +4,4 @@ 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 index 49dce1d..e1c9741 100644 --- a/doc/files/tilesetexists.txt +++ b/doc/files/tilesetexists.txt @@ -4,3 +4,4 @@ Returns true if the given tileset is an active tileset in the program #ref TileMapExists + diff --git a/doc/files/time.txt b/doc/files/time.txt index 574c68b..cc5a851 100644 --- a/doc/files/time.txt +++ b/doc/files/time.txt @@ -1,4 +1,5 @@ #title Time$ [RCBasic Doc] -#header function Time$() +#header Function Time$() Returns the current time in "HH:MM:SS" format + diff --git a/doc/files/timer.txt b/doc/files/timer.txt index 0f6a398..06348ee 100644 --- a/doc/files/timer.txt +++ b/doc/files/timer.txt @@ -1,4 +1,5 @@ #title Timer [RCBasic Doc] -#header function Timer() +#header Function Timer() Returns the number of milliseconds since the start of the program. + diff --git a/doc/files/touchpressure.txt b/doc/files/touchpressure.txt index b9c8de0..a30f222 100644 --- a/doc/files/touchpressure.txt +++ b/doc/files/touchpressure.txt @@ -1,4 +1,5 @@ #title TouchPressure [RCBasic Doc] -#header function TouchPressure() +#header Function TouchPressure() Returns the touch pressure of a touch event. + diff --git a/doc/files/touchx.txt b/doc/files/touchx.txt index 37df950..bc9a258 100644 --- a/doc/files/touchx.txt +++ b/doc/files/touchx.txt @@ -1,6 +1,7 @@ #title TouchX [RCBasic Doc] -#header function TouchX() +#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 index 91a8ee0..9a2efcc 100644 --- a/doc/files/touchy.txt +++ b/doc/files/touchy.txt @@ -1,7 +1,8 @@ #title TouchY [RCBasic Doc] -#header function TouchY() +#header Function TouchY() Return the Y Position of a touch event #ref TouchX GetTouch GetTouchFinger + diff --git a/doc/files/translateactorlocal.txt b/doc/files/translateactorlocal.txt index b54a5d8..99d1645 100644 --- a/doc/files/translateactorlocal.txt +++ b/doc/files/translateactorlocal.txt @@ -1,4 +1,5 @@ #title TranslateActorLocal [RCBasic Doc] -#header sub TranslateActorLocal( actor, x, y, z ) +#header Sub TranslateActorLocal( actor, x, y, z ) Moves an actor relative to its current position + diff --git a/doc/files/translateactorworld.txt b/doc/files/translateactorworld.txt index 8ef62ce..ec41516 100644 --- a/doc/files/translateactorworld.txt +++ b/doc/files/translateactorworld.txt @@ -1,4 +1,5 @@ #title TranslateActorWorld [RCBasic Doc] -#header sub TranslateActorWorld( actor, x, y, z ) +#header Sub TranslateActorWorld( actor, x, y, z ) Moves an actor relative to its current position + diff --git a/doc/files/translatecamera.txt b/doc/files/translatecamera.txt index 4c1e0fa..fe16d75 100644 --- a/doc/files/translatecamera.txt +++ b/doc/files/translatecamera.txt @@ -1,4 +1,5 @@ #title TranslateCamera [RCBasic Doc] -#header sub TranslateCamera( x, y, z) +#header Sub TranslateCamera( x, y, z) Moves the camera relative to its current position + diff --git a/doc/files/translatesprite.txt b/doc/files/translatesprite.txt index 21b05b6..c3788fc 100644 --- a/doc/files/translatesprite.txt +++ b/doc/files/translatesprite.txt @@ -6,3 +6,4 @@ Move a sprite relative to its current position Note: This function sets the position of a sprite without regards to physics properties so it will not trigger collision detection or collision response. #ref SetSpritePosition GetSpritePosition + diff --git a/doc/files/transposematrix.txt b/doc/files/transposematrix.txt index eae9039..a6f6b33 100644 --- a/doc/files/transposematrix.txt +++ b/doc/files/transposematrix.txt @@ -1,4 +1,5 @@ #title TransposeMatrix [RCBasic Doc] -#header function TransposeMatrix(mA, mB) +#header Function TransposeMatrix(mA, mB) Stores the transpose of matrix mA in matrix mB + diff --git a/doc/files/triangle.txt b/doc/files/triangle.txt index baf8414..d901dfc 100644 --- a/doc/files/triangle.txt +++ b/doc/files/triangle.txt @@ -1,5 +1,6 @@ #title Triangle [RCBasic Doc] -#header sub Triangle(x1, y1, x2, y2, x3, y3) +#header Sub Triangle(x1, y1, x2, y2, x3, y3) Draws a filled Triangle + diff --git a/doc/files/triangle3d.txt b/doc/files/triangle3d.txt index 8a070f8..44d44d4 100644 --- a/doc/files/triangle3d.txt +++ b/doc/files/triangle3d.txt @@ -1,4 +1,5 @@ #title Triangle3D [RCBasic Doc] -#header sub Triangle3D(x1, y1, z1, x2, y2, z2, x3, y3, z3) +#header Sub Triangle3D(x1, y1, z1, x2, y2, z2, x3, y3, z3) Draws a triangle in 3D space + diff --git a/doc/files/trim.txt b/doc/files/trim.txt index d2e64a2..a0e2e94 100644 --- a/doc/files/trim.txt +++ b/doc/files/trim.txt @@ -1,4 +1,5 @@ #title Trim$ [RCBasic Doc] -#header function Trim$(src$) +#header Function Trim$(src$) Returns src$ with all leading and trailing spaces removed + diff --git a/doc/files/typearraycopy.txt b/doc/files/typearraycopy.txt index 652df26..b4647fa 100644 --- a/doc/files/typearraycopy.txt +++ b/doc/files/typearraycopy.txt @@ -1,8 +1,9 @@ #title TypeArrayCopy [RCBasic Doc] -#header sub TypeArrayCopy(ByRef src as empty, ByRef dst as empty) +#header Sub TypeArrayCopy(ByRef src as empty, ByRef dst as empty) This function is exists to be internally called by the runtime but should not be called directly. Use ArrayCopy() #ref ArrayCopy + diff --git a/doc/files/typearraydim.txt b/doc/files/typearraydim.txt index 31da7e5..4d62907 100644 --- a/doc/files/typearraydim.txt +++ b/doc/files/typearraydim.txt @@ -1,5 +1,5 @@ #title TypeArrayDim [RCBasic Doc] -#header function TypeArrayDim(Byref id as empty) +#header Function TypeArrayDim(ByRef id as empty) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArrayDim + diff --git a/doc/files/typearrayfill.txt b/doc/files/typearrayfill.txt index 007c111..627af1a 100644 --- a/doc/files/typearrayfill.txt +++ b/doc/files/typearrayfill.txt @@ -1,5 +1,5 @@ #title TypeArrayFill [RCBasic Doc] -#header sub TypeArrayFill(ByRef src as empty, fdata as empty) +#header Sub TypeArrayFill(ByRef src as empty, fdata as empty) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArrayFill + diff --git a/doc/files/typearraysize.txt b/doc/files/typearraysize.txt index 62c8cea..6878de1 100644 --- a/doc/files/typearraysize.txt +++ b/doc/files/typearraysize.txt @@ -1,5 +1,5 @@ #title TypeArraySize [RCBasic Doc] -#header function TypeArraySize(Byref id as empty, array_dim) +#header Function TypeArraySize(ByRef id as empty, array_dim) This function is exists to be internally called by the runtime but should not be called directly. @@ -7,3 +7,4 @@ This function is exists to be internally called by the runtime but should not be #ref ArraySize + diff --git a/doc/files/ucase.txt b/doc/files/ucase.txt index 081a29c..abba4e5 100644 --- a/doc/files/ucase.txt +++ b/doc/files/ucase.txt @@ -1,4 +1,5 @@ #title Ucase$ [RCBasic Doc] -#header function Ucase$(src$) +#header Function Ucase$(src$) Returns src$ with all characters uppercase + diff --git a/doc/files/udp_closesocket.txt b/doc/files/udp_closesocket.txt index c8e2d57..c396e78 100644 --- a/doc/files/udp_closesocket.txt +++ b/doc/files/udp_closesocket.txt @@ -1,4 +1,5 @@ #title UDP_CloseSocket [RCBasic Doc] -#header sub UDP_CloseSocket(socket) +#header Sub UDP_CloseSocket(socket) Closes a UDP Socket + diff --git a/doc/files/udp_getdata.txt b/doc/files/udp_getdata.txt index ba4114f..9643c34 100644 --- a/doc/files/udp_getdata.txt +++ b/doc/files/udp_getdata.txt @@ -1,4 +1,5 @@ #title UDP_GetData [RCBasic Doc] -#header function UDP_GetData(socket, byref host$, byref port, byref sData$) +#header Function UDP_GetData(socket, ByRef host$, ByRef port, ByRef sData$) Reads data from a udp socket. + diff --git a/doc/files/udp_length.txt b/doc/files/udp_length.txt index a70ef35..1e6369c 100644 --- a/doc/files/udp_length.txt +++ b/doc/files/udp_length.txt @@ -1,4 +1,5 @@ #title UDP_Length [RCBasic Doc] -#header function UDP_Length() +#header Function UDP_Length() Returns the number of bytes read from a udp socket + diff --git a/doc/files/udp_maxlength.txt b/doc/files/udp_maxlength.txt index a9ce7cc..0eecee5 100644 --- a/doc/files/udp_maxlength.txt +++ b/doc/files/udp_maxlength.txt @@ -1,4 +1,5 @@ #title UDP_MaxLength [RCBasic Doc] -#header function UDP_MaxLength() +#header Function UDP_MaxLength() Returns the maximum number of bytes from a udp socket + diff --git a/doc/files/udp_opensocket.txt b/doc/files/udp_opensocket.txt index 65ff894..503a0f2 100644 --- a/doc/files/udp_opensocket.txt +++ b/doc/files/udp_opensocket.txt @@ -1,4 +1,5 @@ #title UDP_OpenSocket [RCBasic Doc] -#header function UDP_OpenSocket(port) +#header Function UDP_OpenSocket(port) Opens a UDP socket + diff --git a/doc/files/udp_remotehost.txt b/doc/files/udp_remotehost.txt index a9a0d4e..cbe4636 100644 --- a/doc/files/udp_remotehost.txt +++ b/doc/files/udp_remotehost.txt @@ -1,4 +1,5 @@ #title UDP_RemoteHost$ [RCBasic Doc] -#header function UDP_RemoteHost$(socket) +#header Function UDP_RemoteHost$(socket) Returns the connected host in a udp connection + diff --git a/doc/files/udp_remoteport.txt b/doc/files/udp_remoteport.txt index fb75eb4..3c97525 100644 --- a/doc/files/udp_remoteport.txt +++ b/doc/files/udp_remoteport.txt @@ -1,4 +1,5 @@ #title UDP_RemotePort [RCBasic Doc] -#header function UDP_RemotePort(socket) +#header Function UDP_RemotePort(socket) Returns the port the socket is connected on. + diff --git a/doc/files/udp_senddata.txt b/doc/files/udp_senddata.txt index 3db16d7..c37bd98 100644 --- a/doc/files/udp_senddata.txt +++ b/doc/files/udp_senddata.txt @@ -1,4 +1,5 @@ #title UDP_SendData [RCBasic Doc] -#header sub UDP_SendData(socket, host$, port, sData$) +#header Sub UDP_SendData(socket, host$, port, sData$) Sends data to a host using UDP + diff --git a/doc/files/udp_socketready.txt b/doc/files/udp_socketready.txt index b3b9f2c..ff2f495 100644 --- a/doc/files/udp_socketready.txt +++ b/doc/files/udp_socketready.txt @@ -1,5 +1,5 @@ #title UDP_SocketReady [RCBasic Doc] -#header function UDP_SocketReady(socket) +#header Function UDP_SocketReady(socket) Returns 0 for no activity and non zero for activity. You need to call CheckSockets() at some point before this otherwise it will always return 0. @@ -11,3 +11,4 @@ End If #/code #ref CheckSockets + diff --git a/doc/files/unaugmentmatrix.txt b/doc/files/unaugmentmatrix.txt index d236202..a4763a2 100644 --- a/doc/files/unaugmentmatrix.txt +++ b/doc/files/unaugmentmatrix.txt @@ -1,4 +1,5 @@ #title UnAugmentMatrix [RCBasic Doc] -#header function UnAugmentMatrix(mA, mB, mC) +#header Function UnAugmentMatrix(mA, mB, mC) Splits matrix mA into coefficient mB and augment mC + diff --git a/doc/files/update.txt b/doc/files/update.txt index d3d18cd..d72e7d7 100644 --- a/doc/files/update.txt +++ b/doc/files/update.txt @@ -1,5 +1,5 @@ #title Update [RCBasic Doc] -#header sub Update() +#header Sub Update() This is the most important function in a graphics window. It must be called every frame. @@ -17,3 +17,4 @@ It performs a few different operations #/list If you have a window open, you should have this function being called in your main render loop every frame. + diff --git a/doc/files/updateactorinertiatensor.txt b/doc/files/updateactorinertiatensor.txt index 611f0b5..46cec4f 100644 --- a/doc/files/updateactorinertiatensor.txt +++ b/doc/files/updateactorinertiatensor.txt @@ -1,4 +1,5 @@ -#title updateActorInertiaTensor [RCBasic Doc] -#header sub updateActorInertiaTensor( actor) +#title UpdateActorInertiaTensor [RCBasic Doc] +#header Sub UpdateActorInertiaTensor( actor) Recalculates the inertia tensor of an actor, which is essential for accurately simulating how the actor reacts to forces and torques during its motion. The inertia tensor defines how the mass of the body is distributed in space and influences how the body rotates in response to applied torques. + diff --git a/doc/files/updatecompositechildtransform.txt b/doc/files/updatecompositechildtransform.txt new file mode 100644 index 0000000..6fa4146 --- /dev/null +++ b/doc/files/updatecompositechildtransform.txt @@ -0,0 +1,5 @@ +#title UpdateCompositeChildTransform [RCBasic Doc] +#header Sub UpdateCompositeChildTransform(actor, child_index, t_matrix, recalc_flag) + +Sets a new child transform and updates dynamic AABB tree + diff --git a/doc/files/useconstraintframeoffset.txt b/doc/files/useconstraintframeoffset.txt index 34bca05..eedadb9 100644 --- a/doc/files/useconstraintframeoffset.txt +++ b/doc/files/useconstraintframeoffset.txt @@ -1,6 +1,7 @@ -#title useConstraintFrameOffset [RCBasic Doc] -#header sub useConstraintFrameOffset( constraint_id, flag) +#title UseConstraintFrameOffset [RCBasic Doc] +#header Sub UseConstraintFrameOffset( constraint_id, flag) Enables or disables the use of frame offsets in a constraint. When frame offsets are used, the constraint operates relative to specific local frames defined in the two connected actors, rather than directly in the world frame. Note: Only applies to the hinge and slide constraint + diff --git a/doc/files/usehingereferenceframea.txt b/doc/files/usehingereferenceframea.txt index ecfdedb..5fbe766 100644 --- a/doc/files/usehingereferenceframea.txt +++ b/doc/files/usehingereferenceframea.txt @@ -1,7 +1,8 @@ -#title useHingeReferenceFrameA [RCBasic Doc] -#header sub useHingeReferenceFrameA( constraint_id, flag) +#title UseHingeReferenceFrameA [RCBasic Doc] +#header Sub UseHingeReferenceFrameA( constraint_id, flag) Allows you to specify which actor's local reference frame is used to determine the hinge’s angular limits and motor direction. When flag is true the hinge constraint will use actor A's reference frame as the basis for calculating angular limits and motor directions. + diff --git a/doc/files/useparticleeverymeshvertex.txt b/doc/files/useparticleeverymeshvertex.txt index 57f4984..545c3e9 100644 --- a/doc/files/useparticleeverymeshvertex.txt +++ b/doc/files/useparticleeverymeshvertex.txt @@ -1,6 +1,7 @@ -#title useParticleEveryMeshVertex [RCBasic Doc] -#header sub useParticleEveryMeshVertex( actor, flag) +#title UseParticleEveryMeshVertex [RCBasic Doc] +#header Sub UseParticleEveryMeshVertex( actor, flag) Sets whether to emit min<->max particles for every vertex or to pick min<->max vertices. #ref particleIsUsingEveryMeshVertex + diff --git a/doc/files/useparticlenormaldirection.txt b/doc/files/useparticlenormaldirection.txt index 62fc20c..e75a91d 100644 --- a/doc/files/useparticlenormaldirection.txt +++ b/doc/files/useparticlenormaldirection.txt @@ -1,7 +1,8 @@ -#title useParticleNormalDirection [RCBasic Doc] -#header sub useParticleNormalDirection( actor, flag) +#title UseParticleNormalDirection [RCBasic Doc] +#header Sub UseParticleNormalDirection( actor, flag) Sets whether particle emitter is using vertex normal for direction, or direction specified. #ref particleIsUsingNormalDirection + diff --git a/doc/files/useparticleoutlineonly.txt b/doc/files/useparticleoutlineonly.txt index f87374c..6e8c50e 100644 --- a/doc/files/useparticleoutlineonly.txt +++ b/doc/files/useparticleoutlineonly.txt @@ -1,8 +1,9 @@ -#title useParticleOutlineOnly [RCBasic Doc] -#header sub useParticleOutlineOnly( actor, flag) +#title UseParticleOutlineOnly [RCBasic Doc] +#header Sub UseParticleOutlineOnly( actor, flag) Set whether or not to draw points inside the cylinder. Note: Only applies to cylinder emitter #ref particleIsUsingOutlineOnly + diff --git a/doc/files/val.txt b/doc/files/val.txt index 60150a2..babd78e 100644 --- a/doc/files/val.txt +++ b/doc/files/val.txt @@ -1,6 +1,7 @@ #title Val [RCBasic Doc] -#header function Val(n$) +#header Function Val(n$) Converts a string to a number and returns the value. Returns 0 if the string was not a valid number. + diff --git a/doc/files/vectorisbetweenpoints.txt b/doc/files/vectorisbetweenpoints.txt new file mode 100644 index 0000000..0541528 --- /dev/null +++ b/doc/files/vectorisbetweenpoints.txt @@ -0,0 +1,5 @@ +#title VectorIsBetweenPoints [RCBasic Doc] +#header Function VectorIsBetweenPoints(x, y, z, start_x, start_y, start_z, end_x, end_y, end_z) + +Returns TRUE if a vector is between 2 points + diff --git a/doc/files/videoend.txt b/doc/files/videoend.txt index 420a409..c9f9de7 100644 --- a/doc/files/videoend.txt +++ b/doc/files/videoend.txt @@ -1,4 +1,5 @@ #title VideoEnd [RCBasic Doc] -#header function VideoEnd() +#header Function VideoEnd() Returns true when the currently playing video reaches the end + diff --git a/doc/files/videoexists.txt b/doc/files/videoexists.txt index fbb2228..48d993e 100644 --- a/doc/files/videoexists.txt +++ b/doc/files/videoexists.txt @@ -1,4 +1,5 @@ #title VideoExists [RCBasic Doc] -#header function VideoExists() +#header Function VideoExists() Returns true if there is a video loaded + diff --git a/doc/files/videoisplaying.txt b/doc/files/videoisplaying.txt index d026de5..cc04bdb 100644 --- a/doc/files/videoisplaying.txt +++ b/doc/files/videoisplaying.txt @@ -1,4 +1,5 @@ #title VideoIsPlaying [RCBasic Doc] -#header function VideoIsPlaying() +#header Function VideoIsPlaying() Returns true if a video is playing + diff --git a/doc/files/wait.txt b/doc/files/wait.txt index 532cb58..21bc440 100644 --- a/doc/files/wait.txt +++ b/doc/files/wait.txt @@ -1,4 +1,5 @@ #title Wait [RCBasic Doc] -#header sub Wait(m_sec) +#header Sub Wait(m_sec) Halts execution of a program for a given number of milliseconds. + diff --git a/doc/files/waitkey.txt b/doc/files/waitkey.txt index b15b2b0..c823299 100644 --- a/doc/files/waitkey.txt +++ b/doc/files/waitkey.txt @@ -1,4 +1,5 @@ #title WaitKey [RCBasic Doc] -#header function WaitKey() +#header Function WaitKey() Halts execution of a program until a key is pressed. + diff --git a/doc/files/warpmouse.txt b/doc/files/warpmouse.txt index 519730d..6ee16cb 100644 --- a/doc/files/warpmouse.txt +++ b/doc/files/warpmouse.txt @@ -1,4 +1,5 @@ #title WarpMouse [RCBasic Doc] -#header sub WarpMouse(x, y) +#header Sub WarpMouse(x, y) Move the mouse cursor to xy position in the window + diff --git a/doc/files/warpmouseglobal.txt b/doc/files/warpmouseglobal.txt index bda6283..bfa79cc 100644 --- a/doc/files/warpmouseglobal.txt +++ b/doc/files/warpmouseglobal.txt @@ -1,4 +1,5 @@ #title WarpMouseGlobal [RCBasic Doc] -#header sub WarpMouseGlobal(x, y) +#header Sub WarpMouseGlobal(x, y) Move the mouse cursor to xy position in the display + diff --git a/doc/files/wheelisfront.txt b/doc/files/wheelisfront.txt new file mode 100644 index 0000000..51a8749 --- /dev/null +++ b/doc/files/wheelisfront.txt @@ -0,0 +1,5 @@ +#title WheelIsFront [RCBasic Doc] +#header Function WheelIsFront( actor, wheel ) + +Returns TRUE if a wheel is set as a front wheel + diff --git a/doc/files/windowclip.txt b/doc/files/windowclip.txt index f79c076..1c7b2c5 100644 --- a/doc/files/windowclip.txt +++ b/doc/files/windowclip.txt @@ -1,6 +1,7 @@ #title WindowClip [RCBasic Doc] -#header function WindowClip(x, y, w, h) +#header Function WindowClip(x, y, w, h) Returns an image with a portion of the window stored #ref CanvasClip + diff --git a/doc/files/windowevent_close.txt b/doc/files/windowevent_close.txt index 88ff136..fefbef6 100644 --- a/doc/files/windowevent_close.txt +++ b/doc/files/windowevent_close.txt @@ -1,4 +1,5 @@ #title WindowEvent_Close [RCBasic Doc] -#header function WindowEvent_Close() +#header Function WindowEvent_Close() Returns true if the window close event is called. + diff --git a/doc/files/windowevent_maximize.txt b/doc/files/windowevent_maximize.txt index b2e32d8..25d347e 100644 --- a/doc/files/windowevent_maximize.txt +++ b/doc/files/windowevent_maximize.txt @@ -1,4 +1,5 @@ #title WindowEvent_Maximize [RCBasic Doc] -#header function WindowEvent_Maximize() +#header Function WindowEvent_Maximize() Returns true if the window maximize event is called. + diff --git a/doc/files/windowevent_minimize.txt b/doc/files/windowevent_minimize.txt index 5f0b87d..6f1926b 100644 --- a/doc/files/windowevent_minimize.txt +++ b/doc/files/windowevent_minimize.txt @@ -1,4 +1,5 @@ #title WindowEvent_Minimize [RCBasic Doc] -#header function WindowEvent_Minimize() +#header Function WindowEvent_Minimize() Returns true if the window minimize event is called. + diff --git a/doc/files/windowevent_resize.txt b/doc/files/windowevent_resize.txt index 60b7d8e..f65f1d4 100644 --- a/doc/files/windowevent_resize.txt +++ b/doc/files/windowevent_resize.txt @@ -1,4 +1,5 @@ #title WindowEvent_Resize [RCBasic Doc] -#header function WindowEvent_Resize() +#header Function WindowEvent_Resize() Returns true if the window resize event is called. + diff --git a/doc/files/windowexists.txt b/doc/files/windowexists.txt index a08fac4..39e4584 100644 --- a/doc/files/windowexists.txt +++ b/doc/files/windowexists.txt @@ -1,4 +1,5 @@ #title WindowExists [RCBasic Doc] -#header function WindowExists() +#header Function WindowExists() Returns true if the window is open + diff --git a/doc/files/windowhasinputfocus.txt b/doc/files/windowhasinputfocus.txt index e4c2c8e..f22c82b 100644 --- a/doc/files/windowhasinputfocus.txt +++ b/doc/files/windowhasinputfocus.txt @@ -1,4 +1,5 @@ #title WindowHasInputFocus [RCBasic Doc] -#header function WindowHasInputFocus() +#header Function WindowHasInputFocus() Returns true if the window has input focus, otherwise it returns false. + diff --git a/doc/files/windowhasmousefocus.txt b/doc/files/windowhasmousefocus.txt index 36c9c87..0f3ebd8 100644 --- a/doc/files/windowhasmousefocus.txt +++ b/doc/files/windowhasmousefocus.txt @@ -1,4 +1,5 @@ #title WindowHasMouseFocus [RCBasic Doc] -#header function WindowHasMouseFocus() +#header Function WindowHasMouseFocus() Returns true if the window has mouse focus, otherwise it returns false. + diff --git a/doc/files/windowisbordered.txt b/doc/files/windowisbordered.txt index f22c130..769a1f6 100644 --- a/doc/files/windowisbordered.txt +++ b/doc/files/windowisbordered.txt @@ -1,4 +1,5 @@ #title WindowIsBordered [RCBasic Doc] -#header function WindowIsBordered() +#header Function WindowIsBordered() Returns true if the window has a border, otherwise it will return false. + diff --git a/doc/files/windowisfullscreen.txt b/doc/files/windowisfullscreen.txt index 84a5aa2..b2ce672 100644 --- a/doc/files/windowisfullscreen.txt +++ b/doc/files/windowisfullscreen.txt @@ -1,4 +1,5 @@ #title WindowIsFullscreen [RCBasic Doc] -#header function WindowIsFullscreen() +#header Function WindowIsFullscreen() Returns true if the window is fullscreen, otherwise it will return false. + diff --git a/doc/files/windowisgrabbed.txt b/doc/files/windowisgrabbed.txt index 0aee396..65fef15 100644 --- a/doc/files/windowisgrabbed.txt +++ b/doc/files/windowisgrabbed.txt @@ -1,4 +1,5 @@ #title WindowIsGrabbed [RCBasic Doc] -#header function WindowIsGrabbed( ) +#header Function WindowIsGrabbed( ) Returns the window that is currently grabbing input. It returns -1 on failure. + diff --git a/doc/files/windowismaximized.txt b/doc/files/windowismaximized.txt index a7a9900..d9ddead 100644 --- a/doc/files/windowismaximized.txt +++ b/doc/files/windowismaximized.txt @@ -1,4 +1,5 @@ #title WindowIsMaximized [RCBasic Doc] -#header function WindowIsMaximized() +#header Function WindowIsMaximized() Returns true if the window is maximized, otherwise it will return false. + diff --git a/doc/files/windowisminimized.txt b/doc/files/windowisminimized.txt index 96e20a4..01b4fbf 100644 --- a/doc/files/windowisminimized.txt +++ b/doc/files/windowisminimized.txt @@ -1,4 +1,5 @@ #title WindowIsMinimized [RCBasic Doc] -#header function WindowIsMinimized() +#header Function WindowIsMinimized() Returns true if the window is minimized, otherwise it will return false. + diff --git a/doc/files/windowisresizable.txt b/doc/files/windowisresizable.txt index 14e51a7..9c3df00 100644 --- a/doc/files/windowisresizable.txt +++ b/doc/files/windowisresizable.txt @@ -1,4 +1,5 @@ #title WindowIsResizable [RCBasic Doc] -#header function WindowIsResizable() +#header Function WindowIsResizable() Returns true if the window is resizable, otherwise it will return false. + diff --git a/doc/files/windowisvisible.txt b/doc/files/windowisvisible.txt index d8c2b9c..c366ce4 100644 --- a/doc/files/windowisvisible.txt +++ b/doc/files/windowisvisible.txt @@ -1,4 +1,5 @@ #title WindowIsVisible [RCBasic Doc] -#header function WindowIsVisible() +#header Function WindowIsVisible() Returns true if the window is visible, otherwise it returns false. + diff --git a/doc/files/windowmode.txt b/doc/files/windowmode.txt index d9593d6..15a6872 100644 --- a/doc/files/windowmode.txt +++ b/doc/files/windowmode.txt @@ -1,5 +1,5 @@ #title WindowMode [RCBasic Doc] -#header function WindowMode(visible, fullscreen, resizable, borderless, highDPI) +#header Function WindowMode(visible, fullscreen, resizable, borderless, highDPI) Returns a bitmask of the combined window flags that can be used in OpenWindow() to set the mode for the window. @@ -18,3 +18,4 @@ mode = WindowMode(1, 1, 0, 0, 0) #/code #ref OpenWindow GetWindowMode + diff --git a/doc/files/windowtitle.txt b/doc/files/windowtitle.txt index f3627af..e7b7634 100644 --- a/doc/files/windowtitle.txt +++ b/doc/files/windowtitle.txt @@ -1,6 +1,7 @@ #title WindowTitle$ [RCBasic Doc] -#header function WindowTitle$( ) +#header Function WindowTitle$( ) Returns the window title #ref SetWindowTitle + diff --git a/doc/files/write.txt b/doc/files/write.txt index 7b5cee5..41aa0c3 100644 --- a/doc/files/write.txt +++ b/doc/files/write.txt @@ -1,6 +1,7 @@ #title Write [RCBasic Doc] -#header sub Write(stream, txt$) +#header Sub Write(stream, txt$) Writes a string to a file. #ref WriteLine + diff --git a/doc/files/writebyte.txt b/doc/files/writebyte.txt index 493d948..df1db78 100644 --- a/doc/files/writebyte.txt +++ b/doc/files/writebyte.txt @@ -1,6 +1,7 @@ #title WriteByte [RCBasic Doc] -#header sub WriteByte(stream, byte) +#header Sub WriteByte(stream, byte) Writes a byte to the file. #ref WriteByteBuffer + diff --git a/doc/files/writebytebuffer.txt b/doc/files/writebytebuffer.txt index add1317..affd2a4 100644 --- a/doc/files/writebytebuffer.txt +++ b/doc/files/writebytebuffer.txt @@ -1,4 +1,5 @@ #title WriteByteBuffer [RCBasic Doc] -#header function WriteByteBuffer(stream, ByRef buf, buf_size) +#header Function WriteByteBuffer(stream, ByRef buf, buf_size) Writes a number of bytes from a buffer to the file stream. + diff --git a/doc/files/writeline.txt b/doc/files/writeline.txt index 0a6c172..5d9c649 100644 --- a/doc/files/writeline.txt +++ b/doc/files/writeline.txt @@ -1,6 +1,7 @@ #title WriteLine [RCBasic Doc] -#header sub WriteLine(stream, txt$) +#header Sub WriteLine(stream, txt$) Writes a string to a text file with a new-line appended at the end #ref Write ReadLine$ + diff --git a/doc/files/xorbit.txt b/doc/files/xorbit.txt index 798ec1c..9449fb9 100644 --- a/doc/files/xorbit.txt +++ b/doc/files/xorbit.txt @@ -1,6 +1,7 @@ #title XOrBit [RCBasic Doc] -#header function XOrBit(a, b) +#header Function XOrBit(a, b) Returns the value of the bitwise XOR operation on the operands A and B #ref OrBit AndBit + diff --git a/doc/files/zeromatrix.txt b/doc/files/zeromatrix.txt index e89b1c2..ac829fa 100644 --- a/doc/files/zeromatrix.txt +++ b/doc/files/zeromatrix.txt @@ -1,8 +1,9 @@ #title ZeroMatrix [RCBasic Doc] -#header sub ZeroMatrix(mA) +#header Sub ZeroMatrix(mA) Clears a matrix Note: Literally does the exact same thing as ClearMatrix. Its here as a legacy call convention. #ref ClearMatrix + diff --git a/doc/tmp/navb_tmp.html b/doc/tmp/navb_tmp.html index 75b38dc..644f7b8 100644 --- a/doc/tmp/navb_tmp.html +++ b/doc/tmp/navb_tmp.html @@ -9,7 +9,6 @@ body { background-color: #212837; color: #FFFFFF; } a { color: #40bfb8; } a::before { - content: "---"; font-family: monospace, monospace; display: inline-block; margin-right: 6px; diff --git a/rcbasic_build/intern_inc/switch_cases.h b/rcbasic_build/intern_inc/switch_cases.h index 85bd74a..e027382 100644 --- a/rcbasic_build/intern_inc/switch_cases.h +++ b/rcbasic_build/intern_inc/switch_cases.h @@ -1125,12 +1125,12 @@ rc_setWheelDampingCompression( SETWHEELDAMPINGCOMPRESSION_ACTOR, SETWHEELDAMPIN rc_setWheelDampingRelaxation( SETWHEELDAMPINGRELAXATION_ACTOR, SETWHEELDAMPINGRELAXATION_WHEEL, SETWHEELDAMPINGRELAXATION_DREL_VALUE ) rc_setWheelFrictionSlip( SETWHEELFRICTIONSLIP_ACTOR, SETWHEELFRICTIONSLIP_WHEEL, SETWHEELFRICTIONSLIP_FSLIP_VALUE ) rc_setWheelRotation( SETWHEELROTATION_ACTOR, SETWHEELROTATION_WHEEL, SETWHEELROTATION_ROT ) -rc_setWheelRotationDelta( SETWHEELROTATIONDELTA_ACTOR, SETWHEELROTATIONDELTA_WHEEL, SETWHEELROTATIONDELTA_ROT_DELTA ) rc_setWheelRollInfluence( SETWHEELROLLINFLUENCE_ACTOR, SETWHEELROLLINFLUENCE_WHEEL, SETWHEELROLLINFLUENCE_ROLL_INFLUENCE ) rc_setWheelInverseContactSuspension( SETWHEELINVERSECONTACTSUSPENSION_ACTOR, SETWHEELINVERSECONTACTSUSPENSION_WHEEL, SETWHEELINVERSECONTACTSUSPENSION_C_VALUE ) rc_setWheelSuspensionVelocity( SETWHEELSUSPENSIONVELOCITY_ACTOR, SETWHEELSUSPENSIONVELOCITY_WHEEL, SETWHEELSUSPENSIONVELOCITY_VELOCITY ) rc_setWheelActorOffsetTransform( SETWHEELACTOROFFSETTRANSFORM_ACTOR, SETWHEELACTOROFFSETTRANSFORM_WHEEL, SETWHEELACTOROFFSETTRANSFORM_T_MATRIX ) rc_getWheelActorOffsetTransform( GETWHEELACTOROFFSETTRANSFORM_ACTOR, GETWHEELACTOROFFSETTRANSFORM_WHEEL, GETWHEELACTOROFFSETTRANSFORM_T_MATRIX ) +rc_getVehiclePitchControl( GETVEHICLEPITCHCONTROL_ACTOR ) rc_createMaterial( ) rc_deleteMaterial( DELETEMATERIAL_MATERIAL_ID ) rc_setActorMaterial( SETACTORMATERIAL_ACTOR, SETACTORMATERIAL_MATERIAL_NUM, SETACTORMATERIAL_MATERIAL_ID ) diff --git a/rcbasic_build/intern_lib/vehicle.bas b/rcbasic_build/intern_lib/vehicle.bas index b95cc00..cd73c8e 100644 --- a/rcbasic_build/intern_lib/vehicle.bas +++ b/rcbasic_build/intern_lib/vehicle.bas @@ -40,9 +40,9 @@ Sub SetWheelDampingCompression( actor, wheel, dcomp_value ) Sub SetWheelDampingRelaxation( actor, wheel, drel_value ) Sub SetWheelFrictionSlip( actor, wheel, fslip_value ) Sub SetWheelRotation( actor, wheel, rot ) -Sub SetWheelRotationDelta( actor, wheel, rot_delta ) Sub SetWheelRollInfluence( actor, wheel, roll_influence ) Sub SetWheelInverseContactSuspension( actor, wheel, c_value ) Sub SetWheelSuspensionVelocity( actor, wheel, velocity ) Sub SetWheelActorOffsetTransform( actor, wheel, t_matrix ) Sub GetWheelActorOffsetTransform( actor, wheel, t_matrix ) +Function GetVehiclePitchControl( actor ) diff --git a/rcbasic_build/rc_builtin.h b/rcbasic_build/rc_builtin.h index 3ed428f..756c62c 100755 --- a/rcbasic_build/rc_builtin.h +++ b/rcbasic_build/rc_builtin.h @@ -3630,10 +3630,6 @@ void init_embedded_functions() add_embedded_arg("actor", ID_TYPE_NUM); add_embedded_arg("wheel", ID_TYPE_NUM); add_embedded_arg("rot", ID_TYPE_NUM); - embed_function("SetWheelRotationDelta", ID_TYPE_SUB); - add_embedded_arg("actor", ID_TYPE_NUM); - add_embedded_arg("wheel", ID_TYPE_NUM); - add_embedded_arg("rot_delta", ID_TYPE_NUM); embed_function("SetWheelRollInfluence", ID_TYPE_SUB); add_embedded_arg("actor", ID_TYPE_NUM); add_embedded_arg("wheel", ID_TYPE_NUM); @@ -3654,6 +3650,8 @@ void init_embedded_functions() add_embedded_arg("actor", ID_TYPE_NUM); add_embedded_arg("wheel", ID_TYPE_NUM); add_embedded_arg("t_matrix", ID_TYPE_NUM); + embed_function("GetVehiclePitchControl", ID_TYPE_FN_NUM); + add_embedded_arg("actor", ID_TYPE_NUM); embed_function("createMaterial", ID_TYPE_FN_NUM); embed_function("deleteMaterial", ID_TYPE_SUB); add_embedded_arg("material_id", ID_TYPE_NUM); diff --git a/rcbasic_build/rcbasic4_changes.ods b/rcbasic_build/rcbasic4_changes.ods index cf9d1c5..1ce48eb 100644 Binary files a/rcbasic_build/rcbasic4_changes.ods and b/rcbasic_build/rcbasic4_changes.ods differ diff --git a/rcbasic_build/rcbasic_dev.txt b/rcbasic_build/rcbasic_dev.txt index f0989d2..6ac69bd 100644 --- a/rcbasic_build/rcbasic_dev.txt +++ b/rcbasic_build/rcbasic_dev.txt @@ -3624,10 +3624,6 @@ embed_function("SetWheelRotation", ID_TYPE_SUB); add_embedded_arg("actor", ID_TYPE_NUM); add_embedded_arg("wheel", ID_TYPE_NUM); add_embedded_arg("rot", ID_TYPE_NUM); -embed_function("SetWheelRotationDelta", ID_TYPE_SUB); -add_embedded_arg("actor", ID_TYPE_NUM); -add_embedded_arg("wheel", ID_TYPE_NUM); -add_embedded_arg("rot_delta", ID_TYPE_NUM); embed_function("SetWheelRollInfluence", ID_TYPE_SUB); add_embedded_arg("actor", ID_TYPE_NUM); add_embedded_arg("wheel", ID_TYPE_NUM); @@ -3648,6 +3644,8 @@ embed_function("GetWheelActorOffsetTransform", ID_TYPE_SUB); add_embedded_arg("actor", ID_TYPE_NUM); add_embedded_arg("wheel", ID_TYPE_NUM); add_embedded_arg("t_matrix", ID_TYPE_NUM); +embed_function("GetVehiclePitchControl", ID_TYPE_FN_NUM); +add_embedded_arg("actor", ID_TYPE_NUM); embed_function("createMaterial", ID_TYPE_FN_NUM); embed_function("deleteMaterial", ID_TYPE_SUB); add_embedded_arg("material_id", ID_TYPE_NUM); diff --git a/rcbasic_build/rcbasic_dev2.txt b/rcbasic_build/rcbasic_dev2.txt index 8b6fad2..e663375 100644 --- a/rcbasic_build/rcbasic_dev2.txt +++ b/rcbasic_build/rcbasic_dev2.txt @@ -3624,30 +3624,28 @@ #define SETWHEELROTATION_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELROTATION_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELROTATION_ROT num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelRotationDelta 1127 -#define SETWHEELROTATIONDELTA_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] -#define SETWHEELROTATIONDELTA_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] -#define SETWHEELROTATIONDELTA_ROT_DELTA num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelRollInfluence 1128 +#define FN_SetWheelRollInfluence 1127 #define SETWHEELROLLINFLUENCE_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELROLLINFLUENCE_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELROLLINFLUENCE_ROLL_INFLUENCE num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelInverseContactSuspension 1129 +#define FN_SetWheelInverseContactSuspension 1128 #define SETWHEELINVERSECONTACTSUSPENSION_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELINVERSECONTACTSUSPENSION_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELINVERSECONTACTSUSPENSION_C_VALUE num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelSuspensionVelocity 1130 +#define FN_SetWheelSuspensionVelocity 1129 #define SETWHEELSUSPENSIONVELOCITY_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELSUSPENSIONVELOCITY_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELSUSPENSIONVELOCITY_VELOCITY num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelActorOffsetTransform 1131 +#define FN_SetWheelActorOffsetTransform 1130 #define SETWHEELACTOROFFSETTRANSFORM_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELACTOROFFSETTRANSFORM_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELACTOROFFSETTRANSFORM_T_MATRIX num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_GetWheelActorOffsetTransform 1132 +#define FN_GetWheelActorOffsetTransform 1131 #define GETWHEELACTOROFFSETTRANSFORM_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define GETWHEELACTOROFFSETTRANSFORM_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define GETWHEELACTOROFFSETTRANSFORM_T_MATRIX num_var[2].nref[0].value[ num_var[2].byref_offset ] +#define FN_GetVehiclePitchControl 1132 +#define GETVEHICLEPITCHCONTROL_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define FN_createMaterial 1133 #define FN_deleteMaterial 1134 #define DELETEMATERIAL_MATERIAL_ID num_var[0].nref[0].value[ num_var[0].byref_offset ] diff --git a/rcbasic_build/rcbasic_dev3.txt b/rcbasic_build/rcbasic_dev3.txt index 7c69499..49c490c 100644 --- a/rcbasic_build/rcbasic_dev3.txt +++ b/rcbasic_build/rcbasic_dev3.txt @@ -3407,9 +3407,6 @@ case FN_SetWheelFrictionSlip: //Sub Procedure case FN_SetWheelRotation: //Sub Procedure rc_setWheelRotation( SETWHEELROTATION_ACTOR, SETWHEELROTATION_WHEEL, SETWHEELROTATION_ROT ); break; -case FN_SetWheelRotationDelta: //Sub Procedure - rc_setWheelRotationDelta( SETWHEELROTATIONDELTA_ACTOR, SETWHEELROTATIONDELTA_WHEEL, SETWHEELROTATIONDELTA_ROT_DELTA ); - break; case FN_SetWheelRollInfluence: //Sub Procedure rc_setWheelRollInfluence( SETWHEELROLLINFLUENCE_ACTOR, SETWHEELROLLINFLUENCE_WHEEL, SETWHEELROLLINFLUENCE_ROLL_INFLUENCE ); break; @@ -3425,6 +3422,9 @@ case FN_SetWheelActorOffsetTransform: //Sub Procedure case FN_GetWheelActorOffsetTransform: //Sub Procedure rc_getWheelActorOffsetTransform( GETWHEELACTOROFFSETTRANSFORM_ACTOR, GETWHEELACTOROFFSETTRANSFORM_WHEEL, GETWHEELACTOROFFSETTRANSFORM_T_MATRIX ); break; +case FN_GetVehiclePitchControl: //Number Function + rc_push_num(rc_getVehiclePitchControl( GETVEHICLEPITCHCONTROL_ACTOR )); + break; case FN_createMaterial: //Number Function rc_push_num(rc_createMaterial( )); break; diff --git a/rcbasic_build/tokenizer.h b/rcbasic_build/tokenizer.h index c5d47df..ab1ffac 100755 --- a/rcbasic_build/tokenizer.h +++ b/rcbasic_build/tokenizer.h @@ -1024,6 +1024,10 @@ string rc_keywordToken(string sline) return "6"; else if(sline.compare("ACTOR_SHAPE_TRIMESH")==0) return "7"; + else if(sline.compare("ACTOR_SHAPE_COMPOSITE")==0) + return "9"; + else if(sline.compare("ACTOR_SHAPE_IMPACT_MESH")==0) + return "10"; else if(sline.compare("MATERIAL_FLAG_WIREFRAME")==0) return "" + rc_intToString( 0x1); else if(sline.compare("MATERIAL_FLAG_POINTCLOUD")==0) @@ -1324,6 +1328,30 @@ string rc_keywordToken(string sline) return "4"; else if(sline.compare("POST_EFFECT_PROPERTY_COLOR")==0) return "5"; + else if(sline.compare("ACTOR_TYPE_NONE")==0) + return "0"; + else if(sline.compare("ACTOR_TYPE_ANIMATED")==0) + return "1"; + else if(sline.compare("ACTOR_TYPE_OCTREE")==0) + return "2"; + else if(sline.compare("ACTOR_TYPE_LIGHT")==0) + return "3"; + else if(sline.compare("ACTOR_TYPE_TERRAIN")==0) + return "4"; + else if(sline.compare("ACTOR_TYPE_WATER")==0) + return "5"; + else if(sline.compare("ACTOR_TYPE_BILLBOARD")==0) + return "6"; + else if(sline.compare("ACTOR_TYPE_PARTICLE")==0) + return "7"; + else if(sline.compare("ACTOR_TYPE_PRIMITIVE")==0) + return "8"; + else if(sline.compare("ACTOR_TYPE_PROJECTOR")==0) + return "9"; + else if(sline.compare("ACTOR_TYPE_COMPOSITE")==0) + return "10"; + else if(sline.compare("ACTOR_TYPE_VEHICLE")==0) + return "11"; else { for(int i = 0; i < rc_constants.size(); i++) diff --git a/rcbasic_runtime/rc_base_actor.h b/rcbasic_runtime/rc_base_actor.h index d2f4ae4..244f302 100755 --- a/rcbasic_runtime/rc_base_actor.h +++ b/rcbasic_runtime/rc_base_actor.h @@ -779,6 +779,7 @@ int rc_createVehicleActor(int chassis_actor) rc_actor[actor_id].parent_id = -1; rc_actor[actor_id].isWheel = false; + rc_actor[actor_id].vehicle_properties.pitch_control = 0; rc_vehicle_actors.push_back(actor_id); @@ -3890,6 +3891,22 @@ void rc_setVehiclePitchControl( int actor, double pitch ) return; rc_actor[actor].vehicle_properties.vehicle->setPitchControl(pitch); + rc_actor[actor].vehicle_properties.pitch_control = pitch; +} + + +double rc_getVehiclePitchControl( int actor ) +{ + if(actor < 0 || actor >= rc_actor.size()) + return 0; + + if(!rc_actor[actor].mesh_node) + return 0; + + if(rc_actor[actor].node_type != RC_NODE_TYPE_VEHICLE) + return 0; + + return rc_actor[actor].vehicle_properties.pitch_control; } diff --git a/rcbasic_runtime/rc_defines.h b/rcbasic_runtime/rc_defines.h index 2c8a427..b5ddbdb 100755 --- a/rcbasic_runtime/rc_defines.h +++ b/rcbasic_runtime/rc_defines.h @@ -3627,30 +3627,28 @@ #define SETWHEELROTATION_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELROTATION_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELROTATION_ROT num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelRotationDelta 1127 -#define SETWHEELROTATIONDELTA_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] -#define SETWHEELROTATIONDELTA_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] -#define SETWHEELROTATIONDELTA_ROT_DELTA num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelRollInfluence 1128 +#define FN_SetWheelRollInfluence 1127 #define SETWHEELROLLINFLUENCE_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELROLLINFLUENCE_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELROLLINFLUENCE_ROLL_INFLUENCE num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelInverseContactSuspension 1129 +#define FN_SetWheelInverseContactSuspension 1128 #define SETWHEELINVERSECONTACTSUSPENSION_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELINVERSECONTACTSUSPENSION_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELINVERSECONTACTSUSPENSION_C_VALUE num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelSuspensionVelocity 1130 +#define FN_SetWheelSuspensionVelocity 1129 #define SETWHEELSUSPENSIONVELOCITY_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELSUSPENSIONVELOCITY_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELSUSPENSIONVELOCITY_VELOCITY num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_SetWheelActorOffsetTransform 1131 +#define FN_SetWheelActorOffsetTransform 1130 #define SETWHEELACTOROFFSETTRANSFORM_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define SETWHEELACTOROFFSETTRANSFORM_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define SETWHEELACTOROFFSETTRANSFORM_T_MATRIX num_var[2].nref[0].value[ num_var[2].byref_offset ] -#define FN_GetWheelActorOffsetTransform 1132 +#define FN_GetWheelActorOffsetTransform 1131 #define GETWHEELACTOROFFSETTRANSFORM_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define GETWHEELACTOROFFSETTRANSFORM_WHEEL num_var[1].nref[0].value[ num_var[1].byref_offset ] #define GETWHEELACTOROFFSETTRANSFORM_T_MATRIX num_var[2].nref[0].value[ num_var[2].byref_offset ] +#define FN_GetVehiclePitchControl 1132 +#define GETVEHICLEPITCHCONTROL_ACTOR num_var[0].nref[0].value[ num_var[0].byref_offset ] #define FN_createMaterial 1133 #define FN_deleteMaterial 1134 #define DELETEMATERIAL_MATERIAL_ID num_var[0].nref[0].value[ num_var[0].byref_offset ] diff --git a/rcbasic_runtime/rc_func130_cases.h b/rcbasic_runtime/rc_func130_cases.h index 38c3944..a719b27 100644 --- a/rcbasic_runtime/rc_func130_cases.h +++ b/rcbasic_runtime/rc_func130_cases.h @@ -3407,9 +3407,6 @@ case FN_SetWheelFrictionSlip: //Sub Procedure case FN_SetWheelRotation: //Sub Procedure rc_setWheelRotation( SETWHEELROTATION_ACTOR, SETWHEELROTATION_WHEEL, SETWHEELROTATION_ROT ); break; -case FN_SetWheelRotationDelta: //Sub Procedure - rc_setWheelRotationDelta( SETWHEELROTATIONDELTA_ACTOR, SETWHEELROTATIONDELTA_WHEEL, SETWHEELROTATIONDELTA_ROT_DELTA ); - break; case FN_SetWheelRollInfluence: //Sub Procedure rc_setWheelRollInfluence( SETWHEELROLLINFLUENCE_ACTOR, SETWHEELROLLINFLUENCE_WHEEL, SETWHEELROLLINFLUENCE_ROLL_INFLUENCE ); break; @@ -3425,6 +3422,9 @@ case FN_SetWheelActorOffsetTransform: //Sub Procedure case FN_GetWheelActorOffsetTransform: //Sub Procedure rc_getWheelActorOffsetTransform( GETWHEELACTOROFFSETTRANSFORM_ACTOR, GETWHEELACTOROFFSETTRANSFORM_WHEEL, GETWHEELACTOROFFSETTRANSFORM_T_MATRIX ); break; +case FN_GetVehiclePitchControl: //Number Function + rc_push_num(rc_getVehiclePitchControl( GETVEHICLEPITCHCONTROL_ACTOR )); + break; case FN_createMaterial: //Number Function rc_push_num(rc_createMaterial( )); break; diff --git a/rcbasic_runtime/rc_gfx_core.h b/rcbasic_runtime/rc_gfx_core.h index 4a4dfd4..49764ef 100755 --- a/rcbasic_runtime/rc_gfx_core.h +++ b/rcbasic_runtime/rc_gfx_core.h @@ -640,6 +640,7 @@ struct rc_vehicle_properties int chassis_actor_id; IRaycastVehicle* vehicle; irr::core::array wheels; + double pitch_control; //bullet has know way of getting this value so I am keeping track of it manually }; struct rc_projector_properties diff --git a/rcbasic_runtime/rc_os_defines.h b/rcbasic_runtime/rc_os_defines.h index b28714c..928b6d4 100755 --- a/rcbasic_runtime/rc_os_defines.h +++ b/rcbasic_runtime/rc_os_defines.h @@ -2,7 +2,7 @@ #define RC_OS_DEFINES_H_INCLUDED //USED FOR TESTING ONLY -#define RC_TESTING +//#define RC_TESTING //I am checking Android first since I think it also defines __linux__ diff --git a/rcbasic_runtime/rcbasic_runtime.depend b/rcbasic_runtime/rcbasic_runtime.depend index 76ed0fb..3e62ce1 100755 --- a/rcbasic_runtime/rcbasic_runtime.depend +++ b/rcbasic_runtime/rcbasic_runtime.depend @@ -35,10 +35,10 @@ "rc_func130_cases.h" -1772055421 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_os_defines.h +1772097843 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_os_defines.h -1771822804 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_defines.h +1772139384 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_defines.h 1764140917 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_stdlib.h "rc_os_defines.h" @@ -1276,7 +1276,7 @@ "rc_post_fx.h" -1772060471 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_gfx_core.h +1772097742 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_gfx_core.h "SDL.h" "btBulletDynamicsCommon.h" "BulletSoftBody/btSoftRigidDynamicsWorld.h" @@ -2282,7 +2282,7 @@ "rc_gfx_core.h" -1771822804 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_func130_cases.h +1772139384 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_func130_cases.h 1760243468 source:/home/n00b/Projects/irrBullet/src/irrBullet.cpp "irrBullet.h" @@ -2534,7 +2534,7 @@ 1758412944 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_physics3D_base.h "rc_gfx_core.h" -1771808408 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_base_actor.h +1772097873 /home/n00b/Projects/RCBASIC4/rcbasic_runtime/rc_base_actor.h "ProjectiveTextures.h" "rc_matrix.h"