+ 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 new file mode 100644 index 0000000..c3fadcd --- /dev/null +++ b/doc/doc_files/accelname.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..35de12c --- /dev/null +++ b/doc/doc_files/acos.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c391745 --- /dev/null +++ b/doc/doc_files/activecanvas.html @@ -0,0 +1,33 @@ + + +
+ + ++ Returns the canvas that drawing commands are currently applied to +
+
+ 1 = OpenCanvas(640, 480, 0, 0, 640, 480, 0)
+ 2 = OpenCanvas(640, 480, 0, 0, 640, 480, 0)
+
+ Canvas(1)
+
+ If ActiveCanvas() = 1 Then
+ Print "Active canvas is c1"
+ End If
+
+ Canvas(2)
+
+ If ActiveCanvas() = 2 Then
+ Print "Active canvas is now c2"
+ End If
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/actoranimationislooped.html b/doc/doc_files/actoranimationislooped.html new file mode 100644 index 0000000..6a2ee22 --- /dev/null +++ b/doc/doc_files/actoranimationislooped.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns true if an actors animation is set to looped. +
++ Note: Actor animation is set to looped with the loopActorAnimation() function. +
+Related: + loopActorAnimation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/actoranimationisplaying.html b/doc/doc_files/actoranimationisplaying.html new file mode 100644 index 0000000..7c5fb03 --- /dev/null +++ b/doc/doc_files/actoranimationisplaying.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/actorexists.html b/doc/doc_files/actorexists.html new file mode 100644 index 0000000..642ccd7 --- /dev/null +++ b/doc/doc_files/actorexists.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/actorisintransition.html b/doc/doc_files/actorisintransition.html new file mode 100644 index 0000000..3c26175 --- /dev/null +++ b/doc/doc_files/actorisintransition.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns true if actor is in a transition from its current frame to the frame set in the StartActorTransition() function +
+Related: + StartActorTransition + StopActorTransition + GetActorTransitionTime +
++ + + \ No newline at end of file diff --git a/doc/doc_files/actorissolid.html b/doc/doc_files/actorissolid.html new file mode 100644 index 0000000..71c2baa --- /dev/null +++ b/doc/doc_files/actorissolid.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns true or false depending on if physics and collision response applies to an actor. +
++ Note: Collision is still able to be checked on an actor but the actor will be like a ghost able to go through wall and other objects. +
+
+ SetActorSolid(actor, true)
+ Print "Actor solid state: "; ActorIsSolid(actor) 'This will output 1
+ SetActorSolid(actor, false)
+ Print "Actor solid state: "; ActorIsSolid(actor) 'This will output 0
+ #/end
+
+ #ref SetActorSolid
+
+
+
+
\ No newline at end of file
diff --git a/doc/doc_files/actorisvisible.html b/doc/doc_files/actorisvisible.html
new file mode 100644
index 0000000..e8c734f
--- /dev/null
+++ b/doc/doc_files/actorisvisible.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+ function ActorIsVisible( actor )
+ Returns true if an actor is visible +
+
+ SetActorVisible(actor, true)
+ Print "Actor solid state: "; ActorIsVisible(actor) 'Outputs 1
+ SetActorSolid(actor, false)
+ Print "Actor solid state: "; ActorIsSolid(actor) 'Outputs 0
+
Related: + SetActorVisible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/addactorshadow.html b/doc/doc_files/addactorshadow.html new file mode 100644 index 0000000..60af641 --- /dev/null +++ b/doc/doc_files/addactorshadow.html @@ -0,0 +1,23 @@ + + +
+ + ++ Cast a shadow on an actor during lighting calculations +
++ Note: Also check the section on lights for more info +
+Related: + RemoveActorShadow +
++ + + \ No newline at end of file diff --git a/doc/doc_files/addmatrix.html b/doc/doc_files/addmatrix.html new file mode 100644 index 0000000..5360855 --- /dev/null +++ b/doc/doc_files/addmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..af6b31e --- /dev/null +++ b/doc/doc_files/addmeshbuffer.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the vertices, normals, and texture coordinates for a mesh +
+Related: + CreateMesh +
++ + + \ No newline at end of file diff --git a/doc/doc_files/addsceneskybox.html b/doc/doc_files/addsceneskybox.html new file mode 100644 index 0000000..fc179b2 --- /dev/null +++ b/doc/doc_files/addsceneskybox.html @@ -0,0 +1,21 @@ + + +
+ + ++ Generates a skybox based on the provided images. +
+Related: + AddSceneSkyDome + AddSceneSkyDomeEx +
++ + + \ No newline at end of file diff --git a/doc/doc_files/addsceneskydome.html b/doc/doc_files/addsceneskydome.html new file mode 100644 index 0000000..5b56126 --- /dev/null +++ b/doc/doc_files/addsceneskydome.html @@ -0,0 +1,20 @@ + + +
+ + ++ Adds a sky dome to the scene +
+Related: + AddSceneSkyDomeEx +
++ + + \ No newline at end of file diff --git a/doc/doc_files/addsceneskydomeex.html b/doc/doc_files/addsceneskydomeex.html new file mode 100644 index 0000000..fa4fa68 --- /dev/null +++ b/doc/doc_files/addsceneskydomeex.html @@ -0,0 +1,41 @@ + + +
+ + ++ Adds a sky dome to the scene +
+Related: + AddSceneSkyBox + AddSceneSkyDome +
++ + + \ No newline at end of file diff --git a/doc/doc_files/adjointmatrix.html b/doc/doc_files/adjointmatrix.html new file mode 100644 index 0000000..72dd4db --- /dev/null +++ b/doc/doc_files/adjointmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..34287ba --- /dev/null +++ b/doc/doc_files/andbit.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..cac6134 --- /dev/null +++ b/doc/doc_files/android_getexternalstoragepath.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the designated external storage path +
+Related: + Android_GetExternalStorageState + Android_GetInternalStoragePath$ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/android_getexternalstoragestate.html b/doc/doc_files/android_getexternalstoragestate.html new file mode 100644 index 0000000..9c20903 --- /dev/null +++ b/doc/doc_files/android_getexternalstoragestate.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns a bitmask of these values: +
+
+ If AndBit( Android_GetExternalStorageState(), ANDROID_EXTERNAL_STORAGE_READ ) Then
+ Print "Can read from external storage"
+ End If
+
Related: + Android_GetExternalStoragePath$ + Android_GetInternalStoragePath$ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/android_getinternalstoragepath.html b/doc/doc_files/android_getinternalstoragepath.html new file mode 100644 index 0000000..1c6c85e --- /dev/null +++ b/doc/doc_files/android_getinternalstoragepath.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the internal storage path +
+Related: + Android_GetExternalStorageState + 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 new file mode 100644 index 0000000..ae39c49 --- /dev/null +++ b/doc/doc_files/android_jni_message.html @@ -0,0 +1,20 @@ + + +
+ + ++ Passes arg$ to the rcbasic_android_interface() method in the java code for your android app. The java method returns a string. +
+Related: + Runtime_Utility_Message$ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorcentralforcelocal.html b/doc/doc_files/applyactorcentralforcelocal.html new file mode 100644 index 0000000..7822d13 --- /dev/null +++ b/doc/doc_files/applyactorcentralforcelocal.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorCentralForceWorld + ApplyActorCentralImpulseLocal + ApplyActorCentralImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorcentralforceworld.html b/doc/doc_files/applyactorcentralforceworld.html new file mode 100644 index 0000000..9691595 --- /dev/null +++ b/doc/doc_files/applyactorcentralforceworld.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorCentralForceLocal + ApplyActorCentralImpulseLocal + ApplyActorCentralImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorcentralimpulselocal.html b/doc/doc_files/applyactorcentralimpulselocal.html new file mode 100644 index 0000000..8a6eb1e --- /dev/null +++ b/doc/doc_files/applyactorcentralimpulselocal.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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). +
+Related: + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld + ApplyActorCentralImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorcentralimpulseworld.html b/doc/doc_files/applyactorcentralimpulseworld.html new file mode 100644 index 0000000..2bda8cb --- /dev/null +++ b/doc/doc_files/applyactorcentralimpulseworld.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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). +
+Related: + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld + ApplyActorCentralImpulseLocal +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactordamping.html b/doc/doc_files/applyactordamping.html new file mode 100644 index 0000000..03c9cd4 --- /dev/null +++ b/doc/doc_files/applyactordamping.html @@ -0,0 +1,38 @@ + + +
+ + ++ Reduces the velocity of an actor over time, simulating the effect of friction or air resistance. +
++ This function applies the linear and angular damping values set with the SetActorDamping() function. +
+
+ init_damping = False
+ SetActorDamping(actor, 0.1, 0.5)
+ ApplyActorCentralImpulse(actor, 300, 0, 0)
+
+ While True
+ If Not init_damping Then
+ ApplyActorDamping(actor, 5.0) 'Will apply the damping effect for 5 seconds
+ init_damping = True
+ End If
+ Update()
+ Wend
+
Related: + setActorDamping + getActorLinearDamping + getActorAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorforcelocal.html b/doc/doc_files/applyactorforcelocal.html new file mode 100644 index 0000000..c6b4f27 --- /dev/null +++ b/doc/doc_files/applyactorforcelocal.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorForceWorld + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorforceworld.html b/doc/doc_files/applyactorforceworld.html new file mode 100644 index 0000000..13e7bb0 --- /dev/null +++ b/doc/doc_files/applyactorforceworld.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorForceLocal + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorimpulselocal.html b/doc/doc_files/applyactorimpulselocal.html new file mode 100644 index 0000000..a1a8754 --- /dev/null +++ b/doc/doc_files/applyactorimpulselocal.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorImpulseWorld + ApplyActorForceLocal + ApplyActorForceWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactorimpulseworld.html b/doc/doc_files/applyactorimpulseworld.html new file mode 100644 index 0000000..8d8b6c4 --- /dev/null +++ b/doc/doc_files/applyactorimpulseworld.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorImpulseLocal + ApplyActorForceLocal + ApplyActorForceWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactortorqueimpulselocal.html b/doc/doc_files/applyactortorqueimpulselocal.html new file mode 100644 index 0000000..c738226 --- /dev/null +++ b/doc/doc_files/applyactortorqueimpulselocal.html @@ -0,0 +1,26 @@ + + +
+ + ++ Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. +
+Related: + ApplyActorTorque + ApplyActorTorqueImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactortorqueimpulseworld.html b/doc/doc_files/applyactortorqueimpulseworld.html new file mode 100644 index 0000000..ffc8248 --- /dev/null +++ b/doc/doc_files/applyactortorqueimpulseworld.html @@ -0,0 +1,26 @@ + + +
+ + ++ Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. +
+Related: + ApplyActorTorque + ApplyActorTorqueImpulseLocal +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactortorquelocal.html b/doc/doc_files/applyactortorquelocal.html new file mode 100644 index 0000000..02b61a4 --- /dev/null +++ b/doc/doc_files/applyactortorquelocal.html @@ -0,0 +1,27 @@ + + +
+ + ++ Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. +
+Related: + ApplyActorTorqueWorld + ApplyActorTorqueImpulseLocal + ApplyActorTorqueImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/applyactortorqueworld.html b/doc/doc_files/applyactortorqueworld.html new file mode 100644 index 0000000..d2265c8 --- /dev/null +++ b/doc/doc_files/applyactortorqueworld.html @@ -0,0 +1,27 @@ + + +
+ + ++ Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. +
+Related: + ApplyActorTorqueLocal + ApplyActorTorqueImpulseLocal + ApplyActorTorqueImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/arraycopy.html b/doc/doc_files/arraycopy.html new file mode 100644 index 0000000..01a2788 --- /dev/null +++ b/doc/doc_files/arraycopy.html @@ -0,0 +1,25 @@ + + +
+ + ++ 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 +
+Related: + ArrayDim + ArraySize + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/doc_files/arraydim.html b/doc/doc_files/arraydim.html new file mode 100644 index 0000000..c2b0268 --- /dev/null +++ b/doc/doc_files/arraydim.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the number of dimensions in an array +
+Related: + ArrayCopy + ArrayFill + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/arrayfill.html b/doc/doc_files/arrayfill.html new file mode 100644 index 0000000..c6c12c0 --- /dev/null +++ b/doc/doc_files/arrayfill.html @@ -0,0 +1,22 @@ + + +
+ + ++ Fills all the elements in an array with the value in fdata +
+Related: + ArrayCopy + ArrayDim + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/arrays.html b/doc/doc_files/arrays.html new file mode 100644 index 0000000..add3644 --- /dev/null +++ b/doc/doc_files/arrays.html @@ -0,0 +1,61 @@ + + +
+ + ++ In complex programs there is often a need to be able to store large amounts of data. It would be unreasonable to have to create a variable for each piece of data we may need to store. This is where an array can come in handy. Arrays are simply ways of using one variable to store multiple different values. You can create arrays of numbers or strings. Look at the following: +
+
+ Dim A[5]
+
+ The above example creates an array of numbers called A. A can store five numbers which are retrieved using A[0] to A[4]. Notice that A[4] is the last element in the array and not A[5]. That is because the first index in the array is 0 and the array only stores 5 numbers. To set the values in this array you could do the following: +
+
+ A[0] = 3
+ A[1] = 2
+ A[2] = 7
+ A[3] = 1
+ A[4] = 0
+
+ You would access and array just like you would a variable. Look at the following: +
+
+ X = A[0] + A[3] '( Based on the above example the variable X would be set to 4. )
+
+ To make a string variable you would do the same thing you do to make a number variable except you would use the $ just like you would use to make a normal string variable. Look at the following: +
+
+ Dim B$[3]
+
+ B[0] = "ABC"
+ B[1] = "DEF"
+ B[2] = "I KNOW THE ALPHABET"
+
+ Arrays can have up to 3 dimensions. Adding more dimensions to an array can make organizing data in the array easier depending on the situation. Look at the following: +
+
+ Dim X[2, 3]
+ Dim Y[3, 4, 5]
+
+ The above example creates a 2 dimensional array called X which has 2 indices in its first dimension. Its second dimension has 3 indices. This means that each of the 2 indices in the first dimension can store 3 different values. So X can store a total of 6 different values. The second line creates a 3 dimensional array called Y. Y has 3 indices in its first dimension. Each of those 3 indices has 4 indices in its 2nd dimension. Each of the 4 indices has 5 values it can store. This means that Y can store a total of 60 different values. Look at the following for an example on how to work with these multi-dimensional arrays: +
+
+ X[0, 2] = 5 '(This line sets the 3rd value in the first index to 5. Remember that the first index is always 0 so the 3rd index will be 2.)
+
+ 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 new file mode 100644 index 0000000..20f1cce --- /dev/null +++ b/doc/doc_files/arraysize.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the number of elements in the given dimension of an array +
+Related: + ArrayDim + ArrayCopy + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/doc_files/asc.html b/doc/doc_files/asc.html new file mode 100644 index 0000000..07241b9 --- /dev/null +++ b/doc/doc_files/asc.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ad191a6 --- /dev/null +++ b/doc/doc_files/asin.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b8cf337 --- /dev/null +++ b/doc/doc_files/atan.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..579e4d7 --- /dev/null +++ b/doc/doc_files/atan2.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f482c74 --- /dev/null +++ b/doc/doc_files/augmentmatrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/bin.html b/doc/doc_files/bin.html new file mode 100644 index 0000000..a3ebf49 --- /dev/null +++ b/doc/doc_files/bin.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the binary representation of a number. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/bufferfromimage.html b/doc/doc_files/bufferfromimage.html new file mode 100644 index 0000000..425788e --- /dev/null +++ b/doc/doc_files/bufferfromimage.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/bufferfrommatrix.html b/doc/doc_files/bufferfrommatrix.html new file mode 100644 index 0000000..b6b92f2 --- /dev/null +++ b/doc/doc_files/bufferfrommatrix.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + MatrixFromBuffer +
++ + + \ No newline at end of file diff --git a/doc/doc_files/bufferfromstring.html b/doc/doc_files/bufferfromstring.html new file mode 100644 index 0000000..0b9455e --- /dev/null +++ b/doc/doc_files/bufferfromstring.html @@ -0,0 +1,20 @@ + + +
+ + ++ Stores the byte value of a string into a number buffer +
+Related: + StringFromBuffer$ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/canvas.html b/doc/doc_files/canvas.html new file mode 100644 index 0000000..5ada771 --- /dev/null +++ b/doc/doc_files/canvas.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the active canvas for drawing commands to use +
+Related: + ActiveCanvas +
++ + + \ No newline at end of file diff --git a/doc/doc_files/canvasclip.html b/doc/doc_files/canvasclip.html new file mode 100644 index 0000000..0913f2c --- /dev/null +++ b/doc/doc_files/canvasclip.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an image id with a selected portion of the active drawing canvas saved +
+Related: + WindowClip +
++ + + \ No newline at end of file diff --git a/doc/doc_files/canvasisvisible.html b/doc/doc_files/canvasisvisible.html new file mode 100644 index 0000000..e4d4fe8 --- /dev/null +++ b/doc/doc_files/canvasisvisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if a canvas is shown in the Window +
+Related: + SetCanvasVisible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/canvasz.html b/doc/doc_files/canvasz.html new file mode 100644 index 0000000..b37887e --- /dev/null +++ b/doc/doc_files/canvasz.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetCanvasZ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/changedir.html b/doc/doc_files/changedir.html new file mode 100644 index 0000000..ea7d13d --- /dev/null +++ b/doc/doc_files/changedir.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b8c14df --- /dev/null +++ b/doc/doc_files/channelispaused.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if an audio channel is currently paused +
+Related: + PauseSound +
++ + + \ No newline at end of file diff --git a/doc/doc_files/channelisplaying.html b/doc/doc_files/channelisplaying.html new file mode 100644 index 0000000..4f233de --- /dev/null +++ b/doc/doc_files/channelisplaying.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns true if an audio channel is playing +
+Related: + ChannelIsPaused + PlaySound + PlaySoundTimed +
++ + + \ No newline at end of file diff --git a/doc/doc_files/checksockets.html b/doc/doc_files/checksockets.html new file mode 100644 index 0000000..b57031a --- /dev/null +++ b/doc/doc_files/checksockets.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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) +
++ + + \ No newline at end of file diff --git a/doc/doc_files/chr.html b/doc/doc_files/chr.html new file mode 100644 index 0000000..b449c24 --- /dev/null +++ b/doc/doc_files/chr.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8dea700 --- /dev/null +++ b/doc/doc_files/cint32.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8ecb94d --- /dev/null +++ b/doc/doc_files/cint64.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1af0f09 --- /dev/null +++ b/doc/doc_files/circle.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..554064a --- /dev/null +++ b/doc/doc_files/circlefill.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..43c251a --- /dev/null +++ b/doc/doc_files/clearactorforces.html @@ -0,0 +1,31 @@ + + +
+ + ++ 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. +
++ Notes: +
++ + + \ No newline at end of file diff --git a/doc/doc_files/clearcanvas.html b/doc/doc_files/clearcanvas.html new file mode 100644 index 0000000..e8e98ca --- /dev/null +++ b/doc/doc_files/clearcanvas.html @@ -0,0 +1,17 @@ + + +
+ + ++ Clears the active drawing canvas +
++ + + \ No newline at end of file diff --git a/doc/doc_files/clearmatrix.html b/doc/doc_files/clearmatrix.html new file mode 100644 index 0000000..82c2b5e --- /dev/null +++ b/doc/doc_files/clearmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..188769f --- /dev/null +++ b/doc/doc_files/clearmatrixcolumns.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets all elements in the matrix columns specified to zero. +
+Related: + ClearMatrix + ClearMatrixRows +
++ + + \ No newline at end of file diff --git a/doc/doc_files/clearmatrixrows.html b/doc/doc_files/clearmatrixrows.html new file mode 100644 index 0000000..7ea08e7 --- /dev/null +++ b/doc/doc_files/clearmatrixrows.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets all elements in the matrix rows specified to zero. +
+Related: + ClearMatrix + ClearMatrixColumns +
++ + + \ No newline at end of file diff --git a/doc/doc_files/clearmousezone.html b/doc/doc_files/clearmousezone.html new file mode 100644 index 0000000..e1ee81f --- /dev/null +++ b/doc/doc_files/clearmousezone.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes the previously set mouse zone from the window +
++ + + \ No newline at end of file diff --git a/doc/doc_files/clearstack_n.html b/doc/doc_files/clearstack_n.html new file mode 100644 index 0000000..6135148 --- /dev/null +++ b/doc/doc_files/clearstack_n.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes all elements from the stack +
+Related: + ClearStack_S +
++ + + \ No newline at end of file diff --git a/doc/doc_files/clearstack_s.html b/doc/doc_files/clearstack_s.html new file mode 100644 index 0000000..8587936 --- /dev/null +++ b/doc/doc_files/clearstack_s.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes all elements from the stack +
+Related: + ClearStack_N +
++ + + \ No newline at end of file diff --git a/doc/doc_files/clipmatrix.html b/doc/doc_files/clipmatrix.html new file mode 100644 index 0000000..b06e42b --- /dev/null +++ b/doc/doc_files/clipmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5e228ab --- /dev/null +++ b/doc/doc_files/clonecanvas.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
++ Mode is a canvas render mode like the one passed to OpenCanvas() +
+Related: + OpenCanvas +
++ + + \ No newline at end of file diff --git a/doc/doc_files/closecanvas.html b/doc/doc_files/closecanvas.html new file mode 100644 index 0000000..26ed1e9 --- /dev/null +++ b/doc/doc_files/closecanvas.html @@ -0,0 +1,20 @@ + + +
+ + ++ Closes a canvas +
+Related: + OpenCanvas +
++ + + \ No newline at end of file diff --git a/doc/doc_files/closefile.html b/doc/doc_files/closefile.html new file mode 100644 index 0000000..81566ea --- /dev/null +++ b/doc/doc_files/closefile.html @@ -0,0 +1,20 @@ + + +
+ + ++ Closes a file +
+Related: + OpenFile +
++ + + \ No newline at end of file diff --git a/doc/doc_files/closewindow.html b/doc/doc_files/closewindow.html new file mode 100644 index 0000000..24efc2d --- /dev/null +++ b/doc/doc_files/closewindow.html @@ -0,0 +1,20 @@ + + +
+ + ++ Closes the graphics window +
+Related: + OpenWindow +
++ + + \ No newline at end of file diff --git a/doc/doc_files/cls.html b/doc/doc_files/cls.html new file mode 100644 index 0000000..2ab7692 --- /dev/null +++ b/doc/doc_files/cls.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f3ad1b5 --- /dev/null +++ b/doc/doc_files/cofactormatrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + CopyMatrix +
++ + + \ No newline at end of file diff --git a/doc/doc_files/colorkey.html b/doc/doc_files/colorkey.html new file mode 100644 index 0000000..ef6bf75 --- /dev/null +++ b/doc/doc_files/colorkey.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..558c114 --- /dev/null +++ b/doc/doc_files/command.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns command line arguments passed to a program. +
++ Note: Command$(0) will always be the program being executed ( your_program.cbc ) +
+Related: + NumCommands +
++ + + \ No newline at end of file diff --git a/doc/doc_files/comments.html b/doc/doc_files/comments.html new file mode 100644 index 0000000..65f835d --- /dev/null +++ b/doc/doc_files/comments.html @@ -0,0 +1,32 @@ + + +
+ + ++ Comments are remarks you can add to your code which will be ignored by the compiler. To make a comment you would use a single quote. Look at the following: +
+
+ ' THIS IS A COMMENT
+ Print HELLO "WORLD ' THIS IS ANOTHER COMMENT
+
+ MULTI-LINE COMMENTS +
++ Multi-line comments are comments that can span multiple lines. To start a multi-line comment you would use forward slash followed by a single quote and you would end it with a single quote followed by a forward slash. Look at the following: +
+
+ /' THIS IS
+ A
+ MULTI-LINE COMMENT '/
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/computeactorangularimpulsedenominator.html b/doc/doc_files/computeactorangularimpulsedenominator.html new file mode 100644 index 0000000..06962d3 --- /dev/null +++ b/doc/doc_files/computeactorangularimpulsedenominator.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorImpulseDenominator +
++ + + \ No newline at end of file diff --git a/doc/doc_files/computeactorgyroimpulselocal.html b/doc/doc_files/computeactorgyroimpulselocal.html new file mode 100644 index 0000000..f18826e --- /dev/null +++ b/doc/doc_files/computeactorgyroimpulselocal.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorGyroImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/computeactorgyroimpulseworld.html b/doc/doc_files/computeactorgyroimpulseworld.html new file mode 100644 index 0000000..bad5d65 --- /dev/null +++ b/doc/doc_files/computeactorgyroimpulseworld.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorGyroImpulseLocal +
++ + + \ No newline at end of file diff --git a/doc/doc_files/computeactorimpulsedenominator.html b/doc/doc_files/computeactorimpulsedenominator.html new file mode 100644 index 0000000..a3ce3de --- /dev/null +++ b/doc/doc_files/computeactorimpulsedenominator.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorAngularImpulseDenominator +
++ + + \ No newline at end of file diff --git a/doc/doc_files/conditions.html b/doc/doc_files/conditions.html new file mode 100644 index 0000000..f4fcdd7 --- /dev/null +++ b/doc/doc_files/conditions.html @@ -0,0 +1,60 @@ + + +
+ + ++ RC BASIC uses the same conventions of other programming languages to control the flow of the program. There are two main ways of getting your program to decide on its next course of action. The most common way is with the IF statement block. +
+
+ If 5 > 6 Then
+ Print "THIS WILL NOT PRINT"
+ ElseIf 5 < 6 Then
+ Print "THIS WILL PRINT"
+ Else
+ Print "THIS ALSO WILL NOT PRINT"
+ End If
+
+ The above example does different comparisons and will output text to a console depending on which condition is true. +
++ The next method of control flow is the SELECT statement block. +
+
+ Select Case 5
+ Case 6
+ Print THIS WILL NOT "PRINT
+ Case 5
+ Print "THIS WILL PRINT"
+ Default
+ 'Note: Default will be true if every other case is false.
+ ' Default is optional and can be excluded if you don't need it
+ Print "THIS WILL NOT PRINT"
+ End Select
+
+ The above example will compare each case in the block to the SELECT CASE. If the case is equal to the select case then the code in that case will be executed. You can also add multiple values to compare to each CASE. +
+
+ Select Case 5
+ Case 6
+ Print THIS WILL NOT "PRINT
+ Case 4, 5
+ Print "THIS WILL PRINT"
+ Default
+ Print "THIS WILL NOT PRINT"
+ End Select
+
+ 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 new file mode 100644 index 0000000..4696681 --- /dev/null +++ b/doc/doc_files/constants.html @@ -0,0 +1,21 @@ + + +
+ + ++ RCBasic has a special type of variable called a constant which can hold an expression. This means it can hold an expression and not determine its value until its used. For example you can have a constant called C that is equal to A + B. Everytime you change the value of A or B, C's value will also change. Because constants hold expressions, any valid expression in RCBasic can be stored in a constant. +
+
+ const A = 5
+ 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 new file mode 100644 index 0000000..9ac8234 --- /dev/null +++ b/doc/doc_files/constraintexists.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/copyactormaterial.html b/doc/doc_files/copyactormaterial.html new file mode 100644 index 0000000..acbb09c --- /dev/null +++ b/doc/doc_files/copyactormaterial.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..50b1ca9 --- /dev/null +++ b/doc/doc_files/copyfile.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..be775b7 --- /dev/null +++ b/doc/doc_files/copyimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..075a306 --- /dev/null +++ b/doc/doc_files/copymaterial.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..36f7ff1 --- /dev/null +++ b/doc/doc_files/copymatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6d4898d --- /dev/null +++ b/doc/doc_files/copymatrixcolumns.html @@ -0,0 +1,20 @@ + + +
+ + ++ Copies the specified matrix columns from matrix mA to matrix mB. +
++ 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 new file mode 100644 index 0000000..482687d --- /dev/null +++ b/doc/doc_files/copymatrixrows.html @@ -0,0 +1,20 @@ + + +
+ + ++ Copies the specified matrix rows from matrix mA to matrix mB. +
++ 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 new file mode 100644 index 0000000..7d67e00 --- /dev/null +++ b/doc/doc_files/cos.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..db707e9 --- /dev/null +++ b/doc/doc_files/createactoranimation.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/createanimatedactor.html b/doc/doc_files/createanimatedactor.html new file mode 100644 index 0000000..1146adc --- /dev/null +++ b/doc/doc_files/createanimatedactor.html @@ -0,0 +1,37 @@ + + +
+ + ++ Returns a new animated actor composed of a mesh +
++ The mesh can either be created using CreateMesh() or Loaded using LoadMesh() +
+Related: + CreateMesh + LoadMesh + LoadMeshFromAN8 +
+
+
+
Related: + CreateOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createbillboardactor.html b/doc/doc_files/createbillboardactor.html new file mode 100644 index 0000000..960d051 --- /dev/null +++ b/doc/doc_files/createbillboardactor.html @@ -0,0 +1,29 @@ + + +
+ + ++ Returns a billboard actor +
++ Billboard actors are flat textured planes that are always facing the camera. +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateCubeActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createconeconstraint.html b/doc/doc_files/createconeconstraint.html new file mode 100644 index 0000000..4bc8256 --- /dev/null +++ b/doc/doc_files/createconeconstraint.html @@ -0,0 +1,36 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100)
+
+ rbA = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix
+ SetIdentityMatrix(rbA, 4) 'This will set rbA to a 4x4 identity matrix
+ SetMatrixTranslation(rbA, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin
+ SetMatrixRotation(rbA, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes
+
+ test_cone = CreateConeConstraint( actorA, rbA )
+
+ Note: It is recommended to use CreateConeConstraintEx() in most cases +
+Related: + CreateConeConstraintEx + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createconeconstraintex.html b/doc/doc_files/createconeconstraintex.html new file mode 100644 index 0000000..bfe5bc3 --- /dev/null +++ b/doc/doc_files/createconeconstraintex.html @@ -0,0 +1,39 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100)
+ actorB = CreateCubeActor(100)
+
+ rbA = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix
+ SetIdentityMatrix(rbA, 4) 'This will set rbA to a 4x4 identity matrix
+ SetMatrixTranslation(rbA, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin
+ SetMatrixRotation(rbA, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes
+
+ rbB = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix
+ SetIdentityMatrix(rbB, 4) 'This will set rbA to a 4x4 identity matrix
+ SetMatrixTranslation(rbB, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin
+ SetMatrixRotation(rbB, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes
+
+ test_cone = CreateConeConstraint( actorA, rbA )
+
Related: + CreateConeConstraint + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createcubeactor.html b/doc/doc_files/createcubeactor.html new file mode 100644 index 0000000..b5bccbe --- /dev/null +++ b/doc/doc_files/createcubeactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns an actor with a cube mesh of the specified size ( cube_size x cube_size x cube_size ) +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createhingeconstraint.html b/doc/doc_files/createhingeconstraint.html new file mode 100644 index 0000000..3b5cc44 --- /dev/null +++ b/doc/doc_files/createhingeconstraint.html @@ -0,0 +1,33 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameA, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube
+ hinge = CreateHingeConstraint(actorA, frameA, true)
+
+ Note: It is recommended to use CreateSlideConstraintEx() in most cases +
+Related: + CreateHingeConstraintEx + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createhingeconstraintex.html b/doc/doc_files/createhingeconstraintex.html new file mode 100644 index 0000000..5f2467b --- /dev/null +++ b/doc/doc_files/createhingeconstraintex.html @@ -0,0 +1,39 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameA, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube
+
+ actorB = CreateCubeActor(100) 'Creates a cube actor
+ frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameB, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube
+
+ hinge = CreateHingeConstraint(actorA, actorB, frameA, frameB, true)
+
+ Note: It is recommended to use CreateHingeConstraintEx() in most cases +
+Related: + CreateHingeConstraint + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createimage.html b/doc/doc_files/createimage.html new file mode 100644 index 0000000..1bb8d4f --- /dev/null +++ b/doc/doc_files/createimage.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns an image created from the buffer provided +
+Related: + CreateImageEx + LoadImage +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createimageex.html b/doc/doc_files/createimageex.html new file mode 100644 index 0000000..ca754eb --- /dev/null +++ b/doc/doc_files/createimageex.html @@ -0,0 +1,24 @@ + + +
+ + ++ Returns an image created from the buffer provided +
++ The color parameter is a color key value to apply +
+Related: + CreateImage + LoadImage +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createlightactor.html b/doc/doc_files/createlightactor.html new file mode 100644 index 0000000..46d9463 --- /dev/null +++ b/doc/doc_files/createlightactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns a new light in the scene +
+Related: + CreateMeshActor + CreateMeshOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/creatematerial.html b/doc/doc_files/creatematerial.html new file mode 100644 index 0000000..262368d --- /dev/null +++ b/doc/doc_files/creatematerial.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new material +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createmesh.html b/doc/doc_files/createmesh.html new file mode 100644 index 0000000..023391d --- /dev/null +++ b/doc/doc_files/createmesh.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new mesh +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createmeshactor.html b/doc/doc_files/createmeshactor.html new file mode 100644 index 0000000..7651833 --- /dev/null +++ b/doc/doc_files/createmeshactor.html @@ -0,0 +1,37 @@ + + +
+ + ++ Returns a new animated actor composed of a mesh +
++ The mesh can either be created using CreateMesh() or Loaded using LoadMesh() +
+Related: + CreateMesh + LoadMesh + LoadMeshFromAN8 +
+
+
+
Related: + CreateOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createmeshoctreeactor.html b/doc/doc_files/createmeshoctreeactor.html new file mode 100644 index 0000000..773d56a --- /dev/null +++ b/doc/doc_files/createmeshoctreeactor.html @@ -0,0 +1,33 @@ + + +
+ + ++ Returns a mesh actor optimized for large objects (such as levels) +
+Related: + CreateMesh + LoadMesh +
+
+
+
Related: + CreateMeshActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createoctreeactor.html b/doc/doc_files/createoctreeactor.html new file mode 100644 index 0000000..f98ec0b --- /dev/null +++ b/doc/doc_files/createoctreeactor.html @@ -0,0 +1,33 @@ + + +
+ + ++ Returns a mesh actor optimized for large objects (such as levels) +
+Related: + CreateMesh + LoadMesh +
+
+
+
Related: + CreateAnimatedActor + CreateCubeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createparticleactor.html b/doc/doc_files/createparticleactor.html new file mode 100644 index 0000000..df45f38 --- /dev/null +++ b/doc/doc_files/createparticleactor.html @@ -0,0 +1,49 @@ + + +
+ + ++ Returns a new particle actor +
++ Possible Particle Types +
+Related: + CreateMeshOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createplanemesh.html b/doc/doc_files/createplanemesh.html new file mode 100644 index 0000000..3967e52 --- /dev/null +++ b/doc/doc_files/createplanemesh.html @@ -0,0 +1,25 @@ + + +
+ + ++ Creates a flat plane +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createpointconstraint.html b/doc/doc_files/createpointconstraint.html new file mode 100644 index 0000000..f9ecea7 --- /dev/null +++ b/doc/doc_files/createpointconstraint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + CreatePointConstraintEx +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createpointconstraintex.html b/doc/doc_files/createpointconstraintex.html new file mode 100644 index 0000000..b603e5d --- /dev/null +++ b/doc/doc_files/createpointconstraintex.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + CreatePointConstraint +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createslideconstraint.html b/doc/doc_files/createslideconstraint.html new file mode 100644 index 0000000..d1f8c1e --- /dev/null +++ b/doc/doc_files/createslideconstraint.html @@ -0,0 +1,34 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameB, 0, 50, 0) 'Sets the attach point of the constraint to the top of the cube
+ SetMatrixRotation(frameB, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y
+ slide = CreateSlideConstraint(actorA, frameB, true)
+
+ Note: It is recommended to use CreateSlideConstraintEx() in most cases +
+Related: + CreateSlideConstraintEx + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createslideconstraintex.html b/doc/doc_files/createslideconstraintex.html new file mode 100644 index 0000000..00371f4 --- /dev/null +++ b/doc/doc_files/createslideconstraintex.html @@ -0,0 +1,40 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameA, 0, 0, 0) 'Sets the attach point of the constraint to center of the cube
+ SetMatrixRotation(frameA, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y
+
+ actorB = CreateCubeActor(100) 'Creates a cube actor
+ frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameB, 0, 50, 0) 'Sets the attach point of the constraint to the top of the cube
+ SetMatrixRotation(frameB, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y
+ slide = CreateSlideConstraintEx(actorA, actorB, frameA, frameB, true)
+
+ Note: It is recommended to use CreateSlideConstraintEx() in most cases +
+Related: + CreateSlideConstraint + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createsound.html b/doc/doc_files/createsound.html new file mode 100644 index 0000000..f0e836a --- /dev/null +++ b/doc/doc_files/createsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..78b54cd --- /dev/null +++ b/doc/doc_files/createsphereactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns an actor composed of a sphere mesh +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateBillboardActor + CreateWaterActor + CreateLightActor + CreateCubeActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createsprite.html b/doc/doc_files/createsprite.html new file mode 100644 index 0000000..d92a5ce --- /dev/null +++ b/doc/doc_files/createsprite.html @@ -0,0 +1,52 @@ + + +
+ + ++ This function returns a new sprite which you can place in a variable for use in your program. +
++ Here is an example of opening a sprite canvas layer, creating a sprite, setting it's position and finally displaying it. +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("CreateSprite", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ While Not Key(K_ESCAPE)
+ 'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called.
+ Update() 'Update automatically deals with drawing the sprites on the sprite canvas.
+ Wend
+
Related: + OpenCanvasSpriteLayer + SetSpritePosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createspriteanimation.html b/doc/doc_files/createspriteanimation.html new file mode 100644 index 0000000..86e6406 --- /dev/null +++ b/doc/doc_files/createspriteanimation.html @@ -0,0 +1,25 @@ + + +
+ + ++ Returns a new sprite animation id +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createstack_n.html b/doc/doc_files/createstack_n.html new file mode 100644 index 0000000..0636ce1 --- /dev/null +++ b/doc/doc_files/createstack_n.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5f954c2 --- /dev/null +++ b/doc/doc_files/createstack_s.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d100dea --- /dev/null +++ b/doc/doc_files/createterrainactor.html @@ -0,0 +1,29 @@ + + +
+ + ++ Returns terrain generated from a height map +
++ Note: Height Maps can be any supported image format +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateCubeActor + CreateBillboardActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createtilemap.html b/doc/doc_files/createtilemap.html new file mode 100644 index 0000000..5e0604a --- /dev/null +++ b/doc/doc_files/createtilemap.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns a new tile map. +
++ Parameters +
+Related: + CreateTileSet +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createtileset.html b/doc/doc_files/createtileset.html new file mode 100644 index 0000000..df195b4 --- /dev/null +++ b/doc/doc_files/createtileset.html @@ -0,0 +1,93 @@ + + +
+ + ++ Return a new Tileset +
++ Parameters: +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("TestTileset", winWidth, winHeight, isFullScreen, vSync)
+ mCanvas = OpenCanvas(winWidth, winHeight, canViewPortX, canViewPortY, winWidth, winHeight, 1)
+ Canvas(mCanvas)
+
+ mAtlas = LoadImage("testTileSet.png") 'Load in our atlas or tile set image
+
+ mTileSet = CreateTileSet(mAtlas, 24, 24) 'Create a tile set and assign it a holder to access
+
+ mTileMap = CreateTileMap(mTileSet, 20, 20) 'Create a tile map with our tile set holder "mTileSet"
+
+ 'Now we have a blacnk tilemap to fill with tiles, we now use the mAtlas image to fill in the map
+ 'First we will assign a grass tile across our entire tile map. lets grab a grass tile to fill in.
+
+ FillTile(mTileMap, 166, 0, 0, 20, 20) 'The tile number goes by starting at the top left corner to the right edge of the image,
+ 'then wraps around and comntinues the count, the image is 13 wide (0-12) so 166 would be
+ '2 in from the end of the last row of images on the tileset.
+
+ SetTile(mTileMap, 15, 0, 0) 'With the map filled with grass tiles we can change a single tile, to a little guy in the
+ 'top left corner.
+
+ 'Before we begin our main loop, we need to make some variables for holding some important info
+ mOffsetX = 0
+ mOffsetY = 0 'Offset values for where the tile is to be drawn from, used for scrolling.
+ mViewportX = 640
+ mViewportY = 480 'How much of the tile map is to be drawn on the canvas
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+
+ DrawTileMap(mTileMap, 0, 0, mViewportX, mViewportY, mOffsetX, mOffsetY)
+
+ If Key(K_UP) Then
+ mOffsetY = mOffsetY - 0.5
+ ElseIf Key(K_DOWN) Then
+ mOffsetY = mOffsetY + 0.5
+ ElseIf Key(K_LEFT) Then
+ mOffsetX = mOffsetX - 0.5
+ ElseIf Key(K_RIGHT) Then
+ mOffsetX = mOffsetX + 0.5
+ End If
+
+ Update()
+ Wend
+
+ 'As you can see this replaces the grass tile with a character tile, if we wanted to place the character or any other object or image ontop of the tile
+ 'we would DrawImage() an image not using the tilemap.
+
Related: + CreateTileMap + SetTile + FillTile + DrawTileMap +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createwateractor.html b/doc/doc_files/createwateractor.html new file mode 100644 index 0000000..2fbf096 --- /dev/null +++ b/doc/doc_files/createwateractor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Creates an actor with water properties set on a base mesh +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateCubeActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/createwaterplaneactor.html b/doc/doc_files/createwaterplaneactor.html new file mode 100644 index 0000000..f5b50f6 --- /dev/null +++ b/doc/doc_files/createwaterplaneactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns a water plane actor +
+Related: + CreateMeshActor + CreateMeshOctreeActor + CreateCubeActor + CreateSphereActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/cubematrix.html b/doc/doc_files/cubematrix.html new file mode 100644 index 0000000..fd8344c --- /dev/null +++ b/doc/doc_files/cubematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4ce196c --- /dev/null +++ b/doc/doc_files/date.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8c331fc --- /dev/null +++ b/doc/doc_files/degrees.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0695d93 --- /dev/null +++ b/doc/doc_files/deleteactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes an actor from the scene and frees its memory +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deleteactoranimation.html b/doc/doc_files/deleteactoranimation.html new file mode 100644 index 0000000..89436d3 --- /dev/null +++ b/doc/doc_files/deleteactoranimation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Deletes an actor's animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deleteconstraint.html b/doc/doc_files/deleteconstraint.html new file mode 100644 index 0000000..d4ec770 --- /dev/null +++ b/doc/doc_files/deleteconstraint.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a constraint +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletefont.html b/doc/doc_files/deletefont.html new file mode 100644 index 0000000..a4e5d82 --- /dev/null +++ b/doc/doc_files/deletefont.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..43ba22b --- /dev/null +++ b/doc/doc_files/deleteimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes an image from memory +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletematerial.html b/doc/doc_files/deletematerial.html new file mode 100644 index 0000000..7424dda --- /dev/null +++ b/doc/doc_files/deletematerial.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a material from memory +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletematrix.html b/doc/doc_files/deletematrix.html new file mode 100644 index 0000000..3cd8f16 --- /dev/null +++ b/doc/doc_files/deletematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1d62c02 --- /dev/null +++ b/doc/doc_files/deletematrixcolumns.html @@ -0,0 +1,23 @@ + + +
+ + ++ Removes the specified columns from a matrix +
++ Returns false if column are outside matrix +
+Related: + DeleteMatrixRows +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletematrixrows.html b/doc/doc_files/deletematrixrows.html new file mode 100644 index 0000000..9744bbd --- /dev/null +++ b/doc/doc_files/deletematrixrows.html @@ -0,0 +1,23 @@ + + +
+ + ++ Removes the specified rows from a matrix +
++ Returns false if rows are outside matrix +
+Related: + DeleteMatrixColumns +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletemesh.html b/doc/doc_files/deletemesh.html new file mode 100644 index 0000000..97df4d5 --- /dev/null +++ b/doc/doc_files/deletemesh.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e4ce76d --- /dev/null +++ b/doc/doc_files/deletemusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..030955e --- /dev/null +++ b/doc/doc_files/deletesound.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..33b4ffd --- /dev/null +++ b/doc/doc_files/deletesprite.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a sprite from memory +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletespriteanimation.html b/doc/doc_files/deletespriteanimation.html new file mode 100644 index 0000000..b548c7b --- /dev/null +++ b/doc/doc_files/deletespriteanimation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Delete's a sprite's animation +
+Related: + CreateSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletestack_n.html b/doc/doc_files/deletestack_n.html new file mode 100644 index 0000000..789e58c --- /dev/null +++ b/doc/doc_files/deletestack_n.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2ae26e7 --- /dev/null +++ b/doc/doc_files/deletestack_s.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a string stack from memory +
++ + + \ No newline at end of file diff --git a/doc/doc_files/deletevideo.html b/doc/doc_files/deletevideo.html new file mode 100644 index 0000000..7367586 --- /dev/null +++ b/doc/doc_files/deletevideo.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3ea3bbc --- /dev/null +++ b/doc/doc_files/determinant.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3131ae5 --- /dev/null +++ b/doc/doc_files/dimmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new matrix +
++ + + \ No newline at end of file diff --git a/doc/doc_files/dir.html b/doc/doc_files/dir.html new file mode 100644 index 0000000..bf59ec9 --- /dev/null +++ b/doc/doc_files/dir.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ec8a462 --- /dev/null +++ b/doc/doc_files/direxists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a78ca29 --- /dev/null +++ b/doc/doc_files/dirfirst.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7ed0d9a --- /dev/null +++ b/doc/doc_files/dirnext.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the next item in the directory poll +
+Related: + DirFirst$ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/distance2d.html b/doc/doc_files/distance2d.html new file mode 100644 index 0000000..666e16a --- /dev/null +++ b/doc/doc_files/distance2d.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d306216 --- /dev/null +++ b/doc/doc_files/distance3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1225ee6 --- /dev/null +++ b/doc/doc_files/drawimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..05937c5 --- /dev/null +++ b/doc/doc_files/drawimage_blit.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3827d66 --- /dev/null +++ b/doc/doc_files/drawimage_blitex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Draws a portion of an image to the current canvas scaled to a given width and height. +
+Related: + DrawImage_Blit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/drawimage_flip.html b/doc/doc_files/drawimage_flip.html new file mode 100644 index 0000000..b7ed61e --- /dev/null +++ b/doc/doc_files/drawimage_flip.html @@ -0,0 +1,23 @@ + + +
+ + ++ Draws an image flipped horizontally or vertically. +
++ Note: h and v are boolean values +
+Related: + DrawImage_FlipEx +
++ + + \ No newline at end of file diff --git a/doc/doc_files/drawimage_flipex.html b/doc/doc_files/drawimage_flipex.html new file mode 100644 index 0000000..dfa3595 --- /dev/null +++ b/doc/doc_files/drawimage_flipex.html @@ -0,0 +1,23 @@ + + +
+ + ++ Draws a portion of an image flipped horizontally or vertically. +
++ Note: h and v are boolean values +
+Related: + DrawImage_Flip +
++ + + \ No newline at end of file diff --git a/doc/doc_files/drawimage_rotate.html b/doc/doc_files/drawimage_rotate.html new file mode 100644 index 0000000..363f5ef --- /dev/null +++ b/doc/doc_files/drawimage_rotate.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..305bcc7 --- /dev/null +++ b/doc/doc_files/drawimage_rotateex.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a9069ae --- /dev/null +++ b/doc/doc_files/drawimage_rotozoom.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..880cf70 --- /dev/null +++ b/doc/doc_files/drawimage_rotozoomex.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..71dbd06 --- /dev/null +++ b/doc/doc_files/drawimage_zoom.html @@ -0,0 +1,20 @@ + + +
+ + ++ Draws an image to the current canvas scaled by a given factor +
+Related: + DrawImage_ZoomEx +
++ + + \ No newline at end of file diff --git a/doc/doc_files/drawimage_zoomex.html b/doc/doc_files/drawimage_zoomex.html new file mode 100644 index 0000000..49eb29b --- /dev/null +++ b/doc/doc_files/drawimage_zoomex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Draws a portion of an Image to the current canvas scaled by a given factor +
+Related: + DrawImage_Zoom +
++ + + \ No newline at end of file diff --git a/doc/doc_files/drawtext.html b/doc/doc_files/drawtext.html new file mode 100644 index 0000000..f48e389 --- /dev/null +++ b/doc/doc_files/drawtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..460bc56 --- /dev/null +++ b/doc/doc_files/drawtilemap.html @@ -0,0 +1,37 @@ + + +
+ + ++ Draws a tile map +
++ Note: Can only be drawn on a regular 2D canvas +
++ Parameters: +
++ + + \ No newline at end of file diff --git a/doc/doc_files/easter.html b/doc/doc_files/easter.html new file mode 100644 index 0000000..eea5013 --- /dev/null +++ b/doc/doc_files/easter.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a0ceccf --- /dev/null +++ b/doc/doc_files/ellipse.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c1d01d5 --- /dev/null +++ b/doc/doc_files/ellipsefill.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a filled ellipse on the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/env.html b/doc/doc_files/env.html new file mode 100644 index 0000000..f6c9178 --- /dev/null +++ b/doc/doc_files/env.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the value of the environment variable passed to it. +
+Related: + SetEnv +
++ + + \ No newline at end of file diff --git a/doc/doc_files/eof.html b/doc/doc_files/eof.html new file mode 100644 index 0000000..32196f9 --- /dev/null +++ b/doc/doc_files/eof.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true when end of file is reached +
++ + + \ No newline at end of file diff --git a/doc/doc_files/escape_char.html b/doc/doc_files/escape_char.html new file mode 100644 index 0000000..ed382e6 --- /dev/null +++ b/doc/doc_files/escape_char.html @@ -0,0 +1,58 @@ + + +
+ + +| ESCAPE CHARACTER | +DESCRIPTION | +
| \\ | +INSERTS A "\" INTO A STRING | +
| \n | +INSERTS A NEW-LINE INTO A STRING | +
| \b | +INSERTS A BACKSPACE INTO A STRING | +
| \" | \q | +INSERTS A QUOTATION MARK INTO A STRING | +
| \t | +INSERTS A TAB INTO A STRING | +
| \0 | +INSERTS A NULL CHARACTER INTO A STRING | +
| \a | +INSERTS AN ALERT BELL INTO A STRING | +
| \v | +INSERTS A VERTICAL TAB INTO A STRING | +
| \f | +INSERTS A FORM FEED INTO A STRING | +
| \r | +INSERTS A CARRIAGE RETURN | +
+ Runs javascript code +
++ Returns the return value of the javascript code +
++ 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 new file mode 100644 index 0000000..2939f85 --- /dev/null +++ b/doc/doc_files/exp.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..75dd72d --- /dev/null +++ b/doc/doc_files/fademusicin.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fades music in +
++ + + \ No newline at end of file diff --git a/doc/doc_files/fademusicout.html b/doc/doc_files/fademusicout.html new file mode 100644 index 0000000..6caa49a --- /dev/null +++ b/doc/doc_files/fademusicout.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fades music out +
++ + + \ No newline at end of file diff --git a/doc/doc_files/fileexists.html b/doc/doc_files/fileexists.html new file mode 100644 index 0000000..2e68cd1 --- /dev/null +++ b/doc/doc_files/fileexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d7bcb5a --- /dev/null +++ b/doc/doc_files/filelength.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d2bf669 --- /dev/null +++ b/doc/doc_files/fillmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7af2be5 --- /dev/null +++ b/doc/doc_files/fillmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1f2d4cb --- /dev/null +++ b/doc/doc_files/fillmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b42757e --- /dev/null +++ b/doc/doc_files/filltile.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a1df02e --- /dev/null +++ b/doc/doc_files/flashwindow.html @@ -0,0 +1,34 @@ + + +
+ + ++ Flashes a window to specify an alert +
++ Returns 0 on success and a negative number on failure +
++ Possible flag values: +
++ + + \ No newline at end of file diff --git a/doc/doc_files/floodfill.html b/doc/doc_files/floodfill.html new file mode 100644 index 0000000..ac60db3 --- /dev/null +++ b/doc/doc_files/floodfill.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fills a closed shape in with the current draw color +
++ + + \ No newline at end of file diff --git a/doc/doc_files/fontexists.html b/doc/doc_files/fontexists.html new file mode 100644 index 0000000..fa30d61 --- /dev/null +++ b/doc/doc_files/fontexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..28a21af --- /dev/null +++ b/doc/doc_files/fprint.html @@ -0,0 +1,17 @@ + + +
+ + ++ Outputs text to the console +
++ + + \ No newline at end of file diff --git a/doc/doc_files/fps.html b/doc/doc_files/fps.html new file mode 100644 index 0000000..4636022 --- /dev/null +++ b/doc/doc_files/fps.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..31297cd --- /dev/null +++ b/doc/doc_files/frac.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..721896f --- /dev/null +++ b/doc/doc_files/func_sub.html @@ -0,0 +1,161 @@ + + +
+ + ++ Functions and Sub Routines are blocks of code that can be executed any where in your program. +
++ The biggest difference between Functions and Sub Routines is that Functions can return a value. Basically Functions and be used as a string or number value in an expression. RCBASIC has several built-in functions to perform different task such as compute square roots, get the time, etc. Functions are either numbers or strings just like variables and arrays. As such, functions can be used anywhere a variable or array can be used. Look at the following: +
+
+ Dim x[2]
+ x[0] = Sqrt(25)
+ x[1] = Sqrt(36)
+ Print "THE SQUARE ROOT OF 25 IS "; x[0]
+ Print "THE SQUARE ROOT OF 36 IS "; x[1]
+
+ The above code creates a number array called X with 2 elements in it. It stores the square root of 25 in the first index and stores the square root of 36 in the second index. It then outputs both values to the console. The output should look like this: +
++ THE SQUARE ROOT OF 25 IS 5 THE SQUARE ROOT OF 36 IS 6 +
++ String functions can be used in a string expression just like number functions can be used in a number expression. Look at the following code: +
+
+ B$ = Mid$("HELLO WORLD", 0, 2)
+ Print "THE FIRST TWO CHARACTERS IN HELLO WORLD ARE ";B$
+
+ The above code creates a string variable called B and stores 2 characters starting from position 0 in the string HELLO WORLD. It then outputs the value to the console. The output should look like the following: +
++ THE FIRST TWO CHARACTERS IN HELLO WORLD ARE HE +
++ Sub Routines can execute code in other parts of your program just like a function. However Sub Routines cannot return values and cannot be used in expressions. So why would you want to use a Sub Routine over a function? Well Sub Routines have less over head since it does not have to internally push a value onto the stack like a function does. So in cases where you do not need to return a value you should use a Sub Routine. RC BASIC has several built-in Sub Routines to perform task where a return value is not necessary. Look at the following: +
+
+ FPrint("test")
+
+ FPrint is a Sub Routine that outputs text to the console. Since FPrint doesn't perform calculations of any kind it did not need to be implemented as a Function. +
++ In addition to the built-in Functions and Sub Routines RCBASIC also allows programmers to build there own Functions and Sub Routines. You do this using the FUNCTION or SUB keywords. +
+
+ Function MyFunc(a, b)
+ c = a + b
+ Return c
+ End Function
+
+ The above code creates a function called MyFunc which takes in two arguments: a and b. To use this function you would call it like this: +
+
+ MyFunc(3, 4)
+
+ The code above will pass 3 and 4 to the variables A and B in MYFUNC respectively. The function creates a variable called C and sets it equal to the sum of 3 + 4. It then returns C. So the function equals 7. Since this is a number function you could store the value in a number variable or use PRINT to output the value to the console. +
++ To make a string function you simply add $ to the end of the function name when you create it just like with variables and arrays. +
+
+ Function MyString$ ( G$ )
+ Return "YOU ENTERED " + G$
+ End Function
+
+ Print MyString("SOMETHING")
+
+ The above code should output the following: +
++ YOU ENTERED SOMETHING +
++ Functions can also return a UDT(User Defined Type) as well. Look at the following: +
+
+ Type test_type
+ Dim a$
+ Dim b
+ End Type
+
+ Function test(a$, b) As test_type
+ Dim ret_val As test_type
+ ret_val.a = a
+ ret_val.b = b
+ Return ret_val
+ End Function
+
+ Dim myVar as test_type
+
+ myVar = test("hello", 42)
+
+ You can also have a UDT as a parameter in a function: +
+
+ Function 2(n as test_type, j)
+ Return 0
+ End Function
+
+ Sub Routines are created using the SUB keyword. Look at the following: +
+
+ Sub MySub ( )
+ For i = 1 To 5
+ Print i
+ Next
+ End Sub
+
+ MySub ( )
+
+ The code above creates a Sub Routine called MYSUB which uses a FOR loop to output the numbers 1 to 5 to the console. +
++ Functions and Sub Routines pass variables by value by default. Look at the following: +
+
+ Sub MySub ( a )
+ a = 5
+ End Sub
+
+ n = 0
+
+ MySub ( n )
+ Print n
+
+ In the above code the Sub Routine has a variable called A as an argument. It sets A equal to 5. Then we create a variable called N outside of the Sub Routine and set N equal to 0. N is passed as an argument to MYSUB. Then N is output to the console. This will output 0 to the console. That is because only the value of N is passed to MYSUB so MYSUB is not able to change N itself. In order to allow MYSUB to change N we must have MYSUB accept an argument by Reference. To do this we will use the BYREF keyword. +
+
+ Sub MySub ( ByRef a )
+ a = 5
+ End Sub
+
+ n = 0
+
+ MySub ( n )
+ Print n
+
+ 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 new file mode 100644 index 0000000..8dc1245 --- /dev/null +++ b/doc/doc_files/getaccel.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..731d36b --- /dev/null +++ b/doc/doc_files/getactoraabb.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b3c9a36 --- /dev/null +++ b/doc/doc_files/getactorangulardamping.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the amount of angular damping set on the actor +
+Related: + SetActorDamping + ApplyActorDamping + GetActorLinearDamping +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorangularfactor.html b/doc/doc_files/getactorangularfactor.html new file mode 100644 index 0000000..d8d307e --- /dev/null +++ b/doc/doc_files/getactorangularfactor.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the angular factor set on an actor +
+Related: + SetActorAngularFactor + GetActorLinearFactor + SetActorLinearFactor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorangularsleepthreshold.html b/doc/doc_files/getactorangularsleepthreshold.html new file mode 100644 index 0000000..79b82a2 --- /dev/null +++ b/doc/doc_files/getactorangularsleepthreshold.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the Angular deactivation threshold for the actor +
+Related: + SetActorSleepThresholds + GetActorLinearSleepThreshold +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorangularvelocitylocal.html b/doc/doc_files/getactorangularvelocitylocal.html new file mode 100644 index 0000000..4983a8e --- /dev/null +++ b/doc/doc_files/getactorangularvelocitylocal.html @@ -0,0 +1,22 @@ + + +
+ + ++ Gets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityWorld + SetActorAngularVelocityLocal + SetActorAngularVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorangularvelocityworld.html b/doc/doc_files/getactorangularvelocityworld.html new file mode 100644 index 0000000..897f6fd --- /dev/null +++ b/doc/doc_files/getactorangularvelocityworld.html @@ -0,0 +1,22 @@ + + +
+ + ++ Gets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityLocal + SetActorAngularVelocityLocal + SetActorAngularVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactoranimationendframe.html b/doc/doc_files/getactoranimationendframe.html new file mode 100644 index 0000000..8f983c1 --- /dev/null +++ b/doc/doc_files/getactoranimationendframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the last frame in an actor's animation +
+Related: + SetActorAnimationFrames +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactoranimationspeed.html b/doc/doc_files/getactoranimationspeed.html new file mode 100644 index 0000000..2356721 --- /dev/null +++ b/doc/doc_files/getactoranimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns actor's animation speed in frames per second +
+Related: + SetActorAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactoranimationstartframe.html b/doc/doc_files/getactoranimationstartframe.html new file mode 100644 index 0000000..cdde7d3 --- /dev/null +++ b/doc/doc_files/getactoranimationstartframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the first frame in an actor's animation +
+Related: + SetActorAnimationFrames +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorautoculling.html b/doc/doc_files/getactorautoculling.html new file mode 100644 index 0000000..98d2667 --- /dev/null +++ b/doc/doc_files/getactorautoculling.html @@ -0,0 +1,40 @@ + + +
+ + ++ Returns the automatic culling state for an actor +
++ Possible Culling States +
+Related: + SetActorAutoCulling +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorcollision.html b/doc/doc_files/getactorcollision.html new file mode 100644 index 0000000..39726d8 --- /dev/null +++ b/doc/doc_files/getactorcollision.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if 2 actors collide +
++ Note: This function will work with solid and non solid actors +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorcollisionshape.html b/doc/doc_files/getactorcollisionshape.html new file mode 100644 index 0000000..e920a80 --- /dev/null +++ b/doc/doc_files/getactorcollisionshape.html @@ -0,0 +1,49 @@ + + +
+ + ++ Returns the actor's collision shape +
++ Possible values: +
+Related: + SetActorCollisionShape +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorcomposition.html b/doc/doc_files/getactorcomposition.html new file mode 100644 index 0000000..10b7361 --- /dev/null +++ b/doc/doc_files/getactorcomposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/getactorcurrentanimation.html b/doc/doc_files/getactorcurrentanimation.html new file mode 100644 index 0000000..e1b09e7 --- /dev/null +++ b/doc/doc_files/getactorcurrentanimation.html @@ -0,0 +1,24 @@ + + +
+ + ++ Returns the current animation set on an actor +
++ Note: Current animation will be 0 if the actor's frame was set with SetActorFrame() +
+Related: + SetActorAnimation + SetActorFrame +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorcurrentframe.html b/doc/doc_files/getactorcurrentframe.html new file mode 100644 index 0000000..b9e3af6 --- /dev/null +++ b/doc/doc_files/getactorcurrentframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns an actor's current frame of animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorendframe.html b/doc/doc_files/getactorendframe.html new file mode 100644 index 0000000..2922a77 --- /dev/null +++ b/doc/doc_files/getactorendframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the last frame of an actor's animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorframe.html b/doc/doc_files/getactorframe.html new file mode 100644 index 0000000..6ac58ee --- /dev/null +++ b/doc/doc_files/getactorframe.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the current frame number an actor is currently rendering +
+Related: + SetActorFrame + GetActorAnimationFrame +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorgravity.html b/doc/doc_files/getactorgravity.html new file mode 100644 index 0000000..b437ee9 --- /dev/null +++ b/doc/doc_files/getactorgravity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the gravity of an actor along each access. +
+Related: + SetActorGravity +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorinverseinertiadiaglocal.html b/doc/doc_files/getactorinverseinertiadiaglocal.html new file mode 100644 index 0000000..b3c1c4d --- /dev/null +++ b/doc/doc_files/getactorinverseinertiadiaglocal.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..71e2b9d --- /dev/null +++ b/doc/doc_files/getactorinversemass.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an actor's inverse mass +
+Related: + SetActorMassProperties +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorlineardamping.html b/doc/doc_files/getactorlineardamping.html new file mode 100644 index 0000000..bb9851a --- /dev/null +++ b/doc/doc_files/getactorlineardamping.html @@ -0,0 +1,21 @@ + + +
+ + ++ Return's an actor's linear damping +
+Related: + SetActorDamping + GetActorAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorlinearfactor.html b/doc/doc_files/getactorlinearfactor.html new file mode 100644 index 0000000..7f5f7bd --- /dev/null +++ b/doc/doc_files/getactorlinearfactor.html @@ -0,0 +1,22 @@ + + +
+ + ++ Gets an actor's linear factor +
+Related: + SetActorLinearFactor + GetActorAngularFactor + SetActorAngularFactor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorlinearsleepthreshold.html b/doc/doc_files/getactorlinearsleepthreshold.html new file mode 100644 index 0000000..9676069 --- /dev/null +++ b/doc/doc_files/getactorlinearsleepthreshold.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the linear deactivation threshold for the actor +
+Related: + SetActorSleepThresholds + GetActorAngularSleepThreshold +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorlinearvelocitylocal.html b/doc/doc_files/getactorlinearvelocitylocal.html new file mode 100644 index 0000000..70e34d1 --- /dev/null +++ b/doc/doc_files/getactorlinearvelocitylocal.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets actor's linear velocity +
+Related: + SetActorLinearVelocityLocal + SetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorlinearvelocityworld.html b/doc/doc_files/getactorlinearvelocityworld.html new file mode 100644 index 0000000..12fef83 --- /dev/null +++ b/doc/doc_files/getactorlinearvelocityworld.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets actor's linear velocity +
+Related: + SetActorLinearVelocityLocal + SetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorlocalinertia.html b/doc/doc_files/getactorlocalinertia.html new file mode 100644 index 0000000..a55428b --- /dev/null +++ b/doc/doc_files/getactorlocalinertia.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/getactorlocalpointvelocity.html b/doc/doc_files/getactorlocalpointvelocity.html new file mode 100644 index 0000000..ae085aa --- /dev/null +++ b/doc/doc_files/getactorlocalpointvelocity.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/getactormaterial.html b/doc/doc_files/getactormaterial.html new file mode 100644 index 0000000..f7d3f92 --- /dev/null +++ b/doc/doc_files/getactormaterial.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an actor's material id. +
++ 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 new file mode 100644 index 0000000..c01310d --- /dev/null +++ b/doc/doc_files/getactormaterialcount.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..37298d0 --- /dev/null +++ b/doc/doc_files/getactormaterialflag.html @@ -0,0 +1,85 @@ + + +
+ + ++ Returns the value of the specified material flag +
++ Possible values for flag: +
+Related: + GetMaterialFlag +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactormaterialtype.html b/doc/doc_files/getactormaterialtype.html new file mode 100644 index 0000000..ae96d78 --- /dev/null +++ b/doc/doc_files/getactormaterialtype.html @@ -0,0 +1,102 @@ + + +
+ + ++ Returns the material type of an actor material +
++ Possible material types +
+Related: + SetActorMaterialType + GetMaterialType + SetMaterialType +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorposition.html b/doc/doc_files/getactorposition.html new file mode 100644 index 0000000..f4d8fa5 --- /dev/null +++ b/doc/doc_files/getactorposition.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the actors position +
+Related: + SetActorPosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorrotation.html b/doc/doc_files/getactorrotation.html new file mode 100644 index 0000000..84d704a --- /dev/null +++ b/doc/doc_files/getactorrotation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the actors rotation on each axis +
+Related: + SetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorrotationq.html b/doc/doc_files/getactorrotationq.html new file mode 100644 index 0000000..f79bb42 --- /dev/null +++ b/doc/doc_files/getactorrotationq.html @@ -0,0 +1,24 @@ + + +
+ + ++ Gets the actors rotation as a quaternion. +
++ Note: This is useful for calculations that require quaternion but most developers should just use GetActorRotation() +
+Related: + GetActorRotation + SetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorscale.html b/doc/doc_files/getactorscale.html new file mode 100644 index 0000000..505640a --- /dev/null +++ b/doc/doc_files/getactorscale.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets an actor's scale +
+Related: + SetActorScale +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactorstartframe.html b/doc/doc_files/getactorstartframe.html new file mode 100644 index 0000000..66c338d --- /dev/null +++ b/doc/doc_files/getactorstartframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the start frame of an actor's animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactortotalforce.html b/doc/doc_files/getactortotalforce.html new file mode 100644 index 0000000..a62fbe7 --- /dev/null +++ b/doc/doc_files/getactortotalforce.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetActorTotalTorque +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactortotaltorque.html b/doc/doc_files/getactortotaltorque.html new file mode 100644 index 0000000..fe938cd --- /dev/null +++ b/doc/doc_files/getactortotaltorque.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetTotalForces +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactortransform.html b/doc/doc_files/getactortransform.html new file mode 100644 index 0000000..dc777a7 --- /dev/null +++ b/doc/doc_files/getactortransform.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores the actors absolute transformation in the given matrix +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getactortransitiontime.html b/doc/doc_files/getactortransitiontime.html new file mode 100644 index 0000000..c01ae02 --- /dev/null +++ b/doc/doc_files/getactortransitiontime.html @@ -0,0 +1,25 @@ + + +
+ + ++ Returns the total transition time of an actor transitioning between animations +
++ Note: Time returned is in seconds +
+Related: + StartActorTransition + StopActorTransition + ActorIsInTransition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getan8scenename.html b/doc/doc_files/getan8scenename.html new file mode 100644 index 0000000..db39c07 --- /dev/null +++ b/doc/doc_files/getan8scenename.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the name of a scene in an an8 project +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getbilinearfilter.html b/doc/doc_files/getbilinearfilter.html new file mode 100644 index 0000000..0705660 --- /dev/null +++ b/doc/doc_files/getbilinearfilter.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if bilinear filtering is enabled +
+Related: + SetBilinearFilter +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getblendmode.html b/doc/doc_files/getblendmode.html new file mode 100644 index 0000000..bf79e94 --- /dev/null +++ b/doc/doc_files/getblendmode.html @@ -0,0 +1,58 @@ + + +
+ + ++ Returns the current blend mode +
++ Note: Only applies to 2D image drawing commands +
++ Possible Blend Modes +
+Related: + SetBlendMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcameraaspectratio.html b/doc/doc_files/getcameraaspectratio.html new file mode 100644 index 0000000..a3a71a9 --- /dev/null +++ b/doc/doc_files/getcameraaspectratio.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the camera aspect ratio for the active canvas +
+Related: + SetCameraAspectRatio +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcamerafarvalue.html b/doc/doc_files/getcamerafarvalue.html new file mode 100644 index 0000000..2b4b533 --- /dev/null +++ b/doc/doc_files/getcamerafarvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the far plane of the camera on the active canvas +
+Related: + GetCameraNearValue +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcamerafov.html b/doc/doc_files/getcamerafov.html new file mode 100644 index 0000000..8615370 --- /dev/null +++ b/doc/doc_files/getcamerafov.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..dbce0a2 --- /dev/null +++ b/doc/doc_files/getcameranearvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the near plane of the camera on the active canvas +
+Related: + GetCameraFarValue +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcameraposition.html b/doc/doc_files/getcameraposition.html new file mode 100644 index 0000000..a36f7d7 --- /dev/null +++ b/doc/doc_files/getcameraposition.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the position of the camera +
+Related: + SetCameraPosition + TranslateCamera +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcamerarotation.html b/doc/doc_files/getcamerarotation.html new file mode 100644 index 0000000..7820621 --- /dev/null +++ b/doc/doc_files/getcamerarotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the rotation of the camera on each axis +
+Related: + SetCameraRotation + RotateCamera +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcanvasalpha.html b/doc/doc_files/getcanvasalpha.html new file mode 100644 index 0000000..c8a8d9a --- /dev/null +++ b/doc/doc_files/getcanvasalpha.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the alpha blend value of a canvas +
+Related: + SetCanvasAlpha +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcanvascolormod.html b/doc/doc_files/getcanvascolormod.html new file mode 100644 index 0000000..706be0a --- /dev/null +++ b/doc/doc_files/getcanvascolormod.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the color modulation of a canvas +
+Related: + SetCanvasColorMod +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcanvasoffset.html b/doc/doc_files/getcanvasoffset.html new file mode 100644 index 0000000..12119ea --- /dev/null +++ b/doc/doc_files/getcanvasoffset.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns view offset of a canvas +
+Related: + SetCanvasOffset +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcanvassize.html b/doc/doc_files/getcanvassize.html new file mode 100644 index 0000000..4d9f59e --- /dev/null +++ b/doc/doc_files/getcanvassize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..72831b7 --- /dev/null +++ b/doc/doc_files/getcanvasviewport.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the position and size of a canvas viewport +
+Related: + OpenCanvas + SetCanvasViewport +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getcanvasz.html b/doc/doc_files/getcanvasz.html new file mode 100644 index 0000000..ceb0b39 --- /dev/null +++ b/doc/doc_files/getcanvasz.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetCanvasZ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getchannelvolume.html b/doc/doc_files/getchannelvolume.html new file mode 100644 index 0000000..db50d41 --- /dev/null +++ b/doc/doc_files/getchannelvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..74a0ab2 --- /dev/null +++ b/doc/doc_files/getcirclelineintersection.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getclipboardtext.html b/doc/doc_files/getclipboardtext.html new file mode 100644 index 0000000..58412a4 --- /dev/null +++ b/doc/doc_files/getclipboardtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the clipboard text. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconeanglepoint.html b/doc/doc_files/getconeanglepoint.html new file mode 100644 index 0000000..6a5b905 --- /dev/null +++ b/doc/doc_files/getconeanglepoint.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..478bc1b --- /dev/null +++ b/doc/doc_files/getconebiasfactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ef38697 --- /dev/null +++ b/doc/doc_files/getconedamping.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b022227 --- /dev/null +++ b/doc/doc_files/getconefixthresh.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetConeFixThresh +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconelimit.html b/doc/doc_files/getconelimit.html new file mode 100644 index 0000000..54fa5d1 --- /dev/null +++ b/doc/doc_files/getconelimit.html @@ -0,0 +1,34 @@ + + +
+ + ++ 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. +
++ limitIndex is an integer that indicates which limit to retrieve. It typically takes values corresponding to the type of limit: +
++ 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 new file mode 100644 index 0000000..ad38bce --- /dev/null +++ b/doc/doc_files/getconesolveswinglimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconesolvetwistlimit.html b/doc/doc_files/getconesolvetwistlimit.html new file mode 100644 index 0000000..36d8535 --- /dev/null +++ b/doc/doc_files/getconesolvetwistlimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconeswingspan1.html b/doc/doc_files/getconeswingspan1.html new file mode 100644 index 0000000..3a3f8fe --- /dev/null +++ b/doc/doc_files/getconeswingspan1.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetConeSwingSpan2 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconeswingspan2.html b/doc/doc_files/getconeswingspan2.html new file mode 100644 index 0000000..0387226 --- /dev/null +++ b/doc/doc_files/getconeswingspan2.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetConeSwingSpan1 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconetwistangle.html b/doc/doc_files/getconetwistangle.html new file mode 100644 index 0000000..df774fd --- /dev/null +++ b/doc/doc_files/getconetwistangle.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns the current twist angle between the two actors connected by the constraint +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconetwistlimitsign.html b/doc/doc_files/getconetwistlimitsign.html new file mode 100644 index 0000000..0300b03 --- /dev/null +++ b/doc/doc_files/getconetwistlimitsign.html @@ -0,0 +1,25 @@ + + +
+ + ++ Returns the sign of the twist limit, which indicates the direction of the twist limit enforcement around the twist axis. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconetwistspan.html b/doc/doc_files/getconetwistspan.html new file mode 100644 index 0000000..8ea78b9 --- /dev/null +++ b/doc/doc_files/getconetwistspan.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4eb3aa2 --- /dev/null +++ b/doc/doc_files/getconstraintactora.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..41c5436 --- /dev/null +++ b/doc/doc_files/getconstraintactorb.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0adfb04 --- /dev/null +++ b/doc/doc_files/getconstraintaframe.html @@ -0,0 +1,23 @@ + + +
+ + ++ Stores the transform of the first actor in a constraint in mA +
++ Note: Only applies to cone and hinge constraints +
+Related: + GetConstraintBFrame +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconstraintangularonly.html b/doc/doc_files/getconstraintangularonly.html new file mode 100644 index 0000000..fbdc3f3 --- /dev/null +++ b/doc/doc_files/getconstraintangularonly.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns true if the hinge constraint is set to limit only angular motion while allowing unrestricted linear (translational) motion. +
++ Note: Applies to Cone and Hinge constraints +
+Related: + SetConstraintAngularOnly +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconstraintappliedimpulse.html b/doc/doc_files/getconstraintappliedimpulse.html new file mode 100644 index 0000000..1cd03f1 --- /dev/null +++ b/doc/doc_files/getconstraintappliedimpulse.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3762259 --- /dev/null +++ b/doc/doc_files/getconstraintbframe.html @@ -0,0 +1,23 @@ + + +
+ + ++ Stores the transform of the second actor in a constraint in mA +
++ Note: Only applies to cone and hinge constraints +
+Related: + GetConstraintAFrame +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconstraintbreakingimpulsethreshold.html b/doc/doc_files/getconstraintbreakingimpulsethreshold.html new file mode 100644 index 0000000..4a857de --- /dev/null +++ b/doc/doc_files/getconstraintbreakingimpulsethreshold.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + SetConstraintBreakingImpulseThreshold +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconstraintfixedactor.html b/doc/doc_files/getconstraintfixedactor.html new file mode 100644 index 0000000..7bcee13 --- /dev/null +++ b/doc/doc_files/getconstraintfixedactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c3f63fe --- /dev/null +++ b/doc/doc_files/getconstraintframeoffseta.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetConstraintFrameOffsetB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconstraintframeoffsetb.html b/doc/doc_files/getconstraintframeoffsetb.html new file mode 100644 index 0000000..c8d92c5 --- /dev/null +++ b/doc/doc_files/getconstraintframeoffsetb.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetConstraintFrameOffsetA +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconstraintlimitsoftness.html b/doc/doc_files/getconstraintlimitsoftness.html new file mode 100644 index 0000000..08649a7 --- /dev/null +++ b/doc/doc_files/getconstraintlimitsoftness.html @@ -0,0 +1,32 @@ + + +
+ + ++ 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. +
+Related: + SetConstraintSoftnessDirAng + SetConstraintSoftnessDirLin + SetConstraintSoftnessLimAng + SetConstraintSoftnessLimLin + SetConstraintSoftnessOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getconstraintsolveriterations.html b/doc/doc_files/getconstraintsolveriterations.html new file mode 100644 index 0000000..ca94897 --- /dev/null +++ b/doc/doc_files/getconstraintsolveriterations.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..99d7a60 --- /dev/null +++ b/doc/doc_files/getdesktopdisplaymode.html @@ -0,0 +1,28 @@ + + +
+ + ++ Gets the resolution and refresh rate of a display +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getglobalmouse.html b/doc/doc_files/getglobalmouse.html new file mode 100644 index 0000000..b309a3d --- /dev/null +++ b/doc/doc_files/getglobalmouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the global mouse position and button state +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getgravity2d.html b/doc/doc_files/getgravity2d.html new file mode 100644 index 0000000..030e929 --- /dev/null +++ b/doc/doc_files/getgravity2d.html @@ -0,0 +1,20 @@ + + +
+ + ++ Use this function for retrieving the global gravity vector. A sprite canvas layer must be open. +
+Related: + SetGravity2D +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getgravity3d.html b/doc/doc_files/getgravity3d.html new file mode 100644 index 0000000..4d9e61b --- /dev/null +++ b/doc/doc_files/getgravity3d.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the world gravity +
+Related: + SetGravity3D +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getgyro.html b/doc/doc_files/getgyro.html new file mode 100644 index 0000000..3a94566 --- /dev/null +++ b/doc/doc_files/getgyro.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..266b555 --- /dev/null +++ b/doc/doc_files/gethingeangle.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9b57eab --- /dev/null +++ b/doc/doc_files/gethingeangleex.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ea7f555 --- /dev/null +++ b/doc/doc_files/gethingelimitbiasfactor.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gethingelimitrelaxationfactor.html b/doc/doc_files/gethingelimitrelaxationfactor.html new file mode 100644 index 0000000..dad9624 --- /dev/null +++ b/doc/doc_files/gethingelimitrelaxationfactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/gethingelimitsign.html b/doc/doc_files/gethingelimitsign.html new file mode 100644 index 0000000..f2b8d70 --- /dev/null +++ b/doc/doc_files/gethingelimitsign.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetHingeLimit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gethingesolvelimit.html b/doc/doc_files/gethingesolvelimit.html new file mode 100644 index 0000000..ae09066 --- /dev/null +++ b/doc/doc_files/gethingesolvelimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getimagealpha.html b/doc/doc_files/getimagealpha.html new file mode 100644 index 0000000..f411c76 --- /dev/null +++ b/doc/doc_files/getimagealpha.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..37be61e --- /dev/null +++ b/doc/doc_files/getimagecolormod.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..19288b5 --- /dev/null +++ b/doc/doc_files/getimagesize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the Size of an image +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getjoytrackball.html b/doc/doc_files/getjoytrackball.html new file mode 100644 index 0000000..41455b1 --- /dev/null +++ b/doc/doc_files/getjoytrackball.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8f12635 --- /dev/null +++ b/doc/doc_files/getlightambientcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..49d93ca --- /dev/null +++ b/doc/doc_files/getlightattenuation.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..60ded82 --- /dev/null +++ b/doc/doc_files/getlightdiffusecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f2c918f --- /dev/null +++ b/doc/doc_files/getlightfalloff.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e239a92 --- /dev/null +++ b/doc/doc_files/getlightinnercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1ed16fb --- /dev/null +++ b/doc/doc_files/getlightoutercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a5a1b6e --- /dev/null +++ b/doc/doc_files/getlightradius.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..af93eb7 --- /dev/null +++ b/doc/doc_files/getlightspecularcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..bc32006 --- /dev/null +++ b/doc/doc_files/getlighttype.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns the type of light +
++ Returns -1 if it does not have a type (ie. its not a light) +
++ Possible Light Types +
+Related: + SetLightType +
+ + + \ No newline at end of file diff --git a/doc/doc_files/getlineintersection.html b/doc/doc_files/getlineintersection.html new file mode 100644 index 0000000..6aa0219 --- /dev/null +++ b/doc/doc_files/getlineintersection.html @@ -0,0 +1,20 @@ + + + + + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getlineplaneintersection.html b/doc/doc_files/getlineplaneintersection.html new file mode 100644 index 0000000..4ad04a5 --- /dev/null +++ b/doc/doc_files/getlineplaneintersection.html @@ -0,0 +1,40 @@ + + +
+ + ++ This function calculates the intersection between a line and a plane in 3D space and stores the result in intersection +
++ Parameters: +
++ 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 new file mode 100644 index 0000000..6144f54 --- /dev/null +++ b/doc/doc_files/getmaterialambientcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..25a6797 --- /dev/null +++ b/doc/doc_files/getmaterialantialiasing.html @@ -0,0 +1,46 @@ + + +
+ + ++ Returns the anti-aliasing mode for the material +
++ Possible modes returned +
+Related: + SetMaterialAntiAliasing +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialbackfaceculling.html b/doc/doc_files/getmaterialbackfaceculling.html new file mode 100644 index 0000000..98557db --- /dev/null +++ b/doc/doc_files/getmaterialbackfaceculling.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if backface culling is enabled for a material +
+Related: + SetMaterialBackfaceCulling +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialblendfactor.html b/doc/doc_files/getmaterialblendfactor.html new file mode 100644 index 0000000..f214b39 --- /dev/null +++ b/doc/doc_files/getmaterialblendfactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1c6ba17 --- /dev/null +++ b/doc/doc_files/getmaterialblendmode.html @@ -0,0 +1,55 @@ + + +
+ + ++ Returns a materials blend mode +
++ Possible Blend Modes +
+Related: + SetMaterialBlendMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialcolormask.html b/doc/doc_files/getmaterialcolormask.html new file mode 100644 index 0000000..767551e --- /dev/null +++ b/doc/doc_files/getmaterialcolormask.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..614d3f2 --- /dev/null +++ b/doc/doc_files/getmaterialcolormode.html @@ -0,0 +1,43 @@ + + +
+ + ++ Returns the color mode of a material +
++ Possible modes +
+Related: + SetMaterialColorMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialdiffusecolor.html b/doc/doc_files/getmaterialdiffusecolor.html new file mode 100644 index 0000000..188de37 --- /dev/null +++ b/doc/doc_files/getmaterialdiffusecolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a material's diffuse color +
+Related: + SetMaterialDiffuseColor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialemissivecolor.html b/doc/doc_files/getmaterialemissivecolor.html new file mode 100644 index 0000000..e59c14c --- /dev/null +++ b/doc/doc_files/getmaterialemissivecolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a material's emissive color +
+Related: + SetMaterialEmissiveColor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialflag.html b/doc/doc_files/getmaterialflag.html new file mode 100644 index 0000000..22433e0 --- /dev/null +++ b/doc/doc_files/getmaterialflag.html @@ -0,0 +1,85 @@ + + +
+ + ++ Returns the value of the specified material flag +
++ Possible values for flag: +
+Related: + GetActorMaterialFlag +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialfog.html b/doc/doc_files/getmaterialfog.html new file mode 100644 index 0000000..87ac07a --- /dev/null +++ b/doc/doc_files/getmaterialfog.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if fog is enabled for a material +
+Related: + SetMaterialFog +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialfrontfaceculling.html b/doc/doc_files/getmaterialfrontfaceculling.html new file mode 100644 index 0000000..fbf6e1e --- /dev/null +++ b/doc/doc_files/getmaterialfrontfaceculling.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if front face culling is enabled for a material +
+Related: + SetMaterialFrontfaceCulling +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialshininess.html b/doc/doc_files/getmaterialshininess.html new file mode 100644 index 0000000..8e5dde5 --- /dev/null +++ b/doc/doc_files/getmaterialshininess.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the shininess value for a material +
+Related: + SetMaterialShininess +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialspecularcolor.html b/doc/doc_files/getmaterialspecularcolor.html new file mode 100644 index 0000000..6d226e5 --- /dev/null +++ b/doc/doc_files/getmaterialspecularcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the specular color for a material +
+Related: + SetMaterialSpecularColor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialthickness.html b/doc/doc_files/getmaterialthickness.html new file mode 100644 index 0000000..107b84e --- /dev/null +++ b/doc/doc_files/getmaterialthickness.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns a material's thickness value +
++ Thickness value is mainly for primitives such as lines +
+Related: + SetMaterialThickness +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaterialtype.html b/doc/doc_files/getmaterialtype.html new file mode 100644 index 0000000..b040404 --- /dev/null +++ b/doc/doc_files/getmaterialtype.html @@ -0,0 +1,102 @@ + + +
+ + ++ Returns a material's type +
++ Possible types +
+Related: + SetMaterialType + GetActorMaterialType + SetActorMaterialType +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmatrixrotation.html b/doc/doc_files/getmatrixrotation.html new file mode 100644 index 0000000..5ce7d7f --- /dev/null +++ b/doc/doc_files/getmatrixrotation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the rotation vector of a matrix +
+Related: + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmatrixscale.html b/doc/doc_files/getmatrixscale.html new file mode 100644 index 0000000..95ee4b4 --- /dev/null +++ b/doc/doc_files/getmatrixscale.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the scale vector of a matrix +
+Related: + SetMatrixScale +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmatrixsize.html b/doc/doc_files/getmatrixsize.html new file mode 100644 index 0000000..b8eb6ac --- /dev/null +++ b/doc/doc_files/getmatrixsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the number of rows and columns in a matrix +
+Related: + DimMatrix +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmatrixtranslation.html b/doc/doc_files/getmatrixtranslation.html new file mode 100644 index 0000000..19e3c65 --- /dev/null +++ b/doc/doc_files/getmatrixtranslation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Get the position vector of a matrix +
+Related: + SetMatrixTranslation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmaxparticlespersecond.html b/doc/doc_files/getmaxparticlespersecond.html new file mode 100644 index 0000000..c6ede50 --- /dev/null +++ b/doc/doc_files/getmaxparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the max number of particles emitted per second +
+Related: + SetMaxParticlesPerSecond + GetMinParticlesPerSecond + SetMinParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getminparticlespersecond.html b/doc/doc_files/getminparticlespersecond.html new file mode 100644 index 0000000..3bd31f6 --- /dev/null +++ b/doc/doc_files/getminparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the min number of particles emitted per second +
+Related: + SetMinParticlesPerSecond + GetMaxParticlesPerSecond + SetMaxParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmouse.html b/doc/doc_files/getmouse.html new file mode 100644 index 0000000..ba9b9d8 --- /dev/null +++ b/doc/doc_files/getmouse.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the mouse position and button state local to the graphics window +
+Related: + GetGlobalMouse + MouseX + MouseY + MouseButton +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmousewheel.html b/doc/doc_files/getmousewheel.html new file mode 100644 index 0000000..2d02a60 --- /dev/null +++ b/doc/doc_files/getmousewheel.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the axis positions of the mouse wheel +
+Related: + GetMouse + GetGlobalMouse +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmultitouch.html b/doc/doc_files/getmultitouch.html new file mode 100644 index 0000000..6f75de2 --- /dev/null +++ b/doc/doc_files/getmultitouch.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8b65e66 --- /dev/null +++ b/doc/doc_files/getmusicposition.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the position of the music track +
+Related: + SetMusicPosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getmusicvolume.html b/doc/doc_files/getmusicvolume.html new file mode 100644 index 0000000..b0304d2 --- /dev/null +++ b/doc/doc_files/getmusicvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5ef92e1 --- /dev/null +++ b/doc/doc_files/getnuman8scenes.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the number of scenes in an an8 project +
+Related: + LoadAN8 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlebox.html b/doc/doc_files/getparticlebox.html new file mode 100644 index 0000000..fc6f273 --- /dev/null +++ b/doc/doc_files/getparticlebox.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ad64feb --- /dev/null +++ b/doc/doc_files/getparticlecenter.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the center of a particle emitter +
++ Note: applies to Sphere, Cylinder, and Ring emitters +
+Related: + SetParticleCenter +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticledirection.html b/doc/doc_files/getparticledirection.html new file mode 100644 index 0000000..b152366 --- /dev/null +++ b/doc/doc_files/getparticledirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the direction of a particle emitter +
+Related: + SetParticleDirection +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlelength.html b/doc/doc_files/getparticlelength.html new file mode 100644 index 0000000..29c284e --- /dev/null +++ b/doc/doc_files/getparticlelength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the length of a cylinder particle emitter +
++ Note: Only applies to cylinder particles +
+Related: + SetParticleLength +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxangle.html b/doc/doc_files/getparticlemaxangle.html new file mode 100644 index 0000000..205652e --- /dev/null +++ b/doc/doc_files/getparticlemaxangle.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the max angle of particle emission +
+Related: + SetParticleMaxAngle +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxlife.html b/doc/doc_files/getparticlemaxlife.html new file mode 100644 index 0000000..fd2813e --- /dev/null +++ b/doc/doc_files/getparticlemaxlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the max life of the particle emission +
++ Note: Returned time is in milliseconds +
+Related: + SetParticleMaxLife +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxstartcolor.html b/doc/doc_files/getparticlemaxstartcolor.html new file mode 100644 index 0000000..b01a34e --- /dev/null +++ b/doc/doc_files/getparticlemaxstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns max starting color for particles +
+Related: + SetParticleMaxStartColor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlemaxstartsize.html b/doc/doc_files/getparticlemaxstartsize.html new file mode 100644 index 0000000..b368780 --- /dev/null +++ b/doc/doc_files/getparticlemaxstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the max start size for the particles +
+Related: + SetParticleMaxStartSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticleminlife.html b/doc/doc_files/getparticleminlife.html new file mode 100644 index 0000000..00e0518 --- /dev/null +++ b/doc/doc_files/getparticleminlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Get the min life of particles +
++ Note: Returned time is in milliseconds +
+Related: + SetParticleMinLife +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticleminstartcolor.html b/doc/doc_files/getparticleminstartcolor.html new file mode 100644 index 0000000..005ef5b --- /dev/null +++ b/doc/doc_files/getparticleminstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the min start color for particles +
+Related: + SetParticleMinStartColor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticleminstartsize.html b/doc/doc_files/getparticleminstartsize.html new file mode 100644 index 0000000..7a47a4d --- /dev/null +++ b/doc/doc_files/getparticleminstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the min start size for particle emitter +
+Related: + SetParticleMinStartSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlenormal.html b/doc/doc_files/getparticlenormal.html new file mode 100644 index 0000000..184b6ff --- /dev/null +++ b/doc/doc_files/getparticlenormal.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the normal of a particle emitter +
++ Note: Only applies to cylinder particle emitter +
+Related: + SetParticleNormal +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticlenormaldirectionmod.html b/doc/doc_files/getparticlenormaldirectionmod.html new file mode 100644 index 0000000..2c231af --- /dev/null +++ b/doc/doc_files/getparticlenormaldirectionmod.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the normal direction modifier for a particle emitter +
++ Note: Only applies to mesh particle emitter +
+Related: + SetParticleNormalDirectionMod +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticleradius.html b/doc/doc_files/getparticleradius.html new file mode 100644 index 0000000..5ecfe11 --- /dev/null +++ b/doc/doc_files/getparticleradius.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the radius of a particle emitter +
++ Note: Only applies to Sphere, Cylinder, and Ring emitters +
+Related: + SetParticleRadius +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticleringthickness.html b/doc/doc_files/getparticleringthickness.html new file mode 100644 index 0000000..78d32ba --- /dev/null +++ b/doc/doc_files/getparticleringthickness.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the thickness of a ring emitter +
++ Note: Only applies to ring emitter +
+Related: + SetParticleRingThickness +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getparticletype.html b/doc/doc_files/getparticletype.html new file mode 100644 index 0000000..f71720c --- /dev/null +++ b/doc/doc_files/getparticletype.html @@ -0,0 +1,43 @@ + + +
+ + ++ Returns the particle type +
++ Possible Particle Types +
+Related: + CreateParticleActor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getpixel.html b/doc/doc_files/getpixel.html new file mode 100644 index 0000000..5c0a75e --- /dev/null +++ b/doc/doc_files/getpixel.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..667a691 --- /dev/null +++ b/doc/doc_files/getpointpivota.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotB + SetPointPivotA +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getpointpivotb.html b/doc/doc_files/getpointpivotb.html new file mode 100644 index 0000000..798eae4 --- /dev/null +++ b/doc/doc_files/getpointpivotb.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotA + SetPointPivotB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getpowerinfo.html b/doc/doc_files/getpowerinfo.html new file mode 100644 index 0000000..564f0e6 --- /dev/null +++ b/doc/doc_files/getpowerinfo.html @@ -0,0 +1,40 @@ + + +
+ + ++ Gets the charging status of the device the program is running on. +
++ status - the charging status of the battery. Look below for the different statuses that can be returned. secs - the approximate time in seconds until the battery looses its charge. pct - the percentage of the battery charged. +
++ Possible Statuses +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getprojectionmatrix.html b/doc/doc_files/getprojectionmatrix.html new file mode 100644 index 0000000..e81eb1c --- /dev/null +++ b/doc/doc_files/getprojectionmatrix.html @@ -0,0 +1,31 @@ + + +
+ + ++ Gets the camera projection matrix for the active canvas +
++ Possible values for projection_type +
+Related: + SetProjectionMatrix +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslideanchora.html b/doc/doc_files/getslideanchora.html new file mode 100644 index 0000000..fde1430 --- /dev/null +++ b/doc/doc_files/getslideanchora.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideAnchorB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslideanchorb.html b/doc/doc_files/getslideanchorb.html new file mode 100644 index 0000000..0ead8a9 --- /dev/null +++ b/doc/doc_files/getslideanchorb.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideAnchorA +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslideangdepth.html b/doc/doc_files/getslideangdepth.html new file mode 100644 index 0000000..2694e72 --- /dev/null +++ b/doc/doc_files/getslideangdepth.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e9a63cb --- /dev/null +++ b/doc/doc_files/getslideangularpos.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2b14798 --- /dev/null +++ b/doc/doc_files/getslidedampingdirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingDirAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidedampingdirlin.html b/doc/doc_files/getslidedampingdirlin.html new file mode 100644 index 0000000..6845718 --- /dev/null +++ b/doc/doc_files/getslidedampingdirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingDirLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidedampinglimang.html b/doc/doc_files/getslidedampinglimang.html new file mode 100644 index 0000000..0c27759 --- /dev/null +++ b/doc/doc_files/getslidedampinglimang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + SetSlideDampingLimAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidedampinglimlin.html b/doc/doc_files/getslidedampinglimlin.html new file mode 100644 index 0000000..bbb8c85 --- /dev/null +++ b/doc/doc_files/getslidedampinglimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingLimLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidedampingorthoang.html b/doc/doc_files/getslidedampingorthoang.html new file mode 100644 index 0000000..53ea0f7 --- /dev/null +++ b/doc/doc_files/getslidedampingorthoang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + SetSlideDampingOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidedampingortholin.html b/doc/doc_files/getslidedampingortholin.html new file mode 100644 index 0000000..8a15024 --- /dev/null +++ b/doc/doc_files/getslidedampingortholin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidelindepth.html b/doc/doc_files/getslidelindepth.html new file mode 100644 index 0000000..19ae897 --- /dev/null +++ b/doc/doc_files/getslidelindepth.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidelinearpos.html b/doc/doc_files/getslidelinearpos.html new file mode 100644 index 0000000..73bafbc --- /dev/null +++ b/doc/doc_files/getslidelinearpos.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslideloweranglimit.html b/doc/doc_files/getslideloweranglimit.html new file mode 100644 index 0000000..8041fbc --- /dev/null +++ b/doc/doc_files/getslideloweranglimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideLowerLinLimit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidelowerlinlimit.html b/doc/doc_files/getslidelowerlinlimit.html new file mode 100644 index 0000000..573ec02 --- /dev/null +++ b/doc/doc_files/getslidelowerlinlimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideLowerLinLimit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutiondirang.html b/doc/doc_files/getsliderestitutiondirang.html new file mode 100644 index 0000000..9976925 --- /dev/null +++ b/doc/doc_files/getsliderestitutiondirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideRestitutionDirAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutiondirlin.html b/doc/doc_files/getsliderestitutiondirlin.html new file mode 100644 index 0000000..ad8dd51 --- /dev/null +++ b/doc/doc_files/getsliderestitutiondirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideRestitutionDirLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionlimang.html b/doc/doc_files/getsliderestitutionlimang.html new file mode 100644 index 0000000..7348673 --- /dev/null +++ b/doc/doc_files/getsliderestitutionlimang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + SetSlideRestitutionLimAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionlimlin.html b/doc/doc_files/getsliderestitutionlimlin.html new file mode 100644 index 0000000..78ff5fd --- /dev/null +++ b/doc/doc_files/getsliderestitutionlimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + SetSlideRestitutionLimLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionorthoang.html b/doc/doc_files/getsliderestitutionorthoang.html new file mode 100644 index 0000000..7786ea3 --- /dev/null +++ b/doc/doc_files/getsliderestitutionorthoang.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Angular Motion: In the context of a slider constraint, orthogonal angular motion refers to rotational movement around axes that are perpendicular to the slider's main movement axis. +
++ 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. +
+Related: + SetSlideRestitutionOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getsliderestitutionortholin.html b/doc/doc_files/getsliderestitutionortholin.html new file mode 100644 index 0000000..3d4d2f7 --- /dev/null +++ b/doc/doc_files/getsliderestitutionortholin.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Linear Motion: In the context of a slider constraint, orthogonal linear motion refers to translational movement along axes that are perpendicular to the main sliding axis of the constraint. +
++ 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. +
+Related: + SetSlideRestitutionOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessdirang.html b/doc/doc_files/getslidesoftnessdirang.html new file mode 100644 index 0000000..da6acd2 --- /dev/null +++ b/doc/doc_files/getslidesoftnessdirang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessdirlin.html b/doc/doc_files/getslidesoftnessdirlin.html new file mode 100644 index 0000000..b829876 --- /dev/null +++ b/doc/doc_files/getslidesoftnessdirlin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnesslimang.html b/doc/doc_files/getslidesoftnesslimang.html new file mode 100644 index 0000000..b1599c0 --- /dev/null +++ b/doc/doc_files/getslidesoftnesslimang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnesslimlin.html b/doc/doc_files/getslidesoftnesslimlin.html new file mode 100644 index 0000000..7f57e4e --- /dev/null +++ b/doc/doc_files/getslidesoftnesslimlin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessorthoang.html b/doc/doc_files/getslidesoftnessorthoang.html new file mode 100644 index 0000000..1907905 --- /dev/null +++ b/doc/doc_files/getslidesoftnessorthoang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidesoftnessortholin.html b/doc/doc_files/getslidesoftnessortholin.html new file mode 100644 index 0000000..e56808a --- /dev/null +++ b/doc/doc_files/getslidesoftnessortholin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslidesolveanglimit.html b/doc/doc_files/getslidesolveanglimit.html new file mode 100644 index 0000000..9e15f17 --- /dev/null +++ b/doc/doc_files/getslidesolveanglimit.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..475fa51 --- /dev/null +++ b/doc/doc_files/getslidesolvelinlimit.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..00e8be0 --- /dev/null +++ b/doc/doc_files/getslideupperanglimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslideupperlinlimit.html b/doc/doc_files/getslideupperlinlimit.html new file mode 100644 index 0000000..d818381 --- /dev/null +++ b/doc/doc_files/getslideupperlinlimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getslideuseframeoffset.html b/doc/doc_files/getslideuseframeoffset.html new file mode 100644 index 0000000..ca7d288 --- /dev/null +++ b/doc/doc_files/getslideuseframeoffset.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5b57123 --- /dev/null +++ b/doc/doc_files/getsoundvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the given sounds volume. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspriteanimation.html b/doc/doc_files/getspriteanimation.html new file mode 100644 index 0000000..0c2f637 --- /dev/null +++ b/doc/doc_files/getspriteanimation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the current animation set on a sprite +
+Related: + SetSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspriteanimationframe.html b/doc/doc_files/getspriteanimationframe.html new file mode 100644 index 0000000..dcdb858 --- /dev/null +++ b/doc/doc_files/getspriteanimationframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8e52551 --- /dev/null +++ b/doc/doc_files/getspriteanimationlength.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6da5421 --- /dev/null +++ b/doc/doc_files/getspriteanimationspeed.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the frames per second of a sprite animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspritecurrentanimationframe.html b/doc/doc_files/getspritecurrentanimationframe.html new file mode 100644 index 0000000..db7b998 --- /dev/null +++ b/doc/doc_files/getspritecurrentanimationframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current frame of a sprite's animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspriteframe.html b/doc/doc_files/getspriteframe.html new file mode 100644 index 0000000..32d375f --- /dev/null +++ b/doc/doc_files/getspriteframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/getspriteposition.html b/doc/doc_files/getspriteposition.html new file mode 100644 index 0000000..b74dfbb --- /dev/null +++ b/doc/doc_files/getspriteposition.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the position of a sprite on the canvas +
+Related: + TranslateSprite + SetSpritePosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspriterotation.html b/doc/doc_files/getspriterotation.html new file mode 100644 index 0000000..f1cc8af --- /dev/null +++ b/doc/doc_files/getspriterotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the angle the sprite is rotated by +
+Related: + SetSpriteRotation + RotateSprite +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspritescale.html b/doc/doc_files/getspritescale.html new file mode 100644 index 0000000..95b8e4f --- /dev/null +++ b/doc/doc_files/getspritescale.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the scale of a sprite +
+Related: + ScaleSprite + SetSpriteScale +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspritesize.html b/doc/doc_files/getspritesize.html new file mode 100644 index 0000000..197ebb1 --- /dev/null +++ b/doc/doc_files/getspritesize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the size of a sprite's frames +
+Related: + CreateSprite +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspritesource.html b/doc/doc_files/getspritesource.html new file mode 100644 index 0000000..4134ba3 --- /dev/null +++ b/doc/doc_files/getspritesource.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the source image the sprite renders its frames from +
+Related: + SetSpriteSource + CreateSprite +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getspritetype.html b/doc/doc_files/getspritetype.html new file mode 100644 index 0000000..e64cb7c --- /dev/null +++ b/doc/doc_files/getspritetype.html @@ -0,0 +1,37 @@ + + +
+ + ++ Returns the collison body type of a sprite. +
++ By default, sprites are dynamic when they are created. +
++ Possible types returned +
+Related: + SetSpriteType +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getterraincenter.html b/doc/doc_files/getterraincenter.html new file mode 100644 index 0000000..0e86ec9 --- /dev/null +++ b/doc/doc_files/getterraincenter.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8f84b14 --- /dev/null +++ b/doc/doc_files/getterrainheight.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a548878 --- /dev/null +++ b/doc/doc_files/getterrainpatchaabb.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2a6a2f5 --- /dev/null +++ b/doc/doc_files/getterrainpatchlod.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current level of detail for a terrain patch +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gettextheight.html b/doc/doc_files/gettextheight.html new file mode 100644 index 0000000..a13f22e --- /dev/null +++ b/doc/doc_files/gettextheight.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the height of the text if rendered with the current font +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gettextsize.html b/doc/doc_files/gettextsize.html new file mode 100644 index 0000000..33e8e88 --- /dev/null +++ b/doc/doc_files/gettextsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the size of the text if rendered with the current font +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gettextwidth.html b/doc/doc_files/gettextwidth.html new file mode 100644 index 0000000..ffa9ecb --- /dev/null +++ b/doc/doc_files/gettextwidth.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the width 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 new file mode 100644 index 0000000..6051bae --- /dev/null +++ b/doc/doc_files/gettile.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the tile at a specified location on a tilemap +
++ 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 new file mode 100644 index 0000000..07b94dd --- /dev/null +++ b/doc/doc_files/gettileanimationframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the tile set at a specified frame in a tiles animation +
+Related: + SetTileAnimationFrame +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gettileanimationlength.html b/doc/doc_files/gettileanimationlength.html new file mode 100644 index 0000000..5f10409 --- /dev/null +++ b/doc/doc_files/gettileanimationlength.html @@ -0,0 +1,20 @@ + + +
+ + ++ Return the number of frames in a tile's animation +
+Related: + SetTileAnimationLength +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gettileanimationspeed.html b/doc/doc_files/gettileanimationspeed.html new file mode 100644 index 0000000..db21a4a --- /dev/null +++ b/doc/doc_files/gettileanimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the fps of a tile's animation +
+Related: + SetTileAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gettilemapsize.html b/doc/doc_files/gettilemapsize.html new file mode 100644 index 0000000..d2246dd --- /dev/null +++ b/doc/doc_files/gettilemapsize.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the size of a tile map +
+Related: + CreateTileMap + SetTileMapSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/gettouch.html b/doc/doc_files/gettouch.html new file mode 100644 index 0000000..59261e5 --- /dev/null +++ b/doc/doc_files/gettouch.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..fdfd6d0 --- /dev/null +++ b/doc/doc_files/gettouchfinger.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7663421 --- /dev/null +++ b/doc/doc_files/getvideodrawrect.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..59e3f0c --- /dev/null +++ b/doc/doc_files/getvideoposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..fbbf168 --- /dev/null +++ b/doc/doc_files/getvideosize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8665598 --- /dev/null +++ b/doc/doc_files/getvideostats.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets video data from a video file. +
++ 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 new file mode 100644 index 0000000..93bd505 --- /dev/null +++ b/doc/doc_files/getvideovolume.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the volume of a video +
++ Volume can be in a range of 0 to 128 +
+Related: + SetVideoVolume +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getwatercolor.html b/doc/doc_files/getwatercolor.html new file mode 100644 index 0000000..eb7d869 --- /dev/null +++ b/doc/doc_files/getwatercolor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/getwatercolorblendfactor.html b/doc/doc_files/getwatercolorblendfactor.html new file mode 100644 index 0000000..5c09ccc --- /dev/null +++ b/doc/doc_files/getwatercolorblendfactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/getwaterwaveheight.html b/doc/doc_files/getwaterwaveheight.html new file mode 100644 index 0000000..b5b07f3 --- /dev/null +++ b/doc/doc_files/getwaterwaveheight.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/getwaterwinddirection.html b/doc/doc_files/getwaterwinddirection.html new file mode 100644 index 0000000..5713f7c --- /dev/null +++ b/doc/doc_files/getwaterwinddirection.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/getwaterwindforce.html b/doc/doc_files/getwaterwindforce.html new file mode 100644 index 0000000..0a047b9 --- /dev/null +++ b/doc/doc_files/getwaterwindforce.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/getwindowmaxsize.html b/doc/doc_files/getwindowmaxsize.html new file mode 100644 index 0000000..f7e7ea9 --- /dev/null +++ b/doc/doc_files/getwindowmaxsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8c4206e --- /dev/null +++ b/doc/doc_files/getwindowminsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6017212 --- /dev/null +++ b/doc/doc_files/getwindowmode.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..485151d --- /dev/null +++ b/doc/doc_files/getwindowposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the window position. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getwindowsize.html b/doc/doc_files/getwindowsize.html new file mode 100644 index 0000000..3857c28 --- /dev/null +++ b/doc/doc_files/getwindowsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the size of the window. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/getworldtoviewportposition.html b/doc/doc_files/getworldtoviewportposition.html new file mode 100644 index 0000000..30c6a53 --- /dev/null +++ b/doc/doc_files/getworldtoviewportposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..184093c --- /dev/null +++ b/doc/doc_files/globalmousex.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the absolute X position of the mouse on the display +
+Related: + GlobalMouseY + GetGlobalMouse +
++ + + \ No newline at end of file diff --git a/doc/doc_files/globalmousey.html b/doc/doc_files/globalmousey.html new file mode 100644 index 0000000..c0e507d --- /dev/null +++ b/doc/doc_files/globalmousey.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the absolute Y position of the mouse on the display +
+Related: + GlobalMouseX + GetGlobalMouse +
++ + + \ No newline at end of file diff --git a/doc/doc_files/grabinput.html b/doc/doc_files/grabinput.html new file mode 100644 index 0000000..bdb1337 --- /dev/null +++ b/doc/doc_files/grabinput.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4e05290 --- /dev/null +++ b/doc/doc_files/graphics.html @@ -0,0 +1,103 @@ + + +
+ + ++ Finally, the reason we are all here. Lets draw pretty pictures on the screen. The first thing we need is a window. To open the graphics window, we need to use OpenWindow(). +
+
+ fullscreen = false
+ vsync = true
+
+ OpenWindow("My Graphics Window", 640, 480, fullscreen, vsync)
+
+ The above code will open a 640 x 480 window with vsync enabled. You can reference OpenWindow() for a little more detail. +
++ If we tried to run the code we have so far, the window would open and immediately close. So next to keep our window open and ensure its getting updated we need to make our render loop. +
+
+ While Not Key(K_ESCAPE)
+ Update() 'This needs to be called every frame to refresh the window and poll events
+ Wend
+
+ So now we have our basic render loop but nothing is being drawn. Now is a good time to explain how RCBasic's graphics system works. RCBasic uses virtual render targets called canvases. There are 3 different types of canvases that are used for rendering depending on what you are trying to do. Here is an overview of the different types of canvases: +
++ For now, lets just use a paint canvas. We use OpenCanvas() to open a paint canvas. Before our render loop, we will open our canvas. +
+
+
+ paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1)
+
+ Canvas(paint_canvas) 'Sets out canvas as the active canvas. This is unnecessary since we only have one canvas but its a good habit to get into to set your desired canvas active before doing anything on it.
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas() 'Clears the canvas every frame. If you have an image that never changes you may not want to do this.
+ Update()
+ Wend
+
+ Here we are opening a canvas for drawing and storing the handle for that canvas in a variable called paint_canvas. Anytime we want to reference that canvas we will use the paint_canvas variable. You can reference OpenCanvas() for more details on how it works. After we opened our canvas, we set it as the active canvas using Canvas(). This was not necessary right now since RCBasic sets the first canvas created as the default canvas but its still a good habit to set a canvas active before doing anything with it to ensure you are targeting the right canvas. +
++ Ok, we have a window and a canvas but we still haven't drawn anything. So lets do that. Inside our render loop, we are going to set our draw color to red and draw a box. +
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+
+ SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red
+ RectFill(20, 20, 50, 50) 'Draws a filled rectangle with the current draw color
+
+ Update()
+ Wend
+
+ So now our finished program looks like this: +
+
+ fullscreen = false
+ vsync = true
+
+ OpenWindow("My Graphics Window", 640, 480, fullscreen, vsync)
+
+ paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1)
+
+ Canvas(paint_canvas)
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+
+ SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red
+ RectFill(20, 20, 50, 50) 'Draws a filled rectangle with the current draw color
+
+ Update()
+ Wend
+
+ 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 new file mode 100644 index 0000000..c9019d5 --- /dev/null +++ b/doc/doc_files/gyroname.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ae63ddc --- /dev/null +++ b/doc/doc_files/hasclipboardtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b8ca1a0 --- /dev/null +++ b/doc/doc_files/hello_world.html @@ -0,0 +1,576 @@ + + +
+ + ++ This tutorial is designed to introduce complete newbies to the world of computer programming and specifically programming using RC Basic. This tutorial will not assume any previous programming knowledge and really won't even assume you know much about how a computer works. A basic understanding of 6th Grade Algebra will come in handy but is not necessary. Now that I got that out of the way, lets take our first steps in our journey to becoming computer programmers. +
++ First lets go over the requirements you will need to follow this tutorial. You will need a computer (obviously), RC Basic (yet again obvious, but I had to say it), and the will to learn (not essential but it will definitely help). Ok lets begin. +
++
+
+ Print "Hello World"
+
+ You should see "Hello World" in your console window. Congratulations, you just wrote your first computer program. So lets break this program down into its individual parts. First is the Print command. This is telling the computer to write something to the console (I will be referring to the DOS screen as the console for the rest of this tutorial). And then we have "Hello World". First of all, why is it in quotation marks? The short answer is because it is not a number. We will go over this more in depth later but for now that is all we need to know for right now? Before we move on, use the Print command to write some other stuff to the screen. +
++
+ Look at the following examples. +
+
+ "42"
+ 42
+
+ The first line is a string and the second line is a number. Are you confused yet? The first line has the character "4" and the character "2" in a string and the second line is the number 42. Yes they look the same but the way you perform operations on a string is different than the way you perform operations on numbers. It will make more since with the examples below. +
++ This will add the string "53" to the end of the string "42" and output 4253 to the console. Try it. +
+
+ Print "42" + "53"
+
+ This will will add the number 42 to the number 53 and output 95 to the console. Try it. +
+
+ Print 42 + 53
+
+ The differences between numbers and strings should be starting to clear up a little by now. If you are still a little confused at this point don't worry. This is only an Introduction to programming. If you are able to write some text on the screen and do some simple math by the end of this tutorial you will be ready to continue into the next lesson. +
++ Now we are going to get into operators. I know I said at the beginning of the tutorial I did not expect you to know much but I am assuming you know how to add, subtract, multiply, and divide. We got a brief introduction to the "+" operator in the last example. It is important to note that the "+" operator is the only operator that works on both numbers and strings. +
++ Here is a list of the main string operators. "+": Adds one string to the end of another. This example will output "batman" to the console. +
+
+ Print "bat" + "man"
+
+ Before we continue, lets break down the PRINT statement. It is the simplest way to get text on the screen. PRINT also allows us to output multiple items of different types by separating them with a “;”. +
+
+ Print “Text”; 5+4; “ More Text”;
+
+ ‘Ending Print with a “;” keeps the cursor on the same line in the console.
+
+ Here is a list of the main number operators. "+": Adds two numbers together. This example will output 8 to the console. +
+
+ Print 6 + 2
+
+ "-": Subtracts one number from another. This example will output 4 to the console. +
+
+ Print 6 - 2
+
+ "*": Multiplies two numbers (Note: Multiplication uses an * instead of an x). This example will output 12 to the console. +
+
+ Print 6 * 2
+
+ "/": Divides one number by another. This example will output 3 to the console. +
+
+ Print 6 / 2
+
+ "^": Raises a number to a power. This example will output 36 (6 to the second power) to the console. +
+
+ Print 6 ^ 2
+
+ Both string operators perform the same operation. They will place the characters in the second string at the end of the first string. The number operators perform the same operations they do on a calculator. One more important thing to mention is that the number operators follow the Order of Operations. Take a look at the example below. +
+
+ Print 4+3*2
+
+ In the example above the, following the order of operations PEMDAS (Parenthesis, Exponents, Multiplication, Division, Addition, and Subtraction); 3 is multiplied by 2 which is 6, and then 4 is added to it which is 10. So math is not necessarily done from left to right but it is determined by the order of operations. There is more to the order of operations but we are not going to cover that right now. We covered all of the main operators so before we move on lets look at one more example that uses parenthesis. +
+
+ Print (4+3)*2
+
+ This is almost the same problem as the example before it, but now it groups 4 plus 3 together using parenthesis which means 4 and 3 are added first which will be 7. Then that 7 is multiplied by 2 which is 14. If you do the same problems on a calculator you will get the same answers. Try out a few math problems on your own. +
++ Interacting With The User Up to this point, we have been writing output to the screen. We have been the user as well as the programmer so there was no reason to need to accept input from the screen. But when you write programs that are meant to be used by people other than yourself you will want to get input from the user and process that input to perform some task. So lets dive into some code. For this example we are using the function Input to ask the user "What is your name? " and read what the user types into the console (which should be there name but they can type whatever they want). +
+
+ Input$("What is your name? ")
+
+ You should have seen "What is your name?" and then been able to type something in. You have just received input from the user for the first time. So lets break this line down. First we have the function name Input$. Input$ is a built-in function that prompts the user with something and it returns what the user typed. This is the first time I used the word returns so let me clarify. In the example above lets say you type in Bob for your name. The whole Input$() function call is replaced with "Bob". Take a look at this example. +
++ This line does not prompt anything and just waits for you to type something. We are going to type Bob. +
+
+ Input$("")
+
+ After you enter "Bob" the line above will be replaced with "Bob" and the line will finish processing your commands. +
+
+ "Bob"
+
+ You are probably thinking that is useless. What can we do with a line that just has a string on it. And the answer is you really can't do anything with a line that just has Bob on it. But if we store the string "Bob" we can use it to do other stuff with. +
++ To store "Bob" (or whatever you call yourself) we use something called a variable. You might have seen variables used in math class in school. A variable is just a symbol that holds data. By symbol I don't mean a logo or anything. Just take a look at this example. +
+
+ a = 2
+ b$ = "Bob"
+ batman = 4.5
+ superman$ = "this is just random text"
+
+ This example makes four variables: a, b$, batman, superman$ and stores some data in them. Lets do a break down. +
++ We will start with the variables a and batman. The variables are just storing numbers. We can use variables that store numbers when we have programs that are going to be handling values that change over time. For now lets just do some simple math. Type the variables from the previous example and add the following code and run it. +
+
+ Print a + batman
+
+ This example just adds the values in the variables together and outputs the values to the screen. You can change the value of a variable at any time. This is better explained with another example. +
+
+ a = 5
+ Print a
+ a = 6
+ Print a
+ a = 5 + 6
+ Print a
+
+ What we are doing in the example above is changing the value of a and doing math and storing the value in a. We can also store the value of one variable inside another. Lets Look at another example. +
+
+ a = batman
+ Print a
+ a = a + batman
+ Print a
+
+ The example above will first store the value of batman in the variable a. It will write a to the screen. Then it will add a and batman and store the result in a and write that value to the screen. +
++ Now we are going to take a look at the other two variables we created: the variable b$ and the variable superman$. Did you notice that both of the variables end in a $. There is a reason for that. The $ at the end of the variable name lets the compiler know that these variables are strings. Since these two variables are strings the rules about strings apply to these variables. Look at the following examples. +
+
+ Print b$
+ Print superman$
+ Print b$ + superman$
+
+ The above example writes the value stored in b$ to the screen. Then it writes the value stored in superman$ to the screen. Finally it adds the contents of the superman$ variable to the end of the contents for the b$ variable and writes that to the screen. +
++ Now that we have covered variables, how do we use them with the users input. Well lets look at the Input$() function again. Notice that the function ends in a $. input$() returns a string so it can be used anywhere a string can. Look at this example. +
++ This line does the same thing as the last time we used the Input$() function. The main Difference is now we are storing the value the user enters into the variable name. +
+
+ name$ = Input$("What is your name?")
+
+ This code will store "Bob" or what ever you typed in into the variable name$. Now we can use the name$ as many times as we want anywhere in our program. So now lets make a program that Uses Input$() along with Print. We are going to ask the User for there name and then welcome the User to RC Basic. +
+
+ name$ = Input$("What is your name? ")
+ Print "Hello " + name$ + ". Welcome to RC Basic."
+
+ Lets do our break down again. In the first$ line we create a variable called name$ and call Input$() in it. This will write "What is your name? " to the screen. When the User Enters something, whatever the User types in will replace Input$(). So name$ will be whatever the User types in. On the next line we use Print to write a message to the screen. The only thing different this time is we are adding a variable to our string in Input$(). But remember that our variable is a string and can do anything a string can, so all you are doing is saying "Hello " + the User's name + ". Welcome to RC Basic.". +
++ We have covered a lot in these first few sections so I am going to take this time to challenge you. Write a program that ask the User to type there favorite color in and then tell them what there favorite color is on the next line. +
++ Flow Control Flow control sounds like some really complicated topic. But it will probably make sense almost immediately. So what is flow control? Simply put, flow control is controlling what your program does based on what conditions are met. To control the flow in our programs we will use the If statement. The If statement will allow us to execute a block of code depending on what conditions are met. Let look at the last example from the last segment. +
+
+ name$ = Input$("What is your name? ")
+ Print "Hello " + name$ + ". Welcome to RC Basic."
+
+ To give an idea of how to use the IF statement we are going to extend this program. So lets make the program give a special greeting if Bob is typed in for the name. Look at the following example. +
+
+ name$ = Input$("What is your name? ")
+ Print "Hello " + name$ + ". Welcome to RC Basic."
+
+ If name$ = "Bob" Then
+ Print "We have been expecting you"
+ End If
+
+ This program will do the same thing it did in the last segment but it adds the use of the IF statement. So lets do a quick break down. +
++ This line is saying if name$ has "Bob" stored in it, then run the following code. Each IF statement must end with the THEN statement. +
+
+ If name$ = "Bob" Then
+
+ This line is writing "We have been expecting you" to the screen. +
+
+ Print "We have been expecting you"
+
+ This line is ending the block of code that the IF statement wanted the program to execute and continues the rest of your program. +
++ The block of code started by the IF statement can also be given different conditions to check for and execute a different block of code for each different condition. We are going to take a break from strings and use numbers for our next few examples. We are also going to introduce a few new operators. So lets start by making some number variables. +
+
+ a = 1
+ b = 3
+ c = 5
+
+ Now that we have some variables we are going to make a program that ask the User to enter a number and check if the number is equal to each variable and outputs something different for each one. First I need to cover one very important topic. The Input$() function only takes in a string. So even number that are typed in by the User are treated as strings. So we need to convert the Users input to a number to be able to compare it to another number or do any kind of math with it. To do this we will use the Val() function. The Val() function converts a string to a number. Look at the following example real quick. +
++ This example will convert the string "12" to the number 12. +
+
+ x = Val("12")
+
+ The more programs you write, the more you will get use to converting numbers to strings and strings to numbers. So how do we use Val() with Input$(). Well remember that Input$() can be used anywhere a string can. So instead of putting "12" in Val() like we did in the last example we will simply put Input$() inside Val(). Make sure your program has the variables a, b, and c we created earlier and add this. +
+
+ d = Val( Input$("Enter a number: ") )
+
+ The code above is creating a variable called d. Then it uses the Val() function to convert the string returned by Input$() into a number. The string returned by Input$() is what ever the User types in. Now that we have gotten a number from the User lets compare that number to the variables we made earlier. +
+
+ If d = a Then
+ Print "You typed the A value"
+
+ ElseIf d = b Then
+ Print "That is B"
+
+ ElseIf d = c Then
+ Print "That would be C"
+
+ Else
+ Print "You did not type any of the numbers"
+
+ End If
+
+ Lets do a break down. This is starting a multi-layered If statement block. It should be fairly simple to understand. We are going to go through each line and examine what is happening step by step. +
++ This line is starting your If block by comparing d(which is what the User typed in) to the variable a. If the two variables are equal then it will output "You typed the A value" to the console. +
+
+ If d = a Then
+ Print "You typed the A value"
+
+ This line will compare d and b if d wasn't equal to a. If the value stored in d is equal to the value stored in b then it will output "That is B" to the console. +
+
+ ElseIf d = b Then
+ Print "That is B"
+
+ This line will compare d and c if d wasn't equal to a or b. If d is equal to c then "That would be C" is output to the console. +
+
+ ElseIf d = c Then
+ Print "That would be C"
+
+ This line will output "You did not type any of the numbers" if none of the previous conditions were met. +
+
+ Else
+ Print "You did not type any of the numbers"
+
+ And finally this line will end the If block and finish running the rest of the program. +
+
+ End If
+
+ Now we are going to play with a few other operators for numbers only. In addition to being able to compare if two numbers are equal we can also compare if one number is greater than another, less than another, not equal to another, greater than or equal to another, etc. Here is a list of comparisons we can do with numbers. +
++ Given we have two number stored in variables a and b. +
++ •.a = b : Test if a is equal to b +
++ •.a < b : Test if a is less than b +
++ •.a > b : Test if a is greater than b +
++ •.a <= b : Test if a is less than or equal to b +
++ •.a >= b : Test if a is greater than or equal to b +
++ •.a <> b : Test if a is not equal to b +
++ Here is a few examples of doing some of these comparisons with a IF statement. +
+
+ If a = b Then
+ 'Code to execute
+ End If
+
+ If a < b Then
+ 'Code to execute
+ End If
+
+ If a <> b Then
+ 'Code to execute
+ End If
+
+ These other comparisons are pretty straight forward. To try these out we are going to make a program that ask the User to enter a number. If the number is less than or equal to 10 then "Low" will be output to the console. If the number is greater than 10 then we will check if the number is greater than 20. If it is then then "High" will be output to the console. If neither of these conditions are true then "Mid" will be output to the console. First we need to get a number from the User. Remember we need to use the Val() function to convert the User's input from a string to a number. +
++ Here is where we take the User's input and convert it to a number. The Input$() function will get replaced with what the User types in so we simply use the Val() function to convert Input$() to a number. +
+
+ user_num = Val( Input$("Enter a number: ") )
+
+ We start our If block by comparing user_num (Our input from the User in the previous line) to the number 10. If the user_num variable is less than or equal to 10 then we use the Print statement to write "Low" to the console. +
+
+ If user_num <= 10 Then
+ Print "Low"
+
+ If the previous comparison is false then we compare the user_num variable to 20. If user_num is greater than 20 then we will write "High" to the console. +
+
+ ElseIf user_num > 20 Then
+ Print "High"
+
+ Finally, if none of the previous conditions are true we will write "Mid" to the console. +
+
+ Else
+ Print "Mid"
+
+ End If
+
+ Our complete program looks like this. +
+
+ user_num = Val( Input$("Enter a number: ") )
+
+ If user_num <= 10 Then
+ Print "Low"
+
+ ElseIf user_num > 20 Then
+ Print "High"
+
+ Else
+ Print "Mid"
+
+ End If
+
+ The last thing we will cover on flow control is the keywords AND, OR, XOR, and NOT. These 4 keywords are actually operators that can be used for more specific comparisons. We will start with the AND operator. The AND operator will compare the conditions to its left and its right. If both conditions are true the AND operator sets the whole expression as true. I already know you didn't understand that explanation so it will probably be easier to show you. Just look at this example. +
++ This code will write "This is true" to the console because 1 is equal to 1 and 4 is greater than 2. Yes it is that simple. +
+
+ If 11 AND 4>2 Then
+ Print "This is true"
+ End If
+
+ The OR statement will set the whole expression it is being used in if at least one of the conditions is true. Here is an example of OR. +
++ This code will write "This is true" to the console because although 1 is not equal to 2, 5 is less than or equal to 6. +
+
+ If 12 AND 5<6 Then
+ Print "This is true"
+ End If
+
+ The XOR statement is like the OR statement with one major difference. With XOR, one of the conditions in the expression has to be true and the other has to be false. Here is an example of XOR. +
++ This code will write "This is true" to the console because 1 is equal to 1 and 2 is equal to 2 ( 2 <> 2 is false because 2=2. Remember <> is the NOT EQUAL operator). Basically one condition in the XOR expression has to be true and the other has to be false otherwise the whole expression is false. If this is slightly confusing don't worry. In my 15+ years of programming experience I have never once used this operator. +
+
+ If 11 XOR 2 <> 2 Then
+ Print "This is true"
+ End If
+
+ The last of these special operators we will cover is NOT. This one will be extremely simple to understand. Basically if an expression is true it becomes false and if an expression is false it becomes true. +
++ This code will write "This is true" to the screen because the expression 1=3 is false. The NOT statement reverses the false and makes it true. +
+
+ If NOT (13) Then
+ Print "This is true"
+ End If
+
+ Lets go over one more program before we move on to the next segment. We will ask the User for a number from 1 to 10. If the User enters 3 or 4 then we will write "Good Answer" to the console. If the User enters a number greater than 5 and less than 9 (Basically 6, 7, or 8) then we will write "Choice numbers" to the console. If the User types in any other number then we will write "Maybe next time" to the console. +
++ Here we are asking the User to enter a number from 1 to 10 using the Input$() function. Input$() returns a string so we have to store it in a string variable. +
+
+ user_in$ = Input$("Enter a number from 1 to 10: ")
+
+ Then we convert the string the User entered into a string using the Val() function. Note: We are using a string variable inside the Val() function instead of using Input$() inside it this time. I am showing it this way to get you used to the idea that Val() takes a string. It can be a string variable, string function, or just a regular string between quotation marks. +
+
+ num = Val(user_in$)
+
+ In the first line of this piece of code we are comparing the variable num (which is the number the User entered) to the number 3 and we compare the variable num to the number 4. If the variable num is equal to the number 3 or 4 then we write "Good Answer" to the console. +
+
+ If num = 3 OR num = 4 Then
+ Print "Good Answer"
+
+ This block of code compares the variable num to the number 5 and the number 9 if the previous If condition was false. If num is greater than 5 and num is less than 9 then we write "Choice numbers" to the console. +
+
+ ElseIf num > 5 AND num < 9 Then
+ Print "Choice numbers"
+
+ Finally this last bit of code will write "Maybe next time" to the console if none of the previous IF conditions were true. It then ends the IF block. +
+
+ Else
+ Print "Maybe next time"
+
+ End If
+
+
+ function_name ( argument1, argument2, ..etc ) - A function can have no arguments or several arguments. Arguments in a function can be numbers or strings, it just depends on what function you are using. So lets look at a few different functions to see how other functions are used. +
++ Abs() returns the Absolute value of a number. +
+
+ Abs( -4 )
+
+ Date$() returns the current date as a string. +
+
+ Date$()
+
+ UCase$() returns the argument you give it as an all uppercase string. +
+
+ UCase$("Hello World")
+
+ As you can see there are different functions to accomplish different task. You can learn more functions by looking in the RC Basic reference manual located in the Docs folder in the rcbasic directory. +
++
+ We are going to cover two types of loops. The first one we are going over is the FOR loop. For loops are used when you want to cycle through a block of code a set number of times. Lets just dive into the code. +
++ Type this code into your editor and run it. +
+
+ For i = 1 to 10
+ Print i
+ Next
+
+ The code in the example above writes the numbers 1 to 10 in the console. The FOR loop starts with a variable, which in this case is i. We set it with an initial value of 1 and tell the computer to loop the code between the FOR line and the NEXT line until i is equal to 10. When the NEXT statement is reached, i is increased by 1 and the program goes back to the start of the loop. That is how the FOR loop works in a nutshell. There is some extra control we can take over the For loop with the STEP statement. With the STEP statement we can change the amount the variable in the For line increases by. Look at the following example. +
++ This code will write the even numbers from 2 to 10 to the console. +
+
+ For i = 2 to 10 Step 2
+ Print i
+ Next
+
+ The last loop we are covering in this tutorial is the WHILE loop. The WHILE loop will loop through a block of code while a certain condition is true. Look at the following example. +
+
+ i = 1
+ While i <= 10
+ Print i
+ i = i + 1
+ Wend
+
+ In the example above we are doing a little bit more than we have been doing up to this point. First we are creating a variable called i. We start a While loop that compares i to the number 10. If i is less than or equal to 10 then we write the value stored in i to the console. Then we get to the line i = i + 1. This line is making i equal to the value stored in i plus 1. Basically we are increasing i by 1. The WEND line goes back to the start of the WHILE block where it compares i to 10 and if it is less than or equal to 10 it repeats the block of code again. +
++ Now for some challenges. +
++ 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 new file mode 100644 index 0000000..1c1464d --- /dev/null +++ b/doc/doc_files/hex.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ea343cf --- /dev/null +++ b/doc/doc_files/hexval.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9278c3a --- /dev/null +++ b/doc/doc_files/hidemouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8a08ec0 --- /dev/null +++ b/doc/doc_files/hidewindow.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the window invisible. +
+Related: + ShowWindow + WindowIsVisible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/imageexists.html b/doc/doc_files/imageexists.html new file mode 100644 index 0000000..38f81a8 --- /dev/null +++ b/doc/doc_files/imageexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if img is associated with an allocated image in memory +
++ + + \ No newline at end of file diff --git a/doc/doc_files/images/DripOctober.ttf b/doc/doc_files/images/DripOctober.ttf new file mode 100644 index 0000000..3545865 Binary files /dev/null and b/doc/doc_files/images/DripOctober.ttf differ diff --git a/doc/doc_files/images/frowny1.png b/doc/doc_files/images/frowny1.png new file mode 100644 index 0000000..19d4ddc Binary files /dev/null and b/doc/doc_files/images/frowny1.png differ diff --git a/doc/doc_files/images/frowny2.png b/doc/doc_files/images/frowny2.png new file mode 100644 index 0000000..4553411 Binary files /dev/null and b/doc/doc_files/images/frowny2.png differ diff --git a/doc/doc_files/images/rcbasic_icon.png b/doc/doc_files/images/rcbasic_icon.png new file mode 100755 index 0000000..a90eb8f Binary files /dev/null and b/doc/doc_files/images/rcbasic_icon.png differ diff --git a/doc/doc_files/images/sword.png b/doc/doc_files/images/sword.png new file mode 100644 index 0000000..22f2a56 Binary files /dev/null and b/doc/doc_files/images/sword.png differ diff --git a/doc/doc_files/images/testTileSet.png b/doc/doc_files/images/testTileSet.png new file mode 100644 index 0000000..a0005d7 Binary files /dev/null and b/doc/doc_files/images/testTileSet.png differ diff --git a/doc/doc_files/images/theEye.png b/doc/doc_files/images/theEye.png new file mode 100644 index 0000000..b14eb0c Binary files /dev/null and b/doc/doc_files/images/theEye.png differ diff --git a/doc/doc_files/images/window_gfx_structure.png b/doc/doc_files/images/window_gfx_structure.png new file mode 100755 index 0000000..f915073 Binary files /dev/null and b/doc/doc_files/images/window_gfx_structure.png differ diff --git a/doc/doc_files/incrementmatrixcolumns.html b/doc/doc_files/incrementmatrixcolumns.html new file mode 100644 index 0000000..1a781a0 --- /dev/null +++ b/doc/doc_files/incrementmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..697655f --- /dev/null +++ b/doc/doc_files/incrementmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f5fc3ee --- /dev/null +++ b/doc/doc_files/inkey.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9299c02 --- /dev/null +++ b/doc/doc_files/input.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..96c239e --- /dev/null +++ b/doc/doc_files/insert.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e1320fb --- /dev/null +++ b/doc/doc_files/insertmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2d37e21 --- /dev/null +++ b/doc/doc_files/insertmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1d9ec84 --- /dev/null +++ b/doc/doc_files/instr.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..91dc96c --- /dev/null +++ b/doc/doc_files/int.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f70a3d7 --- /dev/null +++ b/doc/doc_files/integrateactorvelocities.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/interpolate.html b/doc/doc_files/interpolate.html new file mode 100644 index 0000000..0b3fbc2 --- /dev/null +++ b/doc/doc_files/interpolate.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a4dcf10 --- /dev/null +++ b/doc/doc_files/intro.html @@ -0,0 +1,20 @@ + + +
+ + ++ First I would like to say thank you for taking an interest in RCBASIC ( I use all caps because I think it looks more retro that way). RCBASIC is a variant of the BASIC programming language. It consist of a compiler, interpreter, and a code editor. This version of BASIC was mostly influenced by sdlBasic and QBasic. My main reason for writing this software was just to have fun and challenge myself. This language is not as full featured as C++ or Java but you can still create some awesome stuff with it. I hope you have as much fun using this software as I had making it. +
++ Rodney Cunningham (aka. n00b) +
++ + + \ No newline at end of file diff --git a/doc/doc_files/invertmatrix.html b/doc/doc_files/invertmatrix.html new file mode 100644 index 0000000..4d080b5 --- /dev/null +++ b/doc/doc_files/invertmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6c90c03 --- /dev/null +++ b/doc/doc_files/io.html @@ -0,0 +1,41 @@ + + +
+ + ++ RC BASIC has two ways of getting output to a text console. The first way is the PRINT keyword shown here: +
+
+ Print "HELLO WORLD"
+ Print 5
+
+ You can also use a ";" to output multiple values or to prevent PRINT from going to a new-line in its output. +
+
+ Print "This is line 1. ";
+ Print "This is still line 1. Value="; 4+5; " This is the end of line 1"
+ Print "Line 2 start"
+
+ You can also use the FPrint() sub routine to do the same thing as PRINT. It was added back in RCBasic v1.0 since PRINT was not able to stop new-line after its output back then. This is a legacy hold over and does not really add any new functionality. +
++ To get input from the user you would use the INPUT$ function. INPUT$ will display a prompt to the user and then get input from the console. +
+
+ USER_NAME$ = INPUT$("WHAT IS YOUR NAME? ")
+
+ 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 new file mode 100644 index 0000000..cbaf025 --- /dev/null +++ b/doc/doc_files/isequalmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..28fe335 --- /dev/null +++ b/doc/doc_files/joinmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..acfa66d --- /dev/null +++ b/doc/doc_files/joinmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ Appends the rows in matrix mB onto the right of matrix mA. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/joyaxis.html b/doc/doc_files/joyaxis.html new file mode 100644 index 0000000..7c8ee90 --- /dev/null +++ b/doc/doc_files/joyaxis.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0d1d73f --- /dev/null +++ b/doc/doc_files/joybutton.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..cd392c8 --- /dev/null +++ b/doc/doc_files/joyhat.html @@ -0,0 +1,49 @@ + + +
+ + ++ Returns the position of the Hat. +
++ Possible Hat Positions +
++ + + \ No newline at end of file diff --git a/doc/doc_files/joyname.html b/doc/doc_files/joyname.html new file mode 100644 index 0000000..8b84cc5 --- /dev/null +++ b/doc/doc_files/joyname.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the joystick name. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/joyrumbleplay.html b/doc/doc_files/joyrumbleplay.html new file mode 100644 index 0000000..8b9bf12 --- /dev/null +++ b/doc/doc_files/joyrumbleplay.html @@ -0,0 +1,25 @@ + + +
+ + ++ Rumbles a joystick at a specified strength for the specifed duration. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/joyrumblestop.html b/doc/doc_files/joyrumblestop.html new file mode 100644 index 0000000..1d0f439 --- /dev/null +++ b/doc/doc_files/joyrumblestop.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..02a0f3e --- /dev/null +++ b/doc/doc_files/joystickisconnected.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9f8da8a --- /dev/null +++ b/doc/doc_files/joystickishaptic.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..48ec475 --- /dev/null +++ b/doc/doc_files/key.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the given key was pressed and false otherwise. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/key_codes.html b/doc/doc_files/key_codes.html new file mode 100644 index 0000000..2d25688 --- /dev/null +++ b/doc/doc_files/key_codes.html @@ -0,0 +1,1832 @@ + + +
+ + +|
+ KEY NAME + |
+
+ RC BASIC CODE + |
+
|
+ "0" + |
+
+ K_0 + |
+
|
+ "1" + |
+
+ K_1 + |
+
|
+ "2" + |
+
+ K_2 + |
+
|
+ "3" + |
+
+ K_3 + |
+
|
+ "4" + |
+
+ K_4 + |
+
|
+ "5" + |
+
+ K_5 + |
+
|
+ "6" + |
+
+ K_6 + |
+
|
+ "7" + |
+
+ K_7 + |
+
|
+ "8" + |
+
+ K_8 + |
+
|
+ "9" + |
+
+ K_9 + |
+
|
+ "A" + |
+
+ K_A + |
+
|
+ "AC Back" (the Back key (application control + keypad)) + |
+
+ K_AC_BACK + |
+
|
+ "AC Bookmarks" (the Bookmarks key (application + control keypad)) + |
+
+ K_AC_BOOKMARKS + |
+
|
+ "AC Forward" (the Forward key (application + control keypad)) + |
+
+ K_AC_FORWARD + |
+
|
+ "AC Home" (the Home key (application control + keypad)) + |
+
+ K_AC_HOME + |
+
|
+ "AC Refresh" (the Refresh key (application + control keypad)) + |
+
+ K_AC_REFRESH + |
+
|
+ "AC Search" (the Search key (application control + keypad)) + |
+
+ K_AC_SEARCH + |
+
|
+ "AC Stop" (the Stop key (application control + keypad)) + |
+
+ K_AC_STOP + |
+
|
+ "Again" (the Again key (Redo)) + |
+
+ K_AGAIN + |
+
|
+ "AltErase" (Erase-Eaze) + |
+
+ K_ALTERASE + |
+
|
+ "'" + |
+
+ K_APOSTROPHE + |
+
|
+ "Application" (the Application / Compose / + Context Menu (Windows) key ) + |
+
+ K_APPLICATION + |
+
|
+ "AudioMute" (the Mute volume key) + |
+
+ K_AUDIOMUTE + |
+
|
+ "AudioNext" (the Next Track media key) + |
+
+ K_AUDIONEXT + |
+
|
+ "AudioPlay" (the Play media key) + |
+
+ K_AUDIOPLAY + |
+
|
+ "AudioPrev" (the Previous Track media key) + |
+
+ K_AUDIOPREV + |
+
|
+ "AudioStop" (the Stop media key) + |
+
+ K_AUDIOSTOP + |
+
|
+ "B" + |
+
+ K_B + |
+
|
+ "\" (Located at the lower left of the return key + on ISO keyboards and at the right end of the QWERTY row on ANSI + keyboards. Produces REVERSE SOLIDUS (backslash) and VERTICAL LINE + in a US layout, REVERSE SOLIDUS and VERTICAL LINE in a UK Mac + layout, NUMBER SIGN and TILDE in a UK Windows layout, DOLLAR SIGN + and POUND SIGN in a Swiss German layout, NUMBER SIGN and + APOSTROPHE in a German layout, GRAVE ACCENT and POUND SIGN in a + French Mac layout, and ASTERISK and MICRO SIGN in a French Windows + layout.) + |
+
+ K_BACKSLASH + |
+
|
+ "Backspace" + |
+
+ K_BACKSPACE + |
+
|
+ "BrightnessDown" (the Brightness Down key) + |
+
+ K_BRIGHTNESSDOWN + |
+
|
+ "BrightnessUp" (the Brightness Up key) + |
+
+ K_BRIGHTNESSUP + |
+
|
+ "C" + |
+
+ K_C + |
+
|
+ "Calculator" (the Calculator key) + |
+
+ K_CALCULATOR + |
+
|
+ "Cancel" + |
+
+ K_CANCEL + |
+
|
+ "CapsLock" + |
+
+ K_CAPSLOCK + |
+
|
+ "Clear" + |
+
+ K_CLEAR + |
+
|
+ "Clear / Again" + |
+
+ K_CLEARAGAIN + |
+
|
+ "," + |
+
+ K_COMMA + |
+
|
+ "Computer" (the My Computer key) + |
+
+ K_COMPUTER + |
+
|
+ "Copy" + |
+
+ K_COPY + |
+
|
+ "CrSel" + |
+
+ K_CRSEL + |
+
|
+ "CurrencySubUnit" (the Currency Subunit key) + |
+
+ K_CURRENCYSUBUNIT + |
+
|
+ "CurrencyUnit" (the Currency Unit key) + |
+
+ K_CURRENCYUNIT + |
+
|
+ "Cut" + |
+
+ K_CUT + |
+
|
+ "D" + |
+
+ K_D + |
+
|
+ "DecimalSeparator" (the Decimal Separator key) + |
+
+ K_DECIMALSEPARATOR + |
+
|
+ "Delete" + |
+
+ K_DELETE + |
+
|
+ "DisplaySwitch" (display mirroring/dual display + switch, video mode switch) + |
+
+ K_DISPLAYSWITCH + |
+
|
+ "Down" (the Down arrow key (navigation keypad)) + |
+
+ K_DOWN + |
+
|
+ "E" + |
+
+ K_E + |
+
|
+ "Eject" (the Eject key) + |
+
+ K_EJECT + |
+
|
+ "End" + |
+
+ K_END + |
+
|
+ "=" + |
+
+ K_EQUALS + |
+
|
+ "Escape" (the Esc key) + |
+
+ K_ESCAPE + |
+
|
+ "Execute" + |
+
+ K_EXECUTE + |
+
|
+ "ExSel" + |
+
+ K_EXSEL + |
+
|
+ "F" + |
+
+ K_F + |
+
|
+ "F1" + |
+
+ K_F1 + |
+
|
+ "F10" + |
+
+ K_F10 + |
+
|
+ "F11" + |
+
+ K_F11 + |
+
|
+ "F12" + |
+
+ K_F12 + |
+
|
+ "F13" + |
+
+ K_F13 + |
+
|
+ "F14" + |
+
+ K_F14 + |
+
|
+ "F15" + |
+
+ K_F15 + |
+
|
+ "F16" + |
+
+ K_F16 + |
+
|
+ "F17" + |
+
+ K_F17 + |
+
|
+ "F18" + |
+
+ K_F18 + |
+
|
+ "F19" + |
+
+ K_F19 + |
+
|
+ "F2" + |
+
+ K_F2 + |
+
|
+ "F20" + |
+
+ K_F20 + |
+
|
+ "F21" + |
+
+ K_F21 + |
+
|
+ "F22" + |
+
+ K_F22 + |
+
|
+ "F23" + |
+
+ K_F23 + |
+
|
+ "F24" + |
+
+ K_F24 + |
+
|
+ "F3" + |
+
+ K_F3 + |
+
|
+ "F4" + |
+
+ K_F4 + |
+
|
+ "F5" + |
+
+ K_F5 + |
+
|
+ "F6" + |
+
+ K_F6 + |
+
|
+ "F7" + |
+
+ K_F7 + |
+
|
+ "F8" + |
+
+ K_F8 + |
+
|
+ "F9" + |
+
+ K_F9 + |
+
|
+ "Find" + |
+
+ K_FIND + |
+
|
+ "G" + |
+
+ K_G + |
+
|
+ "`" (Located in the top left corner (on both + ANSI and ISO keyboards). Produces GRAVE ACCENT and TILDE in a US + Windows layout and in US and UK Mac layouts on ANSI keyboards, + GRAVE ACCENT and NOT SIGN in a UK Windows layout, SECTION SIGN and + PLUS-MINUS SIGN in US and UK Mac layouts on ISO keyboards, SECTION + SIGN and DEGREE SIGN in a Swiss German layout (Mac: only on ISO + keyboards), CIRCUMFLEX ACCENT and DEGREE SIGN in a German layout + (Mac: only on ISO keyboards), SUPERSCRIPT TWO and TILDE in a + French Windows layout, COMMERCIAL AT and NUMBER SIGN in a French + Mac layout on ISO keyboards, and LESS-THAN SIGN and GREATER-THAN + SIGN in a Swiss German, German, or French Mac layout on ANSI + keyboards.) + |
+
+ K_GRAVE + |
+
|
+ "H" + |
+
+ K_H + |
+
|
+ "Help" + |
+
+ K_HELP + |
+
|
+ "Home" + |
+
+ K_HOME + |
+
|
+ "I" + |
+
+ K_I + |
+
|
+ "Insert" (insert on PC, help on some Mac + keyboards (but does send code 73, not 117)) + |
+
+ K_INSERT + |
+
|
+ "J" + |
+
+ K_J + |
+
|
+ "K" + |
+
+ K_K + |
+
|
+ "KBDIllumDown" (the Keyboard Illumination Down + key) + |
+
+ K_KBDILLUMDOWN + |
+
|
+ "KBDIllumToggle" (the Keyboard Illumination + Toggle key) + |
+
+ K_KBDILLUMTOGGLE + |
+
|
+ "KBDIllumUp" (the Keyboard Illumination Up key) + |
+
+ K_KBDILLUMUP + |
+
|
+ "Keypad 0" (the 0 key (numeric keypad)) + |
+
+ KEYPAD_0 + |
+
|
+ "Keypad 00" (the 00 key (numeric keypad)) + |
+
+ KEYPAD_00 + |
+
|
+ "Keypad 000" (the 000 key (numeric keypad)) + |
+
+ KEYPAD_000 + |
+
|
+ "Keypad 1" (the 1 key (numeric keypad)) + |
+
+ KEYPAD_1 + |
+
|
+ "Keypad 2" (the 2 key (numeric keypad)) + |
+
+ KEYPAD_2 + |
+
|
+ "Keypad 3" (the 3 key (numeric keypad)) + |
+
+ KEYPAD_3 + |
+
|
+ "Keypad 4" (the 4 key (numeric keypad)) + |
+
+ KEYPAD_4 + |
+
|
+ "Keypad 5" (the 5 key (numeric keypad)) + |
+
+ KEYPAD_5 + |
+
|
+ "Keypad 6" (the 6 key (numeric keypad)) + |
+
+ KEYPAD_6 + |
+
|
+ "Keypad 7" (the 7 key (numeric keypad)) + |
+
+ KEYPAD_7 + |
+
|
+ "Keypad 8" (the 8 key (numeric keypad)) + |
+
+ KEYPAD_8 + |
+
|
+ "Keypad 9" (the 9 key (numeric keypad)) + |
+
+ KEYPAD_9 + |
+
|
+ "Keypad A" (the A key (numeric keypad)) + |
+
+ KEYPAD_A + |
+
|
+ "Keypad &" (the & key (numeric keypad)) + |
+
+ KEYPAD_AMPERSAND + |
+
|
+ "Keypad @" (the @ key (numeric keypad)) + |
+
+ KEYPAD_AT + |
+
|
+ "Keypad B" (the B key (numeric keypad)) + |
+
+ KEYPAD_B + |
+
|
+ "Keypad Backspace" (the Backspace key (numeric + keypad)) + |
+
+ KEYPAD_BACKSPACE + |
+
|
+ "Keypad Binary" (the Binary key (numeric + keypad)) + |
+
+ KEYPAD_BINARY + |
+
|
+ "Keypad C" (the C key (numeric keypad)) + |
+
+ KEYPAD_C + |
+
|
+ "Keypad Clear" (the Clear key (numeric keypad)) + |
+
+ KEYPAD_CLEAR + |
+
|
+ "Keypad ClearEntry" (the Clear Entry key + (numeric keypad)) + |
+
+ KEYPAD_CLEARENTRY + |
+
|
+ "Keypad :" (the : key (numeric keypad)) + |
+
+ KEYPAD_COLON + |
+
|
+ "Keypad ," (the Comma key (numeric keypad)) + |
+
+ KEYPAD_COMMA + |
+
|
+ "Keypad D" (the D key (numeric keypad)) + |
+
+ KEYPAD_D + |
+
|
+ "Keypad &&" (the && key (numeric + keypad)) + |
+
+ KEYPAD_DBLAMPERSAND + |
+
|
+ "Keypad ||" (the || key (numeric keypad)) + |
+
+ KEYPAD_DBLVERTICALBAR + |
+
|
+ "Keypad Decimal" (the Decimal key (numeric + keypad)) + |
+
+ KEYPAD_DECIMAL + |
+
|
+ "Keypad /" (the / key (numeric keypad)) + |
+
+ KEYPAD_DIVIDE + |
+
|
+ "Keypad E" (the E key (numeric keypad)) + |
+
+ KEYPAD_E + |
+
|
+ "Keypad Enter" (the Enter key (numeric keypad)) + |
+
+ KEYPAD_ENTER + |
+
|
+ "Keypad =" (the = key (numeric keypad)) + |
+
+ KEYPAD_EQUALS + |
+
|
+ "Keypad = (AS400)" (the Equals AS400 key + (numeric keypad)) + |
+
+ KEYPAD_EQUALSAS400 + |
+
|
+ "Keypad !" (the ! key (numeric keypad)) + |
+
+ KEYPAD_EXCLAM + |
+
|
+ "Keypad F" (the F key (numeric keypad)) + |
+
+ KEYPAD_F + |
+
|
+ "Keypad >" (the Greater key (numeric keypad)) + |
+
+ KEYPAD_GREATER + |
+
|
+ "Keypad #" (the # key (numeric keypad)) + |
+
+ KEYPAD_HASH + |
+
|
+ "Keypad Hexadecimal" (the Hexadecimal key + (numeric keypad)) + |
+
+ KEYPAD_HEXADECIMAL + |
+
|
+ "Keypad {" (the Left Brace key (numeric keypad)) + |
+
+ KEYPAD_LEFTBRACE + |
+
|
+ "Keypad (" (the Left Parenthesis key (numeric + keypad)) + |
+
+ KEYPAD_LEFTPAREN + |
+
|
+ "Keypad <" (the Less key (numeric keypad)) + |
+
+ KEYPAD_LESS + |
+
|
+ "Keypad MemAdd" (the Mem Add key (numeric + keypad)) + |
+
+ KEYPAD_MEMADD + |
+
|
+ "Keypad MemClear" (the Mem Clear key (numeric + keypad)) + |
+
+ KEYPAD_MEMCLEAR + |
+
|
+ "Keypad MemDivide" (the Mem Divide key (numeric + keypad)) + |
+
+ KEYPAD_MEMDIVIDE + |
+
|
+ "Keypad MemMultiply" (the Mem Multiply key + (numeric keypad)) + |
+
+ KEYPAD_MEMMULTIPLY + |
+
|
+ "Keypad MemRecall" (the Mem Recall key (numeric + keypad)) + |
+
+ KEYPAD_MEMRECALL + |
+
|
+ "Keypad MemStore" (the Mem Store key (numeric + keypad)) + |
+
+ KEYPAD_MEMSTORE + |
+
|
+ "Keypad MemSubtract" (the Mem Subtract key + (numeric keypad)) + |
+
+ KEYPAD_MEMSUBTRACT + |
+
|
+ "Keypad -" (the - key (numeric keypad)) + |
+
+ KEYPAD_MINUS + |
+
|
+ "Keypad *" (the * key (numeric keypad)) + |
+
+ KEYPAD_MULTIPLY + |
+
|
+ "Keypad Octal" (the Octal key (numeric keypad)) + |
+
+ KEYPAD_OCTAL + |
+
|
+ "Keypad %" (the Percent key (numeric keypad)) + |
+
+ KEYPAD_PERCENT + |
+
|
+ "Keypad ." (the . key (numeric keypad)) + |
+
+ KEYPAD_PERIOD + |
+
|
+ "Keypad +" (the + key (numeric keypad)) + |
+
+ KEYPAD_PLUS + |
+
|
+ "Keypad +/-" (the +/- key (numeric keypad)) + |
+
+ KEYPAD_PLUSMINUS + |
+
|
+ "Keypad ^" (the Power key (numeric keypad)) + |
+
+ KEYPAD_POWER + |
+
|
+ "Keypad }" (the Right Brace key (numeric + keypad)) + |
+
+ KEYPAD_RIGHTBRACE + |
+
|
+ "Keypad )" (the Right Parenthesis key (numeric + keypad)) + |
+
+ KEYPAD_RIGHTPAREN + |
+
|
+ "Keypad Space" (the Space key (numeric keypad)) + |
+
+ KEYPAD_SPACE + |
+
|
+ "Keypad Tab" (the Tab key (numeric keypad)) + |
+
+ KEYPAD_TAB + |
+
|
+ "Keypad |" (the | key (numeric keypad)) + |
+
+ KEYPAD_VERTICALBAR + |
+
|
+ "Keypad XOR" (the XOR key (numeric keypad)) + |
+
+ KEYPAD_XOR + |
+
|
+ "L" + |
+
+ K_L + |
+
|
+ "Left Alt" (alt, option) + |
+
+ K_LALT + |
+
|
+ "Left Ctrl" + |
+
+ K_LCTRL + |
+
|
+ "Left" (the Left arrow key (navigation keypad)) + |
+
+ K_LEFT + |
+
|
+ "[" + |
+
+ K_LEFTBRACKET + |
+
|
+ "Left GUI" (windows, command (apple), meta) + |
+
+ K_LGUI + |
+
|
+ "Left Shift" + |
+
+ K_LSHIFT + |
+
|
+ "M" + |
+
+ K_M + |
+
|
+ "Mail" (the Mail/eMail key) + |
+
+ K_MAIL + |
+
|
+ "MediaSelect" (the Media Select key) + |
+
+ K_MEDIASELECT + |
+
|
+ "Menu" + |
+
+ K_MENU + |
+
|
+ "-" + |
+
+ K_MINUS + |
+
|
+ "ModeSwitch" (I'm not sure if this is really not + covered by any of the above, but since there's a special KMOD_MODE + for it I'm adding it here) + |
+
+ K_MODE + |
+
|
+ "Mute" + |
+
+ K_MUTE + |
+
|
+ "N" + |
+
+ K_N + |
+
|
+ "Numlock" (the Num Lock key (PC) / the Clear key + (Mac)) + |
+
+ K_NUMLOCKCLEAR + |
+
|
+ "O" + |
+
+ K_O + |
+
|
+ "Oper" + |
+
+ K_OPER + |
+
|
+ "Out" + |
+
+ K_OUT + |
+
|
+ "P" + |
+
+ K_P + |
+
|
+ "PageDown" + |
+
+ K_PAGEDOWN + |
+
|
+ "PageUp" + |
+
+ K_PAGEUP + |
+
|
+ "Paste" + |
+
+ K_PASTE + |
+
|
+ "Pause" (the Pause / Break key) + |
+
+ K_PAUSE + |
+
|
+ "." + |
+
+ K_PERIOD + |
+
|
+ "Power" (The USB document says this is a status + flag, not a physical key - but some Mac keyboards do have a power + key.) + |
+
+ K_POWER + |
+
|
+ "PrintScreen" + |
+
+ K_PRINTSCREEN + |
+
|
+ "Prior" + |
+
+ K_PRIOR + |
+
|
+ "Q" + |
+
+ K_Q + |
+
|
+ "R" + |
+
+ K_R + |
+
|
+ "Right Alt" (alt gr, option) + |
+
+ K_RALT + |
+
|
+ "Right Ctrl" + |
+
+ K_RCTRL + |
+
|
+ "Return" (the Enter key (main keyboard)) + |
+
+ K_RETURN + |
+
|
+ "Return" + |
+
+ K_RETURN2 + |
+
|
+ "Right GUI" (windows, command (apple), meta) + |
+
+ K_RGUI + |
+
|
+ "Right" (the Right arrow key (navigation + keypad)) + |
+
+ K_RIGHT + |
+
|
+ "]" + |
+
+ K_RIGHTBRACKET + |
+
|
+ "Right Shift" + |
+
+ K_RSHIFT + |
+
|
+ "S" + |
+
+ K_S + |
+
|
+ "ScrollLock" + |
+
+ K_SCROLLLOCK + |
+
|
+ "Select" + |
+
+ K_SELECT + |
+
|
+ ";" + |
+
+ K_SEMICOLON + |
+
|
+ "Separator" + |
+
+ K_SEPARATOR + |
+
|
+ "/" + |
+
+ K_SLASH + |
+
|
+ "Sleep" (the Sleep key) + |
+
+ K_SLEEP + |
+
|
+ "Space" (the Space Bar key(s)) + |
+
+ K_SPACE + |
+
|
+ "Stop" + |
+
+ K_STOP + |
+
|
+ "SysReq" (the SysReq key) + |
+
+ K_SYSREQ + |
+
|
+ "T" + |
+
+ K_T + |
+
|
+ "Tab" (the Tab key) + |
+
+ K_TAB + |
+
|
+ "ThousandsSeparator" (the Thousands Separator + key) + |
+
+ K_THOUSANDSSEPARATOR + |
+
|
+ "U" + |
+
+ K_U + |
+
|
+ "Undo" + |
+
+ K_UNDO + |
+
|
+ "" (no name, empty string) + |
+
+ K_UNKNOWN + |
+
|
+ "Up" (the Up arrow key (navigation keypad)) + |
+
+ K_UP + |
+
|
+ "V" + |
+
+ K_V + |
+
|
+ "VolumeDown" + |
+
+ K_VOLUMEDOWN + |
+
|
+ "VolumeUp" + |
+
+ K_VOLUMEUP + |
+
|
+ "W" + |
+
+ K_W + |
+
|
+ "WWW" (the WWW/World Wide Web key) + |
+
+ K_WWW + |
+
|
+ "X" + |
+
+ K_X + |
+
|
+ "Y" + |
+
+ K_Y + |
+
|
+ "Z" + |
+
+ K_Z + |
+
| KEYWORD + |
+ DESCRIPTION + |
+ USAGE + |
+
| INCLUDE | +Include code from an external file. You can reference environment variables inside the include string with this syntax "${env_var}" | +INCLUDE <STRING_LITERAL> | +
| INCLUDE ONCE | +Tells the compiler to only include the current file once. | +INCLUDE ONCE | +
| IF | ELSEIF | ELSE | END IF | +Executes a block of code if an expression is true + NOTE: ELSEIF can be substituted for ELSE IF |
+ IF <EXPRESSION> THEN + ..... + ELSEIF <EXPRESSION> THEN + ..... + ELSE + ..... + END IF |
+
| SELECT | CASE | DEFAULT | + END SELECT |
+ Executes a block of code if a case is equal to the selection case | +SELECT CASE <EXPRESSION> + CASE <EXPRESSION> + ..... + DEFAULT + ..... + END SELECT |
+
| DO | LOOP | UNTIL | WHILE | +Executes a block of code while a + condition is true or until a condition is met | +DO + ..... + LOOP {UNTIL | WHILE} <EXPRESSION> |
+
| WHILE | WEND | +Executes a block of code while a condition is true | +WHILE <EXPRESSION> + ..... + WEND |
+
| FOR | TO | STEP | NEXT | +Sets a counter variable to an initial value and executes a block + of code until the counter variable has reached a peak value | +FOR <ID> = <EXPRESSION> TO <EXPRESSION>
+ {STEP} <EXPRESSION> + ..... + NEXT |
+
| EXIT | +Exits a loop | +EXIT { DO | FOR | WHILE } | +
| CONTINUE | +Jumps back to the start of a loop | +CONTINUE | +
| FUNCTION | RETURN | + END FUNCTION |
+ Creates a function | +FUNCTION <ID> ( {BYREF}<ID>, ...) + ..... + RETURN <EXPRESSION> + END FUNCTION |
+
| SUB | RETURN | END SUB | +Creates a Sub Routine | +SUB <ID> ( {BYREF} <ID>, ...) + ..... + {RETURN} + END SUB |
+
| Outputs Text to a console | +PRINT <EXPRESSION> | +|
| END | +Ends a program. Add a number expression after END to set the exit code. | +END END <EXPRESSION> |
+
| DIM | +Creates a variable or array | +DIM <ID> { [ } <EXPRESSION>{ ] } | +
| REDIM | +Resizes an array | +REDIM <ID> { [ } <EXPRESSION>{ ] } | +
| DELETE | +Deletes an array | +DELETE <ID> | +
| TRUE | +Constant that evaluates to NOT 0 | +TRUE | +
| FALSE | +Constant that evaluates to 0 | +FALSE | +
| KEYWORD + |
+ DESCRIPTION + |
+ USAGE + |
+
| INCLUDE | +Include code from an external file. You can reference environment variables inside the include string with this syntax "${env_var}" | +INCLUDE <STRING_LITERAL> | +
| INCLUDE ONCE | +Tells the compiler to only include the current file once. | +INCLUDE ONCE | +
| IF | ELSEIF | ELSE | END IF | +Executes a block of code if an expression is true + NOTE: ELSEIF can be substituted for ELSE IF |
+ IF <EXPRESSION> THEN + ..... + ELSEIF <EXPRESSION> THEN + ..... + ELSE + ..... + END IF |
+
| SELECT | CASE | DEFAULT | + END SELECT |
+ Executes a block of code if a case is equal to the selection case | +SELECT CASE <EXPRESSION> + CASE <EXPRESSION> + ..... + DEFAULT + ..... + END SELECT |
+
| DO | LOOP | UNTIL | WHILE | +Executes a block of code while a + condition is true or until a condition is met | +DO + ..... + LOOP {UNTIL | WHILE} <EXPRESSION> |
+
| WHILE | WEND | +Executes a block of code while a condition is true | +WHILE <EXPRESSION> + ..... + WEND |
+
| FOR | TO | STEP | NEXT | +Sets a counter variable to an initial value and executes a block + of code until the counter variable has reached a peak value | +FOR <ID> = <EXPRESSION> TO <EXPRESSION>
+ {STEP} <EXPRESSION> + ..... + NEXT |
+
| EXIT | +Exits a loop | +EXIT { DO | FOR | WHILE } | +
| CONTINUE | +Jumps back to the start of a loop | +CONTINUE | +
| FUNCTION | RETURN | + END FUNCTION |
+ Creates a function | +FUNCTION <ID> ( {BYREF}<ID>, ...) + ..... + RETURN <EXPRESSION> + END FUNCTION |
+
| SUB | RETURN | END SUB | +Creates a Sub Routine | +SUB <ID> ( {BYREF} <ID>, ...) + ..... + {RETURN} + END SUB |
+
| Outputs Text to a console | +PRINT <EXPRESSION> | +|
| END | +Ends a program. Add a number expression after END to set the exit code. | +END END <EXPRESSION> |
+
| DIM | +Creates a variable or array | +DIM <ID> { [ } <EXPRESSION>{ ] } | +
| REDIM | +Resizes an array | +REDIM <ID> { [ } <EXPRESSION>{ ] } | +
| DELETE | +Deletes an array | +DELETE <ID> | +
| TRUE | +Constant that evaluates to NOT 0 | +TRUE | +
| FALSE | +Constant that evaluates to 0 | +FALSE | +
+ 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 new file mode 100644 index 0000000..0cfc9c1 --- /dev/null +++ b/doc/doc_files/left.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..206d9ed --- /dev/null +++ b/doc/doc_files/len.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the number of characters in the given string +
++ Note: This function is the exact same as Length() +
+Related: + Length +
++ + + \ No newline at end of file diff --git a/doc/doc_files/length.html b/doc/doc_files/length.html new file mode 100644 index 0000000..80ff13f --- /dev/null +++ b/doc/doc_files/length.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the number of characters in the given string +
++ Note: This function is the exact same as Len() +
+Related: + Length +
++ + + \ No newline at end of file diff --git a/doc/doc_files/license.html b/doc/doc_files/license.html new file mode 100644 index 0000000..c59c270 --- /dev/null +++ b/doc/doc_files/license.html @@ -0,0 +1,32 @@ + + +
+ + ++ RCBasic is available under the zlib license : +
++ This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. +
++ Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: +
++ 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. +
++ 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. +
++ 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 new file mode 100644 index 0000000..9203c78 --- /dev/null +++ b/doc/doc_files/lightiscastingshadow.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if shadow casting is enabled for the given light +
+Related: + SetLightShadowCast +
++ + + \ No newline at end of file diff --git a/doc/doc_files/line.html b/doc/doc_files/line.html new file mode 100644 index 0000000..337dbc8 --- /dev/null +++ b/doc/doc_files/line.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a line +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loadan8.html b/doc/doc_files/loadan8.html new file mode 100644 index 0000000..a9091b8 --- /dev/null +++ b/doc/doc_files/loadan8.html @@ -0,0 +1,20 @@ + + +
+ + ++ Loads an an8 project and returns an id that can be used in LoadMeshFromAN8() +
+Related: + LoadMeshFromAN8 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loadfont.html b/doc/doc_files/loadfont.html new file mode 100644 index 0000000..7f6dbc9 --- /dev/null +++ b/doc/doc_files/loadfont.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..134134d --- /dev/null +++ b/doc/doc_files/loadimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..261dc7d --- /dev/null +++ b/doc/doc_files/loadimageex.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..70bc16d --- /dev/null +++ b/doc/doc_files/loadmesh.html @@ -0,0 +1,95 @@ + + +
+ + ++ Returns a mesh id for the loaded mesh +
++ Supported formats +
+Related: + LoadMeshFromArchive +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loadmeshfroman8.html b/doc/doc_files/loadmeshfroman8.html new file mode 100644 index 0000000..dbc4486 --- /dev/null +++ b/doc/doc_files/loadmeshfroman8.html @@ -0,0 +1,25 @@ + + +
+ + ++ 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 +
+Related: + LoadAN8 + LoadMesh + LoadMeshFromArchive +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loadmeshfromarchive.html b/doc/doc_files/loadmeshfromarchive.html new file mode 100644 index 0000000..52eb137 --- /dev/null +++ b/doc/doc_files/loadmeshfromarchive.html @@ -0,0 +1,95 @@ + + +
+ + ++ Returns a mesh id for the loaded mesh from an archive (*.zip, *.pak, etc.) +
++ Supported formats +
+Related: + LoadMesh +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loadmusic.html b/doc/doc_files/loadmusic.html new file mode 100644 index 0000000..92857fb --- /dev/null +++ b/doc/doc_files/loadmusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Loads a music track +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loadsound.html b/doc/doc_files/loadsound.html new file mode 100644 index 0000000..0f3cd47 --- /dev/null +++ b/doc/doc_files/loadsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1ee8c1e --- /dev/null +++ b/doc/doc_files/loadvideo.html @@ -0,0 +1,17 @@ + + +
+ + ++ Loads a video track +
++ + + \ No newline at end of file diff --git a/doc/doc_files/log.html b/doc/doc_files/log.html new file mode 100644 index 0000000..772da3a --- /dev/null +++ b/doc/doc_files/log.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the logarithm of a number. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loopactoranimation.html b/doc/doc_files/loopactoranimation.html new file mode 100644 index 0000000..834ce51 --- /dev/null +++ b/doc/doc_files/loopactoranimation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Enables or disables actor animation loop +
++ + + \ No newline at end of file diff --git a/doc/doc_files/loops.html b/doc/doc_files/loops.html new file mode 100644 index 0000000..f6f3be7 --- /dev/null +++ b/doc/doc_files/loops.html @@ -0,0 +1,83 @@ + + +
+ + ++ RC BASIC has 3 types of loops: FOR, WHILE, and DO. +
++ The FOR loop repeats a block of code and increments a counter each time it finishes the block between FOR and NEXT. When the counter reaches a certain value the FOR loop stops. +
+
+ For I = 1 To 5
+ Print I
+ Next
+
+ The above code will output the numbers 1 to 5 to the console. Optionally you could use the STEP keyword to set the number that the counter will increase by. Look at the following: +
+
+ For I = 1 To 5 Step 2
+ Print I
+ Next
+
+ The above code will output the numbers 1, 3, and 5 to the console. The STEP keyword increases I by 2 each time through the FOR loop. +
++ WHILE loops will execute a block of code while a certain condition is true. +
+
+ I = 0
+ While I < 5
+ Print I
+ I = I + 1
+ Wend
+
+ The above code will output the numbers 0 to 4. It will not output the number 5 because if ( I < 5 ) is false the loop will not repeat. +
++ The DO loop is similar to the WHILE loop with an exception. The WHILE loop checks for the loop condition at the start of the loop but the DO loop checks for the loop condition at the end of the loop. What this means is that a WHILE loop will never execute if the condition is false at the start but the DO loop is guaranteed to execute at least once before it checks if the condition was true or not. +
++ The DO loop is also unique in that it has 3 different forms. Here is the simplest form of the DO loop. +
+
+ Do
+ Print "HELLO WORLD"
+ Loop
+
+ The code above will continue to output HELLO WORLD to the console infinitely. +
+
+ I = 0
+ Do
+ Print I
+ I = I + 1
+ Loop While I < 5
+
+ The above code will output the numbers 0 to 4 to the console. This form of the DO loop will continue to loop while the loop condition is true. +
+
+ I = 0
+ Do
+ Print I
+ I = I + 1
+ Loop Until I = 5
+
+ 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 new file mode 100644 index 0000000..eaeefe6 --- /dev/null +++ b/doc/doc_files/ltrim.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with all the spaces before the first non-space character removed. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/makedir.html b/doc/doc_files/makedir.html new file mode 100644 index 0000000..79585d6 --- /dev/null +++ b/doc/doc_files/makedir.html @@ -0,0 +1,17 @@ + + +
+ + ++ Creates a new directory. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/materialexists.html b/doc/doc_files/materialexists.html new file mode 100644 index 0000000..28d8e90 --- /dev/null +++ b/doc/doc_files/materialexists.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/materialisaplhablend.html b/doc/doc_files/materialisaplhablend.html new file mode 100644 index 0000000..30353a3 --- /dev/null +++ b/doc/doc_files/materialisaplhablend.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e889bb9 --- /dev/null +++ b/doc/doc_files/materialisgouraudshaded.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..30c2f01 --- /dev/null +++ b/doc/doc_files/materialislit.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if a material is affected by lights in the scene +
+Related: + SetMaterialLighting +
++ + + \ No newline at end of file diff --git a/doc/doc_files/materialisnormalized.html b/doc/doc_files/materialisnormalized.html new file mode 100644 index 0000000..34cf5a2 --- /dev/null +++ b/doc/doc_files/materialisnormalized.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d71a5e0 --- /dev/null +++ b/doc/doc_files/materialispointcloud.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e16d041 --- /dev/null +++ b/doc/doc_files/materialistransparent.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0a706d7 --- /dev/null +++ b/doc/doc_files/materialiswireframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c710863 --- /dev/null +++ b/doc/doc_files/matrixfrombuffer.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/matrixvalue.html b/doc/doc_files/matrixvalue.html new file mode 100644 index 0000000..6e1c269 --- /dev/null +++ b/doc/doc_files/matrixvalue.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6624701 --- /dev/null +++ b/doc/doc_files/max.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the highest of two numbers. +
+Related: + Min +
++ + + \ No newline at end of file diff --git a/doc/doc_files/maximizewindow.html b/doc/doc_files/maximizewindow.html new file mode 100644 index 0000000..9de4ccd --- /dev/null +++ b/doc/doc_files/maximizewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Maximizes the window +
++ + + \ No newline at end of file diff --git a/doc/doc_files/messagebox.html b/doc/doc_files/messagebox.html new file mode 100644 index 0000000..d7b1f94 --- /dev/null +++ b/doc/doc_files/messagebox.html @@ -0,0 +1,17 @@ + + +
+ + ++ Displays a message box +
++ + + \ No newline at end of file diff --git a/doc/doc_files/mid.html b/doc/doc_files/mid.html new file mode 100644 index 0000000..d772a11 --- /dev/null +++ b/doc/doc_files/mid.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..04397c2 --- /dev/null +++ b/doc/doc_files/min.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the lowest of two numbers. +
+Related: + Max +
++ + + \ No newline at end of file diff --git a/doc/doc_files/minimizewindow.html b/doc/doc_files/minimizewindow.html new file mode 100644 index 0000000..c8fec6c --- /dev/null +++ b/doc/doc_files/minimizewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Minimizes the window +
++ + + \ No newline at end of file diff --git a/doc/doc_files/mousebutton.html b/doc/doc_files/mousebutton.html new file mode 100644 index 0000000..c3e33ee --- /dev/null +++ b/doc/doc_files/mousebutton.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..cabdca0 --- /dev/null +++ b/doc/doc_files/mouseisvisible.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns true if mouse cursor is shown +
+Related: + ShowMouse + HideMouse +
++ + + \ No newline at end of file diff --git a/doc/doc_files/mousewheelx.html b/doc/doc_files/mousewheelx.html new file mode 100644 index 0000000..54151f6 --- /dev/null +++ b/doc/doc_files/mousewheelx.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2dcfa4f --- /dev/null +++ b/doc/doc_files/mousewheely.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4c1bd58 --- /dev/null +++ b/doc/doc_files/mousex.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..eef1ed6 --- /dev/null +++ b/doc/doc_files/mousey.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3360ea1 --- /dev/null +++ b/doc/doc_files/movefile.html @@ -0,0 +1,20 @@ + + +
+ + ++ Moves a file on the system. +
++ 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 new file mode 100644 index 0000000..6e6c36a --- /dev/null +++ b/doc/doc_files/multiplymatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b93109c --- /dev/null +++ b/doc/doc_files/musicexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..92448dd --- /dev/null +++ b/doc/doc_files/musicisplaying.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5829f22 --- /dev/null +++ b/doc/doc_files/nav_bottom.html @@ -0,0 +1,2439 @@ + + + +
+ + + + ++ Returns the number of accelerometer sensors detected +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numactoranimationloops.html b/doc/doc_files/numactoranimationloops.html new file mode 100644 index 0000000..faa1a31 --- /dev/null +++ b/doc/doc_files/numactoranimationloops.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the total number of loops the actor is set to repeat the animation for +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numberarraycopy.html b/doc/doc_files/numberarraycopy.html new file mode 100644 index 0000000..b904d54 --- /dev/null +++ b/doc/doc_files/numberarraycopy.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayCopy() +
+Related: + ArrayCopy +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numberarraydim.html b/doc/doc_files/numberarraydim.html new file mode 100644 index 0000000..ef20de6 --- /dev/null +++ b/doc/doc_files/numberarraydim.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayDim() +
+Related: + ArrayDim +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numberarrayfill.html b/doc/doc_files/numberarrayfill.html new file mode 100644 index 0000000..75c5692 --- /dev/null +++ b/doc/doc_files/numberarrayfill.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayFill() +
+Related: + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numberarraysize.html b/doc/doc_files/numberarraysize.html new file mode 100644 index 0000000..f58f8d9 --- /dev/null +++ b/doc/doc_files/numberarraysize.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArraySize() +
+Related: + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numcommands.html b/doc/doc_files/numcommands.html new file mode 100644 index 0000000..4ed7c27 --- /dev/null +++ b/doc/doc_files/numcommands.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of command line arguments passed to the program on start +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numcpus.html b/doc/doc_files/numcpus.html new file mode 100644 index 0000000..c55826f --- /dev/null +++ b/doc/doc_files/numcpus.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of CPUs (ie. cores) available +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numfingers.html b/doc/doc_files/numfingers.html new file mode 100644 index 0000000..7a34f2b --- /dev/null +++ b/doc/doc_files/numfingers.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of fingers detected in the current touch event +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numgyros.html b/doc/doc_files/numgyros.html new file mode 100644 index 0000000..94b5eed --- /dev/null +++ b/doc/doc_files/numgyros.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number Gyros detected in the current touch event +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numjoyaxes.html b/doc/doc_files/numjoyaxes.html new file mode 100644 index 0000000..21e6653 --- /dev/null +++ b/doc/doc_files/numjoyaxes.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numjoybuttons.html b/doc/doc_files/numjoybuttons.html new file mode 100644 index 0000000..9c34d32 --- /dev/null +++ b/doc/doc_files/numjoybuttons.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of buttons on a joystick +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numjoyhats.html b/doc/doc_files/numjoyhats.html new file mode 100644 index 0000000..86c63ca --- /dev/null +++ b/doc/doc_files/numjoyhats.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of hats on a joystick +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numjoysticks.html b/doc/doc_files/numjoysticks.html new file mode 100644 index 0000000..3b1500e --- /dev/null +++ b/doc/doc_files/numjoysticks.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of joysticks detected +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numjoytrackballs.html b/doc/doc_files/numjoytrackballs.html new file mode 100644 index 0000000..6eed02e --- /dev/null +++ b/doc/doc_files/numjoytrackballs.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of trackballs detected on a joystick +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numsoundchannels.html b/doc/doc_files/numsoundchannels.html new file mode 100644 index 0000000..5bb039d --- /dev/null +++ b/doc/doc_files/numsoundchannels.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of sound channels available +
++ + + \ No newline at end of file diff --git a/doc/doc_files/numspriteanimationloops.html b/doc/doc_files/numspriteanimationloops.html new file mode 100644 index 0000000..678cf7a --- /dev/null +++ b/doc/doc_files/numspriteanimationloops.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the number of animation loops the actor has set +
+Related: + SetSpriteAnimationLoops + SetSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/opencanvas.html b/doc/doc_files/opencanvas.html new file mode 100644 index 0000000..a455282 --- /dev/null +++ b/doc/doc_files/opencanvas.html @@ -0,0 +1,35 @@ + + +
+ + ++ Returns a canvas for 2D drawing and text rendering +
+Related: + OpenCanvas3D + OpenCanvasSpriteLayer +
++ + + \ No newline at end of file diff --git a/doc/doc_files/opencanvas3d.html b/doc/doc_files/opencanvas3d.html new file mode 100644 index 0000000..eb07abb --- /dev/null +++ b/doc/doc_files/opencanvas3d.html @@ -0,0 +1,30 @@ + + +
+ + ++ Returns a 3D Canvas for viewing the scene. +
++ Returns -1 if canvas could not be created. +
++ Note: Each 3D canvas has its own camera so you need to make sure you have the canvas active before doing anything with the camera +
++ Note: 2D drawing commands do not work on 3D canvases. You need to open a 2D canvas for drawing images. +
+Related: + OpenCanvas + OpenCanvasSpriteLayer +
++ + + \ No newline at end of file diff --git a/doc/doc_files/opencanvasspritelayer.html b/doc/doc_files/opencanvasspritelayer.html new file mode 100644 index 0000000..eb20172 --- /dev/null +++ b/doc/doc_files/opencanvasspritelayer.html @@ -0,0 +1,27 @@ + + +
+ + ++ Returns a sprite layer. These canvases are used for rendering sprites with the integrated physics engine. +
++ Returns -1 if canvas could not be created. +
++ Note: Sprite Layer must be active when creating sprites. +
+Related: + OpenCanvas + OpenCanvas3D +
++ + + \ No newline at end of file diff --git a/doc/doc_files/openfile.html b/doc/doc_files/openfile.html new file mode 100644 index 0000000..ff67eff --- /dev/null +++ b/doc/doc_files/openfile.html @@ -0,0 +1,66 @@ + + +
+ + ++ Returns an ID for an open file to read or write. +
++ Returns -1 if the file could not be opened. +
++ Possible Text Modes +
+
+
Possible Binary Modes
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/openspritecanvas.html b/doc/doc_files/openspritecanvas.html new file mode 100644 index 0000000..bb95fec --- /dev/null +++ b/doc/doc_files/openspritecanvas.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/openurl.html b/doc/doc_files/openurl.html new file mode 100644 index 0000000..09639c0 --- /dev/null +++ b/doc/doc_files/openurl.html @@ -0,0 +1,17 @@ + + +
+ + ++ Opens a URL in the internet browser +
++ + + \ No newline at end of file diff --git a/doc/doc_files/openwindow.html b/doc/doc_files/openwindow.html new file mode 100644 index 0000000..0948563 --- /dev/null +++ b/doc/doc_files/openwindow.html @@ -0,0 +1,23 @@ + + +
+ + ++ Opens a graphics window +
++ Returns true if window was opened and false if a window could not be opened +
+Related: + OpenWindowEx +
++ + + \ No newline at end of file diff --git a/doc/doc_files/openwindowex.html b/doc/doc_files/openwindowex.html new file mode 100644 index 0000000..37bb333 --- /dev/null +++ b/doc/doc_files/openwindowex.html @@ -0,0 +1,41 @@ + + +
+ + ++ Opens a graphics window +
++ Returns true if window was opened and false if a window could not be opened +
+Related: + OpenWindow + WindowMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/operators.html b/doc/doc_files/operators.html new file mode 100644 index 0000000..ef336f4 --- /dev/null +++ b/doc/doc_files/operators.html @@ -0,0 +1,136 @@ + +
+ + + +| OPERATORS | +DESCRIPTION | +EXAMPLE | +
| ADDITION ( + ) | +ADDS TWO NUMBERS | +1 + 2 | +
| SUBTRACTION ( - ) | +SUBTRACTS ONE NUMBER FROM ANOTHER | +1 - 2 | +
| MULTIPLICATION ( * ) | +MULTIPLIES TWO NUMBERS | +1 * 2 | +
| DIVISION ( / ) | +DIVIDES ONE NUMBER BY ANOTHER | +1 / 2 | +
| EXPONENT ( ^ ) | +RAISES ONE NUMBER TO THE POWER OF + ANOTHER | +1^2 | +
| GREATER ( > ) | +RETURNS TRUE IF THE FIRST NUMBER IS GREATER THAN THE SECOND | +1 > 2 (RETURNS FALSE) + + 2 > 1 (RETURNS TRUE) |
+
| LESS ( < ) | +RETURNS TRUE IF THE FIRST NUMBER IS LESS THAN THE SECOND | +1 < 2 (RETURNS TRUE) + + 2 < 1 (RETURNS FALSE) |
+
| GREATER OR EQUAL ( >= ) | +RETURNS TRUE IF THE FIRST NUMBER IS GREATER THAN OR EQUAL TO THE + SECOND | +1 >= 2 (RETURNS FALSE) + + 1 >= 1 (RETURNS TRUE) + + 2 >= 1 (RETURNS TRUE) |
+
| LESS OR EQUAL ( <= ) | +RETURNS TRUE IF THE FIRST NUMBER IS LESS THAN OR EQUAL TO THE + SECOND | +1 <= 2 (RETURNS TRUE) + + 1 <= 1 (RETURNS TRUE) + + 2 <= 1 (RETURNS FALSE) |
+
| EQUAL ( = ) | +RETURNS TRUE IF BOTH VALUES ARE EQUAL | +1 = 2 (RETURNS FALSE) + + 1 = 1 (RETURNS TRUE) |
+
| NOT EQUAL ( <> ) | +RETURNS TRUE IF BOTH VALUES ARE NOT EQUAL | +1 <> 2 (RETURNS TRUE) + + 1 <> 1 (RETURNS FALSE) |
+
| MODULOUS ( MOD ) | +RETURNS THE REMAINDER OF THE FIRST NUMBER DIVIDED BY THE SECOND | +1 MOD 2 (RETURNS 1) | +
| SHIFT LEFT ( SHL ) | +SHIFTS THE BITS IN A NUMBER TO THE LEFT | +1 SHL 2 (RETURNS 4) | +
| SHIFT RIGHT ( SHR ) | +SHIFTS THE BITS IN A NUMBER TO THE RIGHT | +4 SHR 2 (RETURNS 1) | +
| AND | +CONDUCTS AND COMPARISON OF TWO VALUES | +1 AND 1 | +
| OR | +CONDUCTS OR COMPARISON OF TWO VALUES | +1 OR 1 | +
| XOR | +CONDUCTS EXCLUSIVE-OR COMPARISON OF TWO VALUES | +1 XOR 1 | +
| NOT | +CONDUCTS NOT OPERATION ON A VALUE | +NOT 1 | +
| STRING ADD ( + ) | +COMBINES TWO STRING VALUES | ++ "HELLO"+"WORLD" | +
| END OF INSTRUCTION ( : ) | +TELLS COMPILER TO END CURRENT INSTRUCTION AND READ THE FOLLOWING CODE AS NEW INSTRUCTION | +X = 5: PRINT X | +
+ Returns the value of the bitwise OR operation on the operands A and B +
++ + + \ No newline at end of file diff --git a/doc/doc_files/os.html b/doc/doc_files/os.html new file mode 100644 index 0000000..49d8c68 --- /dev/null +++ b/doc/doc_files/os.html @@ -0,0 +1,43 @@ + + +
+ + ++ Returns the runtimes native operating system. +
++ Possible Return Values +
++ 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" +
++ + + \ No newline at end of file diff --git a/doc/doc_files/particleisusingeverymeshvertex.html b/doc/doc_files/particleisusingeverymeshvertex.html new file mode 100644 index 0000000..6cba404 --- /dev/null +++ b/doc/doc_files/particleisusingeverymeshvertex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if emitter emits min<->max particles for every vertex or to pick min<->max vertices. +
+Related: + useParticleEveryMeshVertex +
++ + + \ No newline at end of file diff --git a/doc/doc_files/particleisusingnormaldirection.html b/doc/doc_files/particleisusingnormaldirection.html new file mode 100644 index 0000000..366f7c2 --- /dev/null +++ b/doc/doc_files/particleisusingnormaldirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if particle emitter is using vertex normal for direction, or direction specified. +
+Related: + useParticleNormalDirection +
++ + + \ No newline at end of file diff --git a/doc/doc_files/particleisusingoutlineonly.html b/doc/doc_files/particleisusingoutlineonly.html new file mode 100644 index 0000000..ac8c2f7 --- /dev/null +++ b/doc/doc_files/particleisusingoutlineonly.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns true if not using draw points inside the cylinder +
++ Note: Only applies to cylinder emitter +
+Related: + useParticleOutlineOnly +
++ + + \ No newline at end of file diff --git a/doc/doc_files/pausemusic.html b/doc/doc_files/pausemusic.html new file mode 100644 index 0000000..0bc4b09 --- /dev/null +++ b/doc/doc_files/pausemusic.html @@ -0,0 +1,21 @@ + + +
+ + ++ Pauses the currently loaded music track. Unlike StopMusic(), paused music can be resumed from its current position. +
+Related: + ResumeMusic + StopMusic +
++ + + \ No newline at end of file diff --git a/doc/doc_files/pausesound.html b/doc/doc_files/pausesound.html new file mode 100644 index 0000000..004094c --- /dev/null +++ b/doc/doc_files/pausesound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Pauses a sound at its current position. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/pausevideo.html b/doc/doc_files/pausevideo.html new file mode 100644 index 0000000..302c6e2 --- /dev/null +++ b/doc/doc_files/pausevideo.html @@ -0,0 +1,17 @@ + + +
+ + ++ Pauses the currently loaded video track +
++ + + \ No newline at end of file diff --git a/doc/doc_files/playmusic.html b/doc/doc_files/playmusic.html new file mode 100644 index 0000000..30508cc --- /dev/null +++ b/doc/doc_files/playmusic.html @@ -0,0 +1,26 @@ + + +
+ + ++ Plays music for set number of loops. +
++ Note: If you only want to play the music once, set this to 0. +
++ Note: Set this to -1 to play infinitely. +
+Related: + StopMusic +
++ + + \ No newline at end of file diff --git a/doc/doc_files/playsound.html b/doc/doc_files/playsound.html new file mode 100644 index 0000000..2ea7d2a --- /dev/null +++ b/doc/doc_files/playsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Plays a sound on the given channel for the given number of loops. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/playsoundtimed.html b/doc/doc_files/playsoundtimed.html new file mode 100644 index 0000000..24df3ab --- /dev/null +++ b/doc/doc_files/playsoundtimed.html @@ -0,0 +1,17 @@ + + +
+ + ++ Plays sound for a given number of loops until the given number of milliseconds is reached. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/playvideo.html b/doc/doc_files/playvideo.html new file mode 100644 index 0000000..23a21b6 --- /dev/null +++ b/doc/doc_files/playvideo.html @@ -0,0 +1,26 @@ + + +
+ + ++ Plays the currently loaded video for a set number of loops. +
++ Note: Set this to 0 to play the video once. +
++ Note: Set this to -1 to the video infinitely. +
+Related: + StopVideo +
++ + + \ No newline at end of file diff --git a/doc/doc_files/pointinquad.html b/doc/doc_files/pointinquad.html new file mode 100644 index 0000000..e6dbc63 --- /dev/null +++ b/doc/doc_files/pointinquad.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the point (px, py) is in the quad (x1, y1) to (x4, y4) +
++ + + \ No newline at end of file diff --git a/doc/doc_files/pointintri.html b/doc/doc_files/pointintri.html new file mode 100644 index 0000000..5d3ea4a --- /dev/null +++ b/doc/doc_files/pointintri.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the point (px, py) is in the quad (x1, y1) to (x3, y3) +
++ + + \ No newline at end of file diff --git a/doc/doc_files/poly.html b/doc/doc_files/poly.html new file mode 100644 index 0000000..5aee9d4 --- /dev/null +++ b/doc/doc_files/poly.html @@ -0,0 +1,33 @@ + + +
+ + ++ Draws a polygon +
+
+ Dim x[3], y[3]
+ x[0] = 50 : y[0] = 50
+ x[1] = 90 : y[1] = 90
+ x[2] = 10 : y[1] = 90
+
+ Poly(3, x, y) 'Draws a triangle
+
+ + + \ No newline at end of file diff --git a/doc/doc_files/pop_n.html b/doc/doc_files/pop_n.html new file mode 100644 index 0000000..10b41bd --- /dev/null +++ b/doc/doc_files/pop_n.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes the top number off a number stack and returns it +
+Related: + Push_N +
++ + + \ No newline at end of file diff --git a/doc/doc_files/pop_s.html b/doc/doc_files/pop_s.html new file mode 100644 index 0000000..c710f63 --- /dev/null +++ b/doc/doc_files/pop_s.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes the top string off a string stack and returns it +
+Related: + Push_S +
++ + + \ No newline at end of file diff --git a/doc/doc_files/prefpath.html b/doc/doc_files/prefpath.html new file mode 100644 index 0000000..9294b7b --- /dev/null +++ b/doc/doc_files/prefpath.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the preferred path for storing files. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/preupdate.html b/doc/doc_files/preupdate.html new file mode 100644 index 0000000..b52ca13 --- /dev/null +++ b/doc/doc_files/preupdate.html @@ -0,0 +1,23 @@ + + +
+ + ++ Processes physics for sprites and actors. +
++ This is useful if you need to know the post solve positions and rotations prior to drawing them. +
+Related: + Update +
++ + + \ No newline at end of file diff --git a/doc/doc_files/pset.html b/doc/doc_files/pset.html new file mode 100644 index 0000000..dca51ca --- /dev/null +++ b/doc/doc_files/pset.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a pixel +
++ + + \ No newline at end of file diff --git a/doc/doc_files/push_n.html b/doc/doc_files/push_n.html new file mode 100644 index 0000000..8573bfe --- /dev/null +++ b/doc/doc_files/push_n.html @@ -0,0 +1,20 @@ + + +
+ + ++ Pushes a number onto a number stack +
+Related: + Pop_N +
++ + + \ No newline at end of file diff --git a/doc/doc_files/push_s.html b/doc/doc_files/push_s.html new file mode 100644 index 0000000..72b28f3 --- /dev/null +++ b/doc/doc_files/push_s.html @@ -0,0 +1,20 @@ + + +
+ + ++ Pushes a string onto a string stack +
+Related: + Pop_S +
++ + + \ No newline at end of file diff --git a/doc/doc_files/queryaudiospec.html b/doc/doc_files/queryaudiospec.html new file mode 100644 index 0000000..019d57a --- /dev/null +++ b/doc/doc_files/queryaudiospec.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the frequency, output format, and number of channels for the audio device being used. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/radians.html b/doc/doc_files/radians.html new file mode 100644 index 0000000..bda2bd4 --- /dev/null +++ b/doc/doc_files/radians.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns an angle converted from degrees to radians +
++ + + \ No newline at end of file diff --git a/doc/doc_files/raisewindow.html b/doc/doc_files/raisewindow.html new file mode 100644 index 0000000..dad4828 --- /dev/null +++ b/doc/doc_files/raisewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Places the current window on top of the other windows. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rand.html b/doc/doc_files/rand.html new file mode 100644 index 0000000..33190bf --- /dev/null +++ b/doc/doc_files/rand.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a random number between 0 and n. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/randomize.html b/doc/doc_files/randomize.html new file mode 100644 index 0000000..704a9f1 --- /dev/null +++ b/doc/doc_files/randomize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Seeds the random number generator +
++ + + \ No newline at end of file diff --git a/doc/doc_files/randomizematrix.html b/doc/doc_files/randomizematrix.html new file mode 100644 index 0000000..ab0a269 --- /dev/null +++ b/doc/doc_files/randomizematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores random values between vmin and vmax in the matrix mA +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rc_cover_page.html b/doc/doc_files/rc_cover_page.html new file mode 100755 index 0000000..0b8d669 --- /dev/null +++ b/doc/doc_files/rc_cover_page.html @@ -0,0 +1,19 @@ + +
+ + + +
+ Reads a byte from a file. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readbytebuffer.html b/doc/doc_files/readbytebuffer.html new file mode 100644 index 0000000..81f9ac9 --- /dev/null +++ b/doc/doc_files/readbytebuffer.html @@ -0,0 +1,31 @@ + + +
+ + ++ Reads a number of bytes from a file stream to an array. +
+Related: + ReadByte +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readinput_settext.html b/doc/doc_files/readinput_settext.html new file mode 100644 index 0000000..8bf830d --- /dev/null +++ b/doc/doc_files/readinput_settext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the text in the ReadInput buffer. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readinput_start.html b/doc/doc_files/readinput_start.html new file mode 100644 index 0000000..ef7d4c9 --- /dev/null +++ b/doc/doc_files/readinput_start.html @@ -0,0 +1,17 @@ + + +
+ + ++ Start reading input from the keyboard. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readinput_stop.html b/doc/doc_files/readinput_stop.html new file mode 100644 index 0000000..daa4832 --- /dev/null +++ b/doc/doc_files/readinput_stop.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stops reading input from the keyboard. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readinput_text.html b/doc/doc_files/readinput_text.html new file mode 100644 index 0000000..d7cf0c5 --- /dev/null +++ b/doc/doc_files/readinput_text.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the text read from the keyboard. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readinput_togglebackspace.html b/doc/doc_files/readinput_togglebackspace.html new file mode 100644 index 0000000..5e944f6 --- /dev/null +++ b/doc/doc_files/readinput_togglebackspace.html @@ -0,0 +1,17 @@ + + +
+ + ++ Determines whether the backspace is applied during ReadInput events. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readline.html b/doc/doc_files/readline.html new file mode 100644 index 0000000..0ddb1ec --- /dev/null +++ b/doc/doc_files/readline.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current line in the file. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rect.html b/doc/doc_files/rect.html new file mode 100644 index 0000000..0f4b6d8 --- /dev/null +++ b/doc/doc_files/rect.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a rectangle to the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rectfill.html b/doc/doc_files/rectfill.html new file mode 100644 index 0000000..12826a9 --- /dev/null +++ b/doc/doc_files/rectfill.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a filled rectangle on the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/removeactorshadow.html b/doc/doc_files/removeactorshadow.html new file mode 100644 index 0000000..77422f1 --- /dev/null +++ b/doc/doc_files/removeactorshadow.html @@ -0,0 +1,20 @@ + + +
+ + ++ Stops shadow casting on an actor +
+Related: + AddActorShadow +
++ + + \ No newline at end of file diff --git a/doc/doc_files/removedir.html b/doc/doc_files/removedir.html new file mode 100644 index 0000000..1afb098 --- /dev/null +++ b/doc/doc_files/removedir.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a directory. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/removefile.html b/doc/doc_files/removefile.html new file mode 100644 index 0000000..b784ad4 --- /dev/null +++ b/doc/doc_files/removefile.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a file. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/removescenesky.html b/doc/doc_files/removescenesky.html new file mode 100644 index 0000000..4a780b1 --- /dev/null +++ b/doc/doc_files/removescenesky.html @@ -0,0 +1,22 @@ + + +
+ + ++ Removes the sky from the current 3D scene +
+Related: + AddSceneSkyBox + AddSceneSkyDome + AddSceneSkyDomeEx +
++ + + \ No newline at end of file diff --git a/doc/doc_files/renamefile.html b/doc/doc_files/renamefile.html new file mode 100644 index 0000000..afd1e17 --- /dev/null +++ b/doc/doc_files/renamefile.html @@ -0,0 +1,17 @@ + + +
+ + ++ Renames src$ file to dst$ file. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/replace.html b/doc/doc_files/replace.html new file mode 100644 index 0000000..944c221 --- /dev/null +++ b/doc/doc_files/replace.html @@ -0,0 +1,17 @@ + + +
+ + ++ Replaces all occurrences of tgt$ with rpc$. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/replacesubstr.html b/doc/doc_files/replacesubstr.html new file mode 100644 index 0000000..6d6cd59 --- /dev/null +++ b/doc/doc_files/replacesubstr.html @@ -0,0 +1,17 @@ + + +
+ + ++ Overwrites the characters at the given position in src$ with rpc$. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/restorewindow.html b/doc/doc_files/restorewindow.html new file mode 100644 index 0000000..049b24d --- /dev/null +++ b/doc/doc_files/restorewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Restores the window if minimized +
++ + + \ No newline at end of file diff --git a/doc/doc_files/resumemusic.html b/doc/doc_files/resumemusic.html new file mode 100644 index 0000000..769b616 --- /dev/null +++ b/doc/doc_files/resumemusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Resumes playing music. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/resumesound.html b/doc/doc_files/resumesound.html new file mode 100644 index 0000000..c4cda35 --- /dev/null +++ b/doc/doc_files/resumesound.html @@ -0,0 +1,20 @@ + + +
+ + ++ Resumes playing sound on the given channel. +
+Related: + PauseSound +
++ + + \ No newline at end of file diff --git a/doc/doc_files/resumevideo.html b/doc/doc_files/resumevideo.html new file mode 100644 index 0000000..2b97a66 --- /dev/null +++ b/doc/doc_files/resumevideo.html @@ -0,0 +1,20 @@ + + +
+ + ++ Resumes the video +
+Related: + PauseVideo +
++ + + \ No newline at end of file diff --git a/doc/doc_files/reverse.html b/doc/doc_files/reverse.html new file mode 100644 index 0000000..b9103fc --- /dev/null +++ b/doc/doc_files/reverse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with the characters in reverse order. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rewindmusic.html b/doc/doc_files/rewindmusic.html new file mode 100644 index 0000000..98096ee --- /dev/null +++ b/doc/doc_files/rewindmusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Rewinds the music track. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rgb.html b/doc/doc_files/rgb.html new file mode 100644 index 0000000..c953bb1 --- /dev/null +++ b/doc/doc_files/rgb.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a 32-bit color value. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rgba.html b/doc/doc_files/rgba.html new file mode 100644 index 0000000..e190b43 --- /dev/null +++ b/doc/doc_files/rgba.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a 32-bit color value. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/right.html b/doc/doc_files/right.html new file mode 100644 index 0000000..bb0ad52 --- /dev/null +++ b/doc/doc_files/right.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns n number of characters from the right side of src$. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rotateactor.html b/doc/doc_files/rotateactor.html new file mode 100644 index 0000000..be24335 --- /dev/null +++ b/doc/doc_files/rotateactor.html @@ -0,0 +1,21 @@ + + +
+ + ++ Rotates and actor a given number of degrees from its current orientation +
+Related: + SetActorRotation + GetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rotatecamera.html b/doc/doc_files/rotatecamera.html new file mode 100644 index 0000000..c8d27af --- /dev/null +++ b/doc/doc_files/rotatecamera.html @@ -0,0 +1,21 @@ + + +
+ + ++ Rotates the camera a given number of degrees from its current orientation +
+Related: + SetCameraRotation + GetCameraRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rotatesprite.html b/doc/doc_files/rotatesprite.html new file mode 100644 index 0000000..9d03bdb --- /dev/null +++ b/doc/doc_files/rotatesprite.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the angle the sprite is rotated by relative to its current rotation +
+Related: + SetSpriteRotation + GetSpriteRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/round.html b/doc/doc_files/round.html new file mode 100644 index 0000000..c150be5 --- /dev/null +++ b/doc/doc_files/round.html @@ -0,0 +1,17 @@ + + +
+ + ++ Rounds n to the nearest whole number. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/rtrim.html b/doc/doc_files/rtrim.html new file mode 100644 index 0000000..2cfea1a --- /dev/null +++ b/doc/doc_files/rtrim.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with all the spaces after the last non-space character removed. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/runtime.html b/doc/doc_files/runtime.html new file mode 100644 index 0000000..0b2322c --- /dev/null +++ b/doc/doc_files/runtime.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the path to the RCBasic runtime that launched the current program +
++ + + \ No newline at end of file diff --git a/doc/doc_files/runtime_utility_message.html b/doc/doc_files/runtime_utility_message.html new file mode 100644 index 0000000..4974d86 --- /dev/null +++ b/doc/doc_files/runtime_utility_message.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/scalarmatrix.html b/doc/doc_files/scalarmatrix.html new file mode 100644 index 0000000..003f199 --- /dev/null +++ b/doc/doc_files/scalarmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Multiplies values in matrix mA by scalar value and stores the results in mB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/scalarmatrixcolumns.html b/doc/doc_files/scalarmatrixcolumns.html new file mode 100644 index 0000000..447d3b9 --- /dev/null +++ b/doc/doc_files/scalarmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ Multiplies values in the specified columns of matrix mA by scalar value and stores the results in mB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/scalarmatrixrows.html b/doc/doc_files/scalarmatrixrows.html new file mode 100644 index 0000000..4f6d033 --- /dev/null +++ b/doc/doc_files/scalarmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ Multiplies values in the specified rows of matrix mA by scalar value and stores the results in mB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/scaleactor.html b/doc/doc_files/scaleactor.html new file mode 100644 index 0000000..2fdd549 --- /dev/null +++ b/doc/doc_files/scaleactor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Multiplies the actor's current scale by the vector given +
+Related: + SetActorScale +
++ + + \ No newline at end of file diff --git a/doc/doc_files/scalesprite.html b/doc/doc_files/scalesprite.html new file mode 100644 index 0000000..ab5e780 --- /dev/null +++ b/doc/doc_files/scalesprite.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the scale of a sprite relative to its current scale +
+Related: + SetSpriteScale + GetSpriteScale +
++ + + \ No newline at end of file diff --git a/doc/doc_files/scaleterraintexture.html b/doc/doc_files/scaleterraintexture.html new file mode 100644 index 0000000..e4f766a --- /dev/null +++ b/doc/doc_files/scaleterraintexture.html @@ -0,0 +1,25 @@ + + +
+ + ++ Scales the base texture, similar to makePlanarTextureMapping. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/scope.html b/doc/doc_files/scope.html new file mode 100644 index 0000000..56fc2a5 --- /dev/null +++ b/doc/doc_files/scope.html @@ -0,0 +1,30 @@ + + +
+ + ++ Scope refers to where you are able to access a variable. Basically variables cannot be accessed from outside the scope they are created in. Look at the following: +
+
+ A = 5
+
+ While A < 10
+ B = 1 '----- B is created inside this loop and cannot be accessed outside of this loop
+ A = A + 1 '----- A was created before this loop started so it will be able to be used after this loop ends
+ Wend
+
+ Print B
+
+ 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 new file mode 100644 index 0000000..b4d0282 --- /dev/null +++ b/doc/doc_files/seek.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the position within a file to read from or write to. +
+Related: + Tell +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorangularfactor.html b/doc/doc_files/setactorangularfactor.html new file mode 100644 index 0000000..8edd8fc --- /dev/null +++ b/doc/doc_files/setactorangularfactor.html @@ -0,0 +1,25 @@ + + +
+ + ++ Sets an actor's angular factor. +
++ The angular factor determines how the actor responds to angular velocity or torque. +
+Related: + GetActorAngularFactor + SetActorAngularFactor + SetActorLinearFactor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorangularvelocitylocal.html b/doc/doc_files/setactorangularvelocitylocal.html new file mode 100644 index 0000000..dd326d2 --- /dev/null +++ b/doc/doc_files/setactorangularvelocitylocal.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityWorld + GetActorAngularVelocityLocal + SetActorAngularVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorangularvelocityworld.html b/doc/doc_files/setactorangularvelocityworld.html new file mode 100644 index 0000000..568a1fd --- /dev/null +++ b/doc/doc_files/setactorangularvelocityworld.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityWorld + GetActorAngularVelocityLocal + SetActorAngularVelocityLocal +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactoranimation.html b/doc/doc_files/setactoranimation.html new file mode 100644 index 0000000..572de60 --- /dev/null +++ b/doc/doc_files/setactoranimation.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the current animation for an actor to start playing +
++ Notes on num_loops +
+Related: + CreateActorAnimation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactoranimationframes.html b/doc/doc_files/setactoranimationframes.html new file mode 100644 index 0000000..2e1687e --- /dev/null +++ b/doc/doc_files/setactoranimationframes.html @@ -0,0 +1,20 @@ + + +
+ + ++ Changes the frames that plays in an actor's animation +
+Related: + CreateActorAnimation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactoranimationspeed.html b/doc/doc_files/setactoranimationspeed.html new file mode 100644 index 0000000..20d9ced --- /dev/null +++ b/doc/doc_files/setactoranimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Set the FPS of an actor animation +
+Related: + GetActorAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorautoculling.html b/doc/doc_files/setactorautoculling.html new file mode 100644 index 0000000..b7bc3d6 --- /dev/null +++ b/doc/doc_files/setactorautoculling.html @@ -0,0 +1,40 @@ + + +
+ + ++ Sets the automatic culling state for an actor +
++ Possible Culling States +
+Related: + GetActorAutoCulling +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorcollisionshape.html b/doc/doc_files/setactorcollisionshape.html new file mode 100644 index 0000000..762c079 --- /dev/null +++ b/doc/doc_files/setactorcollisionshape.html @@ -0,0 +1,49 @@ + + +
+ + ++ Sets the actor's collision shape +
++ Shape Types: +
+Related: + GetActorCollisionShape +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactordamping.html b/doc/doc_files/setactordamping.html new file mode 100644 index 0000000..decd63e --- /dev/null +++ b/doc/doc_files/setactordamping.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the linear and angular damping for an actor +
+Related: + GetActorLinearDamping + GetActorAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorframe.html b/doc/doc_files/setactorframe.html new file mode 100644 index 0000000..abca648 --- /dev/null +++ b/doc/doc_files/setactorframe.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the current frame of an actor +
++ Note: This function will set the actor's animation to 0 which is a default 1 frame animation that is created when the actor is created. +
+Related: + GetActorFrame +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorgravity.html b/doc/doc_files/setactorgravity.html new file mode 100644 index 0000000..707fdf7 --- /dev/null +++ b/doc/doc_files/setactorgravity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the gravity vector of an actor. +
+Related: + SetGravity3D +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorinverseinertiadiaglocal.html b/doc/doc_files/setactorinverseinertiadiaglocal.html new file mode 100644 index 0000000..1d4290f --- /dev/null +++ b/doc/doc_files/setactorinverseinertiadiaglocal.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetActorInverseInertiaDiagLocal +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorlinearfactor.html b/doc/doc_files/setactorlinearfactor.html new file mode 100644 index 0000000..b4b4961 --- /dev/null +++ b/doc/doc_files/setactorlinearfactor.html @@ -0,0 +1,25 @@ + + +
+ + ++ Sets an actor's linear factor. +
++ The linear factor determines how the actor responds to linear velocity or force. +
+Related: + GetActorLinearFactor + SetActorAngularFactor + GetActorAngularFactor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorlinearvelocitylocal.html b/doc/doc_files/setactorlinearvelocitylocal.html new file mode 100644 index 0000000..40bddcc --- /dev/null +++ b/doc/doc_files/setactorlinearvelocitylocal.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets actor's linear velocity +
+Related: + GetActorLinearVelocityLocal + SetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorlinearvelocityworld.html b/doc/doc_files/setactorlinearvelocityworld.html new file mode 100644 index 0000000..c98f700 --- /dev/null +++ b/doc/doc_files/setactorlinearvelocityworld.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets actor's linear velocity +
+Related: + SetActorLinearVelocityLocal + GetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactormassproperties.html b/doc/doc_files/setactormassproperties.html new file mode 100644 index 0000000..1453fc5 --- /dev/null +++ b/doc/doc_files/setactormassproperties.html @@ -0,0 +1,40 @@ + + +
+ + ++ 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. +
++ Mass +
++ Inertial +
+Related: + GetActorLocalInertia + GetActorInverseMass +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactormaterial.html b/doc/doc_files/setactormaterial.html new file mode 100644 index 0000000..cbc4d92 --- /dev/null +++ b/doc/doc_files/setactormaterial.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + GetActorMaterial +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactormaterialflag.html b/doc/doc_files/setactormaterialflag.html new file mode 100644 index 0000000..96167af --- /dev/null +++ b/doc/doc_files/setactormaterialflag.html @@ -0,0 +1,89 @@ + + +
+ + ++ Sets the value of an actor's material flag. +
++ Note: The material on this would be material 0. To set other material flag's you need to get a reference to the actor's material with GetActorMaterial(). +
++ Possible values for flag: +
+Related: + GetActorMaterialFlag + GetActorMaterial +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactormaterialtype.html b/doc/doc_files/setactormaterialtype.html new file mode 100644 index 0000000..d0d5809 --- /dev/null +++ b/doc/doc_files/setactormaterialtype.html @@ -0,0 +1,104 @@ + + +
+ + ++ Sets the material type of an actor material +
++ Note: This will set material 0. If your actor has more than one material you need to get a reference to the actor material with GetActorMaterial() to set them. +
++ Possible material types +
+Related: + GetActorMaterialType + GetActorMaterial +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactormd2animation.html b/doc/doc_files/setactormd2animation.html new file mode 100644 index 0000000..66e48bf --- /dev/null +++ b/doc/doc_files/setactormd2animation.html @@ -0,0 +1,88 @@ + + +
+ + ++ Sets the current animation for an *.md2 model +
++ Possible Animations +
+Related: + SetActorMD2AnimationByName +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactormd2animationbyname.html b/doc/doc_files/setactormd2animationbyname.html new file mode 100644 index 0000000..2f1b6f6 --- /dev/null +++ b/doc/doc_files/setactormd2animationbyname.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the current animation for an *.md2 model +
+Related: + SetActorMD2Animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorposition.html b/doc/doc_files/setactorposition.html new file mode 100644 index 0000000..ee1d056 --- /dev/null +++ b/doc/doc_files/setactorposition.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets the absolute position of an actor +
+Related: + TranslateActorLocal + TranslateActorWorld + GetActorPosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorrotation.html b/doc/doc_files/setactorrotation.html new file mode 100644 index 0000000..70af4ed --- /dev/null +++ b/doc/doc_files/setactorrotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the rotation of an actor around each axis +
+Related: + RotateActor + GetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorscale.html b/doc/doc_files/setactorscale.html new file mode 100644 index 0000000..f115673 --- /dev/null +++ b/doc/doc_files/setactorscale.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the scale of an actor +
+Related: + ScaleActor + GetActorScale +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorsleepstate.html b/doc/doc_files/setactorsleepstate.html new file mode 100644 index 0000000..968f735 --- /dev/null +++ b/doc/doc_files/setactorsleepstate.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorsleepthresholds.html b/doc/doc_files/setactorsleepthresholds.html new file mode 100644 index 0000000..cd19c17 --- /dev/null +++ b/doc/doc_files/setactorsleepthresholds.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the linear and angular deactivation thresholds for an actor +
+Related: + GetActorLinearSleepThreshold + GetActorAngularSleepThreshold +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactorsolid.html b/doc/doc_files/setactorsolid.html new file mode 100644 index 0000000..71f6cb0 --- /dev/null +++ b/doc/doc_files/setactorsolid.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets whether an actor has physics and collision response applied to it +
++ Note: Collision detection will still work for non solid actors +
+Related: + ActorIsSolid +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setactortexture.html b/doc/doc_files/setactortexture.html new file mode 100644 index 0000000..35d04be --- /dev/null +++ b/doc/doc_files/setactortexture.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the texture for an actor's default material +
++ 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 new file mode 100644 index 0000000..7892e26 --- /dev/null +++ b/doc/doc_files/setactorvisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether the actor is visible in the scene +
+Related: + ActorIsVisible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setbilinearfilter.html b/doc/doc_files/setbilinearfilter.html new file mode 100644 index 0000000..7c903d9 --- /dev/null +++ b/doc/doc_files/setbilinearfilter.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4e1c251 --- /dev/null +++ b/doc/doc_files/setblendmode.html @@ -0,0 +1,58 @@ + + +
+ + ++ Sets the current blend mode +
++ Note: Only applies to 2D image drawing commands +
++ Possible Blend Modes +
+Related: + SetBlendMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcameraaspectratio.html b/doc/doc_files/setcameraaspectratio.html new file mode 100644 index 0000000..19ce197 --- /dev/null +++ b/doc/doc_files/setcameraaspectratio.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the aspect ratio for the active canvas camera +
+Related: + GetCameraAspectRatio +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcamerafarvalue.html b/doc/doc_files/setcamerafarvalue.html new file mode 100644 index 0000000..74ded46 --- /dev/null +++ b/doc/doc_files/setcamerafarvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the distance to the camera far plane +
+Related: + GetCameraFarValue +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcamerafov.html b/doc/doc_files/setcamerafov.html new file mode 100644 index 0000000..30660fb --- /dev/null +++ b/doc/doc_files/setcamerafov.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the camera's field of view +
+Related: + GetCameraFOV +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcameranearvalue.html b/doc/doc_files/setcameranearvalue.html new file mode 100644 index 0000000..f2645fe --- /dev/null +++ b/doc/doc_files/setcameranearvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the distance of the camera near plane +
+Related: + GetCameraNearValue +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcameraposition.html b/doc/doc_files/setcameraposition.html new file mode 100644 index 0000000..8c3277f --- /dev/null +++ b/doc/doc_files/setcameraposition.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the absolute position of the camera in the scene +
+Related: + TranslateCamera + GetCameraPosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcameraprojectionmatrix.html b/doc/doc_files/setcameraprojectionmatrix.html new file mode 100644 index 0000000..528fb55 --- /dev/null +++ b/doc/doc_files/setcameraprojectionmatrix.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the camera projection matrix for the active canvas +
++ Possible values for projection_type +
+Related: + GetCameraProjectionMatrix +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcamerarotation.html b/doc/doc_files/setcamerarotation.html new file mode 100644 index 0000000..9b26220 --- /dev/null +++ b/doc/doc_files/setcamerarotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the rotation of the camera around each axis +
+Related: + RotateCamera + GetCameraRotation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcanvas3d.html b/doc/doc_files/setcanvas3d.html new file mode 100644 index 0000000..51e5bc0 --- /dev/null +++ b/doc/doc_files/setcanvas3d.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setcanvasalpha.html b/doc/doc_files/setcanvasalpha.html new file mode 100644 index 0000000..07d853e --- /dev/null +++ b/doc/doc_files/setcanvasalpha.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a931c8f --- /dev/null +++ b/doc/doc_files/setcanvascolormod.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e28e19f --- /dev/null +++ b/doc/doc_files/setcanvasoffset.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the offset of a canvas +
++ The canvas offset is what part of the canvas is visible during rendering. +
+Related: + GetCanvasOffset +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcanvasphysics2d.html b/doc/doc_files/setcanvasphysics2d.html new file mode 100644 index 0000000..4479a6d --- /dev/null +++ b/doc/doc_files/setcanvasphysics2d.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setcanvasviewport.html b/doc/doc_files/setcanvasviewport.html new file mode 100644 index 0000000..e7c3277 --- /dev/null +++ b/doc/doc_files/setcanvasviewport.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the position and size of a canvas viewport +
+Related: + GetCanvasViewport +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcanvasvisible.html b/doc/doc_files/setcanvasvisible.html new file mode 100644 index 0000000..c7e7553 --- /dev/null +++ b/doc/doc_files/setcanvasvisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether a canvas is shown or not. +
+Related: + CanvasIsVisible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcanvasz.html b/doc/doc_files/setcanvasz.html new file mode 100644 index 0000000..acc6547 --- /dev/null +++ b/doc/doc_files/setcanvasz.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetCanvasZ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setchanneldistance.html b/doc/doc_files/setchanneldistance.html new file mode 100644 index 0000000..38ad3a8 --- /dev/null +++ b/doc/doc_files/setchanneldistance.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setchannelpanning.html b/doc/doc_files/setchannelpanning.html new file mode 100644 index 0000000..fcce1d4 --- /dev/null +++ b/doc/doc_files/setchannelpanning.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setchannelspaceposition.html b/doc/doc_files/setchannelspaceposition.html new file mode 100644 index 0000000..e26faca --- /dev/null +++ b/doc/doc_files/setchannelspaceposition.html @@ -0,0 +1,24 @@ + + +
+ + ++ Simulates audio in 3D space +
++ Angle 0 is in front of the listener and increases clockwise +
+Related: + SetChannelDistance + SetChannelPanning +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setchannelvolume.html b/doc/doc_files/setchannelvolume.html new file mode 100644 index 0000000..2da40fe --- /dev/null +++ b/doc/doc_files/setchannelvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e01229f --- /dev/null +++ b/doc/doc_files/setclearcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the color that a canvas is cleared to on ClearCanvas() +
+Related: + ClearCanvas +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setclipboardtext.html b/doc/doc_files/setclipboardtext.html new file mode 100644 index 0000000..ed45c23 --- /dev/null +++ b/doc/doc_files/setclipboardtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the clipboard text. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setcolor.html b/doc/doc_files/setcolor.html new file mode 100644 index 0000000..21734b7 --- /dev/null +++ b/doc/doc_files/setcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..cca7c29 --- /dev/null +++ b/doc/doc_files/setconedamping.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f73d70c --- /dev/null +++ b/doc/doc_files/setconefixthresh.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
++ 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. +
+Related: + GetConeFixThresh +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setconelimit.html b/doc/doc_files/setconelimit.html new file mode 100644 index 0000000..e884fad --- /dev/null +++ b/doc/doc_files/setconelimit.html @@ -0,0 +1,29 @@ + + +
+ + ++ 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. +
++ Softness: Determines how soft or hard the constraint limits are. A value of 1.0 means the limits are hard, while lower values make the limit softer, allowing some flexibility. +
++ Bias Factor: This parameter defines how quickly the constraint should try to correct errors that bring it near or beyond the limit. +
++ Relaxation Factor: This affects how fast the constraint will "relax" after reaching its limit, allowing it to stabilize after hitting the constraint. +
+Related: + GetConeLimit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setconstraintangularonly.html b/doc/doc_files/setconstraintangularonly.html new file mode 100644 index 0000000..0b47bc6 --- /dev/null +++ b/doc/doc_files/setconstraintangularonly.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the hinge constraint to limit only angular motion while allowing unrestricted linear (translational) motion. +
+Related: + GetConstraintAngularOnly +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setconstraintbreakingimpulsethreshold.html b/doc/doc_files/setconstraintbreakingimpulsethreshold.html new file mode 100644 index 0000000..8068509 --- /dev/null +++ b/doc/doc_files/setconstraintbreakingimpulsethreshold.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetConstraintBreakingImpulseThreshold +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setconstraintframes.html b/doc/doc_files/setconstraintframes.html new file mode 100644 index 0000000..faca0ba --- /dev/null +++ b/doc/doc_files/setconstraintframes.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setconstraintsolveriterations.html b/doc/doc_files/setconstraintsolveriterations.html new file mode 100644 index 0000000..5e5a03d --- /dev/null +++ b/doc/doc_files/setconstraintsolveriterations.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..558774f --- /dev/null +++ b/doc/doc_files/setenv.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the value of an environment variable +
+Related: + Env$ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setfont.html b/doc/doc_files/setfont.html new file mode 100644 index 0000000..168aee5 --- /dev/null +++ b/doc/doc_files/setfont.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the active font for text rendering +
+Related: + DrawText +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setgravity2d.html b/doc/doc_files/setgravity2d.html new file mode 100644 index 0000000..e231e64 --- /dev/null +++ b/doc/doc_files/setgravity2d.html @@ -0,0 +1,20 @@ + + +
+ + ++ Use this function for setting the global gravity vector. A sprite canvas layer must be active. +
+Related: + GetGravity2D +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setgravity3d.html b/doc/doc_files/setgravity3d.html new file mode 100644 index 0000000..0859ac0 --- /dev/null +++ b/doc/doc_files/setgravity3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the world gravity +
++ + + \ No newline at end of file diff --git a/doc/doc_files/sethingeaxis.html b/doc/doc_files/sethingeaxis.html new file mode 100644 index 0000000..cf8117a --- /dev/null +++ b/doc/doc_files/sethingeaxis.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/sethingelimit.html b/doc/doc_files/sethingelimit.html new file mode 100644 index 0000000..ae1849f --- /dev/null +++ b/doc/doc_files/sethingelimit.html @@ -0,0 +1,43 @@ + + +
+ + ++ 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. +
++ By default, if no limits are applied, the hinge can rotate freely around the axis. +
+Related: + GetHingeLimitBiasFactor + GetHingeLimitRelaxationFactor + GetHingeLimitSign + GetHingeSolveLimit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setidentitymatrix.html b/doc/doc_files/setidentitymatrix.html new file mode 100644 index 0000000..a737be0 --- /dev/null +++ b/doc/doc_files/setidentitymatrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setimagealpha.html b/doc/doc_files/setimagealpha.html new file mode 100644 index 0000000..43ea08b --- /dev/null +++ b/doc/doc_files/setimagealpha.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the alpha blending value for an image. This value only applies in 2D drawing commands. +
+Related: + GetImageAlpha +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setimagecolormod.html b/doc/doc_files/setimagecolormod.html new file mode 100644 index 0000000..1e1caa4 --- /dev/null +++ b/doc/doc_files/setimagecolormod.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the color modulation vlaue for an image +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setlightambientcolor.html b/doc/doc_files/setlightambientcolor.html new file mode 100644 index 0000000..cc6293a --- /dev/null +++ b/doc/doc_files/setlightambientcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4982366 --- /dev/null +++ b/doc/doc_files/setlightattenuation.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b412acf --- /dev/null +++ b/doc/doc_files/setlightdiffusecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..deb7f5e --- /dev/null +++ b/doc/doc_files/setlightfalloff.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the strength decrease between the inner and outer cone of a light +
++ 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 new file mode 100644 index 0000000..5a79e57 --- /dev/null +++ b/doc/doc_files/setlightinnercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a4bc1fc --- /dev/null +++ b/doc/doc_files/setlightoutercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..fdb58a2 --- /dev/null +++ b/doc/doc_files/setlightradius.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the radius of a light +
+Related: + GetLightRadius +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setlightshadowcast.html b/doc/doc_files/setlightshadowcast.html new file mode 100644 index 0000000..e90f2de --- /dev/null +++ b/doc/doc_files/setlightshadowcast.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether a light will cast shadows on actors that have shadows enabled +
+Related: + AddActorShadow +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setlightspecularcolor.html b/doc/doc_files/setlightspecularcolor.html new file mode 100644 index 0000000..9fd9afe --- /dev/null +++ b/doc/doc_files/setlightspecularcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0dd4c80 --- /dev/null +++ b/doc/doc_files/setlighttype.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the type of light +
++ Possible Light Types +
+Related: + SetLightType +
+ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialambientcolor.html b/doc/doc_files/setmaterialambientcolor.html new file mode 100644 index 0000000..46f78ef --- /dev/null +++ b/doc/doc_files/setmaterialambientcolor.html @@ -0,0 +1,17 @@ + + + + + ++ 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 new file mode 100644 index 0000000..b8a2218 --- /dev/null +++ b/doc/doc_files/setmaterialantialiasing.html @@ -0,0 +1,46 @@ + + +
+ + ++ Sets the anti-aliasing mode for the material +
++ Possible modes returned +
+Related: + GetMaterialAntiAliasing +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialbackfaceculling.html b/doc/doc_files/setmaterialbackfaceculling.html new file mode 100644 index 0000000..a5cc25e --- /dev/null +++ b/doc/doc_files/setmaterialbackfaceculling.html @@ -0,0 +1,20 @@ + + +
+ + ++ Enables or disables material backface culling +
+Related: + GetMaterialBackfaceCulling +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialblendfactor.html b/doc/doc_files/setmaterialblendfactor.html new file mode 100644 index 0000000..b30bdc4 --- /dev/null +++ b/doc/doc_files/setmaterialblendfactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1e9f7b7 --- /dev/null +++ b/doc/doc_files/setmaterialblendmode.html @@ -0,0 +1,55 @@ + + +
+ + ++ Sets a material's blend mode +
++ Possible Blend Modes +
+Related: + SetMaterialBlendMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialcolormask.html b/doc/doc_files/setmaterialcolormask.html new file mode 100644 index 0000000..240a9ca --- /dev/null +++ b/doc/doc_files/setmaterialcolormask.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets a color mask for a material +
+Related: + GetMaterialColorMask +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialcolormode.html b/doc/doc_files/setmaterialcolormode.html new file mode 100644 index 0000000..fb42bb5 --- /dev/null +++ b/doc/doc_files/setmaterialcolormode.html @@ -0,0 +1,43 @@ + + +
+ + ++ Sets the color mode of a material +
++ Possible modes +
+Related: + GetMaterialColorMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialdiffusecolor.html b/doc/doc_files/setmaterialdiffusecolor.html new file mode 100644 index 0000000..45eb2d9 --- /dev/null +++ b/doc/doc_files/setmaterialdiffusecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..df51ebf --- /dev/null +++ b/doc/doc_files/setmaterialemissivecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..728f4fb --- /dev/null +++ b/doc/doc_files/setmaterialflag.html @@ -0,0 +1,86 @@ + + +
+ + ++ Sets the value of the specified material flag +
++ Possible values for flag: +
+Related: + GetMaterialFlag + GetActorMaterialFlag +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialfog.html b/doc/doc_files/setmaterialfog.html new file mode 100644 index 0000000..b15ec5d --- /dev/null +++ b/doc/doc_files/setmaterialfog.html @@ -0,0 +1,17 @@ + + +
+ + ++ Enables or disables fog +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialfrontfaceculling.html b/doc/doc_files/setmaterialfrontfaceculling.html new file mode 100644 index 0000000..75e2008 --- /dev/null +++ b/doc/doc_files/setmaterialfrontfaceculling.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..a1493f2 --- /dev/null +++ b/doc/doc_files/setmaterialgouraudshading.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether material will use gourad shading or flat shading +
++ 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 new file mode 100644 index 0000000..727e318 --- /dev/null +++ b/doc/doc_files/setmateriallighting.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..64a1396 --- /dev/null +++ b/doc/doc_files/setmaterialnormalize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b39615a --- /dev/null +++ b/doc/doc_files/setmaterialpointcloud.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..10b96ab --- /dev/null +++ b/doc/doc_files/setmaterialshininess.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the size of specular highlights +
++ 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 new file mode 100644 index 0000000..3a85dbe --- /dev/null +++ b/doc/doc_files/setmaterialspecularcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..428687e --- /dev/null +++ b/doc/doc_files/setmaterialtexture.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the texture on a specified texture level of a material +
++ 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 new file mode 100644 index 0000000..3ba3dc7 --- /dev/null +++ b/doc/doc_files/setmaterialtexturecanvas.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c1f3700 --- /dev/null +++ b/doc/doc_files/setmaterialthickness.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5029ffa --- /dev/null +++ b/doc/doc_files/setmaterialtype.html @@ -0,0 +1,100 @@ + + +
+ + ++ Sets the material type +
++ Possible material types +
+Related: + GetMaterialType +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmaterialwireframe.html b/doc/doc_files/setmaterialwireframe.html new file mode 100644 index 0000000..cdfb95c --- /dev/null +++ b/doc/doc_files/setmaterialwireframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b60280f --- /dev/null +++ b/doc/doc_files/setmatrixrotation.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1d596aa --- /dev/null +++ b/doc/doc_files/setmatrixscale.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..addc06f --- /dev/null +++ b/doc/doc_files/setmatrixtranslation.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..fb53102 --- /dev/null +++ b/doc/doc_files/setmatrixvalue.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..395147f --- /dev/null +++ b/doc/doc_files/setmaxparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets the max number of particles emitted per second +
+Related: + GetMaxParticlesPerSecond + GetMinParticlesPerSecond + SetMinParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setminparticlespersecond.html b/doc/doc_files/setminparticlespersecond.html new file mode 100644 index 0000000..d5a8b1d --- /dev/null +++ b/doc/doc_files/setminparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets the max number of particles emitted per second +
+Related: + SetMaxParticlesPerSecond + GetMinParticlesPerSecond + SetMaxParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setmouserelative.html b/doc/doc_files/setmouserelative.html new file mode 100644 index 0000000..f85d444 --- /dev/null +++ b/doc/doc_files/setmouserelative.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..784a62e --- /dev/null +++ b/doc/doc_files/setmousezone.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5770617 --- /dev/null +++ b/doc/doc_files/setmusicposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..e9bc35d --- /dev/null +++ b/doc/doc_files/setmusicvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..aeb4177 --- /dev/null +++ b/doc/doc_files/setparticlebox.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c7cde86 --- /dev/null +++ b/doc/doc_files/setparticlecenter.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the center of a particle emitter +
++ Note: applies to Sphere, Cylinder, and Ring emitters +
+Related: + GetParticleCenter +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticledirection.html b/doc/doc_files/setparticledirection.html new file mode 100644 index 0000000..c4385f6 --- /dev/null +++ b/doc/doc_files/setparticledirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the direction of a particle emitter +
+Related: + GetParticleDirection +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlelength.html b/doc/doc_files/setparticlelength.html new file mode 100644 index 0000000..f7623d2 --- /dev/null +++ b/doc/doc_files/setparticlelength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the length of a cylinder particle emitter +
++ Note: Only applies to cylinder particles +
+Related: + GetParticleLength +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxangle.html b/doc/doc_files/setparticlemaxangle.html new file mode 100644 index 0000000..95f204d --- /dev/null +++ b/doc/doc_files/setparticlemaxangle.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the max angle of particle emission +
+Related: + GetParticleMaxAngle +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxlife.html b/doc/doc_files/setparticlemaxlife.html new file mode 100644 index 0000000..d636ab5 --- /dev/null +++ b/doc/doc_files/setparticlemaxlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the max life of the particle emission +
++ Note: maxLife is in milliseconds +
+Related: + GetParticleMaxLife +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxstartcolor.html b/doc/doc_files/setparticlemaxstartcolor.html new file mode 100644 index 0000000..cc22d19 --- /dev/null +++ b/doc/doc_files/setparticlemaxstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets max starting color for particles +
+Related: + SetParticleMaxStartColor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlemaxstartsize.html b/doc/doc_files/setparticlemaxstartsize.html new file mode 100644 index 0000000..333289d --- /dev/null +++ b/doc/doc_files/setparticlemaxstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the max start size for the particles +
+Related: + SetParticleMaxStartSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlemesh.html b/doc/doc_files/setparticlemesh.html new file mode 100644 index 0000000..b5d20bf --- /dev/null +++ b/doc/doc_files/setparticlemesh.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the mesh for a mesh particle emitter +
++ 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 new file mode 100644 index 0000000..fca52ad --- /dev/null +++ b/doc/doc_files/setparticleminlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Set the min life of particles +
++ Note: minLife is in milliseconds +
+Related: + SetParticleMinLife +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticleminstartcolor.html b/doc/doc_files/setparticleminstartcolor.html new file mode 100644 index 0000000..75d3b1b --- /dev/null +++ b/doc/doc_files/setparticleminstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the min start color for particles +
+Related: + GetParticleMinStartColor +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticleminstartsize.html b/doc/doc_files/setparticleminstartsize.html new file mode 100644 index 0000000..0d11976 --- /dev/null +++ b/doc/doc_files/setparticleminstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the min start size for particle emitter +
+Related: + GetParticleMinStartSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlenormal.html b/doc/doc_files/setparticlenormal.html new file mode 100644 index 0000000..02298b6 --- /dev/null +++ b/doc/doc_files/setparticlenormal.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the normal of a particle emitter +
++ Note: Only applies to cylinder particle emitter +
+Related: + GetParticleNormal +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticlenormaldirectionmod.html b/doc/doc_files/setparticlenormaldirectionmod.html new file mode 100644 index 0000000..f685ae2 --- /dev/null +++ b/doc/doc_files/setparticlenormaldirectionmod.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the normal direction modifier for a particle emitter +
++ Note: Only applies to mesh particle emitter +
+Related: + GetParticleNormalDirectionMod +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticleradius.html b/doc/doc_files/setparticleradius.html new file mode 100644 index 0000000..389b3de --- /dev/null +++ b/doc/doc_files/setparticleradius.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the radius of a particle emitter +
++ Note: Only applies to Sphere, Cylinder, and Ring emitters +
+Related: + SetParticleRadius +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setparticleringthickness.html b/doc/doc_files/setparticleringthickness.html new file mode 100644 index 0000000..d65bb93 --- /dev/null +++ b/doc/doc_files/setparticleringthickness.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the thickness of a ring emitter +
++ Note: Only applies to ring emitter +
+Related: + GetParticleRingThickness +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setpointpivota.html b/doc/doc_files/setpointpivota.html new file mode 100644 index 0000000..6c1c183 --- /dev/null +++ b/doc/doc_files/setpointpivota.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotA + SetPointPivotB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setpointpivotb.html b/doc/doc_files/setpointpivotb.html new file mode 100644 index 0000000..cb75d1d --- /dev/null +++ b/doc/doc_files/setpointpivotb.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotA + SetPointPivotB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setprojectionmatrix.html b/doc/doc_files/setprojectionmatrix.html new file mode 100644 index 0000000..6eebabc --- /dev/null +++ b/doc/doc_files/setprojectionmatrix.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the camera projection matrix for the active canvas +
++ Possible values for projection_type +
+Related: + GetProjectionMatrix +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidedampingdirang.html b/doc/doc_files/setslidedampingdirang.html new file mode 100644 index 0000000..4a6c3fa --- /dev/null +++ b/doc/doc_files/setslidedampingdirang.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..069b735 --- /dev/null +++ b/doc/doc_files/setslidedampingdirlin.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f52aa50 --- /dev/null +++ b/doc/doc_files/setslidedampinglimang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingLimAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidedampinglimlin.html b/doc/doc_files/setslidedampinglimlin.html new file mode 100644 index 0000000..28636a7 --- /dev/null +++ b/doc/doc_files/setslidedampinglimlin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingLimLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidedampingorthoang.html b/doc/doc_files/setslidedampingorthoang.html new file mode 100644 index 0000000..b0a69df --- /dev/null +++ b/doc/doc_files/setslidedampingorthoang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidedampingortholin.html b/doc/doc_files/setslidedampingortholin.html new file mode 100644 index 0000000..a65a902 --- /dev/null +++ b/doc/doc_files/setslidedampingortholin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslideloweranglimit.html b/doc/doc_files/setslideloweranglimit.html new file mode 100644 index 0000000..279bd9d --- /dev/null +++ b/doc/doc_files/setslideloweranglimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideLowerAngLimit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidelowerlinlimit.html b/doc/doc_files/setslidelowerlinlimit.html new file mode 100644 index 0000000..2c53377 --- /dev/null +++ b/doc/doc_files/setslidelowerlinlimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideLowerLinLimit +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutiondirang.html b/doc/doc_files/setsliderestitutiondirang.html new file mode 100644 index 0000000..be7d1dd --- /dev/null +++ b/doc/doc_files/setsliderestitutiondirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideRestitutionDirAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutiondirlin.html b/doc/doc_files/setsliderestitutiondirlin.html new file mode 100644 index 0000000..0af7708 --- /dev/null +++ b/doc/doc_files/setsliderestitutiondirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideRestitutionDirLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionlimang.html b/doc/doc_files/setsliderestitutionlimang.html new file mode 100644 index 0000000..955b9a3 --- /dev/null +++ b/doc/doc_files/setsliderestitutionlimang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + GetSlideRestitutionLimAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionlimlin.html b/doc/doc_files/setsliderestitutionlimlin.html new file mode 100644 index 0000000..4747276 --- /dev/null +++ b/doc/doc_files/setsliderestitutionlimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + GetSlideRestitutionLimLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionorthoang.html b/doc/doc_files/setsliderestitutionorthoang.html new file mode 100644 index 0000000..2e877cd --- /dev/null +++ b/doc/doc_files/setsliderestitutionorthoang.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Angular Motion: In the context of a slider constraint, orthogonal angular motion refers to rotational movement around axes that are perpendicular to the slider's main movement axis. +
++ 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. +
+Related: + GetSlideRestitutionOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setsliderestitutionortholin.html b/doc/doc_files/setsliderestitutionortholin.html new file mode 100644 index 0000000..8ee4b4c --- /dev/null +++ b/doc/doc_files/setsliderestitutionortholin.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Linear Motion: In the context of a slider constraint, orthogonal linear motion refers to translational movement along axes that are perpendicular to the main sliding axis of the constraint. +
++ 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. +
+Related: + GetSlideRestitutionOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessdirang.html b/doc/doc_files/setslidesoftnessdirang.html new file mode 100644 index 0000000..b2080b3 --- /dev/null +++ b/doc/doc_files/setslidesoftnessdirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessDirAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessdirlin.html b/doc/doc_files/setslidesoftnessdirlin.html new file mode 100644 index 0000000..910a7af --- /dev/null +++ b/doc/doc_files/setslidesoftnessdirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessDirLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnesslimang.html b/doc/doc_files/setslidesoftnesslimang.html new file mode 100644 index 0000000..7e873fa --- /dev/null +++ b/doc/doc_files/setslidesoftnesslimang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessLimAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnesslimlin.html b/doc/doc_files/setslidesoftnesslimlin.html new file mode 100644 index 0000000..b6bbce0 --- /dev/null +++ b/doc/doc_files/setslidesoftnesslimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessLimLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessorthoang.html b/doc/doc_files/setslidesoftnessorthoang.html new file mode 100644 index 0000000..cad7674 --- /dev/null +++ b/doc/doc_files/setslidesoftnessorthoang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslidesoftnessortholin.html b/doc/doc_files/setslidesoftnessortholin.html new file mode 100644 index 0000000..a48db4b --- /dev/null +++ b/doc/doc_files/setslidesoftnessortholin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslideupperanglimit.html b/doc/doc_files/setslideupperanglimit.html new file mode 100644 index 0000000..927a49c --- /dev/null +++ b/doc/doc_files/setslideupperanglimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setslideupperlinlimit.html b/doc/doc_files/setslideupperlinlimit.html new file mode 100644 index 0000000..957fe31 --- /dev/null +++ b/doc/doc_files/setslideupperlinlimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setsoundchannels.html b/doc/doc_files/setsoundchannels.html new file mode 100644 index 0000000..e1374e8 --- /dev/null +++ b/doc/doc_files/setsoundchannels.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..07a5d38 --- /dev/null +++ b/doc/doc_files/setsoundvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the volume of a sound +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteanimation.html b/doc/doc_files/setspriteanimation.html new file mode 100644 index 0000000..026c7da --- /dev/null +++ b/doc/doc_files/setspriteanimation.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the current animation for a sprite +
++ Note: Once an animation is set, it will automatically start +
+Related: + GetSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteanimationframe.html b/doc/doc_files/setspriteanimationframe.html new file mode 100644 index 0000000..1975a65 --- /dev/null +++ b/doc/doc_files/setspriteanimationframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets a frame in a sprite animation +
+Related: + GetSpriteAnimationFrame +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteanimationlength.html b/doc/doc_files/setspriteanimationlength.html new file mode 100644 index 0000000..85e21a6 --- /dev/null +++ b/doc/doc_files/setspriteanimationlength.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of frames in a sprite animation +
+Related: + GetSpriteAnimationLength +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteanimationloops.html b/doc/doc_files/setspriteanimationloops.html new file mode 100644 index 0000000..e8d9898 --- /dev/null +++ b/doc/doc_files/setspriteanimationloops.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of animation loops for the sprite +
+Related: + NumSpriteAnimationLoops +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteanimationspeed.html b/doc/doc_files/setspriteanimationspeed.html new file mode 100644 index 0000000..84924cf --- /dev/null +++ b/doc/doc_files/setspriteanimationspeed.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the speed in frames per second for a sprite animation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteframe.html b/doc/doc_files/setspriteframe.html new file mode 100644 index 0000000..48a4752 --- /dev/null +++ b/doc/doc_files/setspriteframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets a sprite to a frame in its frame sheet +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriteposition.html b/doc/doc_files/setspriteposition.html new file mode 100644 index 0000000..89e90c8 --- /dev/null +++ b/doc/doc_files/setspriteposition.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the position of the sprite in the canvas +
++ Note: This is canvas position and not screen position +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspriterotation.html b/doc/doc_files/setspriterotation.html new file mode 100644 index 0000000..7ca8963 --- /dev/null +++ b/doc/doc_files/setspriterotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the angle the sprite is rotated by +
+Related: + GetSpriteRotation + RotateSprite +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspritescale.html b/doc/doc_files/setspritescale.html new file mode 100644 index 0000000..f79dad7 --- /dev/null +++ b/doc/doc_files/setspritescale.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the scale of a sprite +
+Related: + ScaleSprite + GetSpriteScale +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspritesolid.html b/doc/doc_files/setspritesolid.html new file mode 100644 index 0000000..89402e7 --- /dev/null +++ b/doc/doc_files/setspritesolid.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether a sprite has physics and collision response enabled +
+Related: + SpriteIsSolid +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspritesource.html b/doc/doc_files/setspritesource.html new file mode 100644 index 0000000..88c6940 --- /dev/null +++ b/doc/doc_files/setspritesource.html @@ -0,0 +1,23 @@ + + +
+ + ++ Changes the image source for a sprite frame sheet +
++ Note: This needs to be the same size as the current image source or you will have rendering issues +
+Related: + GetSpriteSource +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspritetype.html b/doc/doc_files/setspritetype.html new file mode 100644 index 0000000..27f5b01 --- /dev/null +++ b/doc/doc_files/setspritetype.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the type of collision body a sprite has +
+Related: + GetSpriteType +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspritevisible.html b/doc/doc_files/setspritevisible.html new file mode 100644 index 0000000..91162f8 --- /dev/null +++ b/doc/doc_files/setspritevisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether the sprite is visible +
+Related: + SpriteIsVisible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setspritez.html b/doc/doc_files/setspritez.html new file mode 100644 index 0000000..93754eb --- /dev/null +++ b/doc/doc_files/setspritez.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the drawing priority for sprites. +
++ Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top +
+Related: + SpriteZ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setterraincameramovementdelta.html b/doc/doc_files/setterraincameramovementdelta.html new file mode 100644 index 0000000..0a89d1c --- /dev/null +++ b/doc/doc_files/setterraincameramovementdelta.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the movement camera threshold. +
++ 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 new file mode 100644 index 0000000..12b1fdb --- /dev/null +++ b/doc/doc_files/setterraincamerarotationdelta.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the rotation camera threshold. +
++ 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 new file mode 100644 index 0000000..78ee84b --- /dev/null +++ b/doc/doc_files/setterrainloddistance.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7fe03f8 --- /dev/null +++ b/doc/doc_files/setterrainpatchlod.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9b0c3e8 --- /dev/null +++ b/doc/doc_files/settile.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9dd63d1 --- /dev/null +++ b/doc/doc_files/settileanimationframe.html @@ -0,0 +1,34 @@ + + +
+ + ++ Sets a frame of animation for a tile +
++ Parameters: +
++ + + \ No newline at end of file diff --git a/doc/doc_files/settileanimationlength.html b/doc/doc_files/settileanimationlength.html new file mode 100644 index 0000000..d86a5e3 --- /dev/null +++ b/doc/doc_files/settileanimationlength.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of frames in a tile's animation +
+Related: + GetTileAnimationLength +
++ + + \ No newline at end of file diff --git a/doc/doc_files/settileanimationspeed.html b/doc/doc_files/settileanimationspeed.html new file mode 100644 index 0000000..027f3d1 --- /dev/null +++ b/doc/doc_files/settileanimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the speed of a tile's animation +
+Related: + GetTileAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/doc_files/settilemapsize.html b/doc/doc_files/settilemapsize.html new file mode 100644 index 0000000..5aedd8d --- /dev/null +++ b/doc/doc_files/settilemapsize.html @@ -0,0 +1,21 @@ + + +
+ + ++ Resize a tile map +
+Related: + CreateTileMap + GetTileMapSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setup.html b/doc/doc_files/setup.html new file mode 100644 index 0000000..472dfec --- /dev/null +++ b/doc/doc_files/setup.html @@ -0,0 +1,60 @@ + + +
+ + ++ 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. +
++
+ 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. +
++
+ rcbasic_build myprogram.bas
+
+ Once you have a *.cbc file you can pass it to rcbasic to run it. +
+
+ rcbasic 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
+
+
+ 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 new file mode 100644 index 0000000..a982606 --- /dev/null +++ b/doc/doc_files/setvideodrawrect.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setvideoposition.html b/doc/doc_files/setvideoposition.html new file mode 100644 index 0000000..b9864fc --- /dev/null +++ b/doc/doc_files/setvideoposition.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the position within the current video in milliseconds +
+Related: + GetVideoPosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setvideovolume.html b/doc/doc_files/setvideovolume.html new file mode 100644 index 0000000..3315799 --- /dev/null +++ b/doc/doc_files/setvideovolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the volume of the video track +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setwatercolor.html b/doc/doc_files/setwatercolor.html new file mode 100644 index 0000000..c5e2f82 --- /dev/null +++ b/doc/doc_files/setwatercolor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setwatercolorblendfactor.html b/doc/doc_files/setwatercolorblendfactor.html new file mode 100644 index 0000000..864ce48 --- /dev/null +++ b/doc/doc_files/setwatercolorblendfactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setwaterwaveheight.html b/doc/doc_files/setwaterwaveheight.html new file mode 100644 index 0000000..015f34f --- /dev/null +++ b/doc/doc_files/setwaterwaveheight.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setwaterwinddirection.html b/doc/doc_files/setwaterwinddirection.html new file mode 100644 index 0000000..dd717fc --- /dev/null +++ b/doc/doc_files/setwaterwinddirection.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setwaterwindforce.html b/doc/doc_files/setwaterwindforce.html new file mode 100644 index 0000000..7c81415 --- /dev/null +++ b/doc/doc_files/setwaterwindforce.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setwindowalwaysontop.html b/doc/doc_files/setwindowalwaysontop.html new file mode 100644 index 0000000..51cd0a2 --- /dev/null +++ b/doc/doc_files/setwindowalwaysontop.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..cae6f61 --- /dev/null +++ b/doc/doc_files/setwindowautoclose.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..838eee9 --- /dev/null +++ b/doc/doc_files/setwindowbordered.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether the window has a border or not. +
+Related: + WindowIsBordered +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setwindowfullscreen.html b/doc/doc_files/setwindowfullscreen.html new file mode 100644 index 0000000..f853b17 --- /dev/null +++ b/doc/doc_files/setwindowfullscreen.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..daf713a --- /dev/null +++ b/doc/doc_files/setwindowicon.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..68bff67 --- /dev/null +++ b/doc/doc_files/setwindowmaxsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..17fcb12 --- /dev/null +++ b/doc/doc_files/setwindowminsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2590838 --- /dev/null +++ b/doc/doc_files/setwindowposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..fc79bf9 --- /dev/null +++ b/doc/doc_files/setwindowresizable.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..678bcc8 --- /dev/null +++ b/doc/doc_files/setwindowsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f4c8180 --- /dev/null +++ b/doc/doc_files/setwindowtitle.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2f311c1 --- /dev/null +++ b/doc/doc_files/setwindowvsync.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setworld3ddeltatime.html b/doc/doc_files/setworld3ddeltatime.html new file mode 100644 index 0000000..907b8c0 --- /dev/null +++ b/doc/doc_files/setworld3ddeltatime.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/setworld3dmaxsubsteps.html b/doc/doc_files/setworld3dmaxsubsteps.html new file mode 100644 index 0000000..dab9c54 --- /dev/null +++ b/doc/doc_files/setworld3dmaxsubsteps.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetWorld3DMaxTimeStep +
++ + + \ No newline at end of file diff --git a/doc/doc_files/setworld3dtimestep.html b/doc/doc_files/setworld3dtimestep.html new file mode 100644 index 0000000..ac1a233 --- /dev/null +++ b/doc/doc_files/setworld3dtimestep.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetWorld3DMaxSubSteps +
++ + + \ No newline at end of file diff --git a/doc/doc_files/showmouse.html b/doc/doc_files/showmouse.html new file mode 100644 index 0000000..8e4974b --- /dev/null +++ b/doc/doc_files/showmouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..080d503 --- /dev/null +++ b/doc/doc_files/showwindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the window visible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/sign.html b/doc/doc_files/sign.html new file mode 100644 index 0000000..272b35d --- /dev/null +++ b/doc/doc_files/sign.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the sign of a number +
++ 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 new file mode 100644 index 0000000..62e7947 --- /dev/null +++ b/doc/doc_files/sin.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3fd05dc --- /dev/null +++ b/doc/doc_files/size.html @@ -0,0 +1,24 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/solvematrix.html b/doc/doc_files/solvematrix.html new file mode 100644 index 0000000..597d09e --- /dev/null +++ b/doc/doc_files/solvematrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/sound.html b/doc/doc_files/sound.html new file mode 100644 index 0000000..8c1aeb4 --- /dev/null +++ b/doc/doc_files/sound.html @@ -0,0 +1,37 @@ + + +
+ + ++ Loading sound and music is fairly straight forward. The big difference between sounds and music is that your program can only have one music track but you could have several sound tracks at once. +
++ Lets first go over loading and playing sounds. +
+
+ snd = LoadSound("MySound.wav") 'Load a sound file
+ PlaySound(snd, 1, 3) 'Play the sound loaded in snd on channel 1 for 3 loops
+
+ There is a lot you can do with sounds when playing them including simulating 3D positional audio. I highly encourage you to play around with the audio to find the right mix for your project. +
++ There is only 1 music track that can be loaded at one time. Loading and playing music is pretty straight forward. +
+
+ LoadMusic ( "MYMUSIC.MP3" )
+ PlayMusic ( -1 ) 'Setting the music loop to -1 will have it loop infinitely
+
+ 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 new file mode 100644 index 0000000..263c791 --- /dev/null +++ b/doc/doc_files/soundexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b74f6b6 --- /dev/null +++ b/doc/doc_files/soundisenabled.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6c7540b --- /dev/null +++ b/doc/doc_files/spriteanimationisplaying.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/spriteheight.html b/doc/doc_files/spriteheight.html new file mode 100644 index 0000000..5573c94 --- /dev/null +++ b/doc/doc_files/spriteheight.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the frame height of a sprite +
+Related: + SpriteWidth + GetSpriteSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/spriteissolid.html b/doc/doc_files/spriteissolid.html new file mode 100644 index 0000000..73e1d13 --- /dev/null +++ b/doc/doc_files/spriteissolid.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if a sprite is has physics and collision response enabled +
+Related: + SetSpriteSolid +
++ + + \ No newline at end of file diff --git a/doc/doc_files/spriteisvisible.html b/doc/doc_files/spriteisvisible.html new file mode 100644 index 0000000..cef8c71 --- /dev/null +++ b/doc/doc_files/spriteisvisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns whether the sprite is visible +
+Related: + SetSpriteVisible +
++ + + \ No newline at end of file diff --git a/doc/doc_files/spritewidth.html b/doc/doc_files/spritewidth.html new file mode 100644 index 0000000..5350a5f --- /dev/null +++ b/doc/doc_files/spritewidth.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the frame width of a sprite +
+Related: + SpriteHeight + GetSpriteSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/spritex.html b/doc/doc_files/spritex.html new file mode 100644 index 0000000..54fed33 --- /dev/null +++ b/doc/doc_files/spritex.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the X position of a sprite on a canvas +
+Related: + SpriteY + SetSpritePosition + GetSpritePosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/spritey.html b/doc/doc_files/spritey.html new file mode 100644 index 0000000..3f01bb0 --- /dev/null +++ b/doc/doc_files/spritey.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the Y position of a sprite on a canvas +
+Related: + SpriteX + SetSpritePosition + GetSpritePosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/spritez.html b/doc/doc_files/spritez.html new file mode 100644 index 0000000..2c71ab8 --- /dev/null +++ b/doc/doc_files/spritez.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the drawing priority for sprites. +
++ Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top +
+Related: + SetSpriteZ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/sqrt.html b/doc/doc_files/sqrt.html new file mode 100644 index 0000000..58e9a70 --- /dev/null +++ b/doc/doc_files/sqrt.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..8a30349 --- /dev/null +++ b/doc/doc_files/squarematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d2eb11d --- /dev/null +++ b/doc/doc_files/stack_size_n.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..2aba495 --- /dev/null +++ b/doc/doc_files/stack_size_s.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of elements on a string stack +
++ + + \ No newline at end of file diff --git a/doc/doc_files/startactortransition.html b/doc/doc_files/startactortransition.html new file mode 100644 index 0000000..b1e0eb8 --- /dev/null +++ b/doc/doc_files/startactortransition.html @@ -0,0 +1,29 @@ + + +
+ + ++ Starts an actor transition from its current frame in an animation to a specified frame +
+Related: + StopActorTransition + ActorIsInTransition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/startparticleemitter.html b/doc/doc_files/startparticleemitter.html new file mode 100644 index 0000000..27a678a --- /dev/null +++ b/doc/doc_files/startparticleemitter.html @@ -0,0 +1,20 @@ + + +
+ + ++ Starts particle emission for a particle actor +
+Related: + StopParticleEmitter +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stopactortransition.html b/doc/doc_files/stopactortransition.html new file mode 100644 index 0000000..3213d7a --- /dev/null +++ b/doc/doc_files/stopactortransition.html @@ -0,0 +1,21 @@ + + +
+ + ++ Stops a transition that was started with StartActorTransition +
+Related: + StartActorTransition + ActorIsInTransition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stopmusic.html b/doc/doc_files/stopmusic.html new file mode 100644 index 0000000..dbf89ea --- /dev/null +++ b/doc/doc_files/stopmusic.html @@ -0,0 +1,21 @@ + + +
+ + ++ Stops playing the loaded music track and resets the music position to 0 +
+Related: + PlayMusic + PauseMusic +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stopparticleemitter.html b/doc/doc_files/stopparticleemitter.html new file mode 100644 index 0000000..e6a603b --- /dev/null +++ b/doc/doc_files/stopparticleemitter.html @@ -0,0 +1,20 @@ + + +
+ + ++ Stops particle emission for a particle actor +
+Related: + StartParticleEmitter +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stopsound.html b/doc/doc_files/stopsound.html new file mode 100644 index 0000000..967ed26 --- /dev/null +++ b/doc/doc_files/stopsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..77bfba6 --- /dev/null +++ b/doc/doc_files/stopvideo.html @@ -0,0 +1,21 @@ + + +
+ + ++ Stops playing the loaded video track and resets the video position to 0 +
+Related: + PlayVideo + PauseVideo +
++ + + \ No newline at end of file diff --git a/doc/doc_files/str.html b/doc/doc_files/str.html new file mode 100644 index 0000000..bfb27a0 --- /dev/null +++ b/doc/doc_files/str.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0012aee --- /dev/null +++ b/doc/doc_files/str_f.html @@ -0,0 +1,24 @@ + + +
+ + ++ Returns a number converted to a string in fixed notation +
++ The number will be returned with 6 decimal places of precision. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/str_s.html b/doc/doc_files/str_s.html new file mode 100644 index 0000000..8ddbed5 --- /dev/null +++ b/doc/doc_files/str_s.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns a number converted to a string in scientific notation +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stringarraycopy.html b/doc/doc_files/stringarraycopy.html new file mode 100644 index 0000000..7e76381 --- /dev/null +++ b/doc/doc_files/stringarraycopy.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayCopy() +
+Related: + ArrayCopy +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stringarraydim.html b/doc/doc_files/stringarraydim.html new file mode 100644 index 0000000..8d1ce4f --- /dev/null +++ b/doc/doc_files/stringarraydim.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayDim() +
+Related: + ArrayDim +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stringarrayfill.html b/doc/doc_files/stringarrayfill.html new file mode 100644 index 0000000..cfa606c --- /dev/null +++ b/doc/doc_files/stringarrayfill.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayFill() +
+Related: + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stringarraysize.html b/doc/doc_files/stringarraysize.html new file mode 100644 index 0000000..a761347 --- /dev/null +++ b/doc/doc_files/stringarraysize.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArraySize() +
+Related: + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/stringfill.html b/doc/doc_files/stringfill.html new file mode 100644 index 0000000..fb98e68 --- /dev/null +++ b/doc/doc_files/stringfill.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0bc5554 --- /dev/null +++ b/doc/doc_files/stringfrombuffer.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..efce740 --- /dev/null +++ b/doc/doc_files/subtractmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9aeb654 --- /dev/null +++ b/doc/doc_files/swapmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d1930ff --- /dev/null +++ b/doc/doc_files/swapmatrixcolumn.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..cafced5 --- /dev/null +++ b/doc/doc_files/swapmatrixrow.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ec28956 --- /dev/null +++ b/doc/doc_files/system.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c4ed040 --- /dev/null +++ b/doc/doc_files/systemram.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7aa7ca9 --- /dev/null +++ b/doc/doc_files/systemreturnstdout.html @@ -0,0 +1,20 @@ + + +
+ + ++ Runs an operating system command and returns the output +
+Related: + System +
++ + + \ No newline at end of file diff --git a/doc/doc_files/tally.html b/doc/doc_files/tally.html new file mode 100644 index 0000000..1c4819c --- /dev/null +++ b/doc/doc_files/tally.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0a3e829 --- /dev/null +++ b/doc/doc_files/tan.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7708fc2 --- /dev/null +++ b/doc/doc_files/tcp_acceptsocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ Attempts to accept a connection from a server socket. If successful it will open a client socket to communicate with the server and return true. If it fails it will return false. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/tcp_closesocket.html b/doc/doc_files/tcp_closesocket.html new file mode 100644 index 0000000..d4080c1 --- /dev/null +++ b/doc/doc_files/tcp_closesocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3d19ae9 --- /dev/null +++ b/doc/doc_files/tcp_getdata.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1545bdf --- /dev/null +++ b/doc/doc_files/tcp_opensocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..aeeb9a7 --- /dev/null +++ b/doc/doc_files/tcp_remotehost.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d17b60a --- /dev/null +++ b/doc/doc_files/tcp_remoteport.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..342f683 --- /dev/null +++ b/doc/doc_files/tcp_senddata.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..408fa0b --- /dev/null +++ b/doc/doc_files/tcp_socketready.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f583808 --- /dev/null +++ b/doc/doc_files/tell.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..b0f3f2d --- /dev/null +++ b/doc/doc_files/textheight.html @@ -0,0 +1,21 @@ + + +
+ + ++ The height of text rendered with the active font +
+Related: + TextWidth + GetTextSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/textwidth.html b/doc/doc_files/textwidth.html new file mode 100644 index 0000000..8852b65 --- /dev/null +++ b/doc/doc_files/textwidth.html @@ -0,0 +1,21 @@ + + +
+ + ++ The width of text rendered with the active font +
+Related: + TextHeight + GetTextSize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/ticks.html b/doc/doc_files/ticks.html new file mode 100644 index 0000000..cec9e29 --- /dev/null +++ b/doc/doc_files/ticks.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of CPU ticks since the start of a program +
++ + + \ No newline at end of file diff --git a/doc/doc_files/time.html b/doc/doc_files/time.html new file mode 100644 index 0000000..2e0bc47 --- /dev/null +++ b/doc/doc_files/time.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..813b266 --- /dev/null +++ b/doc/doc_files/timer.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..76e0774 --- /dev/null +++ b/doc/doc_files/touchpressure.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the touch pressure of a touch event. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/translateactor.html b/doc/doc_files/translateactor.html new file mode 100644 index 0000000..645b627 --- /dev/null +++ b/doc/doc_files/translateactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/translateactorlocal.html b/doc/doc_files/translateactorlocal.html new file mode 100644 index 0000000..e6c2f7c --- /dev/null +++ b/doc/doc_files/translateactorlocal.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7147fce --- /dev/null +++ b/doc/doc_files/translateactorworld.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5c7c46b --- /dev/null +++ b/doc/doc_files/translatecamera.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..11f67fb --- /dev/null +++ b/doc/doc_files/translatesprite.html @@ -0,0 +1,24 @@ + + +
+ + ++ 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. +
+Related: + SetSpritePosition + GetSpritePosition +
++ + + \ No newline at end of file diff --git a/doc/doc_files/transposematrix.html b/doc/doc_files/transposematrix.html new file mode 100644 index 0000000..eebd419 --- /dev/null +++ b/doc/doc_files/transposematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores the transpose of matrix mA in matrix mB +
++ + + \ No newline at end of file diff --git a/doc/doc_files/trim.html b/doc/doc_files/trim.html new file mode 100644 index 0000000..888f6a2 --- /dev/null +++ b/doc/doc_files/trim.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with all leading and trailing spaces removed +
++ + + \ No newline at end of file diff --git a/doc/doc_files/tst.html b/doc/doc_files/tst.html new file mode 100644 index 0000000..27be6f1 --- /dev/null +++ b/doc/doc_files/tst.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/doc_files/typearraycopy.html b/doc/doc_files/typearraycopy.html new file mode 100644 index 0000000..31eb52e --- /dev/null +++ b/doc/doc_files/typearraycopy.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayCopy() +
+Related: + ArrayCopy +
++ + + \ No newline at end of file diff --git a/doc/doc_files/typearraydim.html b/doc/doc_files/typearraydim.html new file mode 100644 index 0000000..c1b7213 --- /dev/null +++ b/doc/doc_files/typearraydim.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayDim() +
+Related: + ArrayDim +
++ + + \ No newline at end of file diff --git a/doc/doc_files/typearrayfill.html b/doc/doc_files/typearrayfill.html new file mode 100644 index 0000000..a93ae77 --- /dev/null +++ b/doc/doc_files/typearrayfill.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayFill() +
+Related: + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/doc_files/typearraysize.html b/doc/doc_files/typearraysize.html new file mode 100644 index 0000000..67be110 --- /dev/null +++ b/doc/doc_files/typearraysize.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArraySize() +
+Related: + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/doc_files/ucase.html b/doc/doc_files/ucase.html new file mode 100644 index 0000000..23d0d2e --- /dev/null +++ b/doc/doc_files/ucase.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..77c1f24 --- /dev/null +++ b/doc/doc_files/udp_closesocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4d195aa --- /dev/null +++ b/doc/doc_files/udp_getdata.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..061a3e0 --- /dev/null +++ b/doc/doc_files/udp_length.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6323217 --- /dev/null +++ b/doc/doc_files/udp_maxlength.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..cc77368 --- /dev/null +++ b/doc/doc_files/udp_opensocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..c7b5ba2 --- /dev/null +++ b/doc/doc_files/udp_remotehost.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..f3ab41b --- /dev/null +++ b/doc/doc_files/udp_remoteport.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..5784dda --- /dev/null +++ b/doc/doc_files/udp_senddata.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0d58e74 --- /dev/null +++ b/doc/doc_files/udp_socketready.html @@ -0,0 +1,25 @@ + + +
+ + ++ 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. +
+
+ If UDP_SocketReady ( 0 ) > 0 Then
+ 'Socket has activity so we can do something here
+ End If
+
Related: + CheckSockets +
++ + + \ No newline at end of file diff --git a/doc/doc_files/udt.html b/doc/doc_files/udt.html new file mode 100644 index 0000000..169e885 --- /dev/null +++ b/doc/doc_files/udt.html @@ -0,0 +1,73 @@ + + +
+ + ++ RCBasic v4 and up introduces the ability to create user defined types. These are basically structures that allow you to store and manage related data. To create a user defined type you need to use the TYPE keyword. Look at the following: +
+
+ Type player
+ Dim x, y
+ End Type
+
+ In the above code, a type called player is created. The DIM keyword must be used to add attributes to our type. Now we can create a variable with the data type player as follows: +
+
+ Dim hero As player
+
+ Notice that in the above code, we are using the DIM keyword we have used in previous sections to create variables and arrays. We now have a variable called hero whose data type is player. +
++ Since our hero variable is of type player, it has all the attributes of that type. So we can access the attribute's with a "." like so: +
+
+ hero.x = 23
+ Print "Hero x is "; hero.x
+
+ The attributes of a UDT variable are accessed the same way a normal variable is. You can also create an array of UDT's the same way you would create a normal array. Look at the following: +
+
+ Dim enemy[20] As player
+
+ If you read through the section on arrays then this should make sense. We are using the DIM keyword to make an array called enemy and then we use the AS keyword to set the type of enemy to player. +
++ UDTs can also be used for attributes inside other UDTs. Lets say we wanted each player to have stats like health and power. We could create a UDT for player stats and have an attribute of that stat type inside our player UDT. Here is that example demonstrated: +
+
+ Type Player_Stats
+ Dim health
+ Dim power
+ End Type
+
+ Type Player
+ Dim x, y
+ Dim stats As Player_Stats
+ End Type
+
+ Dim hero As Player
+
+ In the above example, hero now has an attribute called stats that is of type Player_Stats. So now we can access the stats attributes like so: +
+
+ hero.stats.health = 100
+ Print "Hero Health = "; hero.stats.health
+
+ 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 new file mode 100644 index 0000000..4b355d6 --- /dev/null +++ b/doc/doc_files/unaugmentmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7ef63ef --- /dev/null +++ b/doc/doc_files/update.html @@ -0,0 +1,37 @@ + + +
+ + ++ This is the most important function in a graphics window. It must be called every frame. +
++ It performs a few different operations +
++ 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 new file mode 100644 index 0000000..ae77614 --- /dev/null +++ b/doc/doc_files/updateactorinertiatensor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1746c40 --- /dev/null +++ b/doc/doc_files/useconstraintframeoffset.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/doc_files/usehingereferenceframea.html b/doc/doc_files/usehingereferenceframea.html new file mode 100644 index 0000000..c8cb9b2 --- /dev/null +++ b/doc/doc_files/usehingereferenceframea.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/doc_files/useparticleeverymeshvertex.html b/doc/doc_files/useparticleeverymeshvertex.html new file mode 100644 index 0000000..841c562 --- /dev/null +++ b/doc/doc_files/useparticleeverymeshvertex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether to emit min<->max particles for every vertex or to pick min<->max vertices. +
+Related: + particleIsUsingEveryMeshVertex +
++ + + \ No newline at end of file diff --git a/doc/doc_files/useparticlenormaldirection.html b/doc/doc_files/useparticlenormaldirection.html new file mode 100644 index 0000000..d72f018 --- /dev/null +++ b/doc/doc_files/useparticlenormaldirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether particle emitter is using vertex normal for direction, or direction specified. +
+Related: + particleIsUsingNormalDirection +
++ + + \ No newline at end of file diff --git a/doc/doc_files/useparticleoutlineonly.html b/doc/doc_files/useparticleoutlineonly.html new file mode 100644 index 0000000..0524db2 --- /dev/null +++ b/doc/doc_files/useparticleoutlineonly.html @@ -0,0 +1,23 @@ + + +
+ + ++ Set whether or not to draw points inside the cylinder. +
++ Note: Only applies to cylinder emitter +
+Related: + particleIsUsingOutlineOnly +
++ + + \ No newline at end of file diff --git a/doc/doc_files/val.html b/doc/doc_files/val.html new file mode 100644 index 0000000..bb16765 --- /dev/null +++ b/doc/doc_files/val.html @@ -0,0 +1,20 @@ + + +
+ + ++ Converts a string to a number and returns the value. +
++ 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 new file mode 100644 index 0000000..e1a4e4e --- /dev/null +++ b/doc/doc_files/var_data.html @@ -0,0 +1,59 @@ + + +
+ + ++ RC Basic supports two basic types of data: Numbers and Strings. These data types can be used to represent any type of data used in a program. +
++ Numbers can be either integers or floating point. To designate an integer value you simply write out the number where you need to use it. Floating point numbers are similiar except that you would write a decimal point to denote the start of the floating point value. Look at the following: +
+
+ 5 'Integer Number
+
+ 5.5 'Floating Point Number
+
+ Strings are used to store and manipulate data other than numbers. They can be used to refer to single characters, words, sentences, paragraphs, etc. Look at the Following: +
+
+ "HELLO WORLD" 'String
+
+ Notice that the string "HELLO WORLD" is surrounded by quotation marks. When setting a strings value manually you must use quotation marks. +
++ In order to be able to use string or number data to do anything useful we have to be able to store and retrieve the data. This is what variables are used for. Look at the following: +
+
+ A = 5
+
+ B$ = "HELLO WORLD"
+
+ The above example creates two variables. The variable A stores the number 5 and the variable B$ stores the string HELLO WORLD. Note that the variable B ends with a $. The $ has to be used when creating a string variable to let RC BASIC know its a string and to not treat it as a number. You only have to use the $ when you first create the variable. +
++ If you don't want to set the value of a variable when you create it you can create the variable with the DIM keyword like this: +
+
+ Dim A
+
+ Dim B$
+
+ You can also declare multiple variables with DIM. +
++ Dim A, B$, C +
++ + + \ No newline at end of file diff --git a/doc/doc_files/videoend.html b/doc/doc_files/videoend.html new file mode 100644 index 0000000..0c54bb4 --- /dev/null +++ b/doc/doc_files/videoend.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..be0496c --- /dev/null +++ b/doc/doc_files/videoexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..117f66d --- /dev/null +++ b/doc/doc_files/videoisplaying.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..ec887cb --- /dev/null +++ b/doc/doc_files/wait.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4597cdc --- /dev/null +++ b/doc/doc_files/waitkey.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d029003 --- /dev/null +++ b/doc/doc_files/warpmouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..820b931 --- /dev/null +++ b/doc/doc_files/warpmouseglobal.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9b39ea0 --- /dev/null +++ b/doc/doc_files/windowclip.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an image with a portion of the window stored +
+Related: + CanvasClip +
++ + + \ No newline at end of file diff --git a/doc/doc_files/windowevent_close.html b/doc/doc_files/windowevent_close.html new file mode 100644 index 0000000..cfd4652 --- /dev/null +++ b/doc/doc_files/windowevent_close.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..0771210 --- /dev/null +++ b/doc/doc_files/windowevent_maximize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..7300635 --- /dev/null +++ b/doc/doc_files/windowevent_minimize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..d8e6529 --- /dev/null +++ b/doc/doc_files/windowevent_resize.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3611124 --- /dev/null +++ b/doc/doc_files/windowexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..45662a4 --- /dev/null +++ b/doc/doc_files/windowhasinputfocus.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3da56fd --- /dev/null +++ b/doc/doc_files/windowhasmousefocus.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..97a56b1 --- /dev/null +++ b/doc/doc_files/windowisbordered.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..9a493e0 --- /dev/null +++ b/doc/doc_files/windowisfullscreen.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..6d7cd80 --- /dev/null +++ b/doc/doc_files/windowisgrabbed.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..1e41434 --- /dev/null +++ b/doc/doc_files/windowismaximized.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..bebd6a4 --- /dev/null +++ b/doc/doc_files/windowisminimized.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..4adbfa3 --- /dev/null +++ b/doc/doc_files/windowisresizable.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..62ad21a --- /dev/null +++ b/doc/doc_files/windowisvisible.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..3013cdd --- /dev/null +++ b/doc/doc_files/windowmode.html @@ -0,0 +1,39 @@ + + +
+ + ++ Returns a bitmask of the combined window flags that can be used in OpenWindow() to set the mode for the window. +
++ Each flag is a boolean that determines whether or not to set that flag in the mask. +
++ Note: For most use cases, one of the following will work +
++ Window +
+
+ mode = WindowMode(1, 0, 0, 0, 0)
+
+
Fullscreen
+
+ mode = WindowMode(1, 1, 0, 0, 0)
+
Related: + OpenWindow + GetWindowMode +
++ + + \ No newline at end of file diff --git a/doc/doc_files/windowtitle.html b/doc/doc_files/windowtitle.html new file mode 100644 index 0000000..f833cd0 --- /dev/null +++ b/doc/doc_files/windowtitle.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the window title +
+Related: + SetWindowTitle +
++ + + \ No newline at end of file diff --git a/doc/doc_files/write.html b/doc/doc_files/write.html new file mode 100644 index 0000000..859d72c --- /dev/null +++ b/doc/doc_files/write.html @@ -0,0 +1,20 @@ + + +
+ + ++ Writes a string to a file. +
+Related: + WriteLine +
++ + + \ No newline at end of file diff --git a/doc/doc_files/writebyte.html b/doc/doc_files/writebyte.html new file mode 100644 index 0000000..d760352 --- /dev/null +++ b/doc/doc_files/writebyte.html @@ -0,0 +1,20 @@ + + +
+ + ++ Writes a byte to the file. +
+Related: + WriteByteBuffer +
++ + + \ No newline at end of file diff --git a/doc/doc_files/writebytebuffer.html b/doc/doc_files/writebytebuffer.html new file mode 100644 index 0000000..5534572 --- /dev/null +++ b/doc/doc_files/writebytebuffer.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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 new file mode 100644 index 0000000..126cd6f --- /dev/null +++ b/doc/doc_files/writeline.html @@ -0,0 +1,21 @@ + + +
+ + ++ Writes a string to a text file with a new-line appended at the end +
+Related: + Write + ReadLine$ +
++ + + \ No newline at end of file diff --git a/doc/doc_files/xorbit.html b/doc/doc_files/xorbit.html new file mode 100644 index 0000000..81d1fe0 --- /dev/null +++ b/doc/doc_files/xorbit.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the value of the bitwise XOR operation on the operands A and B +
++ + + \ No newline at end of file diff --git a/doc/doc_files/zeromatrix.html b/doc/doc_files/zeromatrix.html new file mode 100644 index 0000000..2700775 --- /dev/null +++ b/doc/doc_files/zeromatrix.html @@ -0,0 +1,23 @@ + + +
+ + ++ Clears a matrix +
++ Note: Literally does the exact same thing as ClearMatrix. Its here as a legacy call convention. +
+Related: + ClearMatrix +
++ + + \ No newline at end of file diff --git a/doc/files/abs.html b/doc/files/abs.html new file mode 100644 index 0000000..12fd3b1 --- /dev/null +++ b/doc/files/abs.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the absolute value of n +
++ + + \ No newline at end of file diff --git a/doc/files/abs.txt b/doc/files/abs.txt new file mode 100644 index 0000000..2e9aecd --- /dev/null +++ b/doc/files/abs.txt @@ -0,0 +1,4 @@ +#title Abs [RCBasic Doc] +#header function Abs(n) + +Returns the absolute value of n diff --git a/doc/files/accelname.html b/doc/files/accelname.html new file mode 100644 index 0000000..c3fadcd --- /dev/null +++ b/doc/files/accelname.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the name of an accelerometer +
++ + + \ No newline at end of file diff --git a/doc/files/accelname.txt b/doc/files/accelname.txt new file mode 100644 index 0000000..9acdb1e --- /dev/null +++ b/doc/files/accelname.txt @@ -0,0 +1,6 @@ +#title AccelName$ [RCBasic Doc] +#header function AccelName$(accel_num) + + +Returns the name of an accelerometer + diff --git a/doc/files/acos.html b/doc/files/acos.html new file mode 100644 index 0000000..35de12c --- /dev/null +++ b/doc/files/acos.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the Arcosine of n +
++ + + \ No newline at end of file diff --git a/doc/files/acos.txt b/doc/files/acos.txt new file mode 100644 index 0000000..0553ead --- /dev/null +++ b/doc/files/acos.txt @@ -0,0 +1,4 @@ +#title Acos [RCBasic Doc] +#header function Acos(n) + +Returns the Arcosine of n diff --git a/doc/files/activecanvas.html b/doc/files/activecanvas.html new file mode 100644 index 0000000..efa7f07 --- /dev/null +++ b/doc/files/activecanvas.html @@ -0,0 +1,33 @@ + + +
+ + ++ Returns the canvas that drawing commands are currently applied to +
+
+ c1 = OpenCanvas(640, 480, 0, 0, 640, 480, 0)
+ c2 = OpenCanvas(640, 480, 0, 0, 640, 480, 0)
+
+ Canvas(c1)
+
+ If ActiveCanvas() = c1 Then
+ Print "Active canvas is c1"
+ End If
+
+ Canvas(c2)
+
+ If ActiveCanvas() = c2 Then
+ Print "Active canvas is now c2"
+ End If
+
+ + + \ No newline at end of file diff --git a/doc/files/activecanvas.txt b/doc/files/activecanvas.txt new file mode 100644 index 0000000..11e416b --- /dev/null +++ b/doc/files/activecanvas.txt @@ -0,0 +1,22 @@ +#title ActiveCanvas [RCBasic Doc] +#header function ActiveCanvas() + + +Returns the canvas that drawing commands are currently applied to + +#code +c1 = OpenCanvas(640, 480, 0, 0, 640, 480, 0) +c2 = OpenCanvas(640, 480, 0, 0, 640, 480, 0) + +Canvas(c1) + +If ActiveCanvas() = c1 Then + Print "Active canvas is c1" +End If + +Canvas(c2) + +If ActiveCanvas() = c2 Then + Print "Active canvas is now c2" +End If +#/code diff --git a/doc/files/actoranimationislooped.html b/doc/files/actoranimationislooped.html new file mode 100644 index 0000000..6c82705 --- /dev/null +++ b/doc/files/actoranimationislooped.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns true if an actors animation is set to looped. +
++ Note: Actor animation is set to looped with the LoopActorAnimation() function. +
+Related: + LoopActorAnimation +
++ + + \ No newline at end of file diff --git a/doc/files/actoranimationislooped.txt b/doc/files/actoranimationislooped.txt new file mode 100644 index 0000000..81c89ee --- /dev/null +++ b/doc/files/actoranimationislooped.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/actoranimationisplaying.html new file mode 100644 index 0000000..7c5fb03 --- /dev/null +++ b/doc/files/actoranimationisplaying.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/actoranimationisplaying.txt b/doc/files/actoranimationisplaying.txt new file mode 100644 index 0000000..e833853 --- /dev/null +++ b/doc/files/actoranimationisplaying.txt @@ -0,0 +1,6 @@ +#title ActorAnimationIsPlaying [RCBasic Doc] +#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.html b/doc/files/actorexists.html new file mode 100644 index 0000000..63778ab --- /dev/null +++ b/doc/files/actorexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the id passed is a valid actor +
++ + + \ No newline at end of file diff --git a/doc/files/actorexists.txt b/doc/files/actorexists.txt new file mode 100644 index 0000000..2b585c8 --- /dev/null +++ b/doc/files/actorexists.txt @@ -0,0 +1,4 @@ +#title ActorExists [RCBasic Doc] +#header function ActorExists( actor ) + +Returns true if the id passed is a valid actor diff --git a/doc/files/actorisintransition.html b/doc/files/actorisintransition.html new file mode 100644 index 0000000..3c26175 --- /dev/null +++ b/doc/files/actorisintransition.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns true if actor is in a transition from its current frame to the frame set in the StartActorTransition() function +
+Related: + StartActorTransition + StopActorTransition + GetActorTransitionTime +
++ + + \ No newline at end of file diff --git a/doc/files/actorisintransition.txt b/doc/files/actorisintransition.txt new file mode 100644 index 0000000..6839ff7 --- /dev/null +++ b/doc/files/actorisintransition.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/actorissolid.html new file mode 100644 index 0000000..71c2baa --- /dev/null +++ b/doc/files/actorissolid.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns true or false depending on if physics and collision response applies to an actor. +
++ Note: Collision is still able to be checked on an actor but the actor will be like a ghost able to go through wall and other objects. +
+
+ SetActorSolid(actor, true)
+ Print "Actor solid state: "; ActorIsSolid(actor) 'This will output 1
+ SetActorSolid(actor, false)
+ Print "Actor solid state: "; ActorIsSolid(actor) 'This will output 0
+ #/end
+
+ #ref SetActorSolid
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/actorissolid.txt b/doc/files/actorissolid.txt
new file mode 100644
index 0000000..8233454
--- /dev/null
+++ b/doc/files/actorissolid.txt
@@ -0,0 +1,15 @@
+#title ActorIsSolid [RCBasic Doc]
+#header function ActorIsSolid(actor)
+
+Returns true or false depending on if physics and collision response applies to an actor.
+
+Note: Collision is still able to be checked on an actor but the actor will be like a ghost able to go through wall and other objects.
+
+#code
+SetActorSolid(actor, true)
+Print "Actor solid state: "; ActorIsSolid(actor) 'This will output 1
+SetActorSolid(actor, false)
+Print "Actor solid state: "; ActorIsSolid(actor) 'This will output 0
+#/end
+
+#ref SetActorSolid
diff --git a/doc/files/actorisvisible.html b/doc/files/actorisvisible.html
new file mode 100644
index 0000000..e8c734f
--- /dev/null
+++ b/doc/files/actorisvisible.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+ function ActorIsVisible( actor )
+ Returns true if an actor is visible +
+
+ SetActorVisible(actor, true)
+ Print "Actor solid state: "; ActorIsVisible(actor) 'Outputs 1
+ SetActorSolid(actor, false)
+ Print "Actor solid state: "; ActorIsSolid(actor) 'Outputs 0
+
Related: + SetActorVisible +
++ + + \ No newline at end of file diff --git a/doc/files/actorisvisible.txt b/doc/files/actorisvisible.txt new file mode 100644 index 0000000..3b85c29 --- /dev/null +++ b/doc/files/actorisvisible.txt @@ -0,0 +1,13 @@ +#title ActorIsVisible [RCBasic Doc] +#header function ActorIsVisible( actor ) + +Returns true if an actor is visible + +#code +SetActorVisible(actor, true) +Print "Actor solid state: "; ActorIsVisible(actor) 'Outputs 1 +SetActorSolid(actor, false) +Print "Actor solid state: "; ActorIsSolid(actor) 'Outputs 0 +#/code + +#ref SetActorVisible diff --git a/doc/files/addactorshadow.html b/doc/files/addactorshadow.html new file mode 100644 index 0000000..d6b37af --- /dev/null +++ b/doc/files/addactorshadow.html @@ -0,0 +1,23 @@ + + +
+ + ++ Cast a shadow on an actor during lighting calculations +
++ Note: Also check the section on lights for more info +
+Related: + RemoveActorShadow +
++ + + \ No newline at end of file diff --git a/doc/files/addactorshadow.txt b/doc/files/addactorshadow.txt new file mode 100644 index 0000000..4680595 --- /dev/null +++ b/doc/files/addactorshadow.txt @@ -0,0 +1,9 @@ +#title AddActorShadow [RCBasic Doc] +#header sub AddActorShadow( actor ) + +Cast a shadow on an actor during lighting calculations + +Note: Also check the section on lights for more info + + +#ref RemoveActorShadow diff --git a/doc/files/addmatrix.html b/doc/files/addmatrix.html new file mode 100644 index 0000000..5360855 --- /dev/null +++ b/doc/files/addmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Adds matrix mA to matrix mB and stores the results in mC +
++ + + \ No newline at end of file diff --git a/doc/files/addmatrix.txt b/doc/files/addmatrix.txt new file mode 100644 index 0000000..dd6365e --- /dev/null +++ b/doc/files/addmatrix.txt @@ -0,0 +1,4 @@ +#title AddMatrix [RCBasic Doc] +#header function AddMatrix(mA, mB, mC) + +Adds matrix mA to matrix mB and stores the results in mC diff --git a/doc/files/addmeshbuffer.html b/doc/files/addmeshbuffer.html new file mode 100644 index 0000000..af6b31e --- /dev/null +++ b/doc/files/addmeshbuffer.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the vertices, normals, and texture coordinates for a mesh +
+Related: + CreateMesh +
++ + + \ No newline at end of file diff --git a/doc/files/addmeshbuffer.txt b/doc/files/addmeshbuffer.txt new file mode 100644 index 0000000..c9f8296 --- /dev/null +++ b/doc/files/addmeshbuffer.txt @@ -0,0 +1,6 @@ +#title AddMeshBuffer [RCBasic Doc] +#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/addsceneskybox.html b/doc/files/addsceneskybox.html new file mode 100644 index 0000000..fc179b2 --- /dev/null +++ b/doc/files/addsceneskybox.html @@ -0,0 +1,21 @@ + + +
+ + ++ Generates a skybox based on the provided images. +
+Related: + AddSceneSkyDome + AddSceneSkyDomeEx +
++ + + \ No newline at end of file diff --git a/doc/files/addsceneskybox.txt b/doc/files/addsceneskybox.txt new file mode 100644 index 0000000..dcb6afd --- /dev/null +++ b/doc/files/addsceneskybox.txt @@ -0,0 +1,6 @@ +#title AddSceneSkyBox [RCBasic Doc] +#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.html b/doc/files/addsceneskydome.html new file mode 100644 index 0000000..5b56126 --- /dev/null +++ b/doc/files/addsceneskydome.html @@ -0,0 +1,20 @@ + + +
+ + ++ Adds a sky dome to the scene +
+Related: + AddSceneSkyDomeEx +
++ + + \ No newline at end of file diff --git a/doc/files/addsceneskydome.txt b/doc/files/addsceneskydome.txt new file mode 100644 index 0000000..7f29b40 --- /dev/null +++ b/doc/files/addsceneskydome.txt @@ -0,0 +1,6 @@ +#title AddSceneSkyDome [RCBasic Doc] +#header sub AddSceneSkyDome( img ) + +Adds a sky dome to the scene + +#ref AddSceneSkyDomeEx diff --git a/doc/files/addsceneskydomeex.html b/doc/files/addsceneskydomeex.html new file mode 100644 index 0000000..fa4fa68 --- /dev/null +++ b/doc/files/addsceneskydomeex.html @@ -0,0 +1,41 @@ + + +
+ + ++ Adds a sky dome to the scene +
+Related: + AddSceneSkyBox + AddSceneSkyDome +
++ + + \ No newline at end of file diff --git a/doc/files/addsceneskydomeex.txt b/doc/files/addsceneskydomeex.txt new file mode 100644 index 0000000..170e06c --- /dev/null +++ b/doc/files/addsceneskydomeex.txt @@ -0,0 +1,15 @@ +#title AddSceneSkyDomeEx [RCBasic Doc] +#header sub AddSceneSkyDomeEx( img, horiRes, vertRes, txPercentage, spherePercentage, radius) + +Adds a sky dome to the scene + +#list +#li img - The texture for the sky dome +#li horiRes - Number of vertices of a horizontal layer of the sphere. +#li vertRes - Number of vertices of a vertical layer of the sphere. +#li txPercentage - How much of the height of the texture is used. Should be between 0 and 1. +#li spherePercentage - How much of the sphere is drawn. Value should be between 0 and 2, where 1 is an exact half-sphere and 2 is a full sphere. +#li radius - The Radius of the sphere +#/list + +#ref AddSceneSkyBox AddSceneSkyDome diff --git a/doc/files/adjointmatrix.html b/doc/files/adjointmatrix.html new file mode 100644 index 0000000..708eda7 --- /dev/null +++ b/doc/files/adjointmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores the adjoint matrix of mA in mB +
++ + + \ No newline at end of file diff --git a/doc/files/adjointmatrix.txt b/doc/files/adjointmatrix.txt new file mode 100644 index 0000000..1291a51 --- /dev/null +++ b/doc/files/adjointmatrix.txt @@ -0,0 +1,4 @@ +#title AdjointMatrix [RCBasic Doc] +#header function AdjointMatrix(mA, mB) + +Stores the adjoint matrix of mA in mB diff --git a/doc/files/andbit.html b/doc/files/andbit.html new file mode 100644 index 0000000..34287ba --- /dev/null +++ b/doc/files/andbit.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the bitwise AND operation of 2 numbers +
++ + + \ No newline at end of file diff --git a/doc/files/andbit.txt b/doc/files/andbit.txt new file mode 100644 index 0000000..bd9085d --- /dev/null +++ b/doc/files/andbit.txt @@ -0,0 +1,4 @@ +#title AndBit [RCBasic Doc] +#header function AndBit(a,b) + +Returns the bitwise AND operation of 2 numbers diff --git a/doc/files/android_getexternalstoragepath.html b/doc/files/android_getexternalstoragepath.html new file mode 100644 index 0000000..cac6134 --- /dev/null +++ b/doc/files/android_getexternalstoragepath.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the designated external storage path +
+Related: + Android_GetExternalStorageState + Android_GetInternalStoragePath$ +
++ + + \ No newline at end of file diff --git a/doc/files/android_getexternalstoragepath.txt b/doc/files/android_getexternalstoragepath.txt new file mode 100644 index 0000000..7ea51de --- /dev/null +++ b/doc/files/android_getexternalstoragepath.txt @@ -0,0 +1,6 @@ +#title Android_GetExternalStoragePath$ [RCBasic Doc] +#header function Android_GetExternalStoragePath$() + +Returns the designated external storage path + +#ref Android_GetExternalStorageState Android_GetInternalStoragePath$ diff --git a/doc/files/android_getexternalstoragestate.html b/doc/files/android_getexternalstoragestate.html new file mode 100644 index 0000000..7f60b6a --- /dev/null +++ b/doc/files/android_getexternalstoragestate.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns a bitmask of these values: +
+
+ If AndBit( Android_GetExternalStorageState(), ANDROID_EXTERNAL_STORAGE_READ ) Then
+ Print "Can read from external storage"
+ End If
+
Related: + Android_GetExternalStoragePath$ + Android_GetInternalStoragePath$ +
++ + + \ No newline at end of file diff --git a/doc/files/android_getexternalstoragestate.txt b/doc/files/android_getexternalstoragestate.txt new file mode 100644 index 0000000..2b31fa4 --- /dev/null +++ b/doc/files/android_getexternalstoragestate.txt @@ -0,0 +1,16 @@ +#title Android_GetExternalStorageState [RCBasic Doc] +#header function Android_GetExternalStorageState() + +Returns a bitmask of these values: +#list +#li ANDROID_EXTERNAL_STORAGE_READ +#li ANDROID_EXTERNAL_STORAGE_WRITE +#/list + +#code +If AndBit( Android_GetExternalStorageState(), ANDROID_EXTERNAL_STORAGE_READ ) Then + Print "Can read from external storage" +End If +#/code + +#ref Android_GetExternalStoragePath$ Android_GetInternalStoragePath$ diff --git a/doc/files/android_getinternalstoragepath.html b/doc/files/android_getinternalstoragepath.html new file mode 100644 index 0000000..1c6c85e --- /dev/null +++ b/doc/files/android_getinternalstoragepath.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the internal storage path +
+Related: + Android_GetExternalStorageState + Android_GetExternalStoragePath$ +
++ + + \ No newline at end of file diff --git a/doc/files/android_getinternalstoragepath.txt b/doc/files/android_getinternalstoragepath.txt new file mode 100644 index 0000000..abeb531 --- /dev/null +++ b/doc/files/android_getinternalstoragepath.txt @@ -0,0 +1,6 @@ +#title Android_GetInternalStoragePath$ [RCBasic Doc] +#header function Android_GetInternalStoragePath$() + +Returns the internal storage path + +#ref Android_GetExternalStorageState Android_GetExternalStoragePath$ diff --git a/doc/files/android_jni_message.html b/doc/files/android_jni_message.html new file mode 100644 index 0000000..ae39c49 --- /dev/null +++ b/doc/files/android_jni_message.html @@ -0,0 +1,20 @@ + + +
+ + ++ Passes arg$ to the rcbasic_android_interface() method in the java code for your android app. The java method returns a string. +
+Related: + Runtime_Utility_Message$ +
++ + + \ No newline at end of file diff --git a/doc/files/android_jni_message.txt b/doc/files/android_jni_message.txt new file mode 100644 index 0000000..f44ab82 --- /dev/null +++ b/doc/files/android_jni_message.txt @@ -0,0 +1,6 @@ +#title Android_JNI_Message$ [RCBasic Doc] +#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.html b/doc/files/applyactorcentralforcelocal.html new file mode 100644 index 0000000..7822d13 --- /dev/null +++ b/doc/files/applyactorcentralforcelocal.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorCentralForceWorld + ApplyActorCentralImpulseLocal + ApplyActorCentralImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorcentralforcelocal.txt b/doc/files/applyactorcentralforcelocal.txt new file mode 100644 index 0000000..94abf73 --- /dev/null +++ b/doc/files/applyactorcentralforcelocal.txt @@ -0,0 +1,10 @@ +#title ApplyActorCentralForceLocal [RCBasic Doc] +#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. + +#list +#li x,y,z - direction of the force +#/list + +#ref ApplyActorCentralForceWorld ApplyActorCentralImpulseLocal ApplyActorCentralImpulseWorld diff --git a/doc/files/applyactorcentralforceworld.html b/doc/files/applyactorcentralforceworld.html new file mode 100644 index 0000000..9691595 --- /dev/null +++ b/doc/files/applyactorcentralforceworld.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorCentralForceLocal + ApplyActorCentralImpulseLocal + ApplyActorCentralImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorcentralforceworld.txt b/doc/files/applyactorcentralforceworld.txt new file mode 100644 index 0000000..30d917a --- /dev/null +++ b/doc/files/applyactorcentralforceworld.txt @@ -0,0 +1,10 @@ +#title ApplyActorCentralForceWorld [RCBasic Doc] +#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. + +#list +#li x,y,z - direction of the force +#/list + +#ref ApplyActorCentralForceLocal ApplyActorCentralImpulseLocal ApplyActorCentralImpulseWorld diff --git a/doc/files/applyactorcentralimpulselocal.html b/doc/files/applyactorcentralimpulselocal.html new file mode 100644 index 0000000..8a6eb1e --- /dev/null +++ b/doc/files/applyactorcentralimpulselocal.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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). +
+Related: + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld + ApplyActorCentralImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorcentralimpulselocal.txt b/doc/files/applyactorcentralimpulselocal.txt new file mode 100644 index 0000000..8c992f1 --- /dev/null +++ b/doc/files/applyactorcentralimpulselocal.txt @@ -0,0 +1,10 @@ +#title ApplyActorCentralImpulseLocal [RCBasic Doc] +#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). + +#list +#li x,y,z - direction of the impulse +#/list + +#ref ApplyActorCentralForceLocal ApplyActorCentralForceWorld ApplyActorCentralImpulseWorld diff --git a/doc/files/applyactorcentralimpulseworld.html b/doc/files/applyactorcentralimpulseworld.html new file mode 100644 index 0000000..2bda8cb --- /dev/null +++ b/doc/files/applyactorcentralimpulseworld.html @@ -0,0 +1,27 @@ + + +
+ + ++ 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). +
+Related: + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld + ApplyActorCentralImpulseLocal +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorcentralimpulseworld.txt b/doc/files/applyactorcentralimpulseworld.txt new file mode 100644 index 0000000..388714d --- /dev/null +++ b/doc/files/applyactorcentralimpulseworld.txt @@ -0,0 +1,11 @@ +#title ApplyActorCentralImpulseWorld [RCBasic Doc] +#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). + +#list +#li x,y,z - direction of the impulse +#/list + +#ref ApplyActorCentralForceLocal ApplyActorCentralForceWorld ApplyActorCentralImpulseLocal + diff --git a/doc/files/applyactordamping.html b/doc/files/applyactordamping.html new file mode 100644 index 0000000..eea318b --- /dev/null +++ b/doc/files/applyactordamping.html @@ -0,0 +1,38 @@ + + +
+ + ++ Reduces the velocity of an actor over time, simulating the effect of friction or air resistance. +
++ This function applies the linear and angular damping values set with the SetActorDamping() function. +
+
+ init_damping = False
+ SetActorDamping(actor, 0.1, 0.5)
+ ApplyActorCentralImpulse(actor, 300, 0, 0)
+
+ While True
+ If Not init_damping Then
+ ApplyActorDamping(actor, 5.0) 'Will apply the damping effect for 5 seconds
+ init_damping = True
+ End If
+ Update()
+ Wend
+
Related: + setActorDamping + getActorLinearDamping + getActorAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/files/applyactordamping.txt b/doc/files/applyactordamping.txt new file mode 100644 index 0000000..525881c --- /dev/null +++ b/doc/files/applyactordamping.txt @@ -0,0 +1,22 @@ +#title ApplyActorDamping [RCBasic Doc] +#header sub ApplyActorDamping( actor, timeStep) + +Reduces the velocity of an actor over time, simulating the effect of friction or air resistance. + +This function applies the linear and angular damping values set with the SetActorDamping() function. + +#code +init_damping = False +SetActorDamping(actor, 0.1, 0.5) +ApplyActorCentralImpulse(actor, 300, 0, 0) + +While True + If Not init_damping Then + ApplyActorDamping(actor, 5.0) 'Will apply the damping effect for 5 seconds + init_damping = True + End If + Update() +Wend +#/code + +#ref setActorDamping getActorLinearDamping getActorAngularDamping diff --git a/doc/files/applyactorforcelocal.html b/doc/files/applyactorforcelocal.html new file mode 100644 index 0000000..c6b4f27 --- /dev/null +++ b/doc/files/applyactorforcelocal.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorForceWorld + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorforcelocal.txt b/doc/files/applyactorforcelocal.txt new file mode 100644 index 0000000..a7e104f --- /dev/null +++ b/doc/files/applyactorforcelocal.txt @@ -0,0 +1,11 @@ +#title ApplyActorForceLocal [RCBasic Doc] +#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. + +#list +#li x,y,z - direction of the force +#li rel_x, rel_y, rel_z - position to apply the force to relative to the center of mass +#/list + +#ref ApplyActorForceWorld ApplyActorCentralForceLocal ApplyActorCentralForceWorld diff --git a/doc/files/applyactorforceworld.html b/doc/files/applyactorforceworld.html new file mode 100644 index 0000000..13e7bb0 --- /dev/null +++ b/doc/files/applyactorforceworld.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorForceLocal + ApplyActorCentralForceLocal + ApplyActorCentralForceWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorforceworld.txt b/doc/files/applyactorforceworld.txt new file mode 100644 index 0000000..65462be --- /dev/null +++ b/doc/files/applyactorforceworld.txt @@ -0,0 +1,11 @@ +#title ApplyActorForceWorld [RCBasic Doc] +#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. + +#list +#li x,y,z - direction of the force +#li rel_x, rel_y, rel_z - position to apply the force to relative to the center of mass +#/list + +#ref ApplyActorForceLocal ApplyActorCentralForceLocal ApplyActorCentralForceWorld diff --git a/doc/files/applyactorimpulselocal.html b/doc/files/applyactorimpulselocal.html new file mode 100644 index 0000000..a1a8754 --- /dev/null +++ b/doc/files/applyactorimpulselocal.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorImpulseWorld + ApplyActorForceLocal + ApplyActorForceWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorimpulselocal.txt b/doc/files/applyactorimpulselocal.txt new file mode 100644 index 0000000..03e8898 --- /dev/null +++ b/doc/files/applyactorimpulselocal.txt @@ -0,0 +1,12 @@ +#title ApplyActorImpulseLocal [RCBasic Doc] +#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. + +#list +#li x,y,z - direction of the impulse +#li rel_x, rel_y, rel_z - position to apply the force to relative to the center of mass +#/list + +#ref ApplyActorImpulseWorld ApplyActorForceLocal ApplyActorForceWorld + diff --git a/doc/files/applyactorimpulseworld.html b/doc/files/applyactorimpulseworld.html new file mode 100644 index 0000000..b2a8d08 --- /dev/null +++ b/doc/files/applyactorimpulseworld.html @@ -0,0 +1,30 @@ + + +
+ + ++ 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. +
+Related: + ApplyActorImpulseLocal + ApplyActorForceLocal + ApplyActorForceWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactorimpulseworld.txt b/doc/files/applyactorimpulseworld.txt new file mode 100644 index 0000000..92d6da9 --- /dev/null +++ b/doc/files/applyactorimpulseworld.txt @@ -0,0 +1,11 @@ +#title ApplyActorImpulseWorld [RCBasic Doc] +#header Sub ApplyActorImpulseWorld( 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. + +#list +#li x,y,z - direction of the impulse +#li rel_x, rel_y, rel_z - position to apply the force to relative to the center of mass +#/list + +#ref ApplyActorImpulseLocal ApplyActorForceLocal ApplyActorForceWorld diff --git a/doc/files/applyactortorqueimpulselocal.html b/doc/files/applyactortorqueimpulselocal.html new file mode 100644 index 0000000..9c4ef56 --- /dev/null +++ b/doc/files/applyactortorqueimpulselocal.html @@ -0,0 +1,26 @@ + + +
+ + ++ Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. +
+Related: + ApplyActorTorque + ApplyActorTorqueImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactortorqueimpulselocal.txt b/doc/files/applyactortorqueimpulselocal.txt new file mode 100644 index 0000000..9ed03df --- /dev/null +++ b/doc/files/applyactortorqueimpulselocal.txt @@ -0,0 +1,10 @@ +#title ApplyActorTorqueImpulseLocal [RCBasic Doc] +#header Sub ApplyActorTorqueImpulseLocal( actor, x, y, z) + +Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. + +#list ul +#li x, y, z - Direction of rotation +#/list + +#ref ApplyActorTorque ApplyActorTorqueImpulseWorld diff --git a/doc/files/applyactortorqueimpulseworld.html b/doc/files/applyactortorqueimpulseworld.html new file mode 100644 index 0000000..ff2c529 --- /dev/null +++ b/doc/files/applyactortorqueimpulseworld.html @@ -0,0 +1,26 @@ + + +
+ + ++ Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. +
+Related: + ApplyActorTorque + ApplyActorTorqueImpulseLocal +
++ + + \ No newline at end of file diff --git a/doc/files/applyactortorqueimpulseworld.txt b/doc/files/applyactortorqueimpulseworld.txt new file mode 100644 index 0000000..e8126f5 --- /dev/null +++ b/doc/files/applyactortorqueimpulseworld.txt @@ -0,0 +1,10 @@ +#title ApplyActorTorqueImpulseWorld [RCBasic Doc] +#header Sub ApplyActorTorqueImpulseWorld( actor, x, y, z) + +Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. + +#list ul +#li x, y, z - Direction of rotation +#/list + +#ref ApplyActorTorque ApplyActorTorqueImpulseLocal diff --git a/doc/files/applyactortorquelocal.html b/doc/files/applyactortorquelocal.html new file mode 100644 index 0000000..04a2a1d --- /dev/null +++ b/doc/files/applyactortorquelocal.html @@ -0,0 +1,27 @@ + + +
+ + ++ Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. +
+Related: + ApplyActorTorqueWorld + ApplyActorTorqueImpulseLocal + ApplyActorTorqueImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactortorquelocal.txt b/doc/files/applyactortorquelocal.txt new file mode 100644 index 0000000..4e3a0ee --- /dev/null +++ b/doc/files/applyactortorquelocal.txt @@ -0,0 +1,10 @@ +#title ApplyActorTorqueLocal [RCBasic Doc] +#header Sub ApplyActorTorqueLocal( actor, x, y, z) + +Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. + +#list +#li x, y, z - direction of rotation +#/list + +#ref ApplyActorTorqueWorld ApplyActorTorqueImpulseLocal ApplyActorTorqueImpulseWorld diff --git a/doc/files/applyactortorqueworld.html b/doc/files/applyactortorqueworld.html new file mode 100644 index 0000000..70fc39e --- /dev/null +++ b/doc/files/applyactortorqueworld.html @@ -0,0 +1,27 @@ + + +
+ + ++ Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. +
+Related: + ApplyActorTorqueLocal + ApplyActorTorqueImpulseLocal + ApplyActorTorqueImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/files/applyactortorqueworld.txt b/doc/files/applyactortorqueworld.txt new file mode 100644 index 0000000..cde6ac9 --- /dev/null +++ b/doc/files/applyactortorqueworld.txt @@ -0,0 +1,11 @@ +#title ApplyActorTorqueWorld [RCBasic Doc] +#header Sub ApplyActorTorqueWorld( actor, x, y, z) + +Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. + +#list +#li x, y, z - direction of rotation +#/list + +#ref ApplyActorTorqueLocal ApplyActorTorqueImpulseLocal ApplyActorTorqueImpulseWorld + diff --git a/doc/files/applyspriteangularimpulse.html b/doc/files/applyspriteangularimpulse.html new file mode 100644 index 0000000..8652365 --- /dev/null +++ b/doc/files/applyspriteangularimpulse.html @@ -0,0 +1,20 @@ + + +
+ + ++ Apply an angular impulse to a body. This method affects the body’s rotational motion, changing its angular velocity based on the impulse applied. +
+Related: + ApplySpriteLinearImpulse +
++ + + \ No newline at end of file diff --git a/doc/files/applyspriteangularimpulse.txt b/doc/files/applyspriteangularimpulse.txt new file mode 100644 index 0000000..f95015d --- /dev/null +++ b/doc/files/applyspriteangularimpulse.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/applyspritecentralforce.html new file mode 100644 index 0000000..eb93348 --- /dev/null +++ b/doc/files/applyspritecentralforce.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/applyspritecentralforce.txt b/doc/files/applyspritecentralforce.txt new file mode 100644 index 0000000..2853be5 --- /dev/null +++ b/doc/files/applyspritecentralforce.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/applyspriteforce.html new file mode 100644 index 0000000..86ec72c --- /dev/null +++ b/doc/files/applyspriteforce.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/applyspriteforce.txt b/doc/files/applyspriteforce.txt new file mode 100644 index 0000000..e7c803f --- /dev/null +++ b/doc/files/applyspriteforce.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/applyspritelinearimpulse.html new file mode 100644 index 0000000..9a24e77 --- /dev/null +++ b/doc/files/applyspritelinearimpulse.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ApplySpriteAngularImpulse +
++ + + \ No newline at end of file diff --git a/doc/files/applyspritelinearimpulse.txt b/doc/files/applyspritelinearimpulse.txt new file mode 100644 index 0000000..2ec8881 --- /dev/null +++ b/doc/files/applyspritelinearimpulse.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/applyspritetorque.html new file mode 100644 index 0000000..c0aa765 --- /dev/null +++ b/doc/files/applyspritetorque.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/applyspritetorque.txt b/doc/files/applyspritetorque.txt new file mode 100644 index 0000000..6e8c84a --- /dev/null +++ b/doc/files/applyspritetorque.txt @@ -0,0 +1,4 @@ +#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/arraycopy.html b/doc/files/arraycopy.html new file mode 100644 index 0000000..01a2788 --- /dev/null +++ b/doc/files/arraycopy.html @@ -0,0 +1,25 @@ + + +
+ + ++ 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 +
+Related: + ArrayDim + ArraySize + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/files/arraycopy.txt b/doc/files/arraycopy.txt new file mode 100644 index 0000000..9e28c4a --- /dev/null +++ b/doc/files/arraycopy.txt @@ -0,0 +1,8 @@ +#title ArrayCopy [RCBasic Doc] +#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.html b/doc/files/arraydim.html new file mode 100644 index 0000000..c2b0268 --- /dev/null +++ b/doc/files/arraydim.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the number of dimensions in an array +
+Related: + ArrayCopy + ArrayFill + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/files/arraydim.txt b/doc/files/arraydim.txt new file mode 100644 index 0000000..4cba66b --- /dev/null +++ b/doc/files/arraydim.txt @@ -0,0 +1,6 @@ +#title ArrayDim [RCBasic Doc] +#header function ArrayDim(Byref id) + +Returns the number of dimensions in an array + +#ref ArrayCopy ArrayFill ArraySize diff --git a/doc/files/arrayfill.html b/doc/files/arrayfill.html new file mode 100644 index 0000000..3a86c70 --- /dev/null +++ b/doc/files/arrayfill.html @@ -0,0 +1,22 @@ + + +
+ + ++ Fills all the elements in an array with the value in fdata +
+Related: + ArrayCopy + ArrayDim + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/files/arrayfill.txt b/doc/files/arrayfill.txt new file mode 100644 index 0000000..08ff811 --- /dev/null +++ b/doc/files/arrayfill.txt @@ -0,0 +1,6 @@ +#title ArrayFill [RCBasic Doc] +#header Sub ArrayFill(ByRef src, fdata) + +Fills all the elements in an array with the value in fdata + +#ref ArrayCopy ArrayDim ArraySize diff --git a/doc/files/arrays.html b/doc/files/arrays.html new file mode 100644 index 0000000..add3644 --- /dev/null +++ b/doc/files/arrays.html @@ -0,0 +1,61 @@ + + +
+ + ++ In complex programs there is often a need to be able to store large amounts of data. It would be unreasonable to have to create a variable for each piece of data we may need to store. This is where an array can come in handy. Arrays are simply ways of using one variable to store multiple different values. You can create arrays of numbers or strings. Look at the following: +
+
+ Dim A[5]
+
+ The above example creates an array of numbers called A. A can store five numbers which are retrieved using A[0] to A[4]. Notice that A[4] is the last element in the array and not A[5]. That is because the first index in the array is 0 and the array only stores 5 numbers. To set the values in this array you could do the following: +
+
+ A[0] = 3
+ A[1] = 2
+ A[2] = 7
+ A[3] = 1
+ A[4] = 0
+
+ You would access and array just like you would a variable. Look at the following: +
+
+ X = A[0] + A[3] '( Based on the above example the variable X would be set to 4. )
+
+ To make a string variable you would do the same thing you do to make a number variable except you would use the $ just like you would use to make a normal string variable. Look at the following: +
+
+ Dim B$[3]
+
+ B[0] = "ABC"
+ B[1] = "DEF"
+ B[2] = "I KNOW THE ALPHABET"
+
+ Arrays can have up to 3 dimensions. Adding more dimensions to an array can make organizing data in the array easier depending on the situation. Look at the following: +
+
+ Dim X[2, 3]
+ Dim Y[3, 4, 5]
+
+ The above example creates a 2 dimensional array called X which has 2 indices in its first dimension. Its second dimension has 3 indices. This means that each of the 2 indices in the first dimension can store 3 different values. So X can store a total of 6 different values. The second line creates a 3 dimensional array called Y. Y has 3 indices in its first dimension. Each of those 3 indices has 4 indices in its 2nd dimension. Each of the 4 indices has 5 values it can store. This means that Y can store a total of 60 different values. Look at the following for an example on how to work with these multi-dimensional arrays: +
+
+ X[0, 2] = 5 '(This line sets the 3rd value in the first index to 5. Remember that the first index is always 0 so the 3rd index will be 2.)
+
+ 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/files/arrays.txt b/doc/files/arrays.txt new file mode 100644 index 0000000..b9985d4 --- /dev/null +++ b/doc/files/arrays.txt @@ -0,0 +1,44 @@ +#title RCBasic Arrays [RCBasic Doc] +#header ARRAYS + + +In complex programs there is often a need to be able to store large amounts of data. It would be unreasonable to have to create a variable for each piece of data we may need to store. This is where an array can come in handy. Arrays are simply ways of using one variable to store multiple different values. You can create arrays of numbers or strings. Look at the following: +#code +Dim A[5] +#/code + +The above example creates an array of numbers called A. A can store five numbers which are retrieved using A[0] to A[4]. Notice that A[4] is the last element in the array and not A[5]. That is because the first index in the array is 0 and the array only stores 5 numbers. To set the values in this array you could do the following: +#code +A[0] = 3 +A[1] = 2 +A[2] = 7 +A[3] = 1 +A[4] = 0 +#/code + +You would access and array just like you would a variable. Look at the following: +#code +X = A[0] + A[3] '( Based on the above example the variable X would be set to 4. ) +#/code + +To make a string variable you would do the same thing you do to make a number variable except you would use the $ just like you would use to make a normal string variable. Look at the following: +#code +Dim B$[3] + +B[0] = "ABC" +B[1] = "DEF" +B[2] = "I KNOW THE ALPHABET" +#/code + +Arrays can have up to 3 dimensions. Adding more dimensions to an array can make organizing data in the array easier depending on the situation. Look at the following: +#code +Dim X[2, 3] +Dim Y[3, 4, 5] +#/code + +The above example creates a 2 dimensional array called X which has 2 indices in its first dimension. Its second dimension has 3 indices. This means that each of the 2 indices in the first dimension can store 3 different values. So X can store a total of 6 different values. The second line creates a 3 dimensional array called Y. Y has 3 indices in its first dimension. Each of those 3 indices has 4 indices in its 2nd dimension. Each of the 4 indices has 5 values it can store. This means that Y can store a total of 60 different values. Look at the following for an example on how to work with these multi-dimensional arrays: +#code +X[0, 2] = 5 '(This line sets the 3rd value in the first index to 5. Remember that the first index is always 0 so the 3rd index will be 2.) + +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. ) +#/code diff --git a/doc/files/arraysize.html b/doc/files/arraysize.html new file mode 100644 index 0000000..704c5a3 --- /dev/null +++ b/doc/files/arraysize.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the number of elements in the given dimension of an array +
+Related: + ArrayDim + ArrayCopy + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/files/arraysize.txt b/doc/files/arraysize.txt new file mode 100644 index 0000000..e05767e --- /dev/null +++ b/doc/files/arraysize.txt @@ -0,0 +1,6 @@ +#title ArraySize [RCBasic Doc] +#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.html b/doc/files/asc.html new file mode 100644 index 0000000..14aa178 --- /dev/null +++ b/doc/files/asc.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the ASCII value of a character. +
++ + + \ No newline at end of file diff --git a/doc/files/asc.txt b/doc/files/asc.txt new file mode 100644 index 0000000..6450a9e --- /dev/null +++ b/doc/files/asc.txt @@ -0,0 +1,4 @@ +#title Asc [RCBasic Doc] +#header Function Asc(c$) + +Returns the ASCII value of a character. diff --git a/doc/files/asin.html b/doc/files/asin.html new file mode 100644 index 0000000..53ff2c3 --- /dev/null +++ b/doc/files/asin.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the ArcSine of a number. +
++ + + \ No newline at end of file diff --git a/doc/files/asin.txt b/doc/files/asin.txt new file mode 100644 index 0000000..c1ab938 --- /dev/null +++ b/doc/files/asin.txt @@ -0,0 +1,4 @@ +#title Asin [RCBasic Doc] +#header Function Asin(n) + +Returns the ArcSine of a number. diff --git a/doc/files/atan.html b/doc/files/atan.html new file mode 100644 index 0000000..06fe174 --- /dev/null +++ b/doc/files/atan.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the ArcTangent of a number. +
++ + + \ No newline at end of file diff --git a/doc/files/atan.txt b/doc/files/atan.txt new file mode 100644 index 0000000..f23eeaf --- /dev/null +++ b/doc/files/atan.txt @@ -0,0 +1,4 @@ +#title Atan [RCBasic Doc] +#header Function Atan(n) + +Returns the ArcTangent of a number. diff --git a/doc/files/atan2.html b/doc/files/atan2.html new file mode 100644 index 0000000..579e4d7 --- /dev/null +++ b/doc/files/atan2.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the ArcTangent of x and y +
++ + + \ No newline at end of file diff --git a/doc/files/atan2.txt b/doc/files/atan2.txt new file mode 100644 index 0000000..fd37713 --- /dev/null +++ b/doc/files/atan2.txt @@ -0,0 +1,4 @@ +#title ATan2 [RCBasic Doc] +#header Function ATan2(y, x) + +Returns the ArcTangent of x and y diff --git a/doc/files/augmentmatrix.html b/doc/files/augmentmatrix.html new file mode 100644 index 0000000..a7005d5 --- /dev/null +++ b/doc/files/augmentmatrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/augmentmatrix.txt b/doc/files/augmentmatrix.txt new file mode 100644 index 0000000..2a0e4c5 --- /dev/null +++ b/doc/files/augmentmatrix.txt @@ -0,0 +1,6 @@ +#title AugmentMatrix [RCBasic Doc] +#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.html b/doc/files/bin.html new file mode 100644 index 0000000..a3ebf49 --- /dev/null +++ b/doc/files/bin.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the binary representation of a number. +
++ + + \ No newline at end of file diff --git a/doc/files/bin.txt b/doc/files/bin.txt new file mode 100644 index 0000000..7b40444 --- /dev/null +++ b/doc/files/bin.txt @@ -0,0 +1,4 @@ +#title Bin$ [RCBasic Doc] +#header function Bin$(n) + +Returns the binary representation of a number. diff --git a/doc/files/box3d.html b/doc/files/box3d.html new file mode 100644 index 0000000..d8dd34b --- /dev/null +++ b/doc/files/box3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a box in 3D space +
++ + + \ No newline at end of file diff --git a/doc/files/box3d.txt b/doc/files/box3d.txt new file mode 100644 index 0000000..c750680 --- /dev/null +++ b/doc/files/box3d.txt @@ -0,0 +1,4 @@ +#title Box3D [RCBasic Doc] +#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.html b/doc/files/bufferfromimage.html new file mode 100644 index 0000000..425788e --- /dev/null +++ b/doc/files/bufferfromimage.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/bufferfromimage.txt b/doc/files/bufferfromimage.txt new file mode 100644 index 0000000..02a4cd2 --- /dev/null +++ b/doc/files/bufferfromimage.txt @@ -0,0 +1,4 @@ +#title BufferFromImage [RCBasic Doc] +#header sub BufferFromImage(slot, byref buffer) + + diff --git a/doc/files/bufferfrommatrix.html b/doc/files/bufferfrommatrix.html new file mode 100644 index 0000000..4e99e2d --- /dev/null +++ b/doc/files/bufferfrommatrix.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + MatrixFromBuffer +
++ + + \ No newline at end of file diff --git a/doc/files/bufferfrommatrix.txt b/doc/files/bufferfrommatrix.txt new file mode 100644 index 0000000..fbadd93 --- /dev/null +++ b/doc/files/bufferfrommatrix.txt @@ -0,0 +1,8 @@ +#title BufferFromMatrix [RCBasic Doc] +#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.html b/doc/files/bufferfromstring.html new file mode 100644 index 0000000..cf85941 --- /dev/null +++ b/doc/files/bufferfromstring.html @@ -0,0 +1,20 @@ + + +
+ + ++ Stores the byte value of a string into a number buffer +
+Related: + StringFromBuffer$ +
++ + + \ No newline at end of file diff --git a/doc/files/bufferfromstring.txt b/doc/files/bufferfromstring.txt new file mode 100644 index 0000000..f249035 --- /dev/null +++ b/doc/files/bufferfromstring.txt @@ -0,0 +1,6 @@ +#title BufferFromString [RCBasic Doc] +#header function BufferFromString(s$, ByRef buffer) + +Stores the byte value of a string into a number buffer + +#ref StringFromBuffer$ diff --git a/doc/files/canvas.html b/doc/files/canvas.html new file mode 100644 index 0000000..5ada771 --- /dev/null +++ b/doc/files/canvas.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the active canvas for drawing commands to use +
+Related: + ActiveCanvas +
++ + + \ No newline at end of file diff --git a/doc/files/canvas.txt b/doc/files/canvas.txt new file mode 100644 index 0000000..49cd21d --- /dev/null +++ b/doc/files/canvas.txt @@ -0,0 +1,6 @@ +#title Canvas [RCBasic Doc] +#header sub Canvas(c_num) + +Sets the active canvas for drawing commands to use + +#ref ActiveCanvas diff --git a/doc/files/canvasclip.html b/doc/files/canvasclip.html new file mode 100644 index 0000000..0913f2c --- /dev/null +++ b/doc/files/canvasclip.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an image id with a selected portion of the active drawing canvas saved +
+Related: + WindowClip +
++ + + \ No newline at end of file diff --git a/doc/files/canvasclip.txt b/doc/files/canvasclip.txt new file mode 100644 index 0000000..7391245 --- /dev/null +++ b/doc/files/canvasclip.txt @@ -0,0 +1,6 @@ +#title CanvasClip [RCBasic Doc] +#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.html b/doc/files/canvasisvisible.html new file mode 100644 index 0000000..e4d4fe8 --- /dev/null +++ b/doc/files/canvasisvisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if a canvas is shown in the Window +
+Related: + SetCanvasVisible +
++ + + \ No newline at end of file diff --git a/doc/files/canvasisvisible.txt b/doc/files/canvasisvisible.txt new file mode 100644 index 0000000..8e4c4e4 --- /dev/null +++ b/doc/files/canvasisvisible.txt @@ -0,0 +1,6 @@ +#title CanvasIsVisible [RCBasic Doc] +#header function CanvasIsVisible(c_num) + +Returns true if a canvas is shown in the Window + +#ref SetCanvasVisible diff --git a/doc/files/canvasz.html b/doc/files/canvasz.html new file mode 100644 index 0000000..b37887e --- /dev/null +++ b/doc/files/canvasz.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetCanvasZ +
++ + + \ No newline at end of file diff --git a/doc/files/canvasz.txt b/doc/files/canvasz.txt new file mode 100644 index 0000000..b4bd84b --- /dev/null +++ b/doc/files/canvasz.txt @@ -0,0 +1,8 @@ +#title CanvasZ [RCBasic Doc] +#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.html b/doc/files/castray2d.html new file mode 100644 index 0000000..c460985 --- /dev/null +++ b/doc/files/castray2d.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and get the closest hit on the ray +
++ Returns 1 if there is a hit and 0 if not +
++ NOTE: GetRayHit2D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D + CastRay3D_All + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/castray2d.txt b/doc/files/castray2d.txt new file mode 100644 index 0000000..b39c75e --- /dev/null +++ b/doc/files/castray2d.txt @@ -0,0 +1,10 @@ +#title CastRay2D [RCBasic Doc] +#header function CastRay2D( from_x, from_y, to_x, to_y ) + +Cast a ray and get the closest hit on the ray + +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.html b/doc/files/castray2d_all.html new file mode 100644 index 0000000..2b2f9bb --- /dev/null +++ b/doc/files/castray2d_all.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and gets all hits on the ray +
++ Returns the number of hits from the ray cast +
++ NOTE: GetRayHit2D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D + CastRay3D_All + CastRay2D + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/castray2d_all.txt b/doc/files/castray2d_all.txt new file mode 100644 index 0000000..2093841 --- /dev/null +++ b/doc/files/castray2d_all.txt @@ -0,0 +1,10 @@ +#title CastRay2D_All [RCBasic Doc] +#header function CastRay2D_All( from_x, from_y, to_x, to_y ) + +Cast a ray and gets all hits on the ray + +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.html b/doc/files/castray3d.html new file mode 100644 index 0000000..0847b09 --- /dev/null +++ b/doc/files/castray3d.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and get the closest hit on the ray +
++ Returns 1 if there is a hit and 0 if not +
++ NOTE: GetRayHit3D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D_All + CastRay2D + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/castray3d.txt b/doc/files/castray3d.txt new file mode 100644 index 0000000..77ef899 --- /dev/null +++ b/doc/files/castray3d.txt @@ -0,0 +1,10 @@ +#title CastRay3D [RCBasic Doc] +#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 + +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.html b/doc/files/castray3d_all.html new file mode 100644 index 0000000..38fdbfa --- /dev/null +++ b/doc/files/castray3d_all.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and gets all hits on the ray +
++ Returns the number of hits from the ray cast +
++ NOTE: GetRayHit3D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D + CastRay2D + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/castray3d_all.txt b/doc/files/castray3d_all.txt new file mode 100644 index 0000000..3e20f67 --- /dev/null +++ b/doc/files/castray3d_all.txt @@ -0,0 +1,10 @@ +#title CastRay3D_All [RCBasic Doc] +#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 + +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.html b/doc/files/changedir.html new file mode 100644 index 0000000..ea7d13d --- /dev/null +++ b/doc/files/changedir.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the working directory that the directory commands use +
++ + + \ No newline at end of file diff --git a/doc/files/changedir.txt b/doc/files/changedir.txt new file mode 100644 index 0000000..4b894a5 --- /dev/null +++ b/doc/files/changedir.txt @@ -0,0 +1,4 @@ +#title ChangeDir [RCBasic Doc] +#header sub ChangeDir(p$) + +Sets the working directory that the directory commands use diff --git a/doc/files/channelispaused.html b/doc/files/channelispaused.html new file mode 100644 index 0000000..b8c14df --- /dev/null +++ b/doc/files/channelispaused.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if an audio channel is currently paused +
+Related: + PauseSound +
++ + + \ No newline at end of file diff --git a/doc/files/channelispaused.txt b/doc/files/channelispaused.txt new file mode 100644 index 0000000..39ea742 --- /dev/null +++ b/doc/files/channelispaused.txt @@ -0,0 +1,6 @@ +#title ChannelIsPaused [RCBasic Doc] +#header function ChannelIsPaused(channel) + +Returns true if an audio channel is currently paused + +#ref PauseSound diff --git a/doc/files/channelisplaying.html b/doc/files/channelisplaying.html new file mode 100644 index 0000000..4f233de --- /dev/null +++ b/doc/files/channelisplaying.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns true if an audio channel is playing +
+Related: + ChannelIsPaused + PlaySound + PlaySoundTimed +
++ + + \ No newline at end of file diff --git a/doc/files/channelisplaying.txt b/doc/files/channelisplaying.txt new file mode 100644 index 0000000..73fdfc7 --- /dev/null +++ b/doc/files/channelisplaying.txt @@ -0,0 +1,6 @@ +#title ChannelIsPlaying [RCBasic Doc] +#header function ChannelIsPlaying(channel) + +Returns true if an audio channel is playing + +#ref ChannelIsPaused PlaySound PlaySoundTimed diff --git a/doc/files/checksockets.html b/doc/files/checksockets.html new file mode 100644 index 0000000..46db155 --- /dev/null +++ b/doc/files/checksockets.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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) +
++ + + \ No newline at end of file diff --git a/doc/files/checksockets.txt b/doc/files/checksockets.txt new file mode 100644 index 0000000..efdfd03 --- /dev/null +++ b/doc/files/checksockets.txt @@ -0,0 +1,7 @@ +#title CheckSockets [RCBasic Doc] +#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.html b/doc/files/chr.html new file mode 100644 index 0000000..b449c24 --- /dev/null +++ b/doc/files/chr.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the character with the matching ASCII value n. +
++ + + \ No newline at end of file diff --git a/doc/files/chr.txt b/doc/files/chr.txt new file mode 100644 index 0000000..81ec84c --- /dev/null +++ b/doc/files/chr.txt @@ -0,0 +1,4 @@ +#title Chr$ [RCBasic Doc] +#header function Chr$(n) + +Returns the character with the matching ASCII value n. diff --git a/doc/files/cint32.html b/doc/files/cint32.html new file mode 100644 index 0000000..8dea700 --- /dev/null +++ b/doc/files/cint32.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a 32-bit signed integer. +
++ + + \ No newline at end of file diff --git a/doc/files/cint32.txt b/doc/files/cint32.txt new file mode 100644 index 0000000..f70a19b --- /dev/null +++ b/doc/files/cint32.txt @@ -0,0 +1,4 @@ +#title CInt32 [RCBasic Doc] +#header function CInt32(i) + +Returns a 32-bit signed integer. diff --git a/doc/files/cint64.html b/doc/files/cint64.html new file mode 100644 index 0000000..8ecb94d --- /dev/null +++ b/doc/files/cint64.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a 64-bit signed integer. +
++ + + \ No newline at end of file diff --git a/doc/files/cint64.txt b/doc/files/cint64.txt new file mode 100644 index 0000000..63e5915 --- /dev/null +++ b/doc/files/cint64.txt @@ -0,0 +1,4 @@ +#title CInt64 [RCBasic Doc] +#header function CInt64(i) + +Returns a 64-bit signed integer. diff --git a/doc/files/circle.html b/doc/files/circle.html new file mode 100644 index 0000000..1af0f09 --- /dev/null +++ b/doc/files/circle.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a circle on the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/circle.txt b/doc/files/circle.txt new file mode 100644 index 0000000..65abcfe --- /dev/null +++ b/doc/files/circle.txt @@ -0,0 +1,4 @@ +#title Circle [RCBasic Doc] +#header sub Circle(x,y,radius) + +Draws a circle on the current canvas. diff --git a/doc/files/circlefill.html b/doc/files/circlefill.html new file mode 100644 index 0000000..554064a --- /dev/null +++ b/doc/files/circlefill.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a filled circle on the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/circlefill.txt b/doc/files/circlefill.txt new file mode 100644 index 0000000..88e6ff3 --- /dev/null +++ b/doc/files/circlefill.txt @@ -0,0 +1,4 @@ +#title CircleFill [RCBasic Doc] +#header sub CircleFill(x,y,radius) + +Draws a filled circle on the current canvas. diff --git a/doc/files/clearactorforces.html b/doc/files/clearactorforces.html new file mode 100644 index 0000000..43c251a --- /dev/null +++ b/doc/files/clearactorforces.html @@ -0,0 +1,31 @@ + + +
+ + ++ 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. +
++ Notes: +
++ + + \ No newline at end of file diff --git a/doc/files/clearactorforces.txt b/doc/files/clearactorforces.txt new file mode 100644 index 0000000..cbfeb71 --- /dev/null +++ b/doc/files/clearactorforces.txt @@ -0,0 +1,11 @@ +#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. + +Notes: +#list +#li Resets Forces: It removes all linear forces (like those applied by applyActorForce or applyActorCentralForce) and torques (like those applied by applyActorTorque). +#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.html b/doc/files/clearcanvas.html new file mode 100644 index 0000000..338383d --- /dev/null +++ b/doc/files/clearcanvas.html @@ -0,0 +1,20 @@ + + +
+ + ++ Clears the active drawing canvas +
++ NOTE: This is only for drawing canvases (ie. Those opened with OpenCanvas()) +
++ + + \ No newline at end of file diff --git a/doc/files/clearcanvas.txt b/doc/files/clearcanvas.txt new file mode 100644 index 0000000..3deb5fe --- /dev/null +++ b/doc/files/clearcanvas.txt @@ -0,0 +1,6 @@ +#title ClearCanvas [RCBasic Doc] +#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.html b/doc/files/clearmatrix.html new file mode 100644 index 0000000..82c2b5e --- /dev/null +++ b/doc/files/clearmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets all elements in a matrix to zero +
++ + + \ No newline at end of file diff --git a/doc/files/clearmatrix.txt b/doc/files/clearmatrix.txt new file mode 100644 index 0000000..53b23d6 --- /dev/null +++ b/doc/files/clearmatrix.txt @@ -0,0 +1,4 @@ +#title ClearMatrix [RCBasic Doc] +#header sub ClearMatrix(mA) + +Sets all elements in a matrix to zero diff --git a/doc/files/clearmatrixcolumns.html b/doc/files/clearmatrixcolumns.html new file mode 100644 index 0000000..188769f --- /dev/null +++ b/doc/files/clearmatrixcolumns.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets all elements in the matrix columns specified to zero. +
+Related: + ClearMatrix + ClearMatrixRows +
++ + + \ No newline at end of file diff --git a/doc/files/clearmatrixcolumns.txt b/doc/files/clearmatrixcolumns.txt new file mode 100644 index 0000000..4cae668 --- /dev/null +++ b/doc/files/clearmatrixcolumns.txt @@ -0,0 +1,6 @@ +#title ClearMatrixColumns [RCBasic Doc] +#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.html b/doc/files/clearmatrixrows.html new file mode 100644 index 0000000..7ea08e7 --- /dev/null +++ b/doc/files/clearmatrixrows.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets all elements in the matrix rows specified to zero. +
+Related: + ClearMatrix + ClearMatrixColumns +
++ + + \ No newline at end of file diff --git a/doc/files/clearmatrixrows.txt b/doc/files/clearmatrixrows.txt new file mode 100644 index 0000000..cc1d416 --- /dev/null +++ b/doc/files/clearmatrixrows.txt @@ -0,0 +1,6 @@ +#title ClearMatrixRows [RCBasic Doc] +#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.html b/doc/files/clearmousezone.html new file mode 100644 index 0000000..e1ee81f --- /dev/null +++ b/doc/files/clearmousezone.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes the previously set mouse zone from the window +
++ + + \ No newline at end of file diff --git a/doc/files/clearmousezone.txt b/doc/files/clearmousezone.txt new file mode 100644 index 0000000..953683a --- /dev/null +++ b/doc/files/clearmousezone.txt @@ -0,0 +1,4 @@ +#title ClearMouseZone [RCBasic Doc] +#header sub ClearMouseZone() + +Removes the previously set mouse zone from the window diff --git a/doc/files/clearscene.html b/doc/files/clearscene.html new file mode 100644 index 0000000..4f4882f --- /dev/null +++ b/doc/files/clearscene.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/clearscene.txt b/doc/files/clearscene.txt new file mode 100644 index 0000000..92e11c1 --- /dev/null +++ b/doc/files/clearscene.txt @@ -0,0 +1,4 @@ +#title ClearScene [RCBasic Doc] +#header Sub ClearScene() + + diff --git a/doc/files/clearstack_n.html b/doc/files/clearstack_n.html new file mode 100644 index 0000000..6135148 --- /dev/null +++ b/doc/files/clearstack_n.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes all elements from the stack +
+Related: + ClearStack_S +
++ + + \ No newline at end of file diff --git a/doc/files/clearstack_n.txt b/doc/files/clearstack_n.txt new file mode 100644 index 0000000..60dc4dc --- /dev/null +++ b/doc/files/clearstack_n.txt @@ -0,0 +1,6 @@ +#title ClearStack_N [RCBasic Doc] +#header sub ClearStack_N( num_stack ) + +Removes all elements from the stack + +#ref ClearStack_S diff --git a/doc/files/clearstack_s.html b/doc/files/clearstack_s.html new file mode 100644 index 0000000..8587936 --- /dev/null +++ b/doc/files/clearstack_s.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes all elements from the stack +
+Related: + ClearStack_N +
++ + + \ No newline at end of file diff --git a/doc/files/clearstack_s.txt b/doc/files/clearstack_s.txt new file mode 100644 index 0000000..020ce91 --- /dev/null +++ b/doc/files/clearstack_s.txt @@ -0,0 +1,6 @@ +#title ClearStack_S [RCBasic Doc] +#header sub ClearStack_S( str_stack ) + +Removes all elements from the stack + +#ref ClearStack_N diff --git a/doc/files/clipmatrix.html b/doc/files/clipmatrix.html new file mode 100644 index 0000000..b06e42b --- /dev/null +++ b/doc/files/clipmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Copies the specified portion of matrix mA into matrix mB +
++ + + \ No newline at end of file diff --git a/doc/files/clipmatrix.txt b/doc/files/clipmatrix.txt new file mode 100644 index 0000000..001e5c2 --- /dev/null +++ b/doc/files/clipmatrix.txt @@ -0,0 +1,4 @@ +#title ClipMatrix [RCBasic Doc] +#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.html b/doc/files/clonecanvas.html new file mode 100644 index 0000000..5e228ab --- /dev/null +++ b/doc/files/clonecanvas.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
++ Mode is a canvas render mode like the one passed to OpenCanvas() +
+Related: + OpenCanvas +
++ + + \ No newline at end of file diff --git a/doc/files/clonecanvas.txt b/doc/files/clonecanvas.txt new file mode 100644 index 0000000..8910bca --- /dev/null +++ b/doc/files/clonecanvas.txt @@ -0,0 +1,9 @@ +#title CloneCanvas [RCBasic Doc] +#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. + +Mode is a canvas render mode like the one passed to OpenCanvas() + + +#ref OpenCanvas diff --git a/doc/files/closecanvas.html b/doc/files/closecanvas.html new file mode 100644 index 0000000..26ed1e9 --- /dev/null +++ b/doc/files/closecanvas.html @@ -0,0 +1,20 @@ + + +
+ + ++ Closes a canvas +
+Related: + OpenCanvas +
++ + + \ No newline at end of file diff --git a/doc/files/closecanvas.txt b/doc/files/closecanvas.txt new file mode 100644 index 0000000..c78af01 --- /dev/null +++ b/doc/files/closecanvas.txt @@ -0,0 +1,6 @@ +#title CloseCanvas [RCBasic Doc] +#header Sub CloseCanvas(c_num) + +Closes a canvas + +#ref OpenCanvas diff --git a/doc/files/closefile.html b/doc/files/closefile.html new file mode 100644 index 0000000..81566ea --- /dev/null +++ b/doc/files/closefile.html @@ -0,0 +1,20 @@ + + +
+ + ++ Closes a file +
+Related: + OpenFile +
++ + + \ No newline at end of file diff --git a/doc/files/closefile.txt b/doc/files/closefile.txt new file mode 100644 index 0000000..21efc01 --- /dev/null +++ b/doc/files/closefile.txt @@ -0,0 +1,6 @@ +#title CloseFile [RCBasic Doc] +#header sub CloseFile( stream ) + +Closes a file + +#ref OpenFile diff --git a/doc/files/closewindow.html b/doc/files/closewindow.html new file mode 100644 index 0000000..24efc2d --- /dev/null +++ b/doc/files/closewindow.html @@ -0,0 +1,20 @@ + + +
+ + ++ Closes the graphics window +
+Related: + OpenWindow +
++ + + \ No newline at end of file diff --git a/doc/files/closewindow.txt b/doc/files/closewindow.txt new file mode 100644 index 0000000..05c9656 --- /dev/null +++ b/doc/files/closewindow.txt @@ -0,0 +1,6 @@ +#title CloseWindow [RCBasic Doc] +#header sub CloseWindow( ) + +Closes the graphics window + +#ref OpenWindow diff --git a/doc/files/cls.html b/doc/files/cls.html new file mode 100644 index 0000000..2ab7692 --- /dev/null +++ b/doc/files/cls.html @@ -0,0 +1,17 @@ + + +
+ + ++ Clears the back buffer on the window +
++ + + \ No newline at end of file diff --git a/doc/files/cls.txt b/doc/files/cls.txt new file mode 100644 index 0000000..eaedc84 --- /dev/null +++ b/doc/files/cls.txt @@ -0,0 +1,4 @@ +#title Cls [RCBasic Doc] +#header sub Cls() + +Clears the back buffer on the window diff --git a/doc/files/cofactormatrix.html b/doc/files/cofactormatrix.html new file mode 100644 index 0000000..f3ad1b5 --- /dev/null +++ b/doc/files/cofactormatrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + CopyMatrix +
++ + + \ No newline at end of file diff --git a/doc/files/cofactormatrix.txt b/doc/files/cofactormatrix.txt new file mode 100644 index 0000000..19a1431 --- /dev/null +++ b/doc/files/cofactormatrix.txt @@ -0,0 +1,6 @@ +#title CofactorMatrix [RCBasic Doc] +#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.html b/doc/files/colorkey.html new file mode 100644 index 0000000..ef6bf75 --- /dev/null +++ b/doc/files/colorkey.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the color key for an image +
++ + + \ No newline at end of file diff --git a/doc/files/colorkey.txt b/doc/files/colorkey.txt new file mode 100644 index 0000000..1d00863 --- /dev/null +++ b/doc/files/colorkey.txt @@ -0,0 +1,4 @@ +#title ColorKey [RCBasic Doc] +#header sub ColorKey(img_id, c) + +Sets the color key for an image diff --git a/doc/files/command.html b/doc/files/command.html new file mode 100644 index 0000000..558c114 --- /dev/null +++ b/doc/files/command.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns command line arguments passed to a program. +
++ Note: Command$(0) will always be the program being executed ( your_program.cbc ) +
+Related: + NumCommands +
++ + + \ No newline at end of file diff --git a/doc/files/command.txt b/doc/files/command.txt new file mode 100644 index 0000000..9b71e89 --- /dev/null +++ b/doc/files/command.txt @@ -0,0 +1,8 @@ +#title Command$ [RCBasic Doc] +#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/comments.html b/doc/files/comments.html new file mode 100644 index 0000000..65f835d --- /dev/null +++ b/doc/files/comments.html @@ -0,0 +1,32 @@ + + +
+ + ++ Comments are remarks you can add to your code which will be ignored by the compiler. To make a comment you would use a single quote. Look at the following: +
+
+ ' THIS IS A COMMENT
+ Print HELLO "WORLD ' THIS IS ANOTHER COMMENT
+
+ MULTI-LINE COMMENTS +
++ Multi-line comments are comments that can span multiple lines. To start a multi-line comment you would use forward slash followed by a single quote and you would end it with a single quote followed by a forward slash. Look at the following: +
+
+ /' THIS IS
+ A
+ MULTI-LINE COMMENT '/
+
+ + + \ No newline at end of file diff --git a/doc/files/comments.txt b/doc/files/comments.txt new file mode 100644 index 0000000..f839f32 --- /dev/null +++ b/doc/files/comments.txt @@ -0,0 +1,17 @@ +#title RCBasic Comments [RCBasic Doc] +#header COMMENTS + +Comments are remarks you can add to your code which will be ignored by the compiler. To make a comment you would use a single quote. Look at the following: +#code +' THIS IS A COMMENT +Print HELLO WORLD" ' THIS IS ANOTHER COMMENT +#/code + +MULTI-LINE COMMENTS + +Multi-line comments are comments that can span multiple lines. To start a multi-line comment you would use forward slash followed by a single quote and you would end it with a single quote followed by a forward slash. Look at the following: +#code +/' THIS IS +A +MULTI-LINE COMMENT '/ +#/code diff --git a/doc/files/computeactorangularimpulsedenominator.html b/doc/files/computeactorangularimpulsedenominator.html new file mode 100644 index 0000000..c65a4ff --- /dev/null +++ b/doc/files/computeactorangularimpulsedenominator.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorImpulseDenominator +
++ + + \ No newline at end of file diff --git a/doc/files/computeactorangularimpulsedenominator.txt b/doc/files/computeactorangularimpulsedenominator.txt new file mode 100644 index 0000000..ecf5e43 --- /dev/null +++ b/doc/files/computeactorangularimpulsedenominator.txt @@ -0,0 +1,6 @@ +#title ComputeActorAngularImpulseDenominator [RCBasic Doc] +#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.html b/doc/files/computeactorgyroimpulselocal.html new file mode 100644 index 0000000..265ce83 --- /dev/null +++ b/doc/files/computeactorgyroimpulselocal.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorGyroImpulseWorld +
++ + + \ No newline at end of file diff --git a/doc/files/computeactorgyroimpulselocal.txt b/doc/files/computeactorgyroimpulselocal.txt new file mode 100644 index 0000000..bafdf61 --- /dev/null +++ b/doc/files/computeactorgyroimpulselocal.txt @@ -0,0 +1,6 @@ +#title ComputeActorGyroImpulseLocal [RCBasic Doc] +#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.html b/doc/files/computeactorgyroimpulseworld.html new file mode 100644 index 0000000..431aebd --- /dev/null +++ b/doc/files/computeactorgyroimpulseworld.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorGyroImpulseLocal +
++ + + \ No newline at end of file diff --git a/doc/files/computeactorgyroimpulseworld.txt b/doc/files/computeactorgyroimpulseworld.txt new file mode 100644 index 0000000..875f3fb --- /dev/null +++ b/doc/files/computeactorgyroimpulseworld.txt @@ -0,0 +1,6 @@ +#title ComputeActorGyroImpulseWorld [RCBasic Doc] +#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.html b/doc/files/computeactorimpulsedenominator.html new file mode 100644 index 0000000..7082ceb --- /dev/null +++ b/doc/files/computeactorimpulsedenominator.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + ComputeActorAngularImpulseDenominator +
++ + + \ No newline at end of file diff --git a/doc/files/computeactorimpulsedenominator.txt b/doc/files/computeactorimpulsedenominator.txt new file mode 100644 index 0000000..c0b0cc0 --- /dev/null +++ b/doc/files/computeactorimpulsedenominator.txt @@ -0,0 +1,6 @@ +#title ComputeActorImpulseDenominator [RCBasic Doc] +#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/conditions.html b/doc/files/conditions.html new file mode 100644 index 0000000..13f3c18 --- /dev/null +++ b/doc/files/conditions.html @@ -0,0 +1,60 @@ + + +
+ + ++ RC BASIC uses the same conventions of other programming languages to control the flow of the program. There are two main ways of getting your program to decide on its next course of action. The most common way is with the IF statement block. +
+
+ If 5 > 6 Then
+ Print "THIS WILL NOT PRINT"
+ ElseIf 5 < 6 Then
+ Print "THIS WILL PRINT"
+ Else
+ Print "THIS ALSO WILL NOT PRINT"
+ End If
+
+ The above example does different comparisons and will output text to a console depending on which condition is true. +
++ The next method of control flow is the SELECT statement block. +
+
+ Select Case 5
+ Case 6
+ Print THIS WILL NOT "PRINT
+ Case 5
+ Print "THIS WILL PRINT"
+ Default
+ 'Note: Default will be true if every other case is false.
+ ' Default is optional and can be excluded if you don't need it
+ Print "THIS WILL NOT PRINT"
+ End Select
+
+ The above example will compare each case in the block to the SELECT CASE. If the case is equal to the select case then the code in that case will be executed. You can also add multiple values to compare to each CASE. +
+
+ Select Case 5
+ Case 6
+ Print "THIS WILL NOT PRINT"
+ Case 4, 5
+ Print "THIS WILL PRINT"
+ Default
+ Print "THIS WILL NOT PRINT"
+ End Select
+
+ 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/files/conditions.txt b/doc/files/conditions.txt new file mode 100644 index 0000000..a6fb6b6 --- /dev/null +++ b/doc/files/conditions.txt @@ -0,0 +1,43 @@ +#title RCBasic Conditions [RCBasic Doc] +#header CONDITIONS + +RC BASIC uses the same conventions of other programming languages to control the flow of the program. There are two main ways of getting your program to decide on its next course of action. The most common way is with the IF statement block. +#code +If 5 > 6 Then + Print "THIS WILL NOT PRINT" +ElseIf 5 < 6 Then + Print "THIS WILL PRINT" +Else + Print "THIS ALSO WILL NOT PRINT" +End If +#/code + +The above example does different comparisons and will output text to a console depending on which condition is true. + +The next method of control flow is the SELECT statement block. +#code +Select Case 5 +Case 6 + Print THIS WILL NOT PRINT" +Case 5 + Print "THIS WILL PRINT" +Default + 'Note: Default will be true if every other case is false. + ' Default is optional and can be excluded if you don't need it + Print "THIS WILL NOT PRINT" +End Select +#/code + +The above example will compare each case in the block to the SELECT CASE. If the case is equal to the select case then the code in that case will be executed. You can also add multiple values to compare to each CASE. +#code +Select Case 5 +Case 6 + Print "THIS WILL NOT PRINT" +Case 4, 5 + Print "THIS WILL PRINT" +Default + Print "THIS WILL NOT PRINT" +End Select +#/code + +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. diff --git a/doc/files/constants.html b/doc/files/constants.html new file mode 100644 index 0000000..4696681 --- /dev/null +++ b/doc/files/constants.html @@ -0,0 +1,21 @@ + + +
+ + ++ RCBasic has a special type of variable called a constant which can hold an expression. This means it can hold an expression and not determine its value until its used. For example you can have a constant called C that is equal to A + B. Everytime you change the value of A or B, C's value will also change. Because constants hold expressions, any valid expression in RCBasic can be stored in a constant. +
+
+ const A = 5
+ const MY_PRINT = print "hello world"
+
+ + + \ No newline at end of file diff --git a/doc/files/constants.txt b/doc/files/constants.txt new file mode 100644 index 0000000..a658c22 --- /dev/null +++ b/doc/files/constants.txt @@ -0,0 +1,8 @@ +#title RCBasic Constants [RCBasic Doc] +#header CONSTANTS + +RCBasic has a special type of variable called a constant which can hold an expression. This means it can hold an expression and not determine its value until its used. For example you can have a constant called C that is equal to A + B. Everytime you change the value of A or B, C's value will also change. Because constants hold expressions, any valid expression in RCBasic can be stored in a constant. +#code +const A = 5 +const MY_PRINT = print "hello world" +#/code diff --git a/doc/files/constraintexists.html b/doc/files/constraintexists.html new file mode 100644 index 0000000..42300e5 --- /dev/null +++ b/doc/files/constraintexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the id passed is a valid constraint +
++ + + \ No newline at end of file diff --git a/doc/files/constraintexists.txt b/doc/files/constraintexists.txt new file mode 100644 index 0000000..1ada7e3 --- /dev/null +++ b/doc/files/constraintexists.txt @@ -0,0 +1,4 @@ +#title ConstraintExists [RCBasic Doc] +#header function ConstraintExists( constraint_id ) + +Returns true if the id passed is a valid constraint diff --git a/doc/files/copyactormaterial.html b/doc/files/copyactormaterial.html new file mode 100644 index 0000000..1e3aac6 --- /dev/null +++ b/doc/files/copyactormaterial.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a material id for a copy of an actor's material +
++ + + \ No newline at end of file diff --git a/doc/files/copyactormaterial.txt b/doc/files/copyactormaterial.txt new file mode 100644 index 0000000..30c9ba3 --- /dev/null +++ b/doc/files/copyactormaterial.txt @@ -0,0 +1,4 @@ +#title CopyActorMaterial [RCBasic Doc] +#header function CopyActorMaterial( actor, material_num) + +Returns a material id for a copy of an actor's material diff --git a/doc/files/copyfile.html b/doc/files/copyfile.html new file mode 100644 index 0000000..50b1ca9 --- /dev/null +++ b/doc/files/copyfile.html @@ -0,0 +1,17 @@ + + +
+ + ++ Copies the contents of src$ file to a new dst$ file +
++ + + \ No newline at end of file diff --git a/doc/files/copyfile.txt b/doc/files/copyfile.txt new file mode 100644 index 0000000..af5b3a4 --- /dev/null +++ b/doc/files/copyfile.txt @@ -0,0 +1,4 @@ +#title CopyFile [RCBasic Doc] +#header sub CopyFile(src$, dst$) + +Copies the contents of src$ file to a new dst$ file diff --git a/doc/files/copyimage.html b/doc/files/copyimage.html new file mode 100644 index 0000000..be775b7 --- /dev/null +++ b/doc/files/copyimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a copy of an image +
++ + + \ No newline at end of file diff --git a/doc/files/copyimage.txt b/doc/files/copyimage.txt new file mode 100644 index 0000000..19d0008 --- /dev/null +++ b/doc/files/copyimage.txt @@ -0,0 +1,4 @@ +#title CopyImage [RCBasic Doc] +#header function CopyImage( img_id ) + +Returns a copy of an image diff --git a/doc/files/copymaterial.html b/doc/files/copymaterial.html new file mode 100644 index 0000000..7140ec2 --- /dev/null +++ b/doc/files/copymaterial.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a copy of a material +
++ + + \ No newline at end of file diff --git a/doc/files/copymaterial.txt b/doc/files/copymaterial.txt new file mode 100644 index 0000000..4f7cb7e --- /dev/null +++ b/doc/files/copymaterial.txt @@ -0,0 +1,4 @@ +#title CopyMaterial [RCBasic Doc] +#header function CopyMaterial( smaterial_id) + +Returns a copy of a material diff --git a/doc/files/copymatrix.html b/doc/files/copymatrix.html new file mode 100644 index 0000000..36f7ff1 --- /dev/null +++ b/doc/files/copymatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Copies matrix mA to matrix mB +
++ + + \ No newline at end of file diff --git a/doc/files/copymatrix.txt b/doc/files/copymatrix.txt new file mode 100644 index 0000000..ffd1295 --- /dev/null +++ b/doc/files/copymatrix.txt @@ -0,0 +1,4 @@ +#title CopyMatrix [RCBasic Doc] +#header sub CopyMatrix(mA, mB) + +Copies matrix mA to matrix mB diff --git a/doc/files/copymatrixcolumns.html b/doc/files/copymatrixcolumns.html new file mode 100644 index 0000000..6d4898d --- /dev/null +++ b/doc/files/copymatrixcolumns.html @@ -0,0 +1,20 @@ + + +
+ + ++ Copies the specified matrix columns from matrix mA to matrix mB. +
++ Note: Matrix mB will be redimensioned to the size of the copied columns. +
++ + + \ No newline at end of file diff --git a/doc/files/copymatrixcolumns.txt b/doc/files/copymatrixcolumns.txt new file mode 100644 index 0000000..be6d2d9 --- /dev/null +++ b/doc/files/copymatrixcolumns.txt @@ -0,0 +1,6 @@ +#title CopyMatrixColumns [RCBasic Doc] +#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.html b/doc/files/copymatrixrows.html new file mode 100644 index 0000000..482687d --- /dev/null +++ b/doc/files/copymatrixrows.html @@ -0,0 +1,20 @@ + + +
+ + ++ Copies the specified matrix rows from matrix mA to matrix mB. +
++ Note: Matrix mB will be redimensioned to the size of the copied rows. +
++ + + \ No newline at end of file diff --git a/doc/files/copymatrixrows.txt b/doc/files/copymatrixrows.txt new file mode 100644 index 0000000..b580326 --- /dev/null +++ b/doc/files/copymatrixrows.txt @@ -0,0 +1,7 @@ +#title CopyMatrixRows [RCBasic Doc] +#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.html b/doc/files/cos.html new file mode 100644 index 0000000..7d67e00 --- /dev/null +++ b/doc/files/cos.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the Cosine of an angle +
++ + + \ No newline at end of file diff --git a/doc/files/cos.txt b/doc/files/cos.txt new file mode 100644 index 0000000..5cf7b8d --- /dev/null +++ b/doc/files/cos.txt @@ -0,0 +1,4 @@ +#title Cos [RCBasic Doc] +#header function Cos(n) + +Returns the Cosine of an angle diff --git a/doc/files/createactoranimation.html b/doc/files/createactoranimation.html new file mode 100644 index 0000000..db707e9 --- /dev/null +++ b/doc/files/createactoranimation.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/createactoranimation.txt b/doc/files/createactoranimation.txt new file mode 100644 index 0000000..697ef5d --- /dev/null +++ b/doc/files/createactoranimation.txt @@ -0,0 +1,4 @@ +#title CreateActorAnimation [RCBasic Doc] +#header Function CreateActorAnimation(actor, start_frame, end_frame, speed) + + diff --git a/doc/files/createanimatedactor.html b/doc/files/createanimatedactor.html new file mode 100644 index 0000000..1146adc --- /dev/null +++ b/doc/files/createanimatedactor.html @@ -0,0 +1,37 @@ + + +
+ + ++ Returns a new animated actor composed of a mesh +
++ The mesh can either be created using CreateMesh() or Loaded using LoadMesh() +
+Related: + CreateMesh + LoadMesh + LoadMeshFromAN8 +
+
+
+
Related: + CreateOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/createanimatedactor.txt b/doc/files/createanimatedactor.txt
new file mode 100644
index 0000000..12a89e7
--- /dev/null
+++ b/doc/files/createanimatedactor.txt
@@ -0,0 +1,10 @@
+#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 CreateWaterActor CreateLightActor CreateBillboardActor CreateTerrainActor
diff --git a/doc/files/createbillboardactor.html b/doc/files/createbillboardactor.html
new file mode 100644
index 0000000..960d051
--- /dev/null
+++ b/doc/files/createbillboardactor.html
@@ -0,0 +1,29 @@
+
+
+
+ Returns a billboard actor +
++ Billboard actors are flat textured planes that are always facing the camera. +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateCubeActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createbillboardactor.txt b/doc/files/createbillboardactor.txt new file mode 100644 index 0000000..d9b37bc --- /dev/null +++ b/doc/files/createbillboardactor.txt @@ -0,0 +1,8 @@ +#title CreateBillboardActor [RCBasic Doc] +#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/createconeconstraint.html b/doc/files/createconeconstraint.html new file mode 100644 index 0000000..4bc8256 --- /dev/null +++ b/doc/files/createconeconstraint.html @@ -0,0 +1,36 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100)
+
+ rbA = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix
+ SetIdentityMatrix(rbA, 4) 'This will set rbA to a 4x4 identity matrix
+ SetMatrixTranslation(rbA, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin
+ SetMatrixRotation(rbA, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes
+
+ test_cone = CreateConeConstraint( actorA, rbA )
+
+ Note: It is recommended to use CreateConeConstraintEx() in most cases +
+Related: + CreateConeConstraintEx + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/files/createconeconstraint.txt b/doc/files/createconeconstraint.txt new file mode 100644 index 0000000..4a9c9b7 --- /dev/null +++ b/doc/files/createconeconstraint.txt @@ -0,0 +1,19 @@ +#title CreateConeConstraint [RCBasic Doc] +#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. + +#code +actorA = CreateCubeActor(100) + +rbA = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix +SetIdentityMatrix(rbA, 4) 'This will set rbA to a 4x4 identity matrix +SetMatrixTranslation(rbA, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin +SetMatrixRotation(rbA, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes + +test_cone = CreateConeConstraint( actorA, rbA ) +#/code + +Note: It is recommended to use CreateConeConstraintEx() in most cases + +#ref CreateConeConstraintEx SetIdentityMatrix SetMatrixTranslation SetMatrixRotation diff --git a/doc/files/createconeconstraintex.html b/doc/files/createconeconstraintex.html new file mode 100644 index 0000000..bfe5bc3 --- /dev/null +++ b/doc/files/createconeconstraintex.html @@ -0,0 +1,39 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100)
+ actorB = CreateCubeActor(100)
+
+ rbA = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix
+ SetIdentityMatrix(rbA, 4) 'This will set rbA to a 4x4 identity matrix
+ SetMatrixTranslation(rbA, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin
+ SetMatrixRotation(rbA, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes
+
+ rbB = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix
+ SetIdentityMatrix(rbB, 4) 'This will set rbA to a 4x4 identity matrix
+ SetMatrixTranslation(rbB, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin
+ SetMatrixRotation(rbB, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes
+
+ test_cone = CreateConeConstraint( actorA, rbA )
+
Related: + CreateConeConstraint + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/files/createconeconstraintex.txt b/doc/files/createconeconstraintex.txt new file mode 100644 index 0000000..f742059 --- /dev/null +++ b/doc/files/createconeconstraintex.txt @@ -0,0 +1,23 @@ +#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. + +#code +actorA = CreateCubeActor(100) +actorB = CreateCubeActor(100) + +rbA = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix +SetIdentityMatrix(rbA, 4) 'This will set rbA to a 4x4 identity matrix +SetMatrixTranslation(rbA, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin +SetMatrixRotation(rbA, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes + +rbB = DimMatrix(4, 4) 'A transform matrix should be a 4x4 matrix +SetIdentityMatrix(rbB, 4) 'This will set rbA to a 4x4 identity matrix +SetMatrixTranslation(rbB, 0, 40, 0) 'Set the point where the constraint connects to actorA to 1 unit above its origin +SetMatrixRotation(rbB, 0, 0, 0) 'Sets the angle the constraint is attached at to 0 on all axes + +test_cone = CreateConeConstraint( actorA, rbA ) +#/code + +#ref CreateConeConstraint SetIdentityMatrix SetMatrixTranslation SetMatrixRotation diff --git a/doc/files/createcubeactor.html b/doc/files/createcubeactor.html new file mode 100644 index 0000000..b5bccbe --- /dev/null +++ b/doc/files/createcubeactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns an actor with a cube mesh of the specified size ( cube_size x cube_size x cube_size ) +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createcubeactor.txt b/doc/files/createcubeactor.txt new file mode 100644 index 0000000..2c0f7b7 --- /dev/null +++ b/doc/files/createcubeactor.txt @@ -0,0 +1,6 @@ +#title CreateCubeActor [RCBasic Doc] +#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/createdistancejoint.html b/doc/files/createdistancejoint.html new file mode 100644 index 0000000..8399d24 --- /dev/null +++ b/doc/files/createdistancejoint.html @@ -0,0 +1,37 @@ + + +
+ + ++ Creates a distance joint +
++ A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod. +
++ Parameters +
++ + + \ No newline at end of file diff --git a/doc/files/createdistancejoint.txt b/doc/files/createdistancejoint.txt new file mode 100644 index 0000000..11b0ca9 --- /dev/null +++ b/doc/files/createdistancejoint.txt @@ -0,0 +1,14 @@ +#title createDistanceJoint [RCBasic Doc] +#header function createDistanceJoint( spriteA, spriteB, aX, aY, bX, bY, collide_connect) + +Creates a distance joint + +A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod. + +Parameters +#list ul +#li spriteA - first body +#li spriteB - second body +#li aX, aY - Anchor point on spriteA +#li bX, bY - Anchor point on spriteB +#/list diff --git a/doc/files/createfrictionjoint.html b/doc/files/createfrictionjoint.html new file mode 100644 index 0000000..a8365fd --- /dev/null +++ b/doc/files/createfrictionjoint.html @@ -0,0 +1,34 @@ + + +
+ + ++ Creates a Friction Joint +
++ Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction. +
++ Parameters +
++ + + \ No newline at end of file diff --git a/doc/files/createfrictionjoint.txt b/doc/files/createfrictionjoint.txt new file mode 100644 index 0000000..bd5442b --- /dev/null +++ b/doc/files/createfrictionjoint.txt @@ -0,0 +1,14 @@ +#title createFrictionJoint [RCBasic Doc] +#header function createFrictionJoint( spriteA, spriteB, x, y, collide_connect) + +Creates a Friction Joint + +Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction. + +Parameters +#list ul +#li spriteA - first body +#li spriteB - second body +#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.html b/doc/files/creategearjoint.html new file mode 100644 index 0000000..d8917f5 --- /dev/null +++ b/doc/files/creategearjoint.html @@ -0,0 +1,34 @@ + + +
+ + ++ Creates a Gear Joint +
++ A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear ratio to bind the motions together: coordinate1 + ratio * coordinate2 = constant The ratio can be negative or positive. If one joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of 1/length. +
++ Parameters +
++ + + \ No newline at end of file diff --git a/doc/files/creategearjoint.txt b/doc/files/creategearjoint.txt new file mode 100644 index 0000000..8ef7d8a --- /dev/null +++ b/doc/files/creategearjoint.txt @@ -0,0 +1,14 @@ +#title createGearJoint [RCBasic Doc] +#header function createGearJoint( jointA, jointB, g_ratio, collide_connect) + +Creates a Gear Joint + +A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear ratio to bind the motions together: coordinate1 + ratio * coordinate2 = constant The ratio can be negative or positive. If one joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of 1/length. + +Parameters +#list ul +#li spriteA - first body +#li spriteB - second body +#li ratio - ratio of how much influence jointA has compared to jointB +#/list + diff --git a/doc/files/createhingeconstraint.html b/doc/files/createhingeconstraint.html new file mode 100644 index 0000000..32b22cc --- /dev/null +++ b/doc/files/createhingeconstraint.html @@ -0,0 +1,33 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameA, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube
+ hinge = CreateHingeConstraint(actorA, frameA, true)
+
+ Note: It is recommended to use CreateSlideConstraintEx() in most cases +
+Related: + CreateHingeConstraintEx + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/files/createhingeconstraint.txt b/doc/files/createhingeconstraint.txt new file mode 100644 index 0000000..9bab6d9 --- /dev/null +++ b/doc/files/createhingeconstraint.txt @@ -0,0 +1,17 @@ +#title CreateHingeConstraint [RCBasic Doc] +#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. + +#code +actorA = CreateCubeActor(100) 'Creates a cube actor +frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix +SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix +SetMatrixTranslation(frameA, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube +hinge = CreateHingeConstraint(actorA, frameA, true) +#/code + +Note: It is recommended to use CreateSlideConstraintEx() in most cases + +#ref CreateHingeConstraintEx SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createhingeconstraintex.html b/doc/files/createhingeconstraintex.html new file mode 100644 index 0000000..9e1e9bd --- /dev/null +++ b/doc/files/createhingeconstraintex.html @@ -0,0 +1,39 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameA, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube
+
+ actorB = CreateCubeActor(100) 'Creates a cube actor
+ frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameB, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube
+
+ hinge = CreateHingeConstraint(actorA, actorB, frameA, frameB, true)
+
+ Note: It is recommended to use CreateHingeConstraintEx() in most cases +
+Related: + CreateHingeConstraint + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/files/createhingeconstraintex.txt b/doc/files/createhingeconstraintex.txt new file mode 100644 index 0000000..ea53632 --- /dev/null +++ b/doc/files/createhingeconstraintex.txt @@ -0,0 +1,23 @@ +#title CreateHingeConstraintEx [RCBasic Doc] +#header Function CreateHingeConstraintEx( actorA, actorB, frameA, frameB, 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. + +#code +actorA = CreateCubeActor(100) 'Creates a cube actor +frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix +SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix +SetMatrixTranslation(frameA, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube + +actorB = CreateCubeActor(100) 'Creates a cube actor +frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix +SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix +SetMatrixTranslation(frameB, 0, 1, 0) 'Sets the attach point of the constraint to the top of the cube + +hinge = CreateHingeConstraint(actorA, actorB, frameA, frameB, true) +#/code + +Note: It is recommended to use CreateHingeConstraintEx() in most cases + +#ref CreateHingeConstraint SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createimage.html b/doc/files/createimage.html new file mode 100644 index 0000000..1bb8d4f --- /dev/null +++ b/doc/files/createimage.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns an image created from the buffer provided +
+Related: + CreateImageEx + LoadImage +
++ + + \ No newline at end of file diff --git a/doc/files/createimage.txt b/doc/files/createimage.txt new file mode 100644 index 0000000..116ffba --- /dev/null +++ b/doc/files/createimage.txt @@ -0,0 +1,6 @@ +#title CreateImage [RCBasic Doc] +#header function CreateImage(w, h, byref buffer) + +Returns an image created from the buffer provided + +#ref CreateImageEx LoadImage diff --git a/doc/files/createimageex.html b/doc/files/createimageex.html new file mode 100644 index 0000000..ca754eb --- /dev/null +++ b/doc/files/createimageex.html @@ -0,0 +1,24 @@ + + +
+ + ++ Returns an image created from the buffer provided +
++ The color parameter is a color key value to apply +
+Related: + CreateImage + LoadImage +
++ + + \ No newline at end of file diff --git a/doc/files/createimageex.txt b/doc/files/createimageex.txt new file mode 100644 index 0000000..11f34fe --- /dev/null +++ b/doc/files/createimageex.txt @@ -0,0 +1,9 @@ +#title createImageEx [RCBasic Doc] +#header function createImageEx(w, h, byref buffer, color) + +Returns an image created from the buffer provided + +The color parameter is a color key value to apply + +#ref CreateImage LoadImage + diff --git a/doc/files/createlightactor.html b/doc/files/createlightactor.html new file mode 100644 index 0000000..46d9463 --- /dev/null +++ b/doc/files/createlightactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns a new light in the scene +
+Related: + CreateMeshActor + CreateMeshOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createlightactor.txt b/doc/files/createlightactor.txt new file mode 100644 index 0000000..c0c24d4 --- /dev/null +++ b/doc/files/createlightactor.txt @@ -0,0 +1,6 @@ +#title CreateLightActor [RCBasic Doc] +#header function CreateLightActor( ) + +Returns a new light in the scene + +#ref CreateMeshActor CreateMeshOctreeActor CreateCubeActor CreateSphereActor CreateWaterPlaneActor CreateBillboardActor CreateTerrainActor diff --git a/doc/files/creatematerial.html b/doc/files/creatematerial.html new file mode 100644 index 0000000..262368d --- /dev/null +++ b/doc/files/creatematerial.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new material +
++ + + \ No newline at end of file diff --git a/doc/files/creatematerial.txt b/doc/files/creatematerial.txt new file mode 100644 index 0000000..4cd5875 --- /dev/null +++ b/doc/files/creatematerial.txt @@ -0,0 +1,4 @@ +#title createMaterial [RCBasic Doc] +#header function createMaterial() + +Returns a new material diff --git a/doc/files/createmesh.html b/doc/files/createmesh.html new file mode 100644 index 0000000..023391d --- /dev/null +++ b/doc/files/createmesh.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new mesh +
++ + + \ No newline at end of file diff --git a/doc/files/createmesh.txt b/doc/files/createmesh.txt new file mode 100644 index 0000000..3f258eb --- /dev/null +++ b/doc/files/createmesh.txt @@ -0,0 +1,4 @@ +#title CreateMesh [RCBasic Doc] +#header function CreateMesh( ) + +Returns a new mesh diff --git a/doc/files/createmeshactor.html b/doc/files/createmeshactor.html new file mode 100644 index 0000000..7651833 --- /dev/null +++ b/doc/files/createmeshactor.html @@ -0,0 +1,37 @@ + + +
+ + ++ Returns a new animated actor composed of a mesh +
++ The mesh can either be created using CreateMesh() or Loaded using LoadMesh() +
+Related: + CreateMesh + LoadMesh + LoadMeshFromAN8 +
+
+
+
Related: + CreateOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/createmeshactor.txt b/doc/files/createmeshactor.txt
new file mode 100644
index 0000000..3feb78d
--- /dev/null
+++ b/doc/files/createmeshactor.txt
@@ -0,0 +1,10 @@
+#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/createmeshoctreeactor.html b/doc/files/createmeshoctreeactor.html
new file mode 100644
index 0000000..773d56a
--- /dev/null
+++ b/doc/files/createmeshoctreeactor.html
@@ -0,0 +1,33 @@
+
+
+
+ Returns a mesh actor optimized for large objects (such as levels) +
+Related: + CreateMesh + LoadMesh +
+
+
+
Related: + CreateMeshActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createmotorjoint.html b/doc/files/createmotorjoint.html new file mode 100644 index 0000000..68fb28d --- /dev/null +++ b/doc/files/createmotorjoint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/createmotorjoint.txt b/doc/files/createmotorjoint.txt new file mode 100644 index 0000000..f5426a7 --- /dev/null +++ b/doc/files/createmotorjoint.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/createoctreeactor.html new file mode 100644 index 0000000..f98ec0b --- /dev/null +++ b/doc/files/createoctreeactor.html @@ -0,0 +1,33 @@ + + +
+ + ++ Returns a mesh actor optimized for large objects (such as levels) +
+Related: + CreateMesh + LoadMesh +
+
+
+
Related: + CreateAnimatedActor + CreateCubeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/createoctreeactor.txt b/doc/files/createoctreeactor.txt
new file mode 100644
index 0000000..95c9e3a
--- /dev/null
+++ b/doc/files/createoctreeactor.txt
@@ -0,0 +1,8 @@
+#title CreateOctreeActor [RCBasic Doc]
+#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.html b/doc/files/createparticleactor.html
new file mode 100644
index 0000000..df45f38
--- /dev/null
+++ b/doc/files/createparticleactor.html
@@ -0,0 +1,49 @@
+
+
+
+ Returns a new particle actor +
++ Possible Particle Types +
+Related: + CreateMeshOctreeActor + CreateCubeActor + CreateSphereActor + CreateWaterPlaneActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createparticleactor.txt b/doc/files/createparticleactor.txt new file mode 100644 index 0000000..8cd0ca2 --- /dev/null +++ b/doc/files/createparticleactor.txt @@ -0,0 +1,16 @@ +#title CreateParticleActor [RCBasic Doc] +#header function CreateParticleActor( particle_type ) + +Returns a new particle actor + +Possible Particle Types +#list ul +#li PARTICLE_TYPE_POINT +#li PARTICLE_TYPE_BOX +#li PARTICLE_TYPE_SPHERE +#li PARTICLE_TYPE_CYLINDER +#li PARTICLE_TYPE_MESH +#li PARTICLE_TYPE_RING +#/list + +#ref CreateMeshOctreeActor CreateCubeActor CreateSphereActor CreateWaterPlaneActor CreateLightActor CreateBillboardActor CreateTerrainActor diff --git a/doc/files/createplanemesh.html b/doc/files/createplanemesh.html new file mode 100644 index 0000000..3967e52 --- /dev/null +++ b/doc/files/createplanemesh.html @@ -0,0 +1,25 @@ + + +
+ + ++ Creates a flat plane +
++ + + \ No newline at end of file diff --git a/doc/files/createplanemesh.txt b/doc/files/createplanemesh.txt new file mode 100644 index 0000000..8fd005f --- /dev/null +++ b/doc/files/createplanemesh.txt @@ -0,0 +1,10 @@ +#title CreatePlaneMesh [RCBasic Doc] +#header Function CreatePlaneMesh( w, h, tileCount_w, tileCount_h ) + +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 +#/list + diff --git a/doc/files/createpointconstraint.html b/doc/files/createpointconstraint.html new file mode 100644 index 0000000..a199c13 --- /dev/null +++ b/doc/files/createpointconstraint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + CreatePointConstraintEx +
++ + + \ No newline at end of file diff --git a/doc/files/createpointconstraint.txt b/doc/files/createpointconstraint.txt new file mode 100644 index 0000000..351ed56 --- /dev/null +++ b/doc/files/createpointconstraint.txt @@ -0,0 +1,6 @@ +#title CreatePointConstraint [RCBasic Doc] +#header Function CreatePointConstraint( actorA, pxA, pyA, pzA) + +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.html b/doc/files/createpointconstraintex.html new file mode 100644 index 0000000..1741ed2 --- /dev/null +++ b/doc/files/createpointconstraintex.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + CreatePointConstraint +
++ + + \ No newline at end of file diff --git a/doc/files/createpointconstraintex.txt b/doc/files/createpointconstraintex.txt new file mode 100644 index 0000000..9817321 --- /dev/null +++ b/doc/files/createpointconstraintex.txt @@ -0,0 +1,7 @@ +#title CreatePointConstraintEx [RCBasic Doc] +#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.html b/doc/files/createprismaticjoint.html new file mode 100644 index 0000000..ded3010 --- /dev/null +++ b/doc/files/createprismaticjoint.html @@ -0,0 +1,37 @@ + + +
+ + ++ Creates a Prismatic Joint +
++ A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in bodyA. Relative rotation is prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction. +
++ Parameters +
++ + + \ No newline at end of file diff --git a/doc/files/createprismaticjoint.txt b/doc/files/createprismaticjoint.txt new file mode 100644 index 0000000..3925f8e --- /dev/null +++ b/doc/files/createprismaticjoint.txt @@ -0,0 +1,14 @@ +#title createPrismaticJoint [RCBasic Doc] +#header function createPrismaticJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect) + +Creates a Prismatic Joint + +A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in bodyA. Relative rotation is prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction. + +Parameters +#list ul +#li spriteA - first body +#li spriteB - second body +#li aX, aY - anchor point +#li axisX, axisY - Used to define a linear direction from anchor point +#/list diff --git a/doc/files/createpulleyjoint.html b/doc/files/createpulleyjoint.html new file mode 100644 index 0000000..2132eac --- /dev/null +++ b/doc/files/createpulleyjoint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/createpulleyjoint.txt b/doc/files/createpulleyjoint.txt new file mode 100644 index 0000000..04eee70 --- /dev/null +++ b/doc/files/createpulleyjoint.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/createrevolutejoint.html new file mode 100644 index 0000000..4dabc72 --- /dev/null +++ b/doc/files/createrevolutejoint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/createrevolutejoint.txt b/doc/files/createrevolutejoint.txt new file mode 100644 index 0000000..979114b --- /dev/null +++ b/doc/files/createrevolutejoint.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/createslideconstraint.html new file mode 100644 index 0000000..2db0edc --- /dev/null +++ b/doc/files/createslideconstraint.html @@ -0,0 +1,34 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameB, 0, 50, 0) 'Sets the attach point of the constraint to the top of the cube
+ SetMatrixRotation(frameB, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y
+ slide = CreateSlideConstraint(actorA, frameB, true)
+
+ Note: It is recommended to use CreateSlideConstraintEx() in most cases +
+Related: + CreateSlideConstraintEx + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/files/createslideconstraint.txt b/doc/files/createslideconstraint.txt new file mode 100644 index 0000000..03bd6cb --- /dev/null +++ b/doc/files/createslideconstraint.txt @@ -0,0 +1,17 @@ +#title CreateSlideConstraint [RCBasic Doc] +#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. + +#code +actorA = CreateCubeActor(100) 'Creates a cube actor +frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix +SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix +SetMatrixTranslation(frameB, 0, 50, 0) 'Sets the attach point of the constraint to the top of the cube +SetMatrixRotation(frameB, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y +slide = CreateSlideConstraint(actorA, frameB, true) +#/code + +Note: It is recommended to use CreateSlideConstraintEx() in most cases + +#ref CreateSlideConstraintEx SetIdentityMatrix SetMatrixTranslation SetMatrixRotation diff --git a/doc/files/createslideconstraintex.html b/doc/files/createslideconstraintex.html new file mode 100644 index 0000000..b139388 --- /dev/null +++ b/doc/files/createslideconstraintex.html @@ -0,0 +1,40 @@ + + +
+ + ++ 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. +
+
+ actorA = CreateCubeActor(100) 'Creates a cube actor
+ frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameA, 0, 0, 0) 'Sets the attach point of the constraint to center of the cube
+ SetMatrixRotation(frameA, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y
+
+ actorB = CreateCubeActor(100) 'Creates a cube actor
+ frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix
+ SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix
+ SetMatrixTranslation(frameB, 0, 50, 0) 'Sets the attach point of the constraint to the top of the cube
+ SetMatrixRotation(frameB, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y
+ slide = CreateSlideConstraintEx(actorA, actorB, frameA, frameB, true)
+
+ Note: It is recommended to use CreateSlideConstraintEx() in most cases +
+Related: + CreateSlideConstraint + SetIdentityMatrix + SetMatrixTranslation + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/files/createslideconstraintex.txt b/doc/files/createslideconstraintex.txt new file mode 100644 index 0000000..3acc1cd --- /dev/null +++ b/doc/files/createslideconstraintex.txt @@ -0,0 +1,24 @@ +#title CreateSlideConstraintEx [RCBasic Doc] +#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. + +#code +actorA = CreateCubeActor(100) 'Creates a cube actor +frameA = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix +SetIdentityMatrix(frameA, 4) 'Sets frameB to a 4x4 identity matrix +SetMatrixTranslation(frameA, 0, 0, 0) 'Sets the attach point of the constraint to center of the cube +SetMatrixRotation(frameA, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y + +actorB = CreateCubeActor(100) 'Creates a cube actor +frameB = DimMatrix(4, 4) 'A transform matrix must be a 4x4 matrix +SetIdentityMatrix(frameB, 4) 'Sets frameB to a 4x4 identity matrix +SetMatrixTranslation(frameB, 0, 50, 0) 'Sets the attach point of the constraint to the top of the cube +SetMatrixRotation(frameB, 0, 90, 0) 'Rotates the constraint axis by 90 degrees around y +slide = CreateSlideConstraintEx(actorA, actorB, frameA, frameB, true) +#/code + +Note: It is recommended to use CreateSlideConstraintEx() in most cases + +#ref CreateSlideConstraint SetIdentityMatrix SetMatrixTranslation SetMatrixRotation + diff --git a/doc/files/createsound.html b/doc/files/createsound.html new file mode 100644 index 0000000..f0e836a --- /dev/null +++ b/doc/files/createsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new sound from a buffer of raw audio data +
++ + + \ No newline at end of file diff --git a/doc/files/createsound.txt b/doc/files/createsound.txt new file mode 100644 index 0000000..f5fc41c --- /dev/null +++ b/doc/files/createsound.txt @@ -0,0 +1,4 @@ +#title CreateSound [RCBasic Doc] +#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.html b/doc/files/createsphereactor.html new file mode 100644 index 0000000..78b54cd --- /dev/null +++ b/doc/files/createsphereactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns an actor composed of a sphere mesh +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateBillboardActor + CreateWaterActor + CreateLightActor + CreateCubeActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createsphereactor.txt b/doc/files/createsphereactor.txt new file mode 100644 index 0000000..b8f1faa --- /dev/null +++ b/doc/files/createsphereactor.txt @@ -0,0 +1,6 @@ +#title CreateSphereActor [RCBasic Doc] +#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.html b/doc/files/createsprite.html new file mode 100644 index 0000000..d92a5ce --- /dev/null +++ b/doc/files/createsprite.html @@ -0,0 +1,52 @@ + + +
+ + ++ This function returns a new sprite which you can place in a variable for use in your program. +
++ Here is an example of opening a sprite canvas layer, creating a sprite, setting it's position and finally displaying it. +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("CreateSprite", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ While Not Key(K_ESCAPE)
+ 'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called.
+ Update() 'Update automatically deals with drawing the sprites on the sprite canvas.
+ Wend
+
Related: + OpenCanvasSpriteLayer + SetSpritePosition +
++ + + \ No newline at end of file diff --git a/doc/files/createsprite.txt b/doc/files/createsprite.txt new file mode 100644 index 0000000..44ad67d --- /dev/null +++ b/doc/files/createsprite.txt @@ -0,0 +1,38 @@ +#title CreateSprite [RCBasic Doc] +#header function CreateSprite( img ) + +This function returns a new sprite which you can place in a variable for use in your program. + +Here is an example of opening a sprite canvas layer, creating a sprite, setting it's position and finally displaying it. + +#code + isFullScreen = false + vSync = true + winWidth = 640 + winHeight = 480 + canViewPortX = 0 + canViewPortY = 0 + + OpenWindow("CreateSprite", winWidth, winHeight, isFullScreen, vSync) + sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) + Canvas(sCanvas) + + DIM eye + DIM eyeW + DIM eyeH + + eye = LoadImage("theEye.png") + GetImageSize(eye, eyeW, eyeH) + + eyeSprite = CreateSprite(eye, eyeW, eyeH) + SetSpritePosition(eyeSprite, 100, 100) + + While Not Key(K_ESCAPE) + 'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called. + Update() 'Update automatically deals with drawing the sprites on the sprite canvas. + Wend +#/code + +#image "images/theEye.png" + +#ref OpenCanvasSpriteLayer SetSpritePosition diff --git a/doc/files/createspriteanimation.html b/doc/files/createspriteanimation.html new file mode 100644 index 0000000..86e6406 --- /dev/null +++ b/doc/files/createspriteanimation.html @@ -0,0 +1,25 @@ + + +
+ + ++ Returns a new sprite animation id +
++ + + \ No newline at end of file diff --git a/doc/files/createspriteanimation.txt b/doc/files/createspriteanimation.txt new file mode 100644 index 0000000..b66598e --- /dev/null +++ b/doc/files/createspriteanimation.txt @@ -0,0 +1,9 @@ +#title CreateSpriteAnimation [RCBasic Doc] +#header Function CreateSpriteAnimation(sprite, anim_length, speed) + +Returns a new sprite animation id + +#list ul +#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.html b/doc/files/createstack_n.html new file mode 100644 index 0000000..0636ce1 --- /dev/null +++ b/doc/files/createstack_n.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new number stack +
++ + + \ No newline at end of file diff --git a/doc/files/createstack_n.txt b/doc/files/createstack_n.txt new file mode 100644 index 0000000..2a1f8d3 --- /dev/null +++ b/doc/files/createstack_n.txt @@ -0,0 +1,5 @@ +#title CreateStack_N [RCBasic Doc] +#header function CreateStack_N( ) + +Returns a new number stack + diff --git a/doc/files/createstack_s.html b/doc/files/createstack_s.html new file mode 100644 index 0000000..5f954c2 --- /dev/null +++ b/doc/files/createstack_s.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new string stack +
++ + + \ No newline at end of file diff --git a/doc/files/createstack_s.txt b/doc/files/createstack_s.txt new file mode 100644 index 0000000..48bbc15 --- /dev/null +++ b/doc/files/createstack_s.txt @@ -0,0 +1,5 @@ +#title CreateStack_S [RCBasic Doc] +#header function CreateStack_S() + +Returns a new string stack + diff --git a/doc/files/createterrainactor.html b/doc/files/createterrainactor.html new file mode 100644 index 0000000..d100dea --- /dev/null +++ b/doc/files/createterrainactor.html @@ -0,0 +1,29 @@ + + +
+ + ++ Returns terrain generated from a height map +
++ Note: Height Maps can be any supported image format +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateWaterActor + CreateLightActor + CreateCubeActor + CreateBillboardActor +
++ + + \ No newline at end of file diff --git a/doc/files/createterrainactor.txt b/doc/files/createterrainactor.txt new file mode 100644 index 0000000..9e97d2b --- /dev/null +++ b/doc/files/createterrainactor.txt @@ -0,0 +1,8 @@ +#title CreateTerrainActor [RCBasic Doc] +#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.html b/doc/files/createtilemap.html new file mode 100644 index 0000000..5e0604a --- /dev/null +++ b/doc/files/createtilemap.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns a new tile map. +
++ Parameters +
+Related: + CreateTileSet +
++ + + \ No newline at end of file diff --git a/doc/files/createtilemap.txt b/doc/files/createtilemap.txt new file mode 100644 index 0000000..ebcd366 --- /dev/null +++ b/doc/files/createtilemap.txt @@ -0,0 +1,13 @@ +#title CreateTileMap [RCBasic Doc] +#header Function CreateTileMap(tileset, widthInTiles, heightInTiles) + +Returns a new tile map. + +Parameters +#list ul +#li tileset - A tileset Id. ( Tilesets are created with CreateTileSet() ) +#li widthInTiles - The number of tiles wide ( Note: Not the pixel width but number of tiles ) +#li widthInTiles - The number of tiles high ( Note: Not the pixel height but number of tiles ) +#/list + +#ref CreateTileSet diff --git a/doc/files/createtileset.html b/doc/files/createtileset.html new file mode 100644 index 0000000..df195b4 --- /dev/null +++ b/doc/files/createtileset.html @@ -0,0 +1,93 @@ + + +
+ + ++ Return a new Tileset +
++ Parameters: +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("TestTileset", winWidth, winHeight, isFullScreen, vSync)
+ mCanvas = OpenCanvas(winWidth, winHeight, canViewPortX, canViewPortY, winWidth, winHeight, 1)
+ Canvas(mCanvas)
+
+ mAtlas = LoadImage("testTileSet.png") 'Load in our atlas or tile set image
+
+ mTileSet = CreateTileSet(mAtlas, 24, 24) 'Create a tile set and assign it a holder to access
+
+ mTileMap = CreateTileMap(mTileSet, 20, 20) 'Create a tile map with our tile set holder "mTileSet"
+
+ 'Now we have a blacnk tilemap to fill with tiles, we now use the mAtlas image to fill in the map
+ 'First we will assign a grass tile across our entire tile map. lets grab a grass tile to fill in.
+
+ FillTile(mTileMap, 166, 0, 0, 20, 20) 'The tile number goes by starting at the top left corner to the right edge of the image,
+ 'then wraps around and comntinues the count, the image is 13 wide (0-12) so 166 would be
+ '2 in from the end of the last row of images on the tileset.
+
+ SetTile(mTileMap, 15, 0, 0) 'With the map filled with grass tiles we can change a single tile, to a little guy in the
+ 'top left corner.
+
+ 'Before we begin our main loop, we need to make some variables for holding some important info
+ mOffsetX = 0
+ mOffsetY = 0 'Offset values for where the tile is to be drawn from, used for scrolling.
+ mViewportX = 640
+ mViewportY = 480 'How much of the tile map is to be drawn on the canvas
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+
+ DrawTileMap(mTileMap, 0, 0, mViewportX, mViewportY, mOffsetX, mOffsetY)
+
+ If Key(K_UP) Then
+ mOffsetY = mOffsetY - 0.5
+ ElseIf Key(K_DOWN) Then
+ mOffsetY = mOffsetY + 0.5
+ ElseIf Key(K_LEFT) Then
+ mOffsetX = mOffsetX - 0.5
+ ElseIf Key(K_RIGHT) Then
+ mOffsetX = mOffsetX + 0.5
+ End If
+
+ Update()
+ Wend
+
+ 'As you can see this replaces the grass tile with a character tile, if we wanted to place the character or any other object or image ontop of the tile
+ 'we would DrawImage() an image not using the tilemap.
+
Related: + CreateTileMap + SetTile + FillTile + DrawTileMap +
++ + + \ No newline at end of file diff --git a/doc/files/createtileset.txt b/doc/files/createtileset.txt new file mode 100644 index 0000000..c9d3a10 --- /dev/null +++ b/doc/files/createtileset.txt @@ -0,0 +1,71 @@ +#title CreateTileSet [RCBasic Doc] +#header Function CreateTileSet(img_id, tile_w, tile_h) + +Return a new Tileset + +Parameters: +#list ul +#li img_id - A image to use as a tile sheet +#li tile_w - The width of each tile +#li tile_h - The height of each tile +#/list + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("TestTileset", winWidth, winHeight, isFullScreen, vSync) +mCanvas = OpenCanvas(winWidth, winHeight, canViewPortX, canViewPortY, winWidth, winHeight, 1) +Canvas(mCanvas) + +mAtlas = LoadImage("testTileSet.png") 'Load in our atlas or tile set image + +mTileSet = CreateTileSet(mAtlas, 24, 24) 'Create a tile set and assign it a holder to access + +mTileMap = CreateTileMap(mTileSet, 20, 20) 'Create a tile map with our tile set holder "mTileSet" + +'Now we have a blacnk tilemap to fill with tiles, we now use the mAtlas image to fill in the map +'First we will assign a grass tile across our entire tile map. lets grab a grass tile to fill in. + +FillTile(mTileMap, 166, 0, 0, 20, 20) 'The tile number goes by starting at the top left corner to the right edge of the image, + 'then wraps around and comntinues the count, the image is 13 wide (0-12) so 166 would be + '2 in from the end of the last row of images on the tileset. + +SetTile(mTileMap, 15, 0, 0) 'With the map filled with grass tiles we can change a single tile, to a little guy in the + 'top left corner. + +'Before we begin our main loop, we need to make some variables for holding some important info +mOffsetX = 0 +mOffsetY = 0 'Offset values for where the tile is to be drawn from, used for scrolling. +mViewportX = 640 +mViewportY = 480 'How much of the tile map is to be drawn on the canvas + +While Not Key(K_ESCAPE) + ClearCanvas() + + DrawTileMap(mTileMap, 0, 0, mViewportX, mViewportY, mOffsetX, mOffsetY) + + If Key(K_UP) Then + mOffsetY = mOffsetY - 0.5 + ElseIf Key(K_DOWN) Then + mOffsetY = mOffsetY + 0.5 + ElseIf Key(K_LEFT) Then + mOffsetX = mOffsetX - 0.5 + ElseIf Key(K_RIGHT) Then + mOffsetX = mOffsetX + 0.5 + End If + + Update() +Wend + +'As you can see this replaces the grass tile with a character tile, if we wanted to place the character or any other object or image ontop of the tile +'we would DrawImage() an image not using the tilemap. +#/code + +#image "images/testTileSet.png" + +#ref CreateTileMap SetTile FillTile DrawTileMap diff --git a/doc/files/createwateractor.html b/doc/files/createwateractor.html new file mode 100644 index 0000000..2fbf096 --- /dev/null +++ b/doc/files/createwateractor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Creates an actor with water properties set on a base mesh +
+Related: + CreateAnimatedActor + CreateOctreeActor + CreateSphereActor + CreateCubeActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createwateractor.txt b/doc/files/createwateractor.txt new file mode 100644 index 0000000..2c1577d --- /dev/null +++ b/doc/files/createwateractor.txt @@ -0,0 +1,6 @@ +#title CreateWaterActor [RCBasic Doc] +#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.html b/doc/files/createwaterplaneactor.html new file mode 100644 index 0000000..f5b50f6 --- /dev/null +++ b/doc/files/createwaterplaneactor.html @@ -0,0 +1,26 @@ + + +
+ + ++ Returns a water plane actor +
+Related: + CreateMeshActor + CreateMeshOctreeActor + CreateCubeActor + CreateSphereActor + CreateLightActor + CreateBillboardActor + CreateTerrainActor +
++ + + \ No newline at end of file diff --git a/doc/files/createwaterplaneactor.txt b/doc/files/createwaterplaneactor.txt new file mode 100644 index 0000000..ed1f97f --- /dev/null +++ b/doc/files/createwaterplaneactor.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/createweldjoint.html new file mode 100644 index 0000000..96a885a --- /dev/null +++ b/doc/files/createweldjoint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/createweldjoint.txt b/doc/files/createweldjoint.txt new file mode 100644 index 0000000..997d9ff --- /dev/null +++ b/doc/files/createweldjoint.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/createwheeljoint.html new file mode 100644 index 0000000..0b74ef5 --- /dev/null +++ b/doc/files/createwheeljoint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/createwheeljoint.txt b/doc/files/createwheeljoint.txt new file mode 100644 index 0000000..430cc6e --- /dev/null +++ b/doc/files/createwheeljoint.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/cubematrix.html new file mode 100644 index 0000000..fd8344c --- /dev/null +++ b/doc/files/cubematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns matrix mA raised to the 3rd power +
++ + + \ No newline at end of file diff --git a/doc/files/cubematrix.txt b/doc/files/cubematrix.txt new file mode 100644 index 0000000..e949679 --- /dev/null +++ b/doc/files/cubematrix.txt @@ -0,0 +1,4 @@ +#title CubeMatrix [RCBasic Doc] +#header function CubeMatrix(mA, mB) + +Returns matrix mA raised to the 3rd power diff --git a/doc/files/date.html b/doc/files/date.html new file mode 100644 index 0000000..4ce196c --- /dev/null +++ b/doc/files/date.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the date in "MM-DD-YYYY" format +
++ + + \ No newline at end of file diff --git a/doc/files/date.txt b/doc/files/date.txt new file mode 100644 index 0000000..672d718 --- /dev/null +++ b/doc/files/date.txt @@ -0,0 +1,4 @@ +#title Date$ [RCBasic Doc] +#header function Date$() + +Returns the date in "MM-DD-YYYY" format diff --git a/doc/files/degrees.html b/doc/files/degrees.html new file mode 100644 index 0000000..8c331fc --- /dev/null +++ b/doc/files/degrees.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns angle converted from radians to degrees +
++ + + \ No newline at end of file diff --git a/doc/files/degrees.txt b/doc/files/degrees.txt new file mode 100644 index 0000000..96d0046 --- /dev/null +++ b/doc/files/degrees.txt @@ -0,0 +1,4 @@ +#title Degrees [RCBasic Doc] +#header function Degrees(r) + +Returns angle converted from radians to degrees diff --git a/doc/files/deleteactor.html b/doc/files/deleteactor.html new file mode 100644 index 0000000..7efb430 --- /dev/null +++ b/doc/files/deleteactor.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/deleteactor.txt b/doc/files/deleteactor.txt new file mode 100644 index 0000000..3c7250d --- /dev/null +++ b/doc/files/deleteactor.txt @@ -0,0 +1,6 @@ +#title DeleteActor [RCBasic Doc] +#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.html b/doc/files/deleteactoranimation.html new file mode 100644 index 0000000..89436d3 --- /dev/null +++ b/doc/files/deleteactoranimation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Deletes an actor's animation +
++ + + \ No newline at end of file diff --git a/doc/files/deleteactoranimation.txt b/doc/files/deleteactoranimation.txt new file mode 100644 index 0000000..edeb2ec --- /dev/null +++ b/doc/files/deleteactoranimation.txt @@ -0,0 +1,4 @@ +#title DeleteActorAnimation [RCBasic Doc] +#header sub DeleteActorAnimation(actor, animation) + +Deletes an actor's animation diff --git a/doc/files/deleteconstraint.html b/doc/files/deleteconstraint.html new file mode 100644 index 0000000..2dca7ba --- /dev/null +++ b/doc/files/deleteconstraint.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a constraint +
++ + + \ No newline at end of file diff --git a/doc/files/deleteconstraint.txt b/doc/files/deleteconstraint.txt new file mode 100644 index 0000000..71ab51b --- /dev/null +++ b/doc/files/deleteconstraint.txt @@ -0,0 +1,4 @@ +#title DeleteConstraint [RCBasic Doc] +#header Sub DeleteConstraint( constraint_id) + +Removes a constraint diff --git a/doc/files/deletefont.html b/doc/files/deletefont.html new file mode 100644 index 0000000..65a1bca --- /dev/null +++ b/doc/files/deletefont.html @@ -0,0 +1,17 @@ + + +
+ + ++ Frees a font from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletefont.txt b/doc/files/deletefont.txt new file mode 100644 index 0000000..097249b --- /dev/null +++ b/doc/files/deletefont.txt @@ -0,0 +1,4 @@ +#title DeleteFont [RCBasic Doc] +#header Sub DeleteFont(font_id) + +Frees a font from memory diff --git a/doc/files/deleteimage.html b/doc/files/deleteimage.html new file mode 100644 index 0000000..507d13f --- /dev/null +++ b/doc/files/deleteimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes an image from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deleteimage.txt b/doc/files/deleteimage.txt new file mode 100644 index 0000000..db62800 --- /dev/null +++ b/doc/files/deleteimage.txt @@ -0,0 +1,4 @@ +#title DeleteImage [RCBasic Doc] +#header Sub DeleteImage(img) + +Removes an image from memory diff --git a/doc/files/deletejoint.html b/doc/files/deletejoint.html new file mode 100644 index 0000000..d2f63f4 --- /dev/null +++ b/doc/files/deletejoint.html @@ -0,0 +1,28 @@ + + +
+ + ++ Clears a joint from memory +
+Related: + CreateDistanceJoint + CreateFrictionJoint + CreateGearJoint + CreateMotorJoint + CreatePrismaticJoint + CreatePulleyJoint + CreateRevoluteJoint + CreateWeldJoint + CreateWheelJoint +
++ + + \ No newline at end of file diff --git a/doc/files/deletejoint.txt b/doc/files/deletejoint.txt new file mode 100644 index 0000000..6b3d983 --- /dev/null +++ b/doc/files/deletejoint.txt @@ -0,0 +1,6 @@ +#title DeleteJoint [RCBasic Doc] +#header Sub DeleteJoint( joint_id ) + +Clears a joint from memory + +#ref CreateDistanceJoint CreateFrictionJoint CreateGearJoint CreateMotorJoint CreatePrismaticJoint CreatePulleyJoint CreateRevoluteJoint CreateWeldJoint CreateWheelJoint diff --git a/doc/files/deletematerial.html b/doc/files/deletematerial.html new file mode 100644 index 0000000..9a41461 --- /dev/null +++ b/doc/files/deletematerial.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/deletematerial.txt b/doc/files/deletematerial.txt new file mode 100644 index 0000000..65d6173 --- /dev/null +++ b/doc/files/deletematerial.txt @@ -0,0 +1,6 @@ +#title DeleteMaterial [RCBasic Doc] +#header Sub DeleteMaterial( material_id) + +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.html b/doc/files/deletematrix.html new file mode 100644 index 0000000..3cd8f16 --- /dev/null +++ b/doc/files/deletematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Frees a matrix from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletematrix.txt b/doc/files/deletematrix.txt new file mode 100644 index 0000000..a1774e8 --- /dev/null +++ b/doc/files/deletematrix.txt @@ -0,0 +1,4 @@ +#title DeleteMatrix [RCBasic Doc] +#header Sub DeleteMatrix(mA) + +Frees a matrix from memory diff --git a/doc/files/deletematrixcolumns.html b/doc/files/deletematrixcolumns.html new file mode 100644 index 0000000..1d62c02 --- /dev/null +++ b/doc/files/deletematrixcolumns.html @@ -0,0 +1,23 @@ + + +
+ + ++ Removes the specified columns from a matrix +
++ Returns false if column are outside matrix +
+Related: + DeleteMatrixRows +
++ + + \ No newline at end of file diff --git a/doc/files/deletematrixcolumns.txt b/doc/files/deletematrixcolumns.txt new file mode 100644 index 0000000..51427c0 --- /dev/null +++ b/doc/files/deletematrixcolumns.txt @@ -0,0 +1,8 @@ +#title DeleteMatrixColumns [RCBasic Doc] +#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.html b/doc/files/deletematrixrows.html new file mode 100644 index 0000000..9744bbd --- /dev/null +++ b/doc/files/deletematrixrows.html @@ -0,0 +1,23 @@ + + +
+ + ++ Removes the specified rows from a matrix +
++ Returns false if rows are outside matrix +
+Related: + DeleteMatrixColumns +
++ + + \ No newline at end of file diff --git a/doc/files/deletematrixrows.txt b/doc/files/deletematrixrows.txt new file mode 100644 index 0000000..c6e3a4a --- /dev/null +++ b/doc/files/deletematrixrows.txt @@ -0,0 +1,8 @@ +#title DeleteMatrixRows [RCBasic Doc] +#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.html b/doc/files/deletemesh.html new file mode 100644 index 0000000..97df4d5 --- /dev/null +++ b/doc/files/deletemesh.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a mesh from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletemesh.txt b/doc/files/deletemesh.txt new file mode 100644 index 0000000..fca2650 --- /dev/null +++ b/doc/files/deletemesh.txt @@ -0,0 +1,4 @@ +#title DeleteMesh [RCBasic Doc] +#header sub DeleteMesh( mesh ) + +Removes a mesh from memory diff --git a/doc/files/deletemusic.html b/doc/files/deletemusic.html new file mode 100644 index 0000000..e4ce76d --- /dev/null +++ b/doc/files/deletemusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes the current music track from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletemusic.txt b/doc/files/deletemusic.txt new file mode 100644 index 0000000..617f5ab --- /dev/null +++ b/doc/files/deletemusic.txt @@ -0,0 +1,4 @@ +#title DeleteMusic [RCBasic Doc] +#header sub DeleteMusic() + +Removes the current music track from memory diff --git a/doc/files/deletesound.html b/doc/files/deletesound.html new file mode 100644 index 0000000..030955e --- /dev/null +++ b/doc/files/deletesound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a sound from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletesound.txt b/doc/files/deletesound.txt new file mode 100644 index 0000000..73852c7 --- /dev/null +++ b/doc/files/deletesound.txt @@ -0,0 +1,4 @@ +#title DeleteSound [RCBasic Doc] +#header sub DeleteSound(snd) + +Removes a sound from memory diff --git a/doc/files/deletesprite.html b/doc/files/deletesprite.html new file mode 100644 index 0000000..f80ae44 --- /dev/null +++ b/doc/files/deletesprite.html @@ -0,0 +1,63 @@ + + +
+ + ++ Removes a sprite from memory +
++ Here is an example: +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("CreateSprite", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, 150, 100)
+
+ timePassed = Timer()
+ timePassedDiff = 2000
+
+ While Not Key(K_ESCAPE)
+
+ If Timer() - timePassed > timePassedDiff Then 'After 2 seconds eyeSprite2 will be deleted
+ DeleteSprite(eyeSprite2)
+ End If
+
+ Update()
+ Wend
+
Related: + OpenCanvasSpriteLayer + SetSpritePosition + CreateSprite +
++ + + \ No newline at end of file diff --git a/doc/files/deletesprite.txt b/doc/files/deletesprite.txt new file mode 100644 index 0000000..aea9cd6 --- /dev/null +++ b/doc/files/deletesprite.txt @@ -0,0 +1,48 @@ +#title DeleteSprite [RCBasic Doc] +#header Sub DeleteSprite( sprite ) + +Removes a sprite from memory + +Here is an example: + +#code + isFullScreen = false + vSync = true + winWidth = 640 + winHeight = 480 + canViewPortX = 0 + canViewPortY = 0 + + OpenWindow("CreateSprite", winWidth, winHeight, isFullScreen, vSync) + sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) + Canvas(sCanvas) + + DIM eye + DIM eyeW + DIM eyeH + + eye = LoadImage("theEye.png") + GetImageSize(eye, eyeW, eyeH) + + eyeSprite = CreateSprite(eye, eyeW, eyeH) + SetSpritePosition(eyeSprite, 100, 100) + + eyeSprite2 = CreateSprite(eye, eyeW, eyeH) + SetSpritePosition(eyeSprite2, 150, 100) + + timePassed = Timer() + timePassedDiff = 2000 + + While Not Key(K_ESCAPE) + + If Timer() - timePassed > timePassedDiff Then 'After 2 seconds eyeSprite2 will be deleted + DeleteSprite(eyeSprite2) + End If + + Update() + Wend +#/code + +#image "images/theEye.png" + +#ref OpenCanvasSpriteLayer SetSpritePosition CreateSprite diff --git a/doc/files/deletespriteanimation.html b/doc/files/deletespriteanimation.html new file mode 100644 index 0000000..b548c7b --- /dev/null +++ b/doc/files/deletespriteanimation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Delete's a sprite's animation +
+Related: + CreateSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/files/deletespriteanimation.txt b/doc/files/deletespriteanimation.txt new file mode 100644 index 0000000..3fe5d23 --- /dev/null +++ b/doc/files/deletespriteanimation.txt @@ -0,0 +1,6 @@ +#title DeleteSpriteAnimation [RCBasic Doc] +#header Sub DeleteSpriteAnimation(sprite, animation) + +Delete's a sprite's animation + +#ref CreateSpriteAnimation diff --git a/doc/files/deletestack_n.html b/doc/files/deletestack_n.html new file mode 100644 index 0000000..789e58c --- /dev/null +++ b/doc/files/deletestack_n.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a number stack from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletestack_n.txt b/doc/files/deletestack_n.txt new file mode 100644 index 0000000..672e79c --- /dev/null +++ b/doc/files/deletestack_n.txt @@ -0,0 +1,4 @@ +#title DeleteStack_N [RCBasic Doc] +#header sub DeleteStack_N( num_stack ) + +Removes a number stack from memory diff --git a/doc/files/deletestack_s.html b/doc/files/deletestack_s.html new file mode 100644 index 0000000..2ae26e7 --- /dev/null +++ b/doc/files/deletestack_s.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a string stack from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletestack_s.txt b/doc/files/deletestack_s.txt new file mode 100644 index 0000000..2969a36 --- /dev/null +++ b/doc/files/deletestack_s.txt @@ -0,0 +1,4 @@ +#title DeleteStack_S [RCBasic Doc] +#header sub DeleteStack_S( str_stack ) + +Removes a string stack from memory diff --git a/doc/files/deletetilemap.html b/doc/files/deletetilemap.html new file mode 100644 index 0000000..fc1d742 --- /dev/null +++ b/doc/files/deletetilemap.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/deletetilemap.txt b/doc/files/deletetilemap.txt new file mode 100644 index 0000000..620d238 --- /dev/null +++ b/doc/files/deletetilemap.txt @@ -0,0 +1,4 @@ +#title DeleteTileMap [RCBasic Doc] +#header Sub DeleteTileMap(tilemap) + + diff --git a/doc/files/deletetileset.html b/doc/files/deletetileset.html new file mode 100644 index 0000000..926b1ea --- /dev/null +++ b/doc/files/deletetileset.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/deletetileset.txt b/doc/files/deletetileset.txt new file mode 100644 index 0000000..6d5b4e0 --- /dev/null +++ b/doc/files/deletetileset.txt @@ -0,0 +1,4 @@ +#title DeleteTileSet [RCBasic Doc] +#header Sub DeleteTileSet(tileset) + + diff --git a/doc/files/deletevideo.html b/doc/files/deletevideo.html new file mode 100644 index 0000000..7367586 --- /dev/null +++ b/doc/files/deletevideo.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes the current video track from memory +
++ + + \ No newline at end of file diff --git a/doc/files/deletevideo.txt b/doc/files/deletevideo.txt new file mode 100644 index 0000000..486f00b --- /dev/null +++ b/doc/files/deletevideo.txt @@ -0,0 +1,4 @@ +#title DeleteVideo [RCBasic Doc] +#header sub DeleteVideo() + +Removes the current video track from memory diff --git a/doc/files/determinant.html b/doc/files/determinant.html new file mode 100644 index 0000000..8f746eb --- /dev/null +++ b/doc/files/determinant.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the determinant of matrix mA +
++ + + \ No newline at end of file diff --git a/doc/files/determinant.txt b/doc/files/determinant.txt new file mode 100644 index 0000000..8d255ba --- /dev/null +++ b/doc/files/determinant.txt @@ -0,0 +1,4 @@ +#title Determinant [RCBasic Doc] +#header function Determinant(mA) + +Returns the determinant of matrix mA diff --git a/doc/files/dimmatrix.html b/doc/files/dimmatrix.html new file mode 100644 index 0000000..3131ae5 --- /dev/null +++ b/doc/files/dimmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a new matrix +
++ + + \ No newline at end of file diff --git a/doc/files/dimmatrix.txt b/doc/files/dimmatrix.txt new file mode 100644 index 0000000..c94db52 --- /dev/null +++ b/doc/files/dimmatrix.txt @@ -0,0 +1,4 @@ +#title DimMatrix [RCBasic Doc] +#header function DimMatrix(m_rows, m_cols) + +Returns a new matrix diff --git a/doc/files/dir.html b/doc/files/dir.html new file mode 100644 index 0000000..bf59ec9 --- /dev/null +++ b/doc/files/dir.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current working directory +
++ + + \ No newline at end of file diff --git a/doc/files/dir.txt b/doc/files/dir.txt new file mode 100644 index 0000000..7c5de53 --- /dev/null +++ b/doc/files/dir.txt @@ -0,0 +1,4 @@ +#title Dir$ [RCBasic Doc] +#header function Dir$() + +Returns the current working directory diff --git a/doc/files/direxists.html b/doc/files/direxists.html new file mode 100644 index 0000000..ec8a462 --- /dev/null +++ b/doc/files/direxists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if a directory exists and false if not +
++ + + \ No newline at end of file diff --git a/doc/files/direxists.txt b/doc/files/direxists.txt new file mode 100644 index 0000000..05afda9 --- /dev/null +++ b/doc/files/direxists.txt @@ -0,0 +1,4 @@ +#title DirExists [RCBasic Doc] +#header function DirExists(p$) + +Returns true if a directory exists and false if not diff --git a/doc/files/dirfirst.html b/doc/files/dirfirst.html new file mode 100644 index 0000000..a78ca29 --- /dev/null +++ b/doc/files/dirfirst.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/dirfirst.txt b/doc/files/dirfirst.txt new file mode 100644 index 0000000..2758f31 --- /dev/null +++ b/doc/files/dirfirst.txt @@ -0,0 +1,4 @@ +#title DirFirst$ [RCBasic Doc] +#header function DirFirst$() + +Resets the directory list poll and returns the first item in the current working directory diff --git a/doc/files/dirnext.html b/doc/files/dirnext.html new file mode 100644 index 0000000..7ed0d9a --- /dev/null +++ b/doc/files/dirnext.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the next item in the directory poll +
+Related: + DirFirst$ +
++ + + \ No newline at end of file diff --git a/doc/files/dirnext.txt b/doc/files/dirnext.txt new file mode 100644 index 0000000..8657887 --- /dev/null +++ b/doc/files/dirnext.txt @@ -0,0 +1,6 @@ +#title DirNext$ [RCBasic Doc] +#header function DirNext$() + +Returns the next item in the directory poll + +#ref DirFirst$ diff --git a/doc/files/distance2d.html b/doc/files/distance2d.html new file mode 100644 index 0000000..666e16a --- /dev/null +++ b/doc/files/distance2d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the distance between 2 points in 2d space +
++ + + \ No newline at end of file diff --git a/doc/files/distance2d.txt b/doc/files/distance2d.txt new file mode 100644 index 0000000..ef41e31 --- /dev/null +++ b/doc/files/distance2d.txt @@ -0,0 +1,4 @@ +#title Distance2D [RCBasic Doc] +#header Function Distance2D(x1, y1, x2, y2) + +Returns the distance between 2 points in 2d space diff --git a/doc/files/distance3d.html b/doc/files/distance3d.html new file mode 100644 index 0000000..d306216 --- /dev/null +++ b/doc/files/distance3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the distance between 2 points in 3d space +
++ + + \ No newline at end of file diff --git a/doc/files/distance3d.txt b/doc/files/distance3d.txt new file mode 100644 index 0000000..20cfffb --- /dev/null +++ b/doc/files/distance3d.txt @@ -0,0 +1,5 @@ +#title Distance3D [RCBasic Doc] +#header Function Distance3D(x1, y1, z1, x2, y2, z2) + +Returns the distance between 2 points in 3d space + diff --git a/doc/files/drawimage.html b/doc/files/drawimage.html new file mode 100644 index 0000000..1225ee6 --- /dev/null +++ b/doc/files/drawimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws an image on the active canvas +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage.txt b/doc/files/drawimage.txt new file mode 100644 index 0000000..03d0504 --- /dev/null +++ b/doc/files/drawimage.txt @@ -0,0 +1,4 @@ +#title DrawImage [RCBasic Doc] +#header sub DrawImage(img, x, y) + +Draws an image on the active canvas diff --git a/doc/files/drawimage_blit.html b/doc/files/drawimage_blit.html new file mode 100644 index 0000000..05937c5 --- /dev/null +++ b/doc/files/drawimage_blit.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a portion of an image to the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_blit.txt b/doc/files/drawimage_blit.txt new file mode 100644 index 0000000..3b49158 --- /dev/null +++ b/doc/files/drawimage_blit.txt @@ -0,0 +1,4 @@ +#title DrawImage_Blit [RCBasic Doc] +#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.html b/doc/files/drawimage_blitex.html new file mode 100644 index 0000000..3827d66 --- /dev/null +++ b/doc/files/drawimage_blitex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Draws a portion of an image to the current canvas scaled to a given width and height. +
+Related: + DrawImage_Blit +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_blitex.txt b/doc/files/drawimage_blitex.txt new file mode 100644 index 0000000..b0fb003 --- /dev/null +++ b/doc/files/drawimage_blitex.txt @@ -0,0 +1,6 @@ +#title DrawImage_BlitEx [RCBasic Doc] +#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.html b/doc/files/drawimage_flip.html new file mode 100644 index 0000000..b7ed61e --- /dev/null +++ b/doc/files/drawimage_flip.html @@ -0,0 +1,23 @@ + + +
+ + ++ Draws an image flipped horizontally or vertically. +
++ Note: h and v are boolean values +
+Related: + DrawImage_FlipEx +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_flip.txt b/doc/files/drawimage_flip.txt new file mode 100644 index 0000000..7f55e21 --- /dev/null +++ b/doc/files/drawimage_flip.txt @@ -0,0 +1,8 @@ +#title DrawImage_Flip [RCBasic Doc] +#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.html b/doc/files/drawimage_flipex.html new file mode 100644 index 0000000..dfa3595 --- /dev/null +++ b/doc/files/drawimage_flipex.html @@ -0,0 +1,23 @@ + + +
+ + ++ Draws a portion of an image flipped horizontally or vertically. +
++ Note: h and v are boolean values +
+Related: + DrawImage_Flip +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_flipex.txt b/doc/files/drawimage_flipex.txt new file mode 100644 index 0000000..02e7b99 --- /dev/null +++ b/doc/files/drawimage_flipex.txt @@ -0,0 +1,8 @@ +#title DrawImage_FlipEx [RCBasic Doc] +#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.html b/doc/files/drawimage_rotate.html new file mode 100644 index 0000000..363f5ef --- /dev/null +++ b/doc/files/drawimage_rotate.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws an image to the current canvas rotated by a given angle. +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_rotate.txt b/doc/files/drawimage_rotate.txt new file mode 100644 index 0000000..bcba804 --- /dev/null +++ b/doc/files/drawimage_rotate.txt @@ -0,0 +1,4 @@ +#title DrawImage_Rotate [RCBasic Doc] +#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.html b/doc/files/drawimage_rotateex.html new file mode 100644 index 0000000..ea696db --- /dev/null +++ b/doc/files/drawimage_rotateex.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/drawimage_rotateex.txt b/doc/files/drawimage_rotateex.txt new file mode 100644 index 0000000..ccf321b --- /dev/null +++ b/doc/files/drawimage_rotateex.txt @@ -0,0 +1,4 @@ +#title DrawImage_RotateEx [RCBasic Doc] +#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.html b/doc/files/drawimage_rotozoom.html new file mode 100644 index 0000000..aa375ab --- /dev/null +++ b/doc/files/drawimage_rotozoom.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws an image to the current canvas rotated and scaled +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_rotozoom.txt b/doc/files/drawimage_rotozoom.txt new file mode 100644 index 0000000..41417e7 --- /dev/null +++ b/doc/files/drawimage_rotozoom.txt @@ -0,0 +1,4 @@ +#title DrawImage_Rotozoom [RCBasic Doc] +#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.html b/doc/files/drawimage_rotozoomex.html new file mode 100644 index 0000000..9f3a9f7 --- /dev/null +++ b/doc/files/drawimage_rotozoomex.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a portion of an image to the current canvas rotated and scaled +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_rotozoomex.txt b/doc/files/drawimage_rotozoomex.txt new file mode 100644 index 0000000..6f41a86 --- /dev/null +++ b/doc/files/drawimage_rotozoomex.txt @@ -0,0 +1,4 @@ +#title DrawImage_RotozoomEx [RCBasic Doc] +#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.html b/doc/files/drawimage_zoom.html new file mode 100644 index 0000000..12bde10 --- /dev/null +++ b/doc/files/drawimage_zoom.html @@ -0,0 +1,20 @@ + + +
+ + ++ Draws an image to the current canvas scaled by a given factor +
+Related: + DrawImage_ZoomEx +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_zoom.txt b/doc/files/drawimage_zoom.txt new file mode 100644 index 0000000..1e12138 --- /dev/null +++ b/doc/files/drawimage_zoom.txt @@ -0,0 +1,6 @@ +#title DrawImage_Zoom [RCBasic Doc] +#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.html b/doc/files/drawimage_zoomex.html new file mode 100644 index 0000000..49eb29b --- /dev/null +++ b/doc/files/drawimage_zoomex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Draws a portion of an Image to the current canvas scaled by a given factor +
+Related: + DrawImage_Zoom +
++ + + \ No newline at end of file diff --git a/doc/files/drawimage_zoomex.txt b/doc/files/drawimage_zoomex.txt new file mode 100644 index 0000000..35e51bb --- /dev/null +++ b/doc/files/drawimage_zoomex.txt @@ -0,0 +1,6 @@ +#title DrawImage_ZoomEx [RCBasic Doc] +#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.html b/doc/files/drawtext.html new file mode 100644 index 0000000..a9deca0 --- /dev/null +++ b/doc/files/drawtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws text to the current canvas +
++ + + \ No newline at end of file diff --git a/doc/files/drawtext.txt b/doc/files/drawtext.txt new file mode 100644 index 0000000..6a6cbbe --- /dev/null +++ b/doc/files/drawtext.txt @@ -0,0 +1,4 @@ +#title DrawText [RCBasic Doc] +#header sub DrawText(txt$, x, y) + + Draws text to the current canvas diff --git a/doc/files/drawtilemap.html b/doc/files/drawtilemap.html new file mode 100644 index 0000000..460bc56 --- /dev/null +++ b/doc/files/drawtilemap.html @@ -0,0 +1,37 @@ + + +
+ + ++ Draws a tile map +
++ Note: Can only be drawn on a regular 2D canvas +
++ Parameters: +
++ + + \ No newline at end of file diff --git a/doc/files/drawtilemap.txt b/doc/files/drawtilemap.txt new file mode 100644 index 0000000..cf491fa --- /dev/null +++ b/doc/files/drawtilemap.txt @@ -0,0 +1,15 @@ +#title DrawTileMap [RCBasic Doc] +#header Sub DrawTileMap(tilemap, x, y, w, h, offset_x, offset_y) + +Draws a tile map + +Note: Can only be drawn on a regular 2D canvas + +Parameters: +#list ul +#li tilemap - the tilemap to draw +#li x, y - Where to draw the map on the active canvas +#li w, h - The size of the tilemap viewport +#li offset_x, offset_y - The location in the tilemap to start drawing from +#/list + diff --git a/doc/files/easter.html b/doc/files/easter.html new file mode 100644 index 0000000..eea5013 --- /dev/null +++ b/doc/files/easter.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns easter of the year passed to it. +
++ + + \ No newline at end of file diff --git a/doc/files/easter.txt b/doc/files/easter.txt new file mode 100644 index 0000000..b5842b3 --- /dev/null +++ b/doc/files/easter.txt @@ -0,0 +1,4 @@ +#title Easter$ [RCBasic Doc] +#header function Easter$(year) + +Returns easter of the year passed to it. diff --git a/doc/files/ellipse.html b/doc/files/ellipse.html new file mode 100644 index 0000000..a0ceccf --- /dev/null +++ b/doc/files/ellipse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws an ellipse on the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/ellipse.txt b/doc/files/ellipse.txt new file mode 100644 index 0000000..5917639 --- /dev/null +++ b/doc/files/ellipse.txt @@ -0,0 +1,4 @@ +#title Ellipse [RCBasic Doc] +#header sub Ellipse(x,y,rx,ry) + +Draws an ellipse on the current canvas. diff --git a/doc/files/ellipsefill.html b/doc/files/ellipsefill.html new file mode 100644 index 0000000..c1d01d5 --- /dev/null +++ b/doc/files/ellipsefill.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a filled ellipse on the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/ellipsefill.txt b/doc/files/ellipsefill.txt new file mode 100644 index 0000000..4b195d6 --- /dev/null +++ b/doc/files/ellipsefill.txt @@ -0,0 +1,4 @@ +#title EllipseFill [RCBasic Doc] +#header sub EllipseFill(x,y,rx,ry) + +Draws a filled ellipse on the current canvas. diff --git a/doc/files/enablejointlimit.html b/doc/files/enablejointlimit.html new file mode 100644 index 0000000..0fb2cf1 --- /dev/null +++ b/doc/files/enablejointlimit.html @@ -0,0 +1,35 @@ + + +
+ + ++ Enables or disables joint limits +
++ Used with +
+Related: + JointIsLimitEnabled + SetJointLimits +
++ + + \ No newline at end of file diff --git a/doc/files/enablejointlimit.txt b/doc/files/enablejointlimit.txt new file mode 100644 index 0000000..231e99a --- /dev/null +++ b/doc/files/enablejointlimit.txt @@ -0,0 +1,13 @@ +#title enableJointLimit [RCBasic Doc] +#header sub enableJointLimit( joint_id, flag) + +Enables or disables joint limits + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref JointIsLimitEnabled SetJointLimits diff --git a/doc/files/enablejointmotor.html b/doc/files/enablejointmotor.html new file mode 100644 index 0000000..53ea4f5 --- /dev/null +++ b/doc/files/enablejointmotor.html @@ -0,0 +1,34 @@ + + +
+ + ++ Enables or disables the joint motor +
++ Used with +
+Related: + JointMotorIsEnabled +
++ + + \ No newline at end of file diff --git a/doc/files/enablejointmotor.txt b/doc/files/enablejointmotor.txt new file mode 100644 index 0000000..26a4640 --- /dev/null +++ b/doc/files/enablejointmotor.txt @@ -0,0 +1,13 @@ +#title enableJointMotor [RCBasic Doc] +#header sub enableJointMotor( joint_id, flag) + +Enables or disables the joint motor + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref JointMotorIsEnabled diff --git a/doc/files/env.html b/doc/files/env.html new file mode 100644 index 0000000..f6c9178 --- /dev/null +++ b/doc/files/env.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the value of the environment variable passed to it. +
+Related: + SetEnv +
++ + + \ No newline at end of file diff --git a/doc/files/env.txt b/doc/files/env.txt new file mode 100644 index 0000000..630b8f0 --- /dev/null +++ b/doc/files/env.txt @@ -0,0 +1,6 @@ +#title Env$ [RCBasic Doc] +#header function Env$(v$) + +Returns the value of the environment variable passed to it. + +#ref SetEnv diff --git a/doc/files/eof.html b/doc/files/eof.html new file mode 100644 index 0000000..32196f9 --- /dev/null +++ b/doc/files/eof.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true when end of file is reached +
++ + + \ No newline at end of file diff --git a/doc/files/eof.txt b/doc/files/eof.txt new file mode 100644 index 0000000..425a8f4 --- /dev/null +++ b/doc/files/eof.txt @@ -0,0 +1,4 @@ +#title EOF [RCBasic Doc] +#header function EOF(stream) + +Returns true when end of file is reached diff --git a/doc/files/evaljs.html b/doc/files/evaljs.html new file mode 100644 index 0000000..1aece3f --- /dev/null +++ b/doc/files/evaljs.html @@ -0,0 +1,23 @@ + + +
+ + ++ Runs javascript code +
++ Returns the return value of the javascript code +
++ NOTE: ONLY WORKS IN WEB PORT +
++ + + \ No newline at end of file diff --git a/doc/files/evaljs.txt b/doc/files/evaljs.txt new file mode 100644 index 0000000..8136032 --- /dev/null +++ b/doc/files/evaljs.txt @@ -0,0 +1,8 @@ +#title EvalJS$ [RCBasic Doc] +#header Function EvalJS$(js_code$) 'Only useable in Emscripten + +Runs javascript code + +Returns the return value of the javascript code + +NOTE: ONLY WORKS IN WEB PORT diff --git a/doc/files/exp.html b/doc/files/exp.html new file mode 100644 index 0000000..2939f85 --- /dev/null +++ b/doc/files/exp.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the exponential function of a number. +
++ + + \ No newline at end of file diff --git a/doc/files/exp.txt b/doc/files/exp.txt new file mode 100644 index 0000000..054b1db --- /dev/null +++ b/doc/files/exp.txt @@ -0,0 +1,4 @@ +#title Exp [RCBasic Doc] +#header function Exp(n) + +Returns the exponential function of a number. diff --git a/doc/files/fademusicin.html b/doc/files/fademusicin.html new file mode 100644 index 0000000..75dd72d --- /dev/null +++ b/doc/files/fademusicin.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fades music in +
++ + + \ No newline at end of file diff --git a/doc/files/fademusicin.txt b/doc/files/fademusicin.txt new file mode 100644 index 0000000..fd48cc6 --- /dev/null +++ b/doc/files/fademusicin.txt @@ -0,0 +1,4 @@ +#title FadeMusicIn [RCBasic Doc] +#header sub FadeMusicIn(fade_time, loops) + +Fades music in diff --git a/doc/files/fademusicout.html b/doc/files/fademusicout.html new file mode 100644 index 0000000..6caa49a --- /dev/null +++ b/doc/files/fademusicout.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fades music out +
++ + + \ No newline at end of file diff --git a/doc/files/fademusicout.txt b/doc/files/fademusicout.txt new file mode 100644 index 0000000..688c293 --- /dev/null +++ b/doc/files/fademusicout.txt @@ -0,0 +1,4 @@ +#title FadeMusicOut [RCBasic Doc] +#header sub FadeMusicOut(fade_time) + +Fades music out diff --git a/doc/files/fileexists.html b/doc/files/fileexists.html new file mode 100644 index 0000000..2e68cd1 --- /dev/null +++ b/doc/files/fileexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if a file exists +
++ + + \ No newline at end of file diff --git a/doc/files/fileexists.txt b/doc/files/fileexists.txt new file mode 100644 index 0000000..0dee4f5 --- /dev/null +++ b/doc/files/fileexists.txt @@ -0,0 +1,4 @@ +#title FileExists [RCBasic Doc] +#header function FileExists(fileName$) + +Returns true if a file exists diff --git a/doc/files/filelength.html b/doc/files/filelength.html new file mode 100644 index 0000000..ac5bff7 --- /dev/null +++ b/doc/files/filelength.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the size of a file in bytes. +
++ + + \ No newline at end of file diff --git a/doc/files/filelength.txt b/doc/files/filelength.txt new file mode 100644 index 0000000..4a1fd6d --- /dev/null +++ b/doc/files/filelength.txt @@ -0,0 +1,4 @@ +#title FileLength [RCBasic Doc] +#header function FileLength(fileName$) + + Returns the size of a file in bytes. diff --git a/doc/files/fillmatrix.html b/doc/files/fillmatrix.html new file mode 100644 index 0000000..7cc1386 --- /dev/null +++ b/doc/files/fillmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fills matrix with the given value +
++ + + \ No newline at end of file diff --git a/doc/files/fillmatrix.txt b/doc/files/fillmatrix.txt new file mode 100644 index 0000000..d86419b --- /dev/null +++ b/doc/files/fillmatrix.txt @@ -0,0 +1,4 @@ +#title FillMatrix [RCBasic Doc] +#header sub FillMatrix(mA, v) + +Fills matrix with the given value diff --git a/doc/files/fillmatrixcolumns.html b/doc/files/fillmatrixcolumns.html new file mode 100644 index 0000000..2bc96d0 --- /dev/null +++ b/doc/files/fillmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fills matrix columns with the given value starting at the given column +
++ + + \ No newline at end of file diff --git a/doc/files/fillmatrixcolumns.txt b/doc/files/fillmatrixcolumns.txt new file mode 100644 index 0000000..45f8649 --- /dev/null +++ b/doc/files/fillmatrixcolumns.txt @@ -0,0 +1,4 @@ +#title FillMatrixColumns [RCBasic Doc] +#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.html b/doc/files/fillmatrixrows.html new file mode 100644 index 0000000..861894f --- /dev/null +++ b/doc/files/fillmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fills matrix rows with the given value starting at the given row +
++ + + \ No newline at end of file diff --git a/doc/files/fillmatrixrows.txt b/doc/files/fillmatrixrows.txt new file mode 100644 index 0000000..4dfdc39 --- /dev/null +++ b/doc/files/fillmatrixrows.txt @@ -0,0 +1,4 @@ +#title FillMatrixRows [RCBasic Doc] +#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.html b/doc/files/filltile.html new file mode 100644 index 0000000..b42757e --- /dev/null +++ b/doc/files/filltile.html @@ -0,0 +1,17 @@ + + +
+ + ++ Fills an area of a tile map with a specified tile +
++ + + \ No newline at end of file diff --git a/doc/files/filltile.txt b/doc/files/filltile.txt new file mode 100644 index 0000000..2d33d7a --- /dev/null +++ b/doc/files/filltile.txt @@ -0,0 +1,6 @@ +#title FillTile [RCBasic Doc] +#header Sub FillTile(tilemap, tile, x, y, widthInTiles, heightInTiles) + +Fills an area of a tile map with a specified tile + + diff --git a/doc/files/flashwindow.html b/doc/files/flashwindow.html new file mode 100644 index 0000000..a1df02e --- /dev/null +++ b/doc/files/flashwindow.html @@ -0,0 +1,34 @@ + + +
+ + ++ Flashes a window to specify an alert +
++ Returns 0 on success and a negative number on failure +
++ Possible flag values: +
++ + + \ No newline at end of file diff --git a/doc/files/flashwindow.txt b/doc/files/flashwindow.txt new file mode 100644 index 0000000..9fd4805 --- /dev/null +++ b/doc/files/flashwindow.txt @@ -0,0 +1,13 @@ +#title FlashWindow [RCBasic Doc] +#header function FlashWindow( flag ) + +Flashes a window to specify an alert + +Returns 0 on success and a negative number on failure + +Possible flag values: +#list ul +#li FLASH_CANCEL +#li FLASH_BRIEFLY +#li FLASH_UNTIL_FOCUSED +#/list diff --git a/doc/files/floodfill.html b/doc/files/floodfill.html new file mode 100644 index 0000000..afd743c --- /dev/null +++ b/doc/files/floodfill.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/floodfill.txt b/doc/files/floodfill.txt new file mode 100644 index 0000000..4b6ad3a --- /dev/null +++ b/doc/files/floodfill.txt @@ -0,0 +1,6 @@ +#title FloodFill [RCBasic Doc] +#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.html b/doc/files/fontexists.html new file mode 100644 index 0000000..fa30d61 --- /dev/null +++ b/doc/files/fontexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns True if the specified font id is associated with a loaded font +
++ + + \ No newline at end of file diff --git a/doc/files/fontexists.txt b/doc/files/fontexists.txt new file mode 100644 index 0000000..9e2c720 --- /dev/null +++ b/doc/files/fontexists.txt @@ -0,0 +1,4 @@ +#title FontExists [RCBasic Doc] +#header Function FontExists(fnt_id) + +Returns True if the specified font id is associated with a loaded font diff --git a/doc/files/fprint.html b/doc/files/fprint.html new file mode 100644 index 0000000..ef37dea --- /dev/null +++ b/doc/files/fprint.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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.) +
++ + + \ No newline at end of file diff --git a/doc/files/fprint.txt b/doc/files/fprint.txt new file mode 100644 index 0000000..e2cc2f5 --- /dev/null +++ b/doc/files/fprint.txt @@ -0,0 +1,6 @@ +#title Fprint [RCBasic Doc] +#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.html b/doc/files/fps.html new file mode 100644 index 0000000..4636022 --- /dev/null +++ b/doc/files/fps.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of frames being rendered per second +
++ + + \ No newline at end of file diff --git a/doc/files/fps.txt b/doc/files/fps.txt new file mode 100644 index 0000000..6e53436 --- /dev/null +++ b/doc/files/fps.txt @@ -0,0 +1,4 @@ +#title FPS [RCBasic Doc] +#header function FPS() + +Returns the number of frames being rendered per second diff --git a/doc/files/frac.html b/doc/files/frac.html new file mode 100644 index 0000000..31297cd --- /dev/null +++ b/doc/files/frac.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the decimal portion of a number. +
++ + + \ No newline at end of file diff --git a/doc/files/frac.txt b/doc/files/frac.txt new file mode 100644 index 0000000..369f3b2 --- /dev/null +++ b/doc/files/frac.txt @@ -0,0 +1,4 @@ +#title Frac [RCBasic Doc] +#header function Frac(n) + +Returns the decimal portion of a number. diff --git a/doc/files/func_sub.html b/doc/files/func_sub.html new file mode 100644 index 0000000..8037d17 --- /dev/null +++ b/doc/files/func_sub.html @@ -0,0 +1,161 @@ + + +
+ + ++ Functions and Sub Routines are blocks of code that can be executed any where in your program. +
++ The biggest difference between Functions and Sub Routines is that Functions can return a value. Basically Functions and be used as a string or number value in an expression. RCBASIC has several built-in functions to perform different task such as compute square roots, get the time, etc. Functions are either numbers or strings just like variables and arrays. As such, functions can be used anywhere a variable or array can be used. Look at the following: +
+
+ Dim x[2]
+ x[0] = Sqrt(25)
+ x[1] = Sqrt(36)
+ Print "THE SQUARE ROOT OF 25 IS "; x[0]
+ Print "THE SQUARE ROOT OF 36 IS "; x[1]
+
+ The above code creates a number array called X with 2 elements in it. It stores the square root of 25 in the first index and stores the square root of 36 in the second index. It then outputs both values to the console. The output should look like this: +
++ THE SQUARE ROOT OF 25 IS 5 THE SQUARE ROOT OF 36 IS 6 +
++ String functions can be used in a string expression just like number functions can be used in a number expression. Look at the following code: +
+
+ B$ = Mid$("HELLO WORLD", 0, 2)
+ Print "THE FIRST TWO CHARACTERS IN HELLO WORLD ARE ";B$
+
+ The above code creates a string variable called B and stores 2 characters starting from position 0 in the string HELLO WORLD. It then outputs the value to the console. The output should look like the following: +
++ THE FIRST TWO CHARACTERS IN HELLO WORLD ARE HE +
++ Sub Routines can execute code in other parts of your program just like a function. However Sub Routines cannot return values and cannot be used in expressions. So why would you want to use a Sub Routine over a function? Well Sub Routines have less over head since it does not have to internally push a value onto the stack like a function does. So in cases where you do not need to return a value you should use a Sub Routine. RC BASIC has several built-in Sub Routines to perform task where a return value is not necessary. Look at the following: +
+
+ FPrint("test")
+
+ FPrint is a Sub Routine that outputs text to the console. Since FPrint doesn't perform calculations of any kind it did not need to be implemented as a Function. +
++ In addition to the built-in Functions and Sub Routines RCBASIC also allows programmers to build there own Functions and Sub Routines. You do this using the FUNCTION or SUB keywords. +
+
+ Function MyFunc(a, b)
+ c = a + b
+ Return c
+ End Function
+
+ The above code creates a function called MyFunc which takes in two arguments: a and b. To use this function you would call it like this: +
+
+ MyFunc(3, 4)
+
+ The code above will pass 3 and 4 to the variables A and B in MYFUNC respectively. The function creates a variable called C and sets it equal to the sum of 3 + 4. It then returns C. So the function equals 7. Since this is a number function you could store the value in a number variable or use PRINT to output the value to the console. +
++ To make a string function you simply add $ to the end of the function name when you create it just like with variables and arrays. +
+
+ Function MyString$ ( G$ )
+ Return "YOU ENTERED " + G$
+ End Function
+
+ Print MyString("SOMETHING")
+
+ The above code should output the following: +
++ YOU ENTERED SOMETHING +
++ Functions can also return a UDT(User Defined Type) as well. Look at the following: +
+
+ Type test_type
+ Dim a$
+ Dim b
+ End Type
+
+ Function test(a$, b) As test_type
+ Dim ret_val As test_type
+ ret_val.a = a
+ ret_val.b = b
+ Return ret_val
+ End Function
+
+ Dim myVar as test_type
+
+ myVar = test("hello", 42)
+
+ You can also have a UDT as a parameter in a function: +
+
+ Function test2(n as test_type, j)
+ Return 0
+ End Function
+
+ Sub Routines are created using the SUB keyword. Look at the following: +
+
+ Sub MySub ( )
+ For i = 1 To 5
+ Print i
+ Next
+ End Sub
+
+ MySub ( )
+
+ The code above creates a Sub Routine called MYSUB which uses a FOR loop to output the numbers 1 to 5 to the console. +
++ Functions and Sub Routines pass variables by value by default. Look at the following: +
+
+ Sub MySub ( a )
+ a = 5
+ End Sub
+
+ n = 0
+
+ MySub ( n )
+ Print n
+
+ In the above code the Sub Routine has a variable called A as an argument. It sets A equal to 5. Then we create a variable called N outside of the Sub Routine and set N equal to 0. N is passed as an argument to MYSUB. Then N is output to the console. This will output 0 to the console. That is because only the value of N is passed to MYSUB so MYSUB is not able to change N itself. In order to allow MYSUB to change N we must have MYSUB accept an argument by Reference. To do this we will use the BYREF keyword. +
+
+ Sub MySub ( ByRef a )
+ a = 5
+ End Sub
+
+ n = 0
+
+ MySub ( n )
+ Print n
+
+ 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/files/func_sub.txt b/doc/files/func_sub.txt new file mode 100644 index 0000000..7437549 --- /dev/null +++ b/doc/files/func_sub.txt @@ -0,0 +1,136 @@ +#title RCBasic Functions and Sub Routines [RCBasic Doc] +#header FUNCTIONS AND SUB ROUTINES + +Functions and Sub Routines are blocks of code that can be executed any where in your program. + +The biggest difference between Functions and Sub Routines is that Functions can return a value. Basically Functions and be used as a string or number value in an expression. RCBASIC has several built-in functions to perform different task such as compute square roots, get the time, etc. Functions are either numbers or strings just like variables and arrays. As such, functions can be used anywhere a variable or array can be used. Look at the following: + +#code +Dim x[2] +x[0] = Sqrt(25) +x[1] = Sqrt(36) +Print "THE SQUARE ROOT OF 25 IS "; x[0] +Print "THE SQUARE ROOT OF 36 IS "; x[1] +#/code + +The above code creates a number array called X with 2 elements in it. It stores the square root of 25 in the first index and stores the square root of 36 in the second index. It then outputs both values to the console. The output should look like this: + +THE SQUARE ROOT OF 25 IS 5 +THE SQUARE ROOT OF 36 IS 6 + +String functions can be used in a string expression just like number functions can be used in a number expression. Look at the following code: + +#code +B$ = Mid$("HELLO WORLD", 0, 2) +Print "THE FIRST TWO CHARACTERS IN HELLO WORLD ARE ";B$ +#/code + +The above code creates a string variable called B and stores 2 characters starting from position 0 in the string HELLO WORLD. It then outputs the value to the console. The output should look like the following: + +THE FIRST TWO CHARACTERS IN HELLO WORLD ARE HE + +Sub Routines can execute code in other parts of your program just like a function. However Sub Routines cannot return values and cannot be used in expressions. So why would you want to use a Sub Routine over a function? Well Sub Routines have less over head since it does not have to internally push a value onto the stack like a function does. So in cases where you do not need to return a value you should use a Sub Routine. RC BASIC has several built-in Sub Routines to perform task where a return value is not necessary. Look at the following: + +#code +FPrint("test") +#/code + +FPrint is a Sub Routine that outputs text to the console. Since FPrint doesn't perform calculations of any kind it did not need to be implemented as a Function. + +In addition to the built-in Functions and Sub Routines RCBASIC also allows programmers to build there own Functions and Sub Routines. You do this using the FUNCTION or SUB keywords. + +#code +Function MyFunc(a, b) + c = a + b + Return c +End Function +#/code + +The above code creates a function called MyFunc which takes in two arguments: a and b. To use this function you would call it like this: + +#code +MyFunc(3, 4) +#/code + +The code above will pass 3 and 4 to the variables A and B in MYFUNC respectively. The function creates a variable called C and sets it equal to the sum of 3 + 4. It then returns C. So the function equals 7. Since this is a number function you could store the value in a number variable or use PRINT to output the value to the console. + + +To make a string function you simply add $ to the end of the function name when you create it just like with variables and arrays. + +#code +Function MyString$ ( G$ ) + Return "YOU ENTERED " + G$ +End Function + +Print MyString("SOMETHING") +#/code + +The above code should output the following: + +YOU ENTERED SOMETHING + +Functions can also return a UDT(User Defined Type) as well. Look at the following: + +#code +Type test_type + Dim a$ + Dim b +End Type + +Function test(a$, b) As test_type + Dim ret_val As test_type + ret_val.a = a + ret_val.b = b + Return ret_val +End Function + +Dim myVar as test_type + +myVar = test("hello", 42) +#/code + +You can also have a UDT as a parameter in a function: +#code +Function test2(n as test_type, j) + Return 0 +End Function +#/code + +Sub Routines are created using the SUB keyword. Look at the following: +#code +Sub MySub ( ) + For i = 1 To 5 + Print i + Next +End Sub + +MySub ( ) +#/code + +The code above creates a Sub Routine called MYSUB which uses a FOR loop to output the numbers 1 to 5 to the console. + +Functions and Sub Routines pass variables by value by default. Look at the following: +#code +Sub MySub ( a ) + a = 5 +End Sub + +n = 0 + +MySub ( n ) +Print n +#/code + +In the above code the Sub Routine has a variable called A as an argument. It sets A equal to 5. Then we create a variable called N outside of the Sub Routine and set N equal to 0. N is passed as an argument to MYSUB. Then N is output to the console. This will output 0 to the console. That is because only the value of N is passed to MYSUB so MYSUB is not able to change N itself. In order to allow MYSUB to change N we must have MYSUB accept an argument by Reference. To do this we will use the BYREF keyword. +#code +Sub MySub ( ByRef a ) + a = 5 +End Sub + +n = 0 + +MySub ( n ) +Print n +#/code + +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. diff --git a/doc/files/getaccel.html b/doc/files/getaccel.html new file mode 100644 index 0000000..8dc1245 --- /dev/null +++ b/doc/files/getaccel.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the axis values for an accelerometer. +
++ + + \ No newline at end of file diff --git a/doc/files/getaccel.txt b/doc/files/getaccel.txt new file mode 100644 index 0000000..8da28ae --- /dev/null +++ b/doc/files/getaccel.txt @@ -0,0 +1,4 @@ +#title GetAccel [RCBasic Doc] +#header sub GetAccel(accel_num, ByRef x, ByRef y, ByRef z) + +Gets the axis values for an accelerometer. diff --git a/doc/files/getactoraabb.html b/doc/files/getactoraabb.html new file mode 100644 index 0000000..731d36b --- /dev/null +++ b/doc/files/getactoraabb.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the bounding box for an actor. +
++ + + \ No newline at end of file diff --git a/doc/files/getactoraabb.txt b/doc/files/getactoraabb.txt new file mode 100644 index 0000000..dda85b1 --- /dev/null +++ b/doc/files/getactoraabb.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getactorangulardamping.html new file mode 100644 index 0000000..b3c9a36 --- /dev/null +++ b/doc/files/getactorangulardamping.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the amount of angular damping set on the actor +
+Related: + SetActorDamping + ApplyActorDamping + GetActorLinearDamping +
++ + + \ No newline at end of file diff --git a/doc/files/getactorangulardamping.txt b/doc/files/getactorangulardamping.txt new file mode 100644 index 0000000..dfbe10a --- /dev/null +++ b/doc/files/getactorangulardamping.txt @@ -0,0 +1,6 @@ +#title GetActorAngularDamping [RCBasic Doc] +#header function GetActorAngularDamping( actor) + +Returns the amount of angular damping set on the actor + +#ref SetActorDamping ApplyActorDamping GetActorLinearDamping diff --git a/doc/files/getactorangularfactor.html b/doc/files/getactorangularfactor.html new file mode 100644 index 0000000..d8d307e --- /dev/null +++ b/doc/files/getactorangularfactor.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the angular factor set on an actor +
+Related: + SetActorAngularFactor + GetActorLinearFactor + SetActorLinearFactor +
++ + + \ No newline at end of file diff --git a/doc/files/getactorangularfactor.txt b/doc/files/getactorangularfactor.txt new file mode 100644 index 0000000..9edd76b --- /dev/null +++ b/doc/files/getactorangularfactor.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getactorangularsleepthreshold.html new file mode 100644 index 0000000..79b82a2 --- /dev/null +++ b/doc/files/getactorangularsleepthreshold.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the Angular deactivation threshold for the actor +
+Related: + SetActorSleepThresholds + GetActorLinearSleepThreshold +
++ + + \ No newline at end of file diff --git a/doc/files/getactorangularsleepthreshold.txt b/doc/files/getactorangularsleepthreshold.txt new file mode 100644 index 0000000..3eded28 --- /dev/null +++ b/doc/files/getactorangularsleepthreshold.txt @@ -0,0 +1,6 @@ +#title GetActorAngularSleepThreshold [RCBasic Doc] +#header function GetActorAngularSleepThreshold( actor) + +Returns the Angular deactivation threshold for the actor + +#ref SetActorSleepThresholds GetActorLinearSleepThreshold diff --git a/doc/files/getactorangularvelocitylocal.html b/doc/files/getactorangularvelocitylocal.html new file mode 100644 index 0000000..4983a8e --- /dev/null +++ b/doc/files/getactorangularvelocitylocal.html @@ -0,0 +1,22 @@ + + +
+ + ++ Gets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityWorld + SetActorAngularVelocityLocal + SetActorAngularVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/files/getactorangularvelocitylocal.txt b/doc/files/getactorangularvelocitylocal.txt new file mode 100644 index 0000000..105a9d3 --- /dev/null +++ b/doc/files/getactorangularvelocitylocal.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getactorangularvelocityworld.html new file mode 100644 index 0000000..897f6fd --- /dev/null +++ b/doc/files/getactorangularvelocityworld.html @@ -0,0 +1,22 @@ + + +
+ + ++ Gets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityLocal + SetActorAngularVelocityLocal + SetActorAngularVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/files/getactorangularvelocityworld.txt b/doc/files/getactorangularvelocityworld.txt new file mode 100644 index 0000000..6737f6f --- /dev/null +++ b/doc/files/getactorangularvelocityworld.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getactoranimationendframe.html new file mode 100644 index 0000000..8f983c1 --- /dev/null +++ b/doc/files/getactoranimationendframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the last frame in an actor's animation +
+Related: + SetActorAnimationFrames +
++ + + \ No newline at end of file diff --git a/doc/files/getactoranimationendframe.txt b/doc/files/getactoranimationendframe.txt new file mode 100644 index 0000000..3e171f4 --- /dev/null +++ b/doc/files/getactoranimationendframe.txt @@ -0,0 +1,6 @@ +#title GetActorAnimationEndFrame [RCBasic Doc] +#header Function GetActorAnimationEndFrame(actor, animation) + +Returns the last frame in an actor's animation + +#ref SetActorAnimationFrames diff --git a/doc/files/getactoranimationspeed.html b/doc/files/getactoranimationspeed.html new file mode 100644 index 0000000..2356721 --- /dev/null +++ b/doc/files/getactoranimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns actor's animation speed in frames per second +
+Related: + SetActorAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/files/getactoranimationspeed.txt b/doc/files/getactoranimationspeed.txt new file mode 100644 index 0000000..e16a7fb --- /dev/null +++ b/doc/files/getactoranimationspeed.txt @@ -0,0 +1,6 @@ +#title GetActorAnimationSpeed [RCBasic Doc] +#header function GetActorAnimationSpeed( actor, animation ) + +Returns actor's animation speed in frames per second + +#ref SetActorAnimationSpeed diff --git a/doc/files/getactoranimationstartframe.html b/doc/files/getactoranimationstartframe.html new file mode 100644 index 0000000..cdde7d3 --- /dev/null +++ b/doc/files/getactoranimationstartframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the first frame in an actor's animation +
+Related: + SetActorAnimationFrames +
++ + + \ No newline at end of file diff --git a/doc/files/getactoranimationstartframe.txt b/doc/files/getactoranimationstartframe.txt new file mode 100644 index 0000000..0b92f17 --- /dev/null +++ b/doc/files/getactoranimationstartframe.txt @@ -0,0 +1,6 @@ +#title GetActorAnimationStartFrame [RCBasic Doc] +#header Function GetActorAnimationStartFrame(actor, animation) + +Returns the first frame in an actor's animation + +#ref SetActorAnimationFrames diff --git a/doc/files/getactorautoculling.html b/doc/files/getactorautoculling.html new file mode 100644 index 0000000..98d2667 --- /dev/null +++ b/doc/files/getactorautoculling.html @@ -0,0 +1,40 @@ + + +
+ + ++ Returns the automatic culling state for an actor +
++ Possible Culling States +
+Related: + SetActorAutoCulling +
++ + + \ No newline at end of file diff --git a/doc/files/getactorautoculling.txt b/doc/files/getactorautoculling.txt new file mode 100644 index 0000000..38bcf49 --- /dev/null +++ b/doc/files/getactorautoculling.txt @@ -0,0 +1,16 @@ +#title GetActorAutoCulling [RCBasic Doc] +#header function GetActorAutoCulling( actor ) + +Returns the automatic culling state for an actor + +Possible Culling States +#list +#li AUTOCULLING_OFF +#li AUTOCULLING_BOX +#li AUTOCULLING_FRUSTUM_BOX +#li AUTOCULLING_FRUSTUM_SPHERE +#li AUTOCULLING_OCC_QUERY +#/list + +#ref SetActorAutoCulling + diff --git a/doc/files/getactorcenter.html b/doc/files/getactorcenter.html new file mode 100644 index 0000000..b30ca6b --- /dev/null +++ b/doc/files/getactorcenter.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getactorcenter.txt b/doc/files/getactorcenter.txt new file mode 100644 index 0000000..d5812bd --- /dev/null +++ b/doc/files/getactorcenter.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getactorcollision.html new file mode 100644 index 0000000..39726d8 --- /dev/null +++ b/doc/files/getactorcollision.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if 2 actors collide +
++ Note: This function will work with solid and non solid actors +
++ + + \ No newline at end of file diff --git a/doc/files/getactorcollision.txt b/doc/files/getactorcollision.txt new file mode 100644 index 0000000..4bf4654 --- /dev/null +++ b/doc/files/getactorcollision.txt @@ -0,0 +1,6 @@ +#title GetActorCollision [RCBasic Doc] +#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.html b/doc/files/getactorcollisionshape.html new file mode 100644 index 0000000..e920a80 --- /dev/null +++ b/doc/files/getactorcollisionshape.html @@ -0,0 +1,49 @@ + + +
+ + ++ Returns the actor's collision shape +
++ Possible values: +
+Related: + SetActorCollisionShape +
++ + + \ No newline at end of file diff --git a/doc/files/getactorcollisionshape.txt b/doc/files/getactorcollisionshape.txt new file mode 100644 index 0000000..7df0631 --- /dev/null +++ b/doc/files/getactorcollisionshape.txt @@ -0,0 +1,18 @@ +#title GetActorCollisionShape [RCBasic Doc] +#header function GetActorCollisionShape(actor) + +Returns the actor's collision shape + +Possible values: +#list ul +#li SHAPE_TYPE_NONE +#li SHAPE_TYPE_BOX +#li SHAPE_TYPE_SPHERE +#li SHAPE_TYPE_CYLINDER +#li SHAPE_TYPE_CAPSULE +#li SHAPE_TYPE_CONE +#li SHAPE_TYPE_CONVEXHULL +#li SHAPE_TYPE_TRIMESH +#/list + +#ref SetActorCollisionShape diff --git a/doc/files/getactorcurrentanimation.html b/doc/files/getactorcurrentanimation.html new file mode 100644 index 0000000..e1b09e7 --- /dev/null +++ b/doc/files/getactorcurrentanimation.html @@ -0,0 +1,24 @@ + + +
+ + ++ Returns the current animation set on an actor +
++ Note: Current animation will be 0 if the actor's frame was set with SetActorFrame() +
+Related: + SetActorAnimation + SetActorFrame +
++ + + \ No newline at end of file diff --git a/doc/files/getactorcurrentanimation.txt b/doc/files/getactorcurrentanimation.txt new file mode 100644 index 0000000..429c768 --- /dev/null +++ b/doc/files/getactorcurrentanimation.txt @@ -0,0 +1,8 @@ +#title GetActorCurrentAnimation [RCBasic Doc] +#header Function GetActorCurrentAnimation(actor) + +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.html b/doc/files/getactorcurrentframe.html new file mode 100644 index 0000000..b9e3af6 --- /dev/null +++ b/doc/files/getactorcurrentframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns an actor's current frame of animation +
++ + + \ No newline at end of file diff --git a/doc/files/getactorcurrentframe.txt b/doc/files/getactorcurrentframe.txt new file mode 100644 index 0000000..91247b5 --- /dev/null +++ b/doc/files/getactorcurrentframe.txt @@ -0,0 +1,4 @@ +#title GetActorCurrentFrame [RCBasic Doc] +#header function GetActorCurrentFrame( actor ) + +Returns an actor's current frame of animation diff --git a/doc/files/getactorendframe.html b/doc/files/getactorendframe.html new file mode 100644 index 0000000..2922a77 --- /dev/null +++ b/doc/files/getactorendframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the last frame of an actor's animation +
++ + + \ No newline at end of file diff --git a/doc/files/getactorendframe.txt b/doc/files/getactorendframe.txt new file mode 100644 index 0000000..d4bd288 --- /dev/null +++ b/doc/files/getactorendframe.txt @@ -0,0 +1,4 @@ +#title GetActorEndFrame [RCBasic Doc] +#header function GetActorEndFrame( actor ) + +Returns the last frame of an actor's animation diff --git a/doc/files/getactorframe.html b/doc/files/getactorframe.html new file mode 100644 index 0000000..6ac58ee --- /dev/null +++ b/doc/files/getactorframe.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the current frame number an actor is currently rendering +
+Related: + SetActorFrame + GetActorAnimationFrame +
++ + + \ No newline at end of file diff --git a/doc/files/getactorframe.txt b/doc/files/getactorframe.txt new file mode 100644 index 0000000..d9281ad --- /dev/null +++ b/doc/files/getactorframe.txt @@ -0,0 +1,7 @@ +#title GetActorFrame [RCBasic Doc] +#header function GetActorFrame(actor) + +Returns the current frame number an actor is currently rendering + + +#ref SetActorFrame GetActorAnimationFrame diff --git a/doc/files/getactorgravity.html b/doc/files/getactorgravity.html new file mode 100644 index 0000000..b437ee9 --- /dev/null +++ b/doc/files/getactorgravity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the gravity of an actor along each access. +
+Related: + SetActorGravity +
++ + + \ No newline at end of file diff --git a/doc/files/getactorgravity.txt b/doc/files/getactorgravity.txt new file mode 100644 index 0000000..56b0dd8 --- /dev/null +++ b/doc/files/getactorgravity.txt @@ -0,0 +1,6 @@ +#title GetActorGravity [RCBasic Doc] +#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.html b/doc/files/getactorinverseinertiadiaglocal.html new file mode 100644 index 0000000..b3c1c4d --- /dev/null +++ b/doc/files/getactorinverseinertiadiaglocal.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getactorinverseinertiadiaglocal.txt b/doc/files/getactorinverseinertiadiaglocal.txt new file mode 100644 index 0000000..073f848 --- /dev/null +++ b/doc/files/getactorinverseinertiadiaglocal.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getactorinversemass.html new file mode 100644 index 0000000..71e2b9d --- /dev/null +++ b/doc/files/getactorinversemass.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an actor's inverse mass +
+Related: + SetActorMassProperties +
++ + + \ No newline at end of file diff --git a/doc/files/getactorinversemass.txt b/doc/files/getactorinversemass.txt new file mode 100644 index 0000000..1e546ac --- /dev/null +++ b/doc/files/getactorinversemass.txt @@ -0,0 +1,6 @@ +#title getActorInverseMass [RCBasic Doc] +#header function getActorInverseMass( actor) + +Returns an actor's inverse mass + +#ref SetActorMassProperties diff --git a/doc/files/getactorlineardamping.html b/doc/files/getactorlineardamping.html new file mode 100644 index 0000000..bb9851a --- /dev/null +++ b/doc/files/getactorlineardamping.html @@ -0,0 +1,21 @@ + + +
+ + ++ Return's an actor's linear damping +
+Related: + SetActorDamping + GetActorAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/files/getactorlineardamping.txt b/doc/files/getactorlineardamping.txt new file mode 100644 index 0000000..29d4708 --- /dev/null +++ b/doc/files/getactorlineardamping.txt @@ -0,0 +1,6 @@ +#title GetActorLinearDamping [RCBasic Doc] +#header function GetActorLinearDamping( actor) + +Return's an actor's linear damping + +#ref SetActorDamping GetActorAngularDamping diff --git a/doc/files/getactorlinearfactor.html b/doc/files/getactorlinearfactor.html new file mode 100644 index 0000000..7f5f7bd --- /dev/null +++ b/doc/files/getactorlinearfactor.html @@ -0,0 +1,22 @@ + + +
+ + ++ Gets an actor's linear factor +
+Related: + SetActorLinearFactor + GetActorAngularFactor + SetActorAngularFactor +
++ + + \ No newline at end of file diff --git a/doc/files/getactorlinearfactor.txt b/doc/files/getactorlinearfactor.txt new file mode 100644 index 0000000..3967933 --- /dev/null +++ b/doc/files/getactorlinearfactor.txt @@ -0,0 +1,6 @@ +#title GetActorLinearFactor [RCBasic Doc] +#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.html b/doc/files/getactorlinearsleepthreshold.html new file mode 100644 index 0000000..9676069 --- /dev/null +++ b/doc/files/getactorlinearsleepthreshold.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the linear deactivation threshold for the actor +
+Related: + SetActorSleepThresholds + GetActorAngularSleepThreshold +
++ + + \ No newline at end of file diff --git a/doc/files/getactorlinearsleepthreshold.txt b/doc/files/getactorlinearsleepthreshold.txt new file mode 100644 index 0000000..fb22817 --- /dev/null +++ b/doc/files/getactorlinearsleepthreshold.txt @@ -0,0 +1,6 @@ +#title GetActorLinearSleepThreshold [RCBasic Doc] +#header function GetActorLinearSleepThreshold( actor) + +Returns the linear deactivation threshold for the actor + +#ref SetActorSleepThresholds GetActorAngularSleepThreshold diff --git a/doc/files/getactorlinearvelocitylocal.html b/doc/files/getactorlinearvelocitylocal.html new file mode 100644 index 0000000..70e34d1 --- /dev/null +++ b/doc/files/getactorlinearvelocitylocal.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets actor's linear velocity +
+Related: + SetActorLinearVelocityLocal + SetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/files/getactorlinearvelocitylocal.txt b/doc/files/getactorlinearvelocitylocal.txt new file mode 100644 index 0000000..a7539bd --- /dev/null +++ b/doc/files/getactorlinearvelocitylocal.txt @@ -0,0 +1,6 @@ +#title GetActorLinearVelocityLocal [RCBasic Doc] +#header sub GetActorLinearVelocityLocal( actor, ByRef x, ByRef y, ByRef z) + +Gets actor's linear velocity + +#ref SetActorLinearVelocityLocal SetActorLinearVelocityWorld diff --git a/doc/files/getactorlinearvelocityworld.html b/doc/files/getactorlinearvelocityworld.html new file mode 100644 index 0000000..12fef83 --- /dev/null +++ b/doc/files/getactorlinearvelocityworld.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets actor's linear velocity +
+Related: + SetActorLinearVelocityLocal + SetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/files/getactorlinearvelocityworld.txt b/doc/files/getactorlinearvelocityworld.txt new file mode 100644 index 0000000..52ee7d8 --- /dev/null +++ b/doc/files/getactorlinearvelocityworld.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/getactorlocalinertia.html new file mode 100644 index 0000000..a55428b --- /dev/null +++ b/doc/files/getactorlocalinertia.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getactorlocalinertia.txt b/doc/files/getactorlocalinertia.txt new file mode 100644 index 0000000..7bf348c --- /dev/null +++ b/doc/files/getactorlocalinertia.txt @@ -0,0 +1,5 @@ +#title GetActorLocalInertia [RCBasic Doc] +#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.html b/doc/files/getactorlocalpointvelocity.html new file mode 100644 index 0000000..ae085aa --- /dev/null +++ b/doc/files/getactorlocalpointvelocity.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getactorlocalpointvelocity.txt b/doc/files/getactorlocalpointvelocity.txt new file mode 100644 index 0000000..cc914e0 --- /dev/null +++ b/doc/files/getactorlocalpointvelocity.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getactormaterial.html new file mode 100644 index 0000000..f7d3f92 --- /dev/null +++ b/doc/files/getactormaterial.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an actor's material id. +
++ 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/files/getactormaterial.txt b/doc/files/getactormaterial.txt new file mode 100644 index 0000000..13d1356 --- /dev/null +++ b/doc/files/getactormaterial.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getactormaterialcount.html new file mode 100644 index 0000000..c01310d --- /dev/null +++ b/doc/files/getactormaterialcount.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of materials for an actor. +
++ + + \ No newline at end of file diff --git a/doc/files/getactormaterialcount.txt b/doc/files/getactormaterialcount.txt new file mode 100644 index 0000000..6e1f86e --- /dev/null +++ b/doc/files/getactormaterialcount.txt @@ -0,0 +1,4 @@ +#title getActorMaterialCount [RCBasic Doc] +#header function getActorMaterialCount( actor) + +Returns the number of materials for an actor. diff --git a/doc/files/getactormaterialflag.html b/doc/files/getactormaterialflag.html new file mode 100644 index 0000000..37298d0 --- /dev/null +++ b/doc/files/getactormaterialflag.html @@ -0,0 +1,85 @@ + + +
+ + ++ Returns the value of the specified material flag +
++ Possible values for flag: +
+Related: + GetMaterialFlag +
++ + + \ No newline at end of file diff --git a/doc/files/getactormaterialflag.txt b/doc/files/getactormaterialflag.txt new file mode 100644 index 0000000..303363d --- /dev/null +++ b/doc/files/getactormaterialflag.txt @@ -0,0 +1,30 @@ +#title getActorMaterialFlag [RCBasic Doc] +#header function getActorMaterialFlag( actor, material, flag) + +Returns the value of the specified material flag + +Possible values for flag: +#list +#li MATERIAL_FLAG_WIREFRAME +#li MATERIAL_FLAG_POINTCLOUD +#li MATERIAL_FLAG_GOURAUD_SHADING +#li MATERIAL_FLAG_LIGHTING +#li MATERIAL_FLAG_ZBUFFER +#li MATERIAL_FLAG_ZWRITE_ENABLE +#li MATERIAL_FLAG_BACK_FACE_CULLING +#li MATERIAL_FLAG_FRONT_FACE_CULLING +#li MATERIAL_FLAG_BILINEAR_FILTER +#li MATERIAL_FLAG_TRILINEAR_FILTER +#li MATERIAL_FLAG_ANISOTROPIC_FILTER +#li MATERIAL_FLAG_FOG_ENABLE +#li MATERIAL_FLAG_NORMALIZE_NORMALS +#li MATERIAL_FLAG_TEXTURE_WRAP +#li MATERIAL_FLAG_ANTI_ALIASING +#li MATERIAL_FLAG_COLOR_MASK +#li MATERIAL_FLAG_COLOR_MATERIAL +#li MATERIAL_FLAG_USE_MIP_MAPS +#li MATERIAL_FLAG_BLEND_OPERATION +#li MATERIAL_FLAG_POLYGON_OFFSET +#/list + +#ref GetMaterialFlag diff --git a/doc/files/getactormaterialtype.html b/doc/files/getactormaterialtype.html new file mode 100644 index 0000000..ae96d78 --- /dev/null +++ b/doc/files/getactormaterialtype.html @@ -0,0 +1,102 @@ + + +
+ + ++ Returns the material type of an actor material +
++ Possible material types +
+Related: + SetActorMaterialType + GetMaterialType + SetMaterialType +
++ + + \ No newline at end of file diff --git a/doc/files/getactormaterialtype.txt b/doc/files/getactormaterialtype.txt new file mode 100644 index 0000000..ac3b570 --- /dev/null +++ b/doc/files/getactormaterialtype.txt @@ -0,0 +1,35 @@ +#title GetActorMaterialType [RCBasic Doc] +#header function GetActorMaterialType( actor, material ) + +Returns the material type of an actor material + +Possible material types +#list ul +#li MATERIAL_TYPE_SOLID +#li MATERIAL_TYPE_SOLID_2_LAYER +#li MATERIAL_TYPE_LIGHTMAP +#li MATERIAL_TYPE_LIGHTMAP_ADD +#li MATERIAL_TYPE_LIGHTMAP_M2 +#li MATERIAL_TYPE_LIGHTMAP_M4 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M2 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M4 +#li MATERIAL_TYPE_DETAIL_MAP +#li MATERIAL_TYPE_SPHERE_MAP +#li MATERIAL_TYPE_REFLECTION_2_LAYER +#li MATERIAL_TYPE_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL_REF +#li MATERIAL_TYPE_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_TRANSPARENT_REFLECTION_2_LAYER +#li MATERIAL_TYPE_NORMAL_MAP_SOLID +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_PARALLAX_MAP_SOLID +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_ONETEXTURE_BLEND +#li MATERIAL_TYPE_FORCE_32BIT +#/list + +#ref SetActorMaterialType GetMaterialType SetMaterialType diff --git a/doc/files/getactorposition.html b/doc/files/getactorposition.html new file mode 100644 index 0000000..f4d8fa5 --- /dev/null +++ b/doc/files/getactorposition.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the actors position +
+Related: + SetActorPosition +
++ + + \ No newline at end of file diff --git a/doc/files/getactorposition.txt b/doc/files/getactorposition.txt new file mode 100644 index 0000000..5e8dc69 --- /dev/null +++ b/doc/files/getactorposition.txt @@ -0,0 +1,6 @@ +#title GetActorPosition [RCBasic Doc] +#header sub GetActorPosition( actor, ByRef x, ByRef y, ByRef z ) + +Gets the actors position + +#ref SetActorPosition diff --git a/doc/files/getactorrotation.html b/doc/files/getactorrotation.html new file mode 100644 index 0000000..84d704a --- /dev/null +++ b/doc/files/getactorrotation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the actors rotation on each axis +
+Related: + SetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/files/getactorrotation.txt b/doc/files/getactorrotation.txt new file mode 100644 index 0000000..b8c5909 --- /dev/null +++ b/doc/files/getactorrotation.txt @@ -0,0 +1,6 @@ +#title GetActorRotation [RCBasic Doc] +#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.html b/doc/files/getactorrotationq.html new file mode 100644 index 0000000..4775951 --- /dev/null +++ b/doc/files/getactorrotationq.html @@ -0,0 +1,24 @@ + + +
+ + ++ Gets the actors rotation as a quaternion. +
++ Note: This is useful for calculations that require quaternion but most developers should just use GetActorTransform() +
+Related: + GetActorRotation + SetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/files/getactorrotationq.txt b/doc/files/getactorrotationq.txt new file mode 100644 index 0000000..0197547 --- /dev/null +++ b/doc/files/getactorrotationq.txt @@ -0,0 +1,8 @@ +#title GetActorRotationQ [RCBasic Doc] +#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.html b/doc/files/getactorscale.html new file mode 100644 index 0000000..505640a --- /dev/null +++ b/doc/files/getactorscale.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets an actor's scale +
+Related: + SetActorScale +
++ + + \ No newline at end of file diff --git a/doc/files/getactorscale.txt b/doc/files/getactorscale.txt new file mode 100644 index 0000000..d3d1064 --- /dev/null +++ b/doc/files/getactorscale.txt @@ -0,0 +1,6 @@ +#title GetActorScale [RCBasic Doc] +#header sub GetActorScale( actor, ByRef x, ByRef y, ByRef z ) + +Gets an actor's scale + +#ref SetActorScale diff --git a/doc/files/getactorstartframe.html b/doc/files/getactorstartframe.html new file mode 100644 index 0000000..66c338d --- /dev/null +++ b/doc/files/getactorstartframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the start frame of an actor's animation +
++ + + \ No newline at end of file diff --git a/doc/files/getactorstartframe.txt b/doc/files/getactorstartframe.txt new file mode 100644 index 0000000..a48bd45 --- /dev/null +++ b/doc/files/getactorstartframe.txt @@ -0,0 +1,4 @@ +#title GetActorStartFrame [RCBasic Doc] +#header function GetActorStartFrame( actor ) + +Returns the start frame of an actor's animation diff --git a/doc/files/getactortotalforce.html b/doc/files/getactortotalforce.html new file mode 100644 index 0000000..a62fbe7 --- /dev/null +++ b/doc/files/getactortotalforce.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetActorTotalTorque +
++ + + \ No newline at end of file diff --git a/doc/files/getactortotalforce.txt b/doc/files/getactortotalforce.txt new file mode 100644 index 0000000..e891630 --- /dev/null +++ b/doc/files/getactortotalforce.txt @@ -0,0 +1,6 @@ +#title GetActorTotalForce [RCBasic Doc] +#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.html b/doc/files/getactortotaltorque.html new file mode 100644 index 0000000..fe938cd --- /dev/null +++ b/doc/files/getactortotaltorque.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetTotalForces +
++ + + \ No newline at end of file diff --git a/doc/files/getactortotaltorque.txt b/doc/files/getactortotaltorque.txt new file mode 100644 index 0000000..04516d8 --- /dev/null +++ b/doc/files/getactortotaltorque.txt @@ -0,0 +1,6 @@ +#title GetActorTotalTorque [RCBasic Doc] +#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.html b/doc/files/getactortransform.html new file mode 100644 index 0000000..dc777a7 --- /dev/null +++ b/doc/files/getactortransform.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores the actors absolute transformation in the given matrix +
++ + + \ No newline at end of file diff --git a/doc/files/getactortransform.txt b/doc/files/getactortransform.txt new file mode 100644 index 0000000..fb7ecac --- /dev/null +++ b/doc/files/getactortransform.txt @@ -0,0 +1,4 @@ +#title GetActorTransform [RCBasic Doc] +#header sub GetActorTransform( actor, matrix ) + +Stores the actors absolute transformation in the given matrix diff --git a/doc/files/getactortransitiontime.html b/doc/files/getactortransitiontime.html new file mode 100644 index 0000000..c01ae02 --- /dev/null +++ b/doc/files/getactortransitiontime.html @@ -0,0 +1,25 @@ + + +
+ + ++ Returns the total transition time of an actor transitioning between animations +
++ Note: Time returned is in seconds +
+Related: + StartActorTransition + StopActorTransition + ActorIsInTransition +
++ + + \ No newline at end of file diff --git a/doc/files/getactortransitiontime.txt b/doc/files/getactortransitiontime.txt new file mode 100644 index 0000000..7bb2714 --- /dev/null +++ b/doc/files/getactortransitiontime.txt @@ -0,0 +1,8 @@ +#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/getactorvelocityinlocalpoint.html b/doc/files/getactorvelocityinlocalpoint.html new file mode 100644 index 0000000..3b80b6d --- /dev/null +++ b/doc/files/getactorvelocityinlocalpoint.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getactorvelocityinlocalpoint.txt b/doc/files/getactorvelocityinlocalpoint.txt new file mode 100644 index 0000000..9df2656 --- /dev/null +++ b/doc/files/getactorvelocityinlocalpoint.txt @@ -0,0 +1,5 @@ +#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.html b/doc/files/getan8scenename.html new file mode 100644 index 0000000..db39c07 --- /dev/null +++ b/doc/files/getan8scenename.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the name of a scene in an an8 project +
++ + + \ No newline at end of file diff --git a/doc/files/getan8scenename.txt b/doc/files/getan8scenename.txt new file mode 100644 index 0000000..5fbe4e1 --- /dev/null +++ b/doc/files/getan8scenename.txt @@ -0,0 +1,4 @@ +#title GetAN8SceneName$ [RCBasic Doc] +#header Function GetAN8SceneName$(an8_project, scene_num) + +Returns the name of a scene in an an8 project diff --git a/doc/files/getbilinearfilter.html b/doc/files/getbilinearfilter.html new file mode 100644 index 0000000..0705660 --- /dev/null +++ b/doc/files/getbilinearfilter.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if bilinear filtering is enabled +
+Related: + SetBilinearFilter +
++ + + \ No newline at end of file diff --git a/doc/files/getbilinearfilter.txt b/doc/files/getbilinearfilter.txt new file mode 100644 index 0000000..1cfdac2 --- /dev/null +++ b/doc/files/getbilinearfilter.txt @@ -0,0 +1,6 @@ +#title GetBilinearFilter [RCBasic Doc] +#header function GetBilinearFilter() + +Returns true if bilinear filtering is enabled + +#ref SetBilinearFilter diff --git a/doc/files/getblendmode.html b/doc/files/getblendmode.html new file mode 100644 index 0000000..bf79e94 --- /dev/null +++ b/doc/files/getblendmode.html @@ -0,0 +1,58 @@ + + +
+ + ++ Returns the current blend mode +
++ Note: Only applies to 2D image drawing commands +
++ Possible Blend Modes +
+Related: + SetBlendMode +
++ + + \ No newline at end of file diff --git a/doc/files/getblendmode.txt b/doc/files/getblendmode.txt new file mode 100644 index 0000000..de35dd7 --- /dev/null +++ b/doc/files/getblendmode.txt @@ -0,0 +1,22 @@ +#title GetBlendMode [RCBasic Doc] +#header function GetBlendMode( ) + +Returns the current blend mode + +Note: Only applies to 2D image drawing commands + +Possible Blend Modes +#list ul +#li BLEND_MODE_NONE +#li BLEND_MODE_ADD +#li BLEND_MODE_SUBTRACT +#li BLEND_MODE_REVSUBTRACT +#li BLEND_MODE_MIN +#li BLEND_MODE_MAX +#li BLEND_MODE_MIN_FACTOR +#li BLEND_MODE_MAX_FACTOR +#li BLEND_MODE_MIN_ALPHA +#li BLEND_MODE_MAX_ALPHA +#/list + +#ref SetBlendMode diff --git a/doc/files/getcameraaspectratio.html b/doc/files/getcameraaspectratio.html new file mode 100644 index 0000000..a3a71a9 --- /dev/null +++ b/doc/files/getcameraaspectratio.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the camera aspect ratio for the active canvas +
+Related: + SetCameraAspectRatio +
++ + + \ No newline at end of file diff --git a/doc/files/getcameraaspectratio.txt b/doc/files/getcameraaspectratio.txt new file mode 100644 index 0000000..afd5638 --- /dev/null +++ b/doc/files/getcameraaspectratio.txt @@ -0,0 +1,6 @@ +#title GetCameraAspectRatio [RCBasic Doc] +#header function GetCameraAspectRatio( ) + +Returns the camera aspect ratio for the active canvas + +#ref SetCameraAspectRatio diff --git a/doc/files/getcamerafarvalue.html b/doc/files/getcamerafarvalue.html new file mode 100644 index 0000000..2b4b533 --- /dev/null +++ b/doc/files/getcamerafarvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the far plane of the camera on the active canvas +
+Related: + GetCameraNearValue +
++ + + \ No newline at end of file diff --git a/doc/files/getcamerafarvalue.txt b/doc/files/getcamerafarvalue.txt new file mode 100644 index 0000000..02ad686 --- /dev/null +++ b/doc/files/getcamerafarvalue.txt @@ -0,0 +1,6 @@ +#title GetCameraFarValue [RCBasic Doc] +#header function GetCameraFarValue( ) + +Returns the far plane of the camera on the active canvas + +#ref GetCameraNearValue diff --git a/doc/files/getcamerafov.html b/doc/files/getcamerafov.html new file mode 100644 index 0000000..8615370 --- /dev/null +++ b/doc/files/getcamerafov.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the field of view of the camera on the active canvas +
++ + + \ No newline at end of file diff --git a/doc/files/getcamerafov.txt b/doc/files/getcamerafov.txt new file mode 100644 index 0000000..847d494 --- /dev/null +++ b/doc/files/getcamerafov.txt @@ -0,0 +1,4 @@ +#title GetCameraFOV [RCBasic Doc] +#header function GetCameraFOV( ) + +Returns the field of view of the camera on the active canvas diff --git a/doc/files/getcameranearvalue.html b/doc/files/getcameranearvalue.html new file mode 100644 index 0000000..dbce0a2 --- /dev/null +++ b/doc/files/getcameranearvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the near plane of the camera on the active canvas +
+Related: + GetCameraFarValue +
++ + + \ No newline at end of file diff --git a/doc/files/getcameranearvalue.txt b/doc/files/getcameranearvalue.txt new file mode 100644 index 0000000..cbbeeda --- /dev/null +++ b/doc/files/getcameranearvalue.txt @@ -0,0 +1,6 @@ +#title GetCameraNearValue [RCBasic Doc] +#header function GetCameraNearValue( ) + +Returns the near plane of the camera on the active canvas + +#ref GetCameraFarValue diff --git a/doc/files/getcameraposition.html b/doc/files/getcameraposition.html new file mode 100644 index 0000000..a36f7d7 --- /dev/null +++ b/doc/files/getcameraposition.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the position of the camera +
+Related: + SetCameraPosition + TranslateCamera +
++ + + \ No newline at end of file diff --git a/doc/files/getcameraposition.txt b/doc/files/getcameraposition.txt new file mode 100644 index 0000000..bfbf333 --- /dev/null +++ b/doc/files/getcameraposition.txt @@ -0,0 +1,6 @@ +#title GetCameraPosition [RCBasic Doc] +#header sub GetCameraPosition(ByRef x, ByRef y, ByRef z) + +Gets the position of the camera + +#ref SetCameraPosition TranslateCamera diff --git a/doc/files/getcamerarotation.html b/doc/files/getcamerarotation.html new file mode 100644 index 0000000..7820621 --- /dev/null +++ b/doc/files/getcamerarotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the rotation of the camera on each axis +
+Related: + SetCameraRotation + RotateCamera +
++ + + \ No newline at end of file diff --git a/doc/files/getcamerarotation.txt b/doc/files/getcamerarotation.txt new file mode 100644 index 0000000..5768652 --- /dev/null +++ b/doc/files/getcamerarotation.txt @@ -0,0 +1,6 @@ +#title GetCameraRotation [RCBasic Doc] +#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.html b/doc/files/getcanvasalpha.html new file mode 100644 index 0000000..c8a8d9a --- /dev/null +++ b/doc/files/getcanvasalpha.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the alpha blend value of a canvas +
+Related: + SetCanvasAlpha +
++ + + \ No newline at end of file diff --git a/doc/files/getcanvasalpha.txt b/doc/files/getcanvasalpha.txt new file mode 100644 index 0000000..10e1bf0 --- /dev/null +++ b/doc/files/getcanvasalpha.txt @@ -0,0 +1,6 @@ +#title GetCanvasAlpha [RCBasic Doc] +#header function GetCanvasAlpha(c_num) + +Returns the alpha blend value of a canvas + +#ref SetCanvasAlpha diff --git a/doc/files/getcanvascolormod.html b/doc/files/getcanvascolormod.html new file mode 100644 index 0000000..706be0a --- /dev/null +++ b/doc/files/getcanvascolormod.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the color modulation of a canvas +
+Related: + SetCanvasColorMod +
++ + + \ No newline at end of file diff --git a/doc/files/getcanvascolormod.txt b/doc/files/getcanvascolormod.txt new file mode 100644 index 0000000..6842661 --- /dev/null +++ b/doc/files/getcanvascolormod.txt @@ -0,0 +1,6 @@ +#title GetCanvasColorMod [RCBasic Doc] +#header function GetCanvasColorMod(c_num) + +Returns the color modulation of a canvas + +#ref SetCanvasColorMod diff --git a/doc/files/getcanvasoffset.html b/doc/files/getcanvasoffset.html new file mode 100644 index 0000000..12119ea --- /dev/null +++ b/doc/files/getcanvasoffset.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns view offset of a canvas +
+Related: + SetCanvasOffset +
++ + + \ No newline at end of file diff --git a/doc/files/getcanvasoffset.txt b/doc/files/getcanvasoffset.txt new file mode 100644 index 0000000..c35d618 --- /dev/null +++ b/doc/files/getcanvasoffset.txt @@ -0,0 +1,6 @@ +#title GetCanvasOffset [RCBasic Doc] +#header sub GetCanvasOffset(c_num, byref x, byref y) + +Returns view offset of a canvas + +#ref SetCanvasOffset diff --git a/doc/files/getcanvassize.html b/doc/files/getcanvassize.html new file mode 100644 index 0000000..4d9f59e --- /dev/null +++ b/doc/files/getcanvassize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the size of a canvas +
++ + + \ No newline at end of file diff --git a/doc/files/getcanvassize.txt b/doc/files/getcanvassize.txt new file mode 100644 index 0000000..bdb68af --- /dev/null +++ b/doc/files/getcanvassize.txt @@ -0,0 +1,4 @@ +#title GetCanvasSize [RCBasic Doc] +#header sub GetCanvasSize(c_num, byref w, byref h) + +Gets the size of a canvas diff --git a/doc/files/getcanvasviewport.html b/doc/files/getcanvasviewport.html new file mode 100644 index 0000000..72831b7 --- /dev/null +++ b/doc/files/getcanvasviewport.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the position and size of a canvas viewport +
+Related: + OpenCanvas + SetCanvasViewport +
++ + + \ No newline at end of file diff --git a/doc/files/getcanvasviewport.txt b/doc/files/getcanvasviewport.txt new file mode 100644 index 0000000..99ad32c --- /dev/null +++ b/doc/files/getcanvasviewport.txt @@ -0,0 +1,6 @@ +#title GetCanvasViewport [RCBasic Doc] +#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.html b/doc/files/getcanvasz.html new file mode 100644 index 0000000..ceb0b39 --- /dev/null +++ b/doc/files/getcanvasz.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetCanvasZ +
++ + + \ No newline at end of file diff --git a/doc/files/getcanvasz.txt b/doc/files/getcanvasz.txt new file mode 100644 index 0000000..d82f672 --- /dev/null +++ b/doc/files/getcanvasz.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getchannelvolume.html new file mode 100644 index 0000000..db50d41 --- /dev/null +++ b/doc/files/getchannelvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the volume of the audio on a channel +
++ + + \ No newline at end of file diff --git a/doc/files/getchannelvolume.txt b/doc/files/getchannelvolume.txt new file mode 100644 index 0000000..1101b98 --- /dev/null +++ b/doc/files/getchannelvolume.txt @@ -0,0 +1,4 @@ +#title GetChannelVolume [RCBasic Doc] +#header function GetChannelVolume(channel) + +Returns the volume of the audio on a channel diff --git a/doc/files/getcirclelineintersection.html b/doc/files/getcirclelineintersection.html new file mode 100644 index 0000000..e9b0979 --- /dev/null +++ b/doc/files/getcirclelineintersection.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getcirclelineintersection.txt b/doc/files/getcirclelineintersection.txt new file mode 100644 index 0000000..1026aba --- /dev/null +++ b/doc/files/getcirclelineintersection.txt @@ -0,0 +1,6 @@ +#title GetCircleLineIntersection [RCBasic Doc] +#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.html b/doc/files/getclipboardtext.html new file mode 100644 index 0000000..58412a4 --- /dev/null +++ b/doc/files/getclipboardtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the clipboard text. +
++ + + \ No newline at end of file diff --git a/doc/files/getclipboardtext.txt b/doc/files/getclipboardtext.txt new file mode 100644 index 0000000..46fc3dc --- /dev/null +++ b/doc/files/getclipboardtext.txt @@ -0,0 +1,4 @@ +#title GetClipboardText$ [RCBasic Doc] +#header function GetClipboardText$( ) + +Returns the clipboard text. diff --git a/doc/files/getconeanglepoint.html b/doc/files/getconeanglepoint.html new file mode 100644 index 0000000..2a43082 --- /dev/null +++ b/doc/files/getconeanglepoint.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getconeanglepoint.txt b/doc/files/getconeanglepoint.txt new file mode 100644 index 0000000..7376129 --- /dev/null +++ b/doc/files/getconeanglepoint.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getconebiasfactor.html new file mode 100644 index 0000000..478bc1b --- /dev/null +++ b/doc/files/getconebiasfactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getconebiasfactor.txt b/doc/files/getconebiasfactor.txt new file mode 100644 index 0000000..7837b87 --- /dev/null +++ b/doc/files/getconebiasfactor.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getconedamping.html new file mode 100644 index 0000000..ef38697 --- /dev/null +++ b/doc/files/getconedamping.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getconedamping.txt b/doc/files/getconedamping.txt new file mode 100644 index 0000000..bf4bb89 --- /dev/null +++ b/doc/files/getconedamping.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getconefixthresh.html new file mode 100644 index 0000000..b022227 --- /dev/null +++ b/doc/files/getconefixthresh.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetConeFixThresh +
++ + + \ No newline at end of file diff --git a/doc/files/getconefixthresh.txt b/doc/files/getconefixthresh.txt new file mode 100644 index 0000000..fbce3b5 --- /dev/null +++ b/doc/files/getconefixthresh.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getconelimit.html new file mode 100644 index 0000000..54fa5d1 --- /dev/null +++ b/doc/files/getconelimit.html @@ -0,0 +1,34 @@ + + +
+ + ++ 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. +
++ limitIndex is an integer that indicates which limit to retrieve. It typically takes values corresponding to the type of limit: +
++ 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/files/getconelimit.txt b/doc/files/getconelimit.txt new file mode 100644 index 0000000..cda98a0 --- /dev/null +++ b/doc/files/getconelimit.txt @@ -0,0 +1,13 @@ +#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. + +limitIndex is an integer that indicates which limit to retrieve. It typically takes values corresponding to the type of limit: +#list ul +#li 0: Limit for the twist axis. +#li 1: Limit for the swing1 axis. +#li 2: Limit for the swing2 axis. +#/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.html b/doc/files/getconesolveswinglimit.html new file mode 100644 index 0000000..ad38bce --- /dev/null +++ b/doc/files/getconesolveswinglimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getconesolveswinglimit.txt b/doc/files/getconesolveswinglimit.txt new file mode 100644 index 0000000..791712a --- /dev/null +++ b/doc/files/getconesolveswinglimit.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getconesolvetwistlimit.html new file mode 100644 index 0000000..36d8535 --- /dev/null +++ b/doc/files/getconesolvetwistlimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getconesolvetwistlimit.txt b/doc/files/getconesolvetwistlimit.txt new file mode 100644 index 0000000..ec224ea --- /dev/null +++ b/doc/files/getconesolvetwistlimit.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/getconeswingspan1.html new file mode 100644 index 0000000..3a3f8fe --- /dev/null +++ b/doc/files/getconeswingspan1.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetConeSwingSpan2 +
++ + + \ No newline at end of file diff --git a/doc/files/getconeswingspan1.txt b/doc/files/getconeswingspan1.txt new file mode 100644 index 0000000..18e580e --- /dev/null +++ b/doc/files/getconeswingspan1.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getconeswingspan2.html new file mode 100644 index 0000000..0387226 --- /dev/null +++ b/doc/files/getconeswingspan2.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetConeSwingSpan1 +
++ + + \ No newline at end of file diff --git a/doc/files/getconeswingspan2.txt b/doc/files/getconeswingspan2.txt new file mode 100644 index 0000000..5ecb405 --- /dev/null +++ b/doc/files/getconeswingspan2.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getconetwistangle.html new file mode 100644 index 0000000..df774fd --- /dev/null +++ b/doc/files/getconetwistangle.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns the current twist angle between the two actors connected by the constraint +
++ + + \ No newline at end of file diff --git a/doc/files/getconetwistangle.txt b/doc/files/getconetwistangle.txt new file mode 100644 index 0000000..b4c00e3 --- /dev/null +++ b/doc/files/getconetwistangle.txt @@ -0,0 +1,10 @@ +#title getConeTwistAngle [RCBasic Doc] +#header function getConeTwistAngle( constraint_id) + +Returns the current twist angle between the two actors connected by the constraint + +#list ul +#li The twist angle is the current rotational angle between the two actors around the primary twist axis. +#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.html b/doc/files/getconetwistlimitsign.html new file mode 100644 index 0000000..0300b03 --- /dev/null +++ b/doc/files/getconetwistlimitsign.html @@ -0,0 +1,25 @@ + + +
+ + ++ Returns the sign of the twist limit, which indicates the direction of the twist limit enforcement around the twist axis. +
++ + + \ No newline at end of file diff --git a/doc/files/getconetwistlimitsign.txt b/doc/files/getconetwistlimitsign.txt new file mode 100644 index 0000000..47a753a --- /dev/null +++ b/doc/files/getconetwistlimitsign.txt @@ -0,0 +1,9 @@ +#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. + +#list ul +#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.html b/doc/files/getconetwistspan.html new file mode 100644 index 0000000..8ea78b9 --- /dev/null +++ b/doc/files/getconetwistspan.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getconetwistspan.txt b/doc/files/getconetwistspan.txt new file mode 100644 index 0000000..b892f53 --- /dev/null +++ b/doc/files/getconetwistspan.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getconstraintactora.html new file mode 100644 index 0000000..4eb3aa2 --- /dev/null +++ b/doc/files/getconstraintactora.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the first actor in a constraint +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintactora.txt b/doc/files/getconstraintactora.txt new file mode 100644 index 0000000..2a5767f --- /dev/null +++ b/doc/files/getconstraintactora.txt @@ -0,0 +1,4 @@ +#title getConstraintActorA [RCBasic Doc] +#header function getConstraintActorA( constraint_id) + +Returns the first actor in a constraint diff --git a/doc/files/getconstraintactorb.html b/doc/files/getconstraintactorb.html new file mode 100644 index 0000000..41c5436 --- /dev/null +++ b/doc/files/getconstraintactorb.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the second actor in a constraint +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintactorb.txt b/doc/files/getconstraintactorb.txt new file mode 100644 index 0000000..b4bb449 --- /dev/null +++ b/doc/files/getconstraintactorb.txt @@ -0,0 +1,4 @@ +#title getConstraintActorB [RCBasic Doc] +#header function getConstraintActorB( constraint_id) + +Returns the second actor in a constraint diff --git a/doc/files/getconstraintaframe.html b/doc/files/getconstraintaframe.html new file mode 100644 index 0000000..0adfb04 --- /dev/null +++ b/doc/files/getconstraintaframe.html @@ -0,0 +1,23 @@ + + +
+ + ++ Stores the transform of the first actor in a constraint in mA +
++ Note: Only applies to cone and hinge constraints +
+Related: + GetConstraintBFrame +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintaframe.txt b/doc/files/getconstraintaframe.txt new file mode 100644 index 0000000..08d4376 --- /dev/null +++ b/doc/files/getconstraintaframe.txt @@ -0,0 +1,8 @@ +#title GetConstraintAFrame [RCBasic Doc] +#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.html b/doc/files/getconstraintangularonly.html new file mode 100644 index 0000000..fbdc3f3 --- /dev/null +++ b/doc/files/getconstraintangularonly.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns true if the hinge constraint is set to limit only angular motion while allowing unrestricted linear (translational) motion. +
++ Note: Applies to Cone and Hinge constraints +
+Related: + SetConstraintAngularOnly +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintangularonly.txt b/doc/files/getconstraintangularonly.txt new file mode 100644 index 0000000..437e99c --- /dev/null +++ b/doc/files/getconstraintangularonly.txt @@ -0,0 +1,9 @@ +#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. + +Note: Applies to Cone and Hinge constraints + +#ref SetConstraintAngularOnly + diff --git a/doc/files/getconstraintappliedimpulse.html b/doc/files/getconstraintappliedimpulse.html new file mode 100644 index 0000000..1cd03f1 --- /dev/null +++ b/doc/files/getconstraintappliedimpulse.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getconstraintappliedimpulse.txt b/doc/files/getconstraintappliedimpulse.txt new file mode 100644 index 0000000..fb49e1e --- /dev/null +++ b/doc/files/getconstraintappliedimpulse.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getconstraintbframe.html new file mode 100644 index 0000000..3762259 --- /dev/null +++ b/doc/files/getconstraintbframe.html @@ -0,0 +1,23 @@ + + +
+ + ++ Stores the transform of the second actor in a constraint in mA +
++ Note: Only applies to cone and hinge constraints +
+Related: + GetConstraintAFrame +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintbframe.txt b/doc/files/getconstraintbframe.txt new file mode 100644 index 0000000..1419f08 --- /dev/null +++ b/doc/files/getconstraintbframe.txt @@ -0,0 +1,8 @@ +#title GetConstraintBFrame [RCBasic Doc] +#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.html b/doc/files/getconstraintbreakingimpulsethreshold.html new file mode 100644 index 0000000..4a857de --- /dev/null +++ b/doc/files/getconstraintbreakingimpulsethreshold.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + SetConstraintBreakingImpulseThreshold +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintbreakingimpulsethreshold.txt b/doc/files/getconstraintbreakingimpulsethreshold.txt new file mode 100644 index 0000000..b206943 --- /dev/null +++ b/doc/files/getconstraintbreakingimpulsethreshold.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getconstraintfixedactor.html new file mode 100644 index 0000000..7bcee13 --- /dev/null +++ b/doc/files/getconstraintfixedactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getconstraintfixedactor.txt b/doc/files/getconstraintfixedactor.txt new file mode 100644 index 0000000..35c29e1 --- /dev/null +++ b/doc/files/getconstraintfixedactor.txt @@ -0,0 +1,5 @@ +#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.html b/doc/files/getconstraintframeoffseta.html new file mode 100644 index 0000000..c3f63fe --- /dev/null +++ b/doc/files/getconstraintframeoffseta.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetConstraintFrameOffsetB +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintframeoffseta.txt b/doc/files/getconstraintframeoffseta.txt new file mode 100644 index 0000000..d45c687 --- /dev/null +++ b/doc/files/getconstraintframeoffseta.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getconstraintframeoffsetb.html new file mode 100644 index 0000000..c8d92c5 --- /dev/null +++ b/doc/files/getconstraintframeoffsetb.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetConstraintFrameOffsetA +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintframeoffsetb.txt b/doc/files/getconstraintframeoffsetb.txt new file mode 100644 index 0000000..c4c59a7 --- /dev/null +++ b/doc/files/getconstraintframeoffsetb.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getconstraintlimitsoftness.html new file mode 100644 index 0000000..08649a7 --- /dev/null +++ b/doc/files/getconstraintlimitsoftness.html @@ -0,0 +1,32 @@ + + +
+ + ++ 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. +
+Related: + SetConstraintSoftnessDirAng + SetConstraintSoftnessDirLin + SetConstraintSoftnessLimAng + SetConstraintSoftnessLimLin + SetConstraintSoftnessOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/files/getconstraintlimitsoftness.txt b/doc/files/getconstraintlimitsoftness.txt new file mode 100644 index 0000000..77c85b8 --- /dev/null +++ b/doc/files/getconstraintlimitsoftness.txt @@ -0,0 +1,11 @@ +#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. + +#list ul +#li Hard Limits: If the softness value is set to 1.0, it means the limits are treated as hard constraints. The physics engine will enforce these limits strictly, applying strong corrective forces to keep the motion within the limits. +#li Soft Limits: A softness value less than 1.0 allows for some flexibility in the motion. The actors can "push" against the limits without an immediate strong corrective force, leading to a more gradual response when approaching the limits. +#/list + +#ref SetConstraintSoftnessDirAng SetConstraintSoftnessDirLin SetConstraintSoftnessLimAng SetConstraintSoftnessLimLin SetConstraintSoftnessOrthoAng diff --git a/doc/files/getconstraintsolveriterations.html b/doc/files/getconstraintsolveriterations.html new file mode 100644 index 0000000..ca94897 --- /dev/null +++ b/doc/files/getconstraintsolveriterations.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getconstraintsolveriterations.txt b/doc/files/getconstraintsolveriterations.txt new file mode 100644 index 0000000..cbf42a2 --- /dev/null +++ b/doc/files/getconstraintsolveriterations.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getdesktopdisplaymode.html new file mode 100644 index 0000000..51cce9a --- /dev/null +++ b/doc/files/getdesktopdisplaymode.html @@ -0,0 +1,28 @@ + + +
+ + ++ Gets the resolution and refresh rate of a display +
++ + + \ No newline at end of file diff --git a/doc/files/getdesktopdisplaymode.txt b/doc/files/getdesktopdisplaymode.txt new file mode 100644 index 0000000..65150ed --- /dev/null +++ b/doc/files/getdesktopdisplaymode.txt @@ -0,0 +1,10 @@ +#title GetDesktopDisplayMode [RCBasic Doc] +#header Sub GetDesktopDisplayMode(index, ByRef w, ByRef h, ByRef freq) + +Gets the resolution and refresh rate of a display + +#list +#li index - The display index (ie. if you have 3 displays then index could be 0, 1, or 2) +#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.html b/doc/files/getglobalmouse.html new file mode 100644 index 0000000..b309a3d --- /dev/null +++ b/doc/files/getglobalmouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the global mouse position and button state +
++ + + \ No newline at end of file diff --git a/doc/files/getglobalmouse.txt b/doc/files/getglobalmouse.txt new file mode 100644 index 0000000..7267e36 --- /dev/null +++ b/doc/files/getglobalmouse.txt @@ -0,0 +1,4 @@ +#title GetGlobalMouse [RCBasic Doc] +#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/getgravity2d.html b/doc/files/getgravity2d.html new file mode 100644 index 0000000..030e929 --- /dev/null +++ b/doc/files/getgravity2d.html @@ -0,0 +1,20 @@ + + +
+ + ++ Use this function for retrieving the global gravity vector. A sprite canvas layer must be open. +
+Related: + SetGravity2D +
++ + + \ No newline at end of file diff --git a/doc/files/getgravity2d.txt b/doc/files/getgravity2d.txt new file mode 100644 index 0000000..a181a73 --- /dev/null +++ b/doc/files/getgravity2d.txt @@ -0,0 +1,6 @@ +#title GetGravity2D [RCBasic Doc] +#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.html b/doc/files/getgravity3d.html new file mode 100644 index 0000000..4d9e61b --- /dev/null +++ b/doc/files/getgravity3d.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the world gravity +
+Related: + SetGravity3D +
++ + + \ No newline at end of file diff --git a/doc/files/getgravity3d.txt b/doc/files/getgravity3d.txt new file mode 100644 index 0000000..ffb2a6a --- /dev/null +++ b/doc/files/getgravity3d.txt @@ -0,0 +1,6 @@ +#title GetGravity3D [RCBasic Doc] +#header sub GetGravity3D(ByRef x, ByRef y, ByRef z) + +Gets the world gravity + +#ref SetGravity3D diff --git a/doc/files/getgyro.html b/doc/files/getgyro.html new file mode 100644 index 0000000..3a94566 --- /dev/null +++ b/doc/files/getgyro.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the values of a Gyro sensor +
++ + + \ No newline at end of file diff --git a/doc/files/getgyro.txt b/doc/files/getgyro.txt new file mode 100644 index 0000000..b622e77 --- /dev/null +++ b/doc/files/getgyro.txt @@ -0,0 +1,4 @@ +#title GetGyro [RCBasic Doc] +#header sub GetGyro(gyro_num, ByRef x, ByRef y, ByRef z) + +Gets the values of a Gyro sensor diff --git a/doc/files/gethingeangle.html b/doc/files/gethingeangle.html new file mode 100644 index 0000000..266b555 --- /dev/null +++ b/doc/files/gethingeangle.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the angle of a hinge constraint +
++ + + \ No newline at end of file diff --git a/doc/files/gethingeangle.txt b/doc/files/gethingeangle.txt new file mode 100644 index 0000000..341c02c --- /dev/null +++ b/doc/files/gethingeangle.txt @@ -0,0 +1,4 @@ +#title getHingeAngle [RCBasic Doc] +#header function getHingeAngle( constraint_id) + +Returns the angle of a hinge constraint diff --git a/doc/files/gethingeangleex.html b/doc/files/gethingeangleex.html new file mode 100644 index 0000000..9b57eab --- /dev/null +++ b/doc/files/gethingeangleex.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the transforms of the 2 actors in a hinge constraint +
++ + + \ No newline at end of file diff --git a/doc/files/gethingeangleex.txt b/doc/files/gethingeangleex.txt new file mode 100644 index 0000000..c89928a --- /dev/null +++ b/doc/files/gethingeangleex.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/gethingelimitbiasfactor.html new file mode 100644 index 0000000..ea7f555 --- /dev/null +++ b/doc/files/gethingelimitbiasfactor.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/gethingelimitbiasfactor.txt b/doc/files/gethingelimitbiasfactor.txt new file mode 100644 index 0000000..466156c --- /dev/null +++ b/doc/files/gethingelimitbiasfactor.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/gethingelimitrelaxationfactor.html new file mode 100644 index 0000000..dad9624 --- /dev/null +++ b/doc/files/gethingelimitrelaxationfactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/gethingelimitrelaxationfactor.txt b/doc/files/gethingelimitrelaxationfactor.txt new file mode 100644 index 0000000..61f10f0 --- /dev/null +++ b/doc/files/gethingelimitrelaxationfactor.txt @@ -0,0 +1,4 @@ +#title getHingeLimitRelaxationFactor [RCBasic Doc] +#header function getHingeLimitRelaxationFactor( constraint_id) + + diff --git a/doc/files/gethingelimitsign.html b/doc/files/gethingelimitsign.html new file mode 100644 index 0000000..f2b8d70 --- /dev/null +++ b/doc/files/gethingelimitsign.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetHingeLimit +
++ + + \ No newline at end of file diff --git a/doc/files/gethingelimitsign.txt b/doc/files/gethingelimitsign.txt new file mode 100644 index 0000000..07a5d39 --- /dev/null +++ b/doc/files/gethingelimitsign.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/gethingesolvelimit.html new file mode 100644 index 0000000..ae09066 --- /dev/null +++ b/doc/files/gethingesolvelimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/gethingesolvelimit.txt b/doc/files/gethingesolvelimit.txt new file mode 100644 index 0000000..ce518db --- /dev/null +++ b/doc/files/gethingesolvelimit.txt @@ -0,0 +1,6 @@ +#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/getimagealpha.html b/doc/files/getimagealpha.html new file mode 100644 index 0000000..f411c76 --- /dev/null +++ b/doc/files/getimagealpha.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the alpha blend value of an image +
++ + + \ No newline at end of file diff --git a/doc/files/getimagealpha.txt b/doc/files/getimagealpha.txt new file mode 100644 index 0000000..7b25488 --- /dev/null +++ b/doc/files/getimagealpha.txt @@ -0,0 +1,4 @@ +#title GetImageAlpha [RCBasic Doc] +#header function GetImageAlpha( img_id ) + +Returns the alpha blend value of an image diff --git a/doc/files/getimagecolormod.html b/doc/files/getimagecolormod.html new file mode 100644 index 0000000..37be61e --- /dev/null +++ b/doc/files/getimagecolormod.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the color modulation of an image +
++ + + \ No newline at end of file diff --git a/doc/files/getimagecolormod.txt b/doc/files/getimagecolormod.txt new file mode 100644 index 0000000..c6b6c95 --- /dev/null +++ b/doc/files/getimagecolormod.txt @@ -0,0 +1,4 @@ +#title GetImageColorMod [RCBasic Doc] +#header function GetImageColorMod(img) + +Returns the color modulation of an image diff --git a/doc/files/getimagesize.html b/doc/files/getimagesize.html new file mode 100644 index 0000000..19288b5 --- /dev/null +++ b/doc/files/getimagesize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the Size of an image +
++ + + \ No newline at end of file diff --git a/doc/files/getimagesize.txt b/doc/files/getimagesize.txt new file mode 100644 index 0000000..b58abc4 --- /dev/null +++ b/doc/files/getimagesize.txt @@ -0,0 +1,4 @@ +#title GetImageSize [RCBasic Doc] +#header sub GetImageSize(slot, byref w, byref h) + +Gets the Size of an image diff --git a/doc/files/getjointangle.html b/doc/files/getjointangle.html new file mode 100644 index 0000000..461bed3 --- /dev/null +++ b/doc/files/getjointangle.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns the current joint angle +
++ Used with +
++ + + \ No newline at end of file diff --git a/doc/files/getjointangle.txt b/doc/files/getjointangle.txt new file mode 100644 index 0000000..995f3c9 --- /dev/null +++ b/doc/files/getjointangle.txt @@ -0,0 +1,10 @@ +#title getJointAngle [RCBasic Doc] +#header function getJointAngle( joint_id) + +Returns the current joint angle + +Used with +#list ul +#li Revolute Joint +#li Wheel Joint +#/list diff --git a/doc/files/getjointangularoffset.html b/doc/files/getjointangularoffset.html new file mode 100644 index 0000000..7472f1b --- /dev/null +++ b/doc/files/getjointangularoffset.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the target angular offset +
++ Used with Motor Joint +
+Related: + SetJointAngularOffset +
++ + + \ No newline at end of file diff --git a/doc/files/getjointangularoffset.txt b/doc/files/getjointangularoffset.txt new file mode 100644 index 0000000..cc20881 --- /dev/null +++ b/doc/files/getjointangularoffset.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointangularspeed.html new file mode 100644 index 0000000..9a380dc --- /dev/null +++ b/doc/files/getjointangularspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Return the current joint angular speed +
++ Used with Wheel Joint +
++ + + \ No newline at end of file diff --git a/doc/files/getjointangularspeed.txt b/doc/files/getjointangularspeed.txt new file mode 100644 index 0000000..de5013b --- /dev/null +++ b/doc/files/getjointangularspeed.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getjointcorrectionfactor.html new file mode 100644 index 0000000..ec2786d --- /dev/null +++ b/doc/files/getjointcorrectionfactor.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
++ Used with Motor Joints +
+Related: + GetJointCorrectionFactor +
++ + + \ No newline at end of file diff --git a/doc/files/getjointcorrectionfactor.txt b/doc/files/getjointcorrectionfactor.txt new file mode 100644 index 0000000..08ab123 --- /dev/null +++ b/doc/files/getjointcorrectionfactor.txt @@ -0,0 +1,9 @@ +#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. + +Used with Motor Joints + +#ref GetJointCorrectionFactor + diff --git a/doc/files/getjointcurrentlength.html b/doc/files/getjointcurrentlength.html new file mode 100644 index 0000000..a12fad9 --- /dev/null +++ b/doc/files/getjointcurrentlength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the current distance between BodyA and BodyB +
++ Used with Distance Joint +
+Related: + GetJointLength +
++ + + \ No newline at end of file diff --git a/doc/files/getjointcurrentlength.txt b/doc/files/getjointcurrentlength.txt new file mode 100644 index 0000000..e265efc --- /dev/null +++ b/doc/files/getjointcurrentlength.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointcurrentlengtha.html new file mode 100644 index 0000000..7831fa0 --- /dev/null +++ b/doc/files/getjointcurrentlengtha.html @@ -0,0 +1,23 @@ + + +
+ + ++ Return the current length of the segment attached to bodyA. +
++ Used with Pulley Joint +
+Related: + GetJointCurrentLengthB +
++ + + \ No newline at end of file diff --git a/doc/files/getjointcurrentlengtha.txt b/doc/files/getjointcurrentlengtha.txt new file mode 100644 index 0000000..7455b65 --- /dev/null +++ b/doc/files/getjointcurrentlengtha.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointcurrentlengthb.html new file mode 100644 index 0000000..e1c0ce2 --- /dev/null +++ b/doc/files/getjointcurrentlengthb.html @@ -0,0 +1,23 @@ + + +
+ + ++ Return the current length of the segment attached to bodyB. +
++ Used with Pulley Joint +
+Related: + GetJointCurrentLengthA +
++ + + \ No newline at end of file diff --git a/doc/files/getjointcurrentlengthb.txt b/doc/files/getjointcurrentlengthb.txt new file mode 100644 index 0000000..78e1490 --- /dev/null +++ b/doc/files/getjointcurrentlengthb.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointdamping.html new file mode 100644 index 0000000..5358486 --- /dev/null +++ b/doc/files/getjointdamping.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns the damping value for a joint +
++ Used with +
+Related: + SetJointDamping +
++ + + \ No newline at end of file diff --git a/doc/files/getjointdamping.txt b/doc/files/getjointdamping.txt new file mode 100644 index 0000000..131ecdc --- /dev/null +++ b/doc/files/getjointdamping.txt @@ -0,0 +1,13 @@ +#title getJointDamping [RCBasic Doc] +#header function getJointDamping( joint_id) + +Returns the damping value for a joint + +Used with +#list ul +#li Distance Joint +#li Weld Joint +#li Wheel Joint +#/list + +#ref SetJointDamping diff --git a/doc/files/getjointgroundanchora.html b/doc/files/getjointgroundanchora.html new file mode 100644 index 0000000..15e94a4 --- /dev/null +++ b/doc/files/getjointgroundanchora.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the first ground anchor +
++ Used with Pulley Joint +
+Related: + GetJointGroundAnchorB +
++ + + \ No newline at end of file diff --git a/doc/files/getjointgroundanchora.txt b/doc/files/getjointgroundanchora.txt new file mode 100644 index 0000000..3abb253 --- /dev/null +++ b/doc/files/getjointgroundanchora.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointgroundanchorb.html new file mode 100644 index 0000000..a48bbad --- /dev/null +++ b/doc/files/getjointgroundanchorb.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the second ground anchor +
++ Used with Pulley Joint +
+Related: + GetJointGroundAnchorA +
++ + + \ No newline at end of file diff --git a/doc/files/getjointgroundanchorb.txt b/doc/files/getjointgroundanchorb.txt new file mode 100644 index 0000000..ac3d8db --- /dev/null +++ b/doc/files/getjointgroundanchorb.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointlength.html new file mode 100644 index 0000000..76e0b9a --- /dev/null +++ b/doc/files/getjointlength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the Joint Length +
++ Used with distance Joints +
+Related: + SetJointLength +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlength.txt b/doc/files/getjointlength.txt new file mode 100644 index 0000000..60a9416 --- /dev/null +++ b/doc/files/getjointlength.txt @@ -0,0 +1,9 @@ +#title getJointLength [RCBasic Doc] +#header function getJointLength( joint_id) + +Returns the Joint Length + +Used with distance Joints + +#ref SetJointLength + diff --git a/doc/files/getjointlengtha.html b/doc/files/getjointlengtha.html new file mode 100644 index 0000000..bbb26a4 --- /dev/null +++ b/doc/files/getjointlengtha.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + GetJointLengthB +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlengtha.txt b/doc/files/getjointlengtha.txt new file mode 100644 index 0000000..395010a --- /dev/null +++ b/doc/files/getjointlengtha.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointlengthb.html new file mode 100644 index 0000000..0a078b6 --- /dev/null +++ b/doc/files/getjointlengthb.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + GetJointLengthA +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlengthb.txt b/doc/files/getjointlengthb.txt new file mode 100644 index 0000000..969f110 --- /dev/null +++ b/doc/files/getjointlengthb.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointlinearoffset.html new file mode 100644 index 0000000..4561599 --- /dev/null +++ b/doc/files/getjointlinearoffset.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the target position offset for the connected bodies relative to each other. +
++ Used with Motor Joints +
+Related: + SetJointLinearOffset +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlinearoffset.txt b/doc/files/getjointlinearoffset.txt new file mode 100644 index 0000000..e1eb1a1 --- /dev/null +++ b/doc/files/getjointlinearoffset.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointlinearspeed.html new file mode 100644 index 0000000..1aa5aac --- /dev/null +++ b/doc/files/getjointlinearspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the current joint linear speed, usually in meters per second. +
++ Used with Wheel Joint +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlinearspeed.txt b/doc/files/getjointlinearspeed.txt new file mode 100644 index 0000000..e773051 --- /dev/null +++ b/doc/files/getjointlinearspeed.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getjointlocalanchora.html new file mode 100644 index 0000000..502a4eb --- /dev/null +++ b/doc/files/getjointlocalanchora.html @@ -0,0 +1,40 @@ + + +
+ + ++ Returns the local anchor point relative to bodyA's origin. +
+Related: + GetJointLocalAnchorB +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlocalanchora.txt b/doc/files/getjointlocalanchora.txt new file mode 100644 index 0000000..3ab327f --- /dev/null +++ b/doc/files/getjointlocalanchora.txt @@ -0,0 +1,15 @@ +#title getJointLocalAnchorA [RCBasic Doc] +#header sub getJointLocalAnchorA( joint_id, ByRef x, ByRef y) + +Returns the local anchor point relative to bodyA's origin. + +#list ul +#li Distance Joint +#li Friction Joint +#li Prismatic Joint +#li Revolute Joint +#li Weld Joint +#li Wheel Joint +#/list + +#ref GetJointLocalAnchorB diff --git a/doc/files/getjointlocalanchorb.html b/doc/files/getjointlocalanchorb.html new file mode 100644 index 0000000..1b6f117 --- /dev/null +++ b/doc/files/getjointlocalanchorb.html @@ -0,0 +1,40 @@ + + +
+ + ++ Returns the local anchor point relative to bodyB's origin. +
+Related: + GetJointLocalAnchorA +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlocalanchorb.txt b/doc/files/getjointlocalanchorb.txt new file mode 100644 index 0000000..59355b5 --- /dev/null +++ b/doc/files/getjointlocalanchorb.txt @@ -0,0 +1,15 @@ +#title getJointLocalAnchorB [RCBasic Doc] +#header sub getJointLocalAnchorB( joint_id, ByRef x, ByRef y) + +Returns the local anchor point relative to bodyB's origin. + +#list ul +#li Distance Joint +#li Friction Joint +#li Prismatic Joint +#li Revolute Joint +#li Weld Joint +#li Wheel Joint +#/list + +#ref GetJointLocalAnchorA diff --git a/doc/files/getjointlocalaxisa.html b/doc/files/getjointlocalaxisa.html new file mode 100644 index 0000000..c1e934c --- /dev/null +++ b/doc/files/getjointlocalaxisa.html @@ -0,0 +1,28 @@ + + +
+ + ++ Gets the local joint axis relative to bodyA +
++ Used with +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlocalaxisa.txt b/doc/files/getjointlocalaxisa.txt new file mode 100644 index 0000000..fbaf6ad --- /dev/null +++ b/doc/files/getjointlocalaxisa.txt @@ -0,0 +1,11 @@ +#title getJointLocalAxisA [RCBasic Doc] +#header sub getJointLocalAxisA( joint_id, ByRef x, ByRef y) + +Gets the local joint axis relative to bodyA + +Used with +#list ul +#li Prismatic Joint +#li Wheel Joint +#/list + diff --git a/doc/files/getjointlowerlimit.html b/doc/files/getjointlowerlimit.html new file mode 100644 index 0000000..6fedb2c --- /dev/null +++ b/doc/files/getjointlowerlimit.html @@ -0,0 +1,34 @@ + + +
+ + ++ Get the lower joint translation limit, usually in meters. +
++ Used with +
+Related: + GetJointUpperLimit +
++ + + \ No newline at end of file diff --git a/doc/files/getjointlowerlimit.txt b/doc/files/getjointlowerlimit.txt new file mode 100644 index 0000000..3de2db7 --- /dev/null +++ b/doc/files/getjointlowerlimit.txt @@ -0,0 +1,13 @@ +#title getJointLowerLimit [RCBasic Doc] +#header function getJointLowerLimit( joint_id) + +Get the lower joint translation limit, usually in meters. + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref GetJointUpperLimit diff --git a/doc/files/getjointmaxforce.html b/doc/files/getjointmaxforce.html new file mode 100644 index 0000000..bcc6be7 --- /dev/null +++ b/doc/files/getjointmaxforce.html @@ -0,0 +1,28 @@ + + +
+ + ++ Return the maximum friction force in N. +
++ Used with +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmaxforce.txt b/doc/files/getjointmaxforce.txt new file mode 100644 index 0000000..6d9a4d4 --- /dev/null +++ b/doc/files/getjointmaxforce.txt @@ -0,0 +1,10 @@ +#title getJointMaxForce [RCBasic Doc] +#header function getJointMaxForce( joint_id) + +Return the maximum friction force in N. + +Used with +#list ul +#li Friction Joint +#li Motor Joint +#/list diff --git a/doc/files/getjointmaxlength.html b/doc/files/getjointmaxlength.html new file mode 100644 index 0000000..ba5f227 --- /dev/null +++ b/doc/files/getjointmaxlength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the maximum length +
++ Used with Distance Joint +
+Related: + GetJointMinLength +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmaxlength.txt b/doc/files/getjointmaxlength.txt new file mode 100644 index 0000000..c2e08be --- /dev/null +++ b/doc/files/getjointmaxlength.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointmaxmotorforce.html new file mode 100644 index 0000000..f91df43 --- /dev/null +++ b/doc/files/getjointmaxmotorforce.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetJointMaxMotorForce +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmaxmotorforce.txt b/doc/files/getjointmaxmotorforce.txt new file mode 100644 index 0000000..d1cbcc9 --- /dev/null +++ b/doc/files/getjointmaxmotorforce.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointmaxmotortorque.html new file mode 100644 index 0000000..30ca2ae --- /dev/null +++ b/doc/files/getjointmaxmotortorque.html @@ -0,0 +1,31 @@ + + +
+ + ++ 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. +
++ Used with +
+Related: + SetJointMaxMotorTorque +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmaxmotortorque.txt b/doc/files/getjointmaxmotortorque.txt new file mode 100644 index 0000000..48a1ca2 --- /dev/null +++ b/doc/files/getjointmaxmotortorque.txt @@ -0,0 +1,12 @@ +#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. + +Used with +#list ul +#li Revolute Joint +#li Wheel Joint +#/list + +#ref SetJointMaxMotorTorque diff --git a/doc/files/getjointmaxtorque.html b/doc/files/getjointmaxtorque.html new file mode 100644 index 0000000..549db1e --- /dev/null +++ b/doc/files/getjointmaxtorque.html @@ -0,0 +1,31 @@ + + +
+ + ++ 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. +
++ Used with +
+Related: + SetJointMaxTorque +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmaxtorque.txt b/doc/files/getjointmaxtorque.txt new file mode 100644 index 0000000..479724c --- /dev/null +++ b/doc/files/getjointmaxtorque.txt @@ -0,0 +1,12 @@ +#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. + +Used with +#list ul +#li Friction Joint +#li Motor Joint +#/list + +#ref SetJointMaxTorque diff --git a/doc/files/getjointminlength.html b/doc/files/getjointminlength.html new file mode 100644 index 0000000..5ec0d93 --- /dev/null +++ b/doc/files/getjointminlength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the minimum length +
++ Used with Distance Joint +
+Related: + GetJointMaxLength +
++ + + \ No newline at end of file diff --git a/doc/files/getjointminlength.txt b/doc/files/getjointminlength.txt new file mode 100644 index 0000000..3114321 --- /dev/null +++ b/doc/files/getjointminlength.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointmotorforce.html new file mode 100644 index 0000000..2aec882 --- /dev/null +++ b/doc/files/getjointmotorforce.html @@ -0,0 +1,23 @@ + + +
+ + ++ Return the current motor force given the inverse time step, usually in N. +
++ Used with Prismatic Joint +
+Related: + SetJointMotorForce +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmotorforce.txt b/doc/files/getjointmotorforce.txt new file mode 100644 index 0000000..e954a31 --- /dev/null +++ b/doc/files/getjointmotorforce.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointmotorspeed.html new file mode 100644 index 0000000..c8f91ec --- /dev/null +++ b/doc/files/getjointmotorspeed.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns the motor speed +
++ Used with +
+Related: + SetJointMotorSpeed +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmotorspeed.txt b/doc/files/getjointmotorspeed.txt new file mode 100644 index 0000000..80b725f --- /dev/null +++ b/doc/files/getjointmotorspeed.txt @@ -0,0 +1,13 @@ +#title getJointMotorSpeed [RCBasic Doc] +#header function getJointMotorSpeed( joint_id) + +Returns the motor speed + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref SetJointMotorSpeed diff --git a/doc/files/getjointmotortorque.html b/doc/files/getjointmotortorque.html new file mode 100644 index 0000000..a232663 --- /dev/null +++ b/doc/files/getjointmotortorque.html @@ -0,0 +1,32 @@ + + +
+ + ++ Returns the current motor torque given the inverse time step. Unit is N*m. +
++ Used with +
+Related: + GetJointMaxMotorTorque + SetJointMaxMotorTorque +
++ + + \ No newline at end of file diff --git a/doc/files/getjointmotortorque.txt b/doc/files/getjointmotortorque.txt new file mode 100644 index 0000000..022fa33 --- /dev/null +++ b/doc/files/getjointmotortorque.txt @@ -0,0 +1,12 @@ +#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. + +Used with +#list ul +#li Revolute Joint +#li Wheel Joint +#/list + +#ref GetJointMaxMotorTorque SetJointMaxMotorTorque diff --git a/doc/files/getjointratio.html b/doc/files/getjointratio.html new file mode 100644 index 0000000..25ceffb --- /dev/null +++ b/doc/files/getjointratio.html @@ -0,0 +1,31 @@ + + +
+ + ++ Returns the gear/pulley ratio +
++ Used with +
+Related: + SetJointRatio +
++ + + \ No newline at end of file diff --git a/doc/files/getjointratio.txt b/doc/files/getjointratio.txt new file mode 100644 index 0000000..32d1ae1 --- /dev/null +++ b/doc/files/getjointratio.txt @@ -0,0 +1,12 @@ +#title getJointRatio [RCBasic Doc] +#header function getJointRatio( joint_id) + +Returns the gear/pulley ratio + +Used with +#list ul +#li Gear Joint +#li Pulley Joint +#/list + +#ref SetJointRatio diff --git a/doc/files/getjointreactionforce.html b/doc/files/getjointreactionforce.html new file mode 100644 index 0000000..077797a --- /dev/null +++ b/doc/files/getjointreactionforce.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the reaction force on bodyB at the joint anchor in Newtons. +
++ Can be used with all joints +
+Related: + GetJointReactionTorque +
++ + + \ No newline at end of file diff --git a/doc/files/getjointreactionforce.txt b/doc/files/getjointreactionforce.txt new file mode 100644 index 0000000..179d558 --- /dev/null +++ b/doc/files/getjointreactionforce.txt @@ -0,0 +1,9 @@ +#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. + +Can be used with all joints + +#ref GetJointReactionTorque + diff --git a/doc/files/getjointreactiontorque.html b/doc/files/getjointreactiontorque.html new file mode 100644 index 0000000..119be76 --- /dev/null +++ b/doc/files/getjointreactiontorque.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the reaction torque on bodyB in N*m +
++ Can be used with all joints +
+Related: + GetJointReactionForce +
++ + + \ No newline at end of file diff --git a/doc/files/getjointreactiontorque.txt b/doc/files/getjointreactiontorque.txt new file mode 100644 index 0000000..1bbcf38 --- /dev/null +++ b/doc/files/getjointreactiontorque.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointreferenceangle.html new file mode 100644 index 0000000..f7727de --- /dev/null +++ b/doc/files/getjointreferenceangle.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns the reference angle. +
++ Used with +
++ + + \ No newline at end of file diff --git a/doc/files/getjointreferenceangle.txt b/doc/files/getjointreferenceangle.txt new file mode 100644 index 0000000..d30f77c --- /dev/null +++ b/doc/files/getjointreferenceangle.txt @@ -0,0 +1,10 @@ +#title getJointReferenceAngle [RCBasic Doc] +#header function getJointReferenceAngle( joint_id) + +Returns the reference angle. + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#/list diff --git a/doc/files/getjointspeed.html b/doc/files/getjointspeed.html new file mode 100644 index 0000000..aded632 --- /dev/null +++ b/doc/files/getjointspeed.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns the current joint angle speed +
++ Used with +
++ + + \ No newline at end of file diff --git a/doc/files/getjointspeed.txt b/doc/files/getjointspeed.txt new file mode 100644 index 0000000..49e647d --- /dev/null +++ b/doc/files/getjointspeed.txt @@ -0,0 +1,10 @@ +#title getJointSpeed [RCBasic Doc] +#header function getJointSpeed( joint_id) + +Returns the current joint angle speed + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#/list diff --git a/doc/files/getjointstiffness.html b/doc/files/getjointstiffness.html new file mode 100644 index 0000000..216095a --- /dev/null +++ b/doc/files/getjointstiffness.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns spring stiffness +
++ Used with +
+Related: + SetJointStiffness +
++ + + \ No newline at end of file diff --git a/doc/files/getjointstiffness.txt b/doc/files/getjointstiffness.txt new file mode 100644 index 0000000..cecf85e --- /dev/null +++ b/doc/files/getjointstiffness.txt @@ -0,0 +1,13 @@ +#title getJointStiffness [RCBasic Doc] +#header function getJointStiffness( joint_id) + +Returns spring stiffness + +Used with +#list ul +#li Distance Joint +#li Weld Joint +#li Wheel Joint +#/list + +#ref SetJointStiffness diff --git a/doc/files/getjointtranslation.html b/doc/files/getjointtranslation.html new file mode 100644 index 0000000..e11406d --- /dev/null +++ b/doc/files/getjointtranslation.html @@ -0,0 +1,28 @@ + + +
+ + ++ Returns the current joint translation, usually in meters. +
++ Used with +
++ + + \ No newline at end of file diff --git a/doc/files/getjointtranslation.txt b/doc/files/getjointtranslation.txt new file mode 100644 index 0000000..286942c --- /dev/null +++ b/doc/files/getjointtranslation.txt @@ -0,0 +1,10 @@ +#title getJointTranslation [RCBasic Doc] +#header function getJointTranslation( joint_id) + +Returns the current joint translation, usually in meters. + +Used with +#list ul +#li Prismatic Joint +#li Wheel Joint +#/list diff --git a/doc/files/getjointupperlimit.html b/doc/files/getjointupperlimit.html new file mode 100644 index 0000000..8ce9b4c --- /dev/null +++ b/doc/files/getjointupperlimit.html @@ -0,0 +1,34 @@ + + +
+ + ++ Get the upper joint translation limit, usually in meters. +
++ Used with +
+Related: + GetJointLowerLimit +
++ + + \ No newline at end of file diff --git a/doc/files/getjointupperlimit.txt b/doc/files/getjointupperlimit.txt new file mode 100644 index 0000000..4d96565 --- /dev/null +++ b/doc/files/getjointupperlimit.txt @@ -0,0 +1,13 @@ +#title getJointUpperLimit [RCBasic Doc] +#header function getJointUpperLimit( joint_id) + +Get the upper joint translation limit, usually in meters. + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref GetJointLowerLimit diff --git a/doc/files/getjointworldanchora.html b/doc/files/getjointworldanchora.html new file mode 100644 index 0000000..36b589c --- /dev/null +++ b/doc/files/getjointworldanchora.html @@ -0,0 +1,23 @@ + + +
+ + ++ Get the anchor point on bodyA in world coordinates. +
++ Can be used with all joints +
+Related: + GetJointWorldAnchorB +
++ + + \ No newline at end of file diff --git a/doc/files/getjointworldanchora.txt b/doc/files/getjointworldanchora.txt new file mode 100644 index 0000000..336857f --- /dev/null +++ b/doc/files/getjointworldanchora.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjointworldanchorb.html new file mode 100644 index 0000000..3b4818e --- /dev/null +++ b/doc/files/getjointworldanchorb.html @@ -0,0 +1,23 @@ + + +
+ + ++ Get the anchor point on bodyB in world coordinates. +
++ Can be used with all joints +
+Related: + GetJointWorldAnchorA +
++ + + \ No newline at end of file diff --git a/doc/files/getjointworldanchorb.txt b/doc/files/getjointworldanchorb.txt new file mode 100644 index 0000000..43a4ede --- /dev/null +++ b/doc/files/getjointworldanchorb.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getjoytrackball.html new file mode 100644 index 0000000..41455b1 --- /dev/null +++ b/doc/files/getjoytrackball.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the axis values of a track ball +
++ + + \ No newline at end of file diff --git a/doc/files/getjoytrackball.txt b/doc/files/getjoytrackball.txt new file mode 100644 index 0000000..943a43e --- /dev/null +++ b/doc/files/getjoytrackball.txt @@ -0,0 +1,4 @@ +#title GetJoyTrackBall [RCBasic Doc] +#header sub GetJoyTrackBall(joy_num, ball, byref dx, byref dy) + +Gets the axis values of a track ball diff --git a/doc/files/getlightambientcolor.html b/doc/files/getlightambientcolor.html new file mode 100644 index 0000000..8f12635 --- /dev/null +++ b/doc/files/getlightambientcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the ambient color of a light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightambientcolor.txt b/doc/files/getlightambientcolor.txt new file mode 100644 index 0000000..ea6f936 --- /dev/null +++ b/doc/files/getlightambientcolor.txt @@ -0,0 +1,4 @@ +#title GetLightAmbientColor [RCBasic Doc] +#header function GetLightAmbientColor( actor ) + +Returns the ambient color of a light diff --git a/doc/files/getlightattenuation.html b/doc/files/getlightattenuation.html new file mode 100644 index 0000000..49d93ca --- /dev/null +++ b/doc/files/getlightattenuation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the strength of the light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightattenuation.txt b/doc/files/getlightattenuation.txt new file mode 100644 index 0000000..b671d9e --- /dev/null +++ b/doc/files/getlightattenuation.txt @@ -0,0 +1,4 @@ +#title GetLightAttenuation [RCBasic Doc] +#header sub GetLightAttenuation( actor, ByRef constant, ByRef linear, ByRef quadratic) + +Gets the strength of the light diff --git a/doc/files/getlightdiffusecolor.html b/doc/files/getlightdiffusecolor.html new file mode 100644 index 0000000..60ded82 --- /dev/null +++ b/doc/files/getlightdiffusecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the diffuse color of the light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightdiffusecolor.txt b/doc/files/getlightdiffusecolor.txt new file mode 100644 index 0000000..643d85d --- /dev/null +++ b/doc/files/getlightdiffusecolor.txt @@ -0,0 +1,4 @@ +#title GetLightDiffuseColor [RCBasic Doc] +#header function GetLightDiffuseColor( actor ) + +Returns the diffuse color of the light diff --git a/doc/files/getlightfalloff.html b/doc/files/getlightfalloff.html new file mode 100644 index 0000000..f2c918f --- /dev/null +++ b/doc/files/getlightfalloff.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the strength decrease between the inner and outer cone of a light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightfalloff.txt b/doc/files/getlightfalloff.txt new file mode 100644 index 0000000..0a2f291 --- /dev/null +++ b/doc/files/getlightfalloff.txt @@ -0,0 +1,4 @@ +#title GetLightFalloff [RCBasic Doc] +#header function GetLightFalloff( actor ) + +Returns the strength decrease between the inner and outer cone of a light diff --git a/doc/files/getlightinnercone.html b/doc/files/getlightinnercone.html new file mode 100644 index 0000000..e239a92 --- /dev/null +++ b/doc/files/getlightinnercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the inner cone of a spot light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightinnercone.txt b/doc/files/getlightinnercone.txt new file mode 100644 index 0000000..cbf606b --- /dev/null +++ b/doc/files/getlightinnercone.txt @@ -0,0 +1,4 @@ +#title GetLightInnerCone [RCBasic Doc] +#header function GetLightInnerCone( actor ) + +Returns the inner cone of a spot light diff --git a/doc/files/getlightoutercone.html b/doc/files/getlightoutercone.html new file mode 100644 index 0000000..1ed16fb --- /dev/null +++ b/doc/files/getlightoutercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the outer cone of a spot light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightoutercone.txt b/doc/files/getlightoutercone.txt new file mode 100644 index 0000000..fd6355b --- /dev/null +++ b/doc/files/getlightoutercone.txt @@ -0,0 +1,4 @@ +#title GetLightOuterCone [RCBasic Doc] +#header function GetLightOuterCone( actor ) + +Returns the outer cone of a spot light diff --git a/doc/files/getlightradius.html b/doc/files/getlightradius.html new file mode 100644 index 0000000..a5a1b6e --- /dev/null +++ b/doc/files/getlightradius.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the radius of the light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightradius.txt b/doc/files/getlightradius.txt new file mode 100644 index 0000000..97c1d9d --- /dev/null +++ b/doc/files/getlightradius.txt @@ -0,0 +1,4 @@ +#title getLightRadius [RCBasic Doc] +#header function getLightRadius( actor ) + +Returns the radius of the light diff --git a/doc/files/getlightspecularcolor.html b/doc/files/getlightspecularcolor.html new file mode 100644 index 0000000..af93eb7 --- /dev/null +++ b/doc/files/getlightspecularcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the specular color of a light +
++ + + \ No newline at end of file diff --git a/doc/files/getlightspecularcolor.txt b/doc/files/getlightspecularcolor.txt new file mode 100644 index 0000000..85fcc57 --- /dev/null +++ b/doc/files/getlightspecularcolor.txt @@ -0,0 +1,4 @@ +#title GetLightSpecularColor [RCBasic Doc] +#header function GetLightSpecularColor( actor ) + +Returns the specular color of a light diff --git a/doc/files/getlighttype.html b/doc/files/getlighttype.html new file mode 100644 index 0000000..ba71148 --- /dev/null +++ b/doc/files/getlighttype.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns the type of light +
++ Returns -1 if it does not have a type (ie. its not a light) +
++ Possible Light Types +
+Related: + SetLightType +
+ + + \ No newline at end of file diff --git a/doc/files/getlighttype.txt b/doc/files/getlighttype.txt new file mode 100644 index 0000000..3b1e91b --- /dev/null +++ b/doc/files/getlighttype.txt @@ -0,0 +1,15 @@ +#title GetLightType [RCBasic Doc] +#header function GetLightType( actor ) + +Returns the type of light + +Returns -1 if it does not have a type (ie. its not a light) + +Possible Light Types +#list ul +#li LIGHT_TYPE_POINT +#li LIGHT_TYPE_DIRECTIONAL +#li LIGHT_TYPE_SPOT +#/light + +#ref SetLightType diff --git a/doc/files/getlineintersection.html b/doc/files/getlineintersection.html new file mode 100644 index 0000000..6aa0219 --- /dev/null +++ b/doc/files/getlineintersection.html @@ -0,0 +1,20 @@ + + + + + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/getlineintersection.txt b/doc/files/getlineintersection.txt new file mode 100644 index 0000000..2de427b --- /dev/null +++ b/doc/files/getlineintersection.txt @@ -0,0 +1,6 @@ +#title GetLineIntersection [RCBasic Doc] +#header Function GetLineIntersection(p0_x, p0_y, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, ByRef i_x, ByRef i_y) + +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.html b/doc/files/getlineplaneintersection.html new file mode 100644 index 0000000..b8e52c2 --- /dev/null +++ b/doc/files/getlineplaneintersection.html @@ -0,0 +1,40 @@ + + +
+ + ++ This function calculates the intersection between a line and a plane in 3D space and stores the result in intersection +
++ Parameters: +
++ Returns true if intersection point is on the plane +
++ + + \ No newline at end of file diff --git a/doc/files/getlineplaneintersection.txt b/doc/files/getlineplaneintersection.txt new file mode 100644 index 0000000..d929740 --- /dev/null +++ b/doc/files/getlineplaneintersection.txt @@ -0,0 +1,15 @@ +#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) + +This function calculates the intersection between a line and a plane in 3D space and stores the result in intersection + +Parameters: +#list ul +#li line_point - An array with an (x,y,z) point representing the start of a line +#li line_direction - An array with an (x,y,z) point representing another point on the line in the direction its moving +#li plane_point_1 - An array with an (x,y,z) point representing a point on a plane in 3D space +#li plane_point_2 - An array with an (x,y,z) point representing a point on a plane in 3D space +#li plane_point_3 - An array with an (x,y,z) point representing a point on a plane in 3D space +#/list + +Returns true if intersection point is on the plane diff --git a/doc/files/getmaterialambientcolor.html b/doc/files/getmaterialambientcolor.html new file mode 100644 index 0000000..6144f54 --- /dev/null +++ b/doc/files/getmaterialambientcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the ambient color of a material +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialambientcolor.txt b/doc/files/getmaterialambientcolor.txt new file mode 100644 index 0000000..2de78a6 --- /dev/null +++ b/doc/files/getmaterialambientcolor.txt @@ -0,0 +1,4 @@ +#title GetMaterialAmbientColor [RCBasic Doc] +#header function GetMaterialAmbientColor( material_id) + +Returns the ambient color of a material diff --git a/doc/files/getmaterialantialiasing.html b/doc/files/getmaterialantialiasing.html new file mode 100644 index 0000000..25a6797 --- /dev/null +++ b/doc/files/getmaterialantialiasing.html @@ -0,0 +1,46 @@ + + +
+ + ++ Returns the anti-aliasing mode for the material +
++ Possible modes returned +
+Related: + SetMaterialAntiAliasing +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialantialiasing.txt b/doc/files/getmaterialantialiasing.txt new file mode 100644 index 0000000..b847cd7 --- /dev/null +++ b/doc/files/getmaterialantialiasing.txt @@ -0,0 +1,17 @@ +#title GetMaterialAntiAliasing [RCBasic Doc] +#header function GetMaterialAntiAliasing( material_id) + +Returns the anti-aliasing mode for the material + +Possible modes returned +#list +#li AA_MODE_OFF=0, +#li AA_MODE_SIMPLE=1, +#li AA_MODE_QUALITY=3, +#li AA_MODE_LINE_SMOOTH=4, +#li AA_MODE_POINT_SMOOTH=8, +#li AA_MODE_FULL_BASIC=15, +#li AA_MODE_ALPHA_TO_COVERAGE=16 +#/list + +#ref SetMaterialAntiAliasing diff --git a/doc/files/getmaterialbackfaceculling.html b/doc/files/getmaterialbackfaceculling.html new file mode 100644 index 0000000..98557db --- /dev/null +++ b/doc/files/getmaterialbackfaceculling.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if backface culling is enabled for a material +
+Related: + SetMaterialBackfaceCulling +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialbackfaceculling.txt b/doc/files/getmaterialbackfaceculling.txt new file mode 100644 index 0000000..ac49cc4 --- /dev/null +++ b/doc/files/getmaterialbackfaceculling.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getmaterialblendfactor.html new file mode 100644 index 0000000..f214b39 --- /dev/null +++ b/doc/files/getmaterialblendfactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a materials blend factor +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialblendfactor.txt b/doc/files/getmaterialblendfactor.txt new file mode 100644 index 0000000..11e4ee6 --- /dev/null +++ b/doc/files/getmaterialblendfactor.txt @@ -0,0 +1,7 @@ +#title getMaterialBlendFactor [RCBasic Doc] +#header function getMaterialBlendFactor( material_id) + +Returns a materials blend factor + + + diff --git a/doc/files/getmaterialblendmode.html b/doc/files/getmaterialblendmode.html new file mode 100644 index 0000000..edc46e0 --- /dev/null +++ b/doc/files/getmaterialblendmode.html @@ -0,0 +1,55 @@ + + +
+ + ++ Returns a materials blend mode +
++ Possible Blend Modes +
+Related: + SetMaterialBlendMode +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialblendmode.txt b/doc/files/getmaterialblendmode.txt new file mode 100644 index 0000000..88bf52b --- /dev/null +++ b/doc/files/getmaterialblendmode.txt @@ -0,0 +1,20 @@ +#title getMaterialBlendMode [RCBasic Doc] +#header function getMaterialBlendMode( material_id) + +Returns a materials blend mode + +Possible Blend Modes +#list ul +#li BLEND_MODE_NONE +#li BLEND_MODE_ADD +#li BLEND_MODE_SUBTRACT +#li BLEND_MODE_REVSUBTRACT +#li BLEND_MODE_MIN +#li BLEND_MODE_MAX +#li BLEND_MODE_MIN_FACTOR +#li BLEND_MODE_MAX_FACTOR +#li BLEND_MODE_MIN_ALPHA +#li BLEND_MODE_MAX_ALPHA +#/list + +#ref SetMaterialBlendMode diff --git a/doc/files/getmaterialcolormask.html b/doc/files/getmaterialcolormask.html new file mode 100644 index 0000000..767551e --- /dev/null +++ b/doc/files/getmaterialcolormask.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the color mask for a material +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialcolormask.txt b/doc/files/getmaterialcolormask.txt new file mode 100644 index 0000000..b0eddc2 --- /dev/null +++ b/doc/files/getmaterialcolormask.txt @@ -0,0 +1,4 @@ +#title GetMaterialColorMask [RCBasic Doc] +#header function GetMaterialColorMask( material_id) + +Returns the color mask for a material diff --git a/doc/files/getmaterialcolormode.html b/doc/files/getmaterialcolormode.html new file mode 100644 index 0000000..614d3f2 --- /dev/null +++ b/doc/files/getmaterialcolormode.html @@ -0,0 +1,43 @@ + + +
+ + ++ Returns the color mode of a material +
++ Possible modes +
+Related: + SetMaterialColorMode +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialcolormode.txt b/doc/files/getmaterialcolormode.txt new file mode 100644 index 0000000..0f51fe2 --- /dev/null +++ b/doc/files/getmaterialcolormode.txt @@ -0,0 +1,16 @@ +#title getMaterialColorMode [RCBasic Doc] +#header function getMaterialColorMode( material_id) + +Returns the color mode of a material + +Possible modes +#list ul +#li COLOR_MODE_NONE +#li COLOR_MODE_DIFFUSE +#li COLOR_MODE_AMBIENT +#li COLOR_MODE_EMISSIVE +#li COLOR_MODE_SPECULAR +#li COLOR_MODE_DIFFUSE_AND_AMBIENT +#/list + +#ref SetMaterialColorMode diff --git a/doc/files/getmaterialdiffusecolor.html b/doc/files/getmaterialdiffusecolor.html new file mode 100644 index 0000000..188de37 --- /dev/null +++ b/doc/files/getmaterialdiffusecolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a material's diffuse color +
+Related: + SetMaterialDiffuseColor +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialdiffusecolor.txt b/doc/files/getmaterialdiffusecolor.txt new file mode 100644 index 0000000..7fb645d --- /dev/null +++ b/doc/files/getmaterialdiffusecolor.txt @@ -0,0 +1,6 @@ +#title getMaterialDiffuseColor [RCBasic Doc] +#header function getMaterialDiffuseColor( material_id) + +Returns a material's diffuse color + +#ref SetMaterialDiffuseColor diff --git a/doc/files/getmaterialemissivecolor.html b/doc/files/getmaterialemissivecolor.html new file mode 100644 index 0000000..e59c14c --- /dev/null +++ b/doc/files/getmaterialemissivecolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a material's emissive color +
+Related: + SetMaterialEmissiveColor +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialemissivecolor.txt b/doc/files/getmaterialemissivecolor.txt new file mode 100644 index 0000000..38cda17 --- /dev/null +++ b/doc/files/getmaterialemissivecolor.txt @@ -0,0 +1,6 @@ +#title getMaterialEmissiveColor [RCBasic Doc] +#header function getMaterialEmissiveColor( material_id) + +Returns a material's emissive color + +#ref SetMaterialEmissiveColor diff --git a/doc/files/getmaterialflag.html b/doc/files/getmaterialflag.html new file mode 100644 index 0000000..22433e0 --- /dev/null +++ b/doc/files/getmaterialflag.html @@ -0,0 +1,85 @@ + + +
+ + ++ Returns the value of the specified material flag +
++ Possible values for flag: +
+Related: + GetActorMaterialFlag +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialflag.txt b/doc/files/getmaterialflag.txt new file mode 100644 index 0000000..9760883 --- /dev/null +++ b/doc/files/getmaterialflag.txt @@ -0,0 +1,30 @@ +#title getMaterialFlag [RCBasic Doc] +#header function getMaterialFlag( material_id, material_flag) + +Returns the value of the specified material flag + +Possible values for flag: +#list +#li MATERIAL_FLAG_WIREFRAME +#li MATERIAL_FLAG_POINTCLOUD +#li MATERIAL_FLAG_GOURAUD_SHADING +#li MATERIAL_FLAG_LIGHTING +#li MATERIAL_FLAG_ZBUFFER +#li MATERIAL_FLAG_ZWRITE_ENABLE +#li MATERIAL_FLAG_BACK_FACE_CULLING +#li MATERIAL_FLAG_FRONT_FACE_CULLING +#li MATERIAL_FLAG_BILINEAR_FILTER +#li MATERIAL_FLAG_TRILINEAR_FILTER +#li MATERIAL_FLAG_ANISOTROPIC_FILTER +#li MATERIAL_FLAG_FOG_ENABLE +#li MATERIAL_FLAG_NORMALIZE_NORMALS +#li MATERIAL_FLAG_TEXTURE_WRAP +#li MATERIAL_FLAG_ANTI_ALIASING +#li MATERIAL_FLAG_COLOR_MASK +#li MATERIAL_FLAG_COLOR_MATERIAL +#li MATERIAL_FLAG_USE_MIP_MAPS +#li MATERIAL_FLAG_BLEND_OPERATION +#li MATERIAL_FLAG_POLYGON_OFFSET +#/list + +#ref GetActorMaterialFlag diff --git a/doc/files/getmaterialfog.html b/doc/files/getmaterialfog.html new file mode 100644 index 0000000..87ac07a --- /dev/null +++ b/doc/files/getmaterialfog.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if fog is enabled for a material +
+Related: + SetMaterialFog +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialfog.txt b/doc/files/getmaterialfog.txt new file mode 100644 index 0000000..0e7de18 --- /dev/null +++ b/doc/files/getmaterialfog.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getmaterialfrontfaceculling.html new file mode 100644 index 0000000..fbf6e1e --- /dev/null +++ b/doc/files/getmaterialfrontfaceculling.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if front face culling is enabled for a material +
+Related: + SetMaterialFrontfaceCulling +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialfrontfaceculling.txt b/doc/files/getmaterialfrontfaceculling.txt new file mode 100644 index 0000000..5efcf81 --- /dev/null +++ b/doc/files/getmaterialfrontfaceculling.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getmaterialshininess.html new file mode 100644 index 0000000..8e5dde5 --- /dev/null +++ b/doc/files/getmaterialshininess.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the shininess value for a material +
+Related: + SetMaterialShininess +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialshininess.txt b/doc/files/getmaterialshininess.txt new file mode 100644 index 0000000..976155a --- /dev/null +++ b/doc/files/getmaterialshininess.txt @@ -0,0 +1,6 @@ +#title getMaterialShininess [RCBasic Doc] +#header function getMaterialShininess( material_id) + +Returns the shininess value for a material + +#ref SetMaterialShininess diff --git a/doc/files/getmaterialspecularcolor.html b/doc/files/getmaterialspecularcolor.html new file mode 100644 index 0000000..6d226e5 --- /dev/null +++ b/doc/files/getmaterialspecularcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the specular color for a material +
+Related: + SetMaterialSpecularColor +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialspecularcolor.txt b/doc/files/getmaterialspecularcolor.txt new file mode 100644 index 0000000..4b85db8 --- /dev/null +++ b/doc/files/getmaterialspecularcolor.txt @@ -0,0 +1,6 @@ +#title getMaterialSpecularColor [RCBasic Doc] +#header function getMaterialSpecularColor( material_id) + +Returns the specular color for a material + +#ref SetMaterialSpecularColor diff --git a/doc/files/getmaterialthickness.html b/doc/files/getmaterialthickness.html new file mode 100644 index 0000000..107b84e --- /dev/null +++ b/doc/files/getmaterialthickness.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns a material's thickness value +
++ Thickness value is mainly for primitives such as lines +
+Related: + SetMaterialThickness +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialthickness.txt b/doc/files/getmaterialthickness.txt new file mode 100644 index 0000000..1725ccd --- /dev/null +++ b/doc/files/getmaterialthickness.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getmaterialtype.html new file mode 100644 index 0000000..b040404 --- /dev/null +++ b/doc/files/getmaterialtype.html @@ -0,0 +1,102 @@ + + +
+ + ++ Returns a material's type +
++ Possible types +
+Related: + SetMaterialType + GetActorMaterialType + SetActorMaterialType +
++ + + \ No newline at end of file diff --git a/doc/files/getmaterialtype.txt b/doc/files/getmaterialtype.txt new file mode 100644 index 0000000..53ee577 --- /dev/null +++ b/doc/files/getmaterialtype.txt @@ -0,0 +1,35 @@ +#title getMaterialType [RCBasic Doc] +#header function getMaterialType( material_id) + +Returns a material's type + +Possible types +#list ul +#li MATERIAL_TYPE_SOLID +#li MATERIAL_TYPE_SOLID_2_LAYER +#li MATERIAL_TYPE_LIGHTMAP +#li MATERIAL_TYPE_LIGHTMAP_ADD +#li MATERIAL_TYPE_LIGHTMAP_M2 +#li MATERIAL_TYPE_LIGHTMAP_M4 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M2 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M4 +#li MATERIAL_TYPE_DETAIL_MAP +#li MATERIAL_TYPE_SPHERE_MAP +#li MATERIAL_TYPE_REFLECTION_2_LAYER +#li MATERIAL_TYPE_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL_REF +#li MATERIAL_TYPE_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_TRANSPARENT_REFLECTION_2_LAYER +#li MATERIAL_TYPE_NORMAL_MAP_SOLID +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_PARALLAX_MAP_SOLID +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_ONETEXTURE_BLEND +#li MATERIAL_TYPE_FORCE_32BIT +#/list + +#ref SetMaterialType GetActorMaterialType SetActorMaterialType diff --git a/doc/files/getmatrixrotation.html b/doc/files/getmatrixrotation.html new file mode 100644 index 0000000..5ce7d7f --- /dev/null +++ b/doc/files/getmatrixrotation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the rotation vector of a matrix +
+Related: + SetMatrixRotation +
++ + + \ No newline at end of file diff --git a/doc/files/getmatrixrotation.txt b/doc/files/getmatrixrotation.txt new file mode 100644 index 0000000..d8ad74a --- /dev/null +++ b/doc/files/getmatrixrotation.txt @@ -0,0 +1,7 @@ +#title GetMatrixRotation [RCBasic Doc] +#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.html b/doc/files/getmatrixscale.html new file mode 100644 index 0000000..95ee4b4 --- /dev/null +++ b/doc/files/getmatrixscale.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the scale vector of a matrix +
+Related: + SetMatrixScale +
++ + + \ No newline at end of file diff --git a/doc/files/getmatrixscale.txt b/doc/files/getmatrixscale.txt new file mode 100644 index 0000000..f0125cc --- /dev/null +++ b/doc/files/getmatrixscale.txt @@ -0,0 +1,6 @@ +#title GetMatrixScale [RCBasic Doc] +#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.html b/doc/files/getmatrixsize.html new file mode 100644 index 0000000..b8eb6ac --- /dev/null +++ b/doc/files/getmatrixsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the number of rows and columns in a matrix +
+Related: + DimMatrix +
++ + + \ No newline at end of file diff --git a/doc/files/getmatrixsize.txt b/doc/files/getmatrixsize.txt new file mode 100644 index 0000000..2f4ad2e --- /dev/null +++ b/doc/files/getmatrixsize.txt @@ -0,0 +1,6 @@ +#title GetMatrixSize [RCBasic Doc] +#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.html b/doc/files/getmatrixtranslation.html new file mode 100644 index 0000000..19e3c65 --- /dev/null +++ b/doc/files/getmatrixtranslation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Get the position vector of a matrix +
+Related: + SetMatrixTranslation +
++ + + \ No newline at end of file diff --git a/doc/files/getmatrixtranslation.txt b/doc/files/getmatrixtranslation.txt new file mode 100644 index 0000000..66dbc20 --- /dev/null +++ b/doc/files/getmatrixtranslation.txt @@ -0,0 +1,6 @@ +#title GetMatrixTranslation [RCBasic Doc] +#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.html b/doc/files/getmaxparticlespersecond.html new file mode 100644 index 0000000..c6ede50 --- /dev/null +++ b/doc/files/getmaxparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the max number of particles emitted per second +
+Related: + SetMaxParticlesPerSecond + GetMinParticlesPerSecond + SetMinParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/files/getmaxparticlespersecond.txt b/doc/files/getmaxparticlespersecond.txt new file mode 100644 index 0000000..2958f6b --- /dev/null +++ b/doc/files/getmaxparticlespersecond.txt @@ -0,0 +1,6 @@ +#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/getminparticlespersecond.html b/doc/files/getminparticlespersecond.html new file mode 100644 index 0000000..3bd31f6 --- /dev/null +++ b/doc/files/getminparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Returns the min number of particles emitted per second +
+Related: + SetMinParticlesPerSecond + GetMaxParticlesPerSecond + SetMaxParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/files/getminparticlespersecond.txt b/doc/files/getminparticlespersecond.txt new file mode 100644 index 0000000..b751ae9 --- /dev/null +++ b/doc/files/getminparticlespersecond.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/getmouse.html new file mode 100644 index 0000000..ba9b9d8 --- /dev/null +++ b/doc/files/getmouse.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the mouse position and button state local to the graphics window +
+Related: + GetGlobalMouse + MouseX + MouseY + MouseButton +
++ + + \ No newline at end of file diff --git a/doc/files/getmouse.txt b/doc/files/getmouse.txt new file mode 100644 index 0000000..c0361f5 --- /dev/null +++ b/doc/files/getmouse.txt @@ -0,0 +1,6 @@ +#title GetMouse [RCBasic Doc] +#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.html b/doc/files/getmousewheel.html new file mode 100644 index 0000000..2d02a60 --- /dev/null +++ b/doc/files/getmousewheel.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the axis positions of the mouse wheel +
+Related: + GetMouse + GetGlobalMouse +
++ + + \ No newline at end of file diff --git a/doc/files/getmousewheel.txt b/doc/files/getmousewheel.txt new file mode 100644 index 0000000..5845da7 --- /dev/null +++ b/doc/files/getmousewheel.txt @@ -0,0 +1,6 @@ +#title GetMouseWheel [RCBasic Doc] +#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.html b/doc/files/getmultitouch.html new file mode 100644 index 0000000..6f75de2 --- /dev/null +++ b/doc/files/getmultitouch.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getmultitouch.txt b/doc/files/getmultitouch.txt new file mode 100644 index 0000000..5347b6a --- /dev/null +++ b/doc/files/getmultitouch.txt @@ -0,0 +1,4 @@ +#title GetMultiTouch [RCBasic Doc] +#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.html b/doc/files/getmusicposition.html new file mode 100644 index 0000000..8b65e66 --- /dev/null +++ b/doc/files/getmusicposition.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the position of the music track +
+Related: + SetMusicPosition +
++ + + \ No newline at end of file diff --git a/doc/files/getmusicposition.txt b/doc/files/getmusicposition.txt new file mode 100644 index 0000000..38c7b7b --- /dev/null +++ b/doc/files/getmusicposition.txt @@ -0,0 +1,6 @@ +#title GetMusicPosition [RCBasic Doc] +#header function GetMusicPosition() + +Returns the position of the music track + +#ref SetMusicPosition diff --git a/doc/files/getmusicvolume.html b/doc/files/getmusicvolume.html new file mode 100644 index 0000000..b0304d2 --- /dev/null +++ b/doc/files/getmusicvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the music track's volume +
++ + + \ No newline at end of file diff --git a/doc/files/getmusicvolume.txt b/doc/files/getmusicvolume.txt new file mode 100644 index 0000000..ec82d6e --- /dev/null +++ b/doc/files/getmusicvolume.txt @@ -0,0 +1,4 @@ +#title GetMusicVolume [RCBasic Doc] +#header function GetMusicVolume() + +Returns the music track's volume diff --git a/doc/files/getnuman8scenes.html b/doc/files/getnuman8scenes.html new file mode 100644 index 0000000..5ef92e1 --- /dev/null +++ b/doc/files/getnuman8scenes.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the number of scenes in an an8 project +
+Related: + LoadAN8 +
++ + + \ No newline at end of file diff --git a/doc/files/getnuman8scenes.txt b/doc/files/getnuman8scenes.txt new file mode 100644 index 0000000..bf95065 --- /dev/null +++ b/doc/files/getnuman8scenes.txt @@ -0,0 +1,6 @@ +#title GetNumAN8Scenes [RCBasic Doc] +#header Function GetNumAN8Scenes(an8_project) + +Returns the number of scenes in an an8 project + +#ref LoadAN8 diff --git a/doc/files/getparticlebox.html b/doc/files/getparticlebox.html new file mode 100644 index 0000000..fc6f273 --- /dev/null +++ b/doc/files/getparticlebox.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the bounding box for a particle emitter +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlebox.txt b/doc/files/getparticlebox.txt new file mode 100644 index 0000000..e72a599 --- /dev/null +++ b/doc/files/getparticlebox.txt @@ -0,0 +1,5 @@ +#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.html b/doc/files/getparticlecenter.html new file mode 100644 index 0000000..ad64feb --- /dev/null +++ b/doc/files/getparticlecenter.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the center of a particle emitter +
++ Note: applies to Sphere, Cylinder, and Ring emitters +
+Related: + SetParticleCenter +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlecenter.txt b/doc/files/getparticlecenter.txt new file mode 100644 index 0000000..4f9e9d8 --- /dev/null +++ b/doc/files/getparticlecenter.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticledirection.html new file mode 100644 index 0000000..b152366 --- /dev/null +++ b/doc/files/getparticledirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the direction of a particle emitter +
+Related: + SetParticleDirection +
++ + + \ No newline at end of file diff --git a/doc/files/getparticledirection.txt b/doc/files/getparticledirection.txt new file mode 100644 index 0000000..bfda3c8 --- /dev/null +++ b/doc/files/getparticledirection.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getparticlelength.html new file mode 100644 index 0000000..29c284e --- /dev/null +++ b/doc/files/getparticlelength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the length of a cylinder particle emitter +
++ Note: Only applies to cylinder particles +
+Related: + SetParticleLength +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlelength.txt b/doc/files/getparticlelength.txt new file mode 100644 index 0000000..9d8a82d --- /dev/null +++ b/doc/files/getparticlelength.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticlemaxangle.html new file mode 100644 index 0000000..205652e --- /dev/null +++ b/doc/files/getparticlemaxangle.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the max angle of particle emission +
+Related: + SetParticleMaxAngle +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlemaxangle.txt b/doc/files/getparticlemaxangle.txt new file mode 100644 index 0000000..d252a8e --- /dev/null +++ b/doc/files/getparticlemaxangle.txt @@ -0,0 +1,6 @@ +#title getParticleMaxAngle [RCBasic Doc] +#header function getParticleMaxAngle( actor) + +Returns the max angle of particle emission + +#ref SetParticleMaxAngle diff --git a/doc/files/getparticlemaxlife.html b/doc/files/getparticlemaxlife.html new file mode 100644 index 0000000..fd2813e --- /dev/null +++ b/doc/files/getparticlemaxlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the max life of the particle emission +
++ Note: Returned time is in milliseconds +
+Related: + SetParticleMaxLife +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlemaxlife.txt b/doc/files/getparticlemaxlife.txt new file mode 100644 index 0000000..dc6c069 --- /dev/null +++ b/doc/files/getparticlemaxlife.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticlemaxstartcolor.html new file mode 100644 index 0000000..b01a34e --- /dev/null +++ b/doc/files/getparticlemaxstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns max starting color for particles +
+Related: + SetParticleMaxStartColor +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlemaxstartcolor.txt b/doc/files/getparticlemaxstartcolor.txt new file mode 100644 index 0000000..0f66081 --- /dev/null +++ b/doc/files/getparticlemaxstartcolor.txt @@ -0,0 +1,6 @@ +#title getParticleMaxStartColor [RCBasic Doc] +#header function getParticleMaxStartColor( actor) + +Returns max starting color for particles + +#ref SetParticleMaxStartColor diff --git a/doc/files/getparticlemaxstartsize.html b/doc/files/getparticlemaxstartsize.html new file mode 100644 index 0000000..b368780 --- /dev/null +++ b/doc/files/getparticlemaxstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the max start size for the particles +
+Related: + SetParticleMaxStartSize +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlemaxstartsize.txt b/doc/files/getparticlemaxstartsize.txt new file mode 100644 index 0000000..778bf18 --- /dev/null +++ b/doc/files/getparticlemaxstartsize.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getparticleminlife.html new file mode 100644 index 0000000..00e0518 --- /dev/null +++ b/doc/files/getparticleminlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Get the min life of particles +
++ Note: Returned time is in milliseconds +
+Related: + SetParticleMinLife +
++ + + \ No newline at end of file diff --git a/doc/files/getparticleminlife.txt b/doc/files/getparticleminlife.txt new file mode 100644 index 0000000..f126098 --- /dev/null +++ b/doc/files/getparticleminlife.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticleminstartcolor.html new file mode 100644 index 0000000..005ef5b --- /dev/null +++ b/doc/files/getparticleminstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the min start color for particles +
+Related: + SetParticleMinStartColor +
++ + + \ No newline at end of file diff --git a/doc/files/getparticleminstartcolor.txt b/doc/files/getparticleminstartcolor.txt new file mode 100644 index 0000000..01ed65a --- /dev/null +++ b/doc/files/getparticleminstartcolor.txt @@ -0,0 +1,6 @@ +#title getParticleMinStartColor [RCBasic Doc] +#header function getParticleMinStartColor( actor) + +Returns the min start color for particles + +#ref SetParticleMinStartColor diff --git a/doc/files/getparticleminstartsize.html b/doc/files/getparticleminstartsize.html new file mode 100644 index 0000000..7a47a4d --- /dev/null +++ b/doc/files/getparticleminstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the min start size for particle emitter +
+Related: + SetParticleMinStartSize +
++ + + \ No newline at end of file diff --git a/doc/files/getparticleminstartsize.txt b/doc/files/getparticleminstartsize.txt new file mode 100644 index 0000000..aae8d9f --- /dev/null +++ b/doc/files/getparticleminstartsize.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getparticlenormal.html new file mode 100644 index 0000000..184b6ff --- /dev/null +++ b/doc/files/getparticlenormal.html @@ -0,0 +1,23 @@ + + +
+ + ++ Gets the normal of a particle emitter +
++ Note: Only applies to cylinder particle emitter +
+Related: + SetParticleNormal +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlenormal.txt b/doc/files/getparticlenormal.txt new file mode 100644 index 0000000..4e8cb4f --- /dev/null +++ b/doc/files/getparticlenormal.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticlenormaldirectionmod.html new file mode 100644 index 0000000..2c231af --- /dev/null +++ b/doc/files/getparticlenormaldirectionmod.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the normal direction modifier for a particle emitter +
++ Note: Only applies to mesh particle emitter +
+Related: + SetParticleNormalDirectionMod +
++ + + \ No newline at end of file diff --git a/doc/files/getparticlenormaldirectionmod.txt b/doc/files/getparticlenormaldirectionmod.txt new file mode 100644 index 0000000..c26062a --- /dev/null +++ b/doc/files/getparticlenormaldirectionmod.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticleradius.html new file mode 100644 index 0000000..5ecfe11 --- /dev/null +++ b/doc/files/getparticleradius.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the radius of a particle emitter +
++ Note: Only applies to Sphere, Cylinder, and Ring emitters +
+Related: + SetParticleRadius +
++ + + \ No newline at end of file diff --git a/doc/files/getparticleradius.txt b/doc/files/getparticleradius.txt new file mode 100644 index 0000000..f64d1ff --- /dev/null +++ b/doc/files/getparticleradius.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticleringthickness.html new file mode 100644 index 0000000..78d32ba --- /dev/null +++ b/doc/files/getparticleringthickness.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the thickness of a ring emitter +
++ Note: Only applies to ring emitter +
+Related: + SetParticleRingThickness +
++ + + \ No newline at end of file diff --git a/doc/files/getparticleringthickness.txt b/doc/files/getparticleringthickness.txt new file mode 100644 index 0000000..08d6d54 --- /dev/null +++ b/doc/files/getparticleringthickness.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getparticletype.html new file mode 100644 index 0000000..f71720c --- /dev/null +++ b/doc/files/getparticletype.html @@ -0,0 +1,43 @@ + + +
+ + ++ Returns the particle type +
++ Possible Particle Types +
+Related: + CreateParticleActor +
++ + + \ No newline at end of file diff --git a/doc/files/getparticletype.txt b/doc/files/getparticletype.txt new file mode 100644 index 0000000..e93a373 --- /dev/null +++ b/doc/files/getparticletype.txt @@ -0,0 +1,16 @@ +#title getParticleType [RCBasic Doc] +#header function getParticleType( actor ) + +Returns the particle type + +Possible Particle Types +#list ul +#li PARTICLE_TYPE_POINT +#li PARTICLE_TYPE_BOX +#li PARTICLE_TYPE_SPHERE +#li PARTICLE_TYPE_CYLINDER +#li PARTICLE_TYPE_MESH +#li PARTICLE_TYPE_RING +#/list + +#ref CreateParticleActor diff --git a/doc/files/getpixel.html b/doc/files/getpixel.html new file mode 100644 index 0000000..5c0a75e --- /dev/null +++ b/doc/files/getpixel.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the color of a pixel +
++ + + \ No newline at end of file diff --git a/doc/files/getpixel.txt b/doc/files/getpixel.txt new file mode 100644 index 0000000..04537fe --- /dev/null +++ b/doc/files/getpixel.txt @@ -0,0 +1,4 @@ +#title GetPixel [RCBasic Doc] +#header function GetPixel(x,y) + +Returns the color of a pixel diff --git a/doc/files/getpointpivota.html b/doc/files/getpointpivota.html new file mode 100644 index 0000000..667a691 --- /dev/null +++ b/doc/files/getpointpivota.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotB + SetPointPivotA +
++ + + \ No newline at end of file diff --git a/doc/files/getpointpivota.txt b/doc/files/getpointpivota.txt new file mode 100644 index 0000000..33f0bae --- /dev/null +++ b/doc/files/getpointpivota.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getpointpivotb.html new file mode 100644 index 0000000..798eae4 --- /dev/null +++ b/doc/files/getpointpivotb.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotA + SetPointPivotB +
++ + + \ No newline at end of file diff --git a/doc/files/getpointpivotb.txt b/doc/files/getpointpivotb.txt new file mode 100644 index 0000000..1d82a00 --- /dev/null +++ b/doc/files/getpointpivotb.txt @@ -0,0 +1,7 @@ +#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/getpowerinfo.html b/doc/files/getpowerinfo.html new file mode 100644 index 0000000..564f0e6 --- /dev/null +++ b/doc/files/getpowerinfo.html @@ -0,0 +1,40 @@ + + +
+ + ++ Gets the charging status of the device the program is running on. +
++ status - the charging status of the battery. Look below for the different statuses that can be returned. secs - the approximate time in seconds until the battery looses its charge. pct - the percentage of the battery charged. +
++ Possible Statuses +
++ + + \ No newline at end of file diff --git a/doc/files/getpowerinfo.txt b/doc/files/getpowerinfo.txt new file mode 100644 index 0000000..015951e --- /dev/null +++ b/doc/files/getpowerinfo.txt @@ -0,0 +1,17 @@ +#title GetPowerInfo [RCBasic Doc] +#header Sub GetPowerInfo(ByRef status, ByRef secs, ByRef pct) + +Gets the charging status of the device the program is running on. + +status - the charging status of the battery. Look below for the different statuses that can be returned. +secs - the approximate time in seconds until the battery looses its charge. +pct - the percentage of the battery charged. + +Possible Statuses +#list ul +#li POWERSTATE_UNKNOWN +#li POWERSTATE_ON_BATTERY +#li POWERSTATE_NO_BATTERY +#li POWERSTATE_CHARGING +#li POWERSTATE_CHARGED +#/list diff --git a/doc/files/getprojectionmatrix.html b/doc/files/getprojectionmatrix.html new file mode 100644 index 0000000..e81eb1c --- /dev/null +++ b/doc/files/getprojectionmatrix.html @@ -0,0 +1,31 @@ + + +
+ + ++ Gets the camera projection matrix for the active canvas +
++ Possible values for projection_type +
+Related: + SetProjectionMatrix +
++ + + \ No newline at end of file diff --git a/doc/files/getprojectionmatrix.txt b/doc/files/getprojectionmatrix.txt new file mode 100644 index 0000000..52703a6 --- /dev/null +++ b/doc/files/getprojectionmatrix.txt @@ -0,0 +1,12 @@ +#title GetProjectionMatrix [RCBasic Doc] +#header Sub GetProjectionMatrix(matA) + +Gets 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 SetProjectionMatrix diff --git a/doc/files/getrayhit2d.html b/doc/files/getrayhit2d.html new file mode 100644 index 0000000..a3cd111 --- /dev/null +++ b/doc/files/getrayhit2d.html @@ -0,0 +1,35 @@ + + +
+ + ++ This function will get the collision point and the normal of a ray hit. +
++ NOTES: +
+Related: + GetRayHit3D + CastRay3D + CastRay3D_All + CastRay2D + CastRay2D_All +
++ + + \ No newline at end of file diff --git a/doc/files/getrayhit2d.txt b/doc/files/getrayhit2d.txt new file mode 100644 index 0000000..19fae36 --- /dev/null +++ b/doc/files/getrayhit2d.txt @@ -0,0 +1,12 @@ +#title GetRayHit2D [RCBasic Doc] +#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. + +NOTES: +#list ul +#li CastRay2D or CastRay2D_All must be called prior to calling this function +#li spr_id will return -1 if there was not a hit at the specified index +#/list + +#ref GetRayHit3D CastRay3D CastRay3D_All CastRay2D CastRay2D_All diff --git a/doc/files/getrayhit3d.html b/doc/files/getrayhit3d.html new file mode 100644 index 0000000..83d13c6 --- /dev/null +++ b/doc/files/getrayhit3d.html @@ -0,0 +1,35 @@ + + +
+ + ++ This function will get the collision point and the normal of a ray hit. +
++ NOTES: +
+Related: + CastRay3D + CastRay3D_All + CastRay2D + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/getrayhit3d.txt b/doc/files/getrayhit3d.txt new file mode 100644 index 0000000..74fc46e --- /dev/null +++ b/doc/files/getrayhit3d.txt @@ -0,0 +1,12 @@ +#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 ) + +This function will get the collision point and the normal of a ray hit. + +NOTES: +#list ul +#li CastRay3D or CastRay3D_All must be called prior to calling this function +#li actor_id will return -1 if there was not a hit at the specified index +#/list + +#ref CastRay3D CastRay3D_All CastRay2D CastRay2D_All GetRayHit2D diff --git a/doc/files/getscenefog.html b/doc/files/getscenefog.html new file mode 100644 index 0000000..14080f8 --- /dev/null +++ b/doc/files/getscenefog.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/getscenefog.txt b/doc/files/getscenefog.txt new file mode 100644 index 0000000..cf2897d --- /dev/null +++ b/doc/files/getscenefog.txt @@ -0,0 +1,4 @@ +#title GetSceneFog [RCBasic Doc] +#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/getslideanchora.html b/doc/files/getslideanchora.html new file mode 100644 index 0000000..fde1430 --- /dev/null +++ b/doc/files/getslideanchora.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideAnchorB +
++ + + \ No newline at end of file diff --git a/doc/files/getslideanchora.txt b/doc/files/getslideanchora.txt new file mode 100644 index 0000000..26eee73 --- /dev/null +++ b/doc/files/getslideanchora.txt @@ -0,0 +1,6 @@ +#title GetSlideAnchorA [RCBasic Doc] +#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.html b/doc/files/getslideanchorb.html new file mode 100644 index 0000000..0ead8a9 --- /dev/null +++ b/doc/files/getslideanchorb.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideAnchorA +
++ + + \ No newline at end of file diff --git a/doc/files/getslideanchorb.txt b/doc/files/getslideanchorb.txt new file mode 100644 index 0000000..a89932e --- /dev/null +++ b/doc/files/getslideanchorb.txt @@ -0,0 +1,7 @@ +#title GetSlideAnchorB [RCBasic Doc] +#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.html b/doc/files/getslideangdepth.html new file mode 100644 index 0000000..2694e72 --- /dev/null +++ b/doc/files/getslideangdepth.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getslideangdepth.txt b/doc/files/getslideangdepth.txt new file mode 100644 index 0000000..004427f --- /dev/null +++ b/doc/files/getslideangdepth.txt @@ -0,0 +1,4 @@ +#title GetSlideAngDepth [RCBasic Doc] +#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.html b/doc/files/getslideangularpos.html new file mode 100644 index 0000000..e9a63cb --- /dev/null +++ b/doc/files/getslideangularpos.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getslideangularpos.txt b/doc/files/getslideangularpos.txt new file mode 100644 index 0000000..29a8140 --- /dev/null +++ b/doc/files/getslideangularpos.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getslidedampingdirang.html new file mode 100644 index 0000000..2b14798 --- /dev/null +++ b/doc/files/getslidedampingdirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingDirAng +
++ + + \ No newline at end of file diff --git a/doc/files/getslidedampingdirang.txt b/doc/files/getslidedampingdirang.txt new file mode 100644 index 0000000..54f13c8 --- /dev/null +++ b/doc/files/getslidedampingdirang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getslidedampingdirlin.html new file mode 100644 index 0000000..6845718 --- /dev/null +++ b/doc/files/getslidedampingdirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingDirLin +
++ + + \ No newline at end of file diff --git a/doc/files/getslidedampingdirlin.txt b/doc/files/getslidedampingdirlin.txt new file mode 100644 index 0000000..8092032 --- /dev/null +++ b/doc/files/getslidedampingdirlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getslidedampinglimang.html new file mode 100644 index 0000000..0c27759 --- /dev/null +++ b/doc/files/getslidedampinglimang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + SetSlideDampingLimAng +
++ + + \ No newline at end of file diff --git a/doc/files/getslidedampinglimang.txt b/doc/files/getslidedampinglimang.txt new file mode 100644 index 0000000..f839a2b --- /dev/null +++ b/doc/files/getslidedampinglimang.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/getslidedampinglimlin.html new file mode 100644 index 0000000..bbb8c85 --- /dev/null +++ b/doc/files/getslidedampinglimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingLimLin +
++ + + \ No newline at end of file diff --git a/doc/files/getslidedampinglimlin.txt b/doc/files/getslidedampinglimlin.txt new file mode 100644 index 0000000..9dad93d --- /dev/null +++ b/doc/files/getslidedampinglimlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getslidedampingorthoang.html new file mode 100644 index 0000000..53ea0f7 --- /dev/null +++ b/doc/files/getslidedampingorthoang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + SetSlideDampingOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/files/getslidedampingorthoang.txt b/doc/files/getslidedampingorthoang.txt new file mode 100644 index 0000000..9bea570 --- /dev/null +++ b/doc/files/getslidedampingorthoang.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslidedampingortholin.html new file mode 100644 index 0000000..8a15024 --- /dev/null +++ b/doc/files/getslidedampingortholin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetSlideDampingOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/files/getslidedampingortholin.txt b/doc/files/getslidedampingortholin.txt new file mode 100644 index 0000000..c9506cb --- /dev/null +++ b/doc/files/getslidedampingortholin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getslidelindepth.html new file mode 100644 index 0000000..19ae897 --- /dev/null +++ b/doc/files/getslidelindepth.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidelindepth.txt b/doc/files/getslidelindepth.txt new file mode 100644 index 0000000..7fba322 --- /dev/null +++ b/doc/files/getslidelindepth.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslidelinearpos.html new file mode 100644 index 0000000..73bafbc --- /dev/null +++ b/doc/files/getslidelinearpos.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidelinearpos.txt b/doc/files/getslidelinearpos.txt new file mode 100644 index 0000000..f20b0ae --- /dev/null +++ b/doc/files/getslidelinearpos.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslideloweranglimit.html new file mode 100644 index 0000000..8041fbc --- /dev/null +++ b/doc/files/getslideloweranglimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideLowerLinLimit +
++ + + \ No newline at end of file diff --git a/doc/files/getslideloweranglimit.txt b/doc/files/getslideloweranglimit.txt new file mode 100644 index 0000000..5fe004d --- /dev/null +++ b/doc/files/getslideloweranglimit.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getslidelowerlinlimit.html new file mode 100644 index 0000000..573ec02 --- /dev/null +++ b/doc/files/getslidelowerlinlimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideLowerLinLimit +
++ + + \ No newline at end of file diff --git a/doc/files/getslidelowerlinlimit.txt b/doc/files/getslidelowerlinlimit.txt new file mode 100644 index 0000000..9a6d38e --- /dev/null +++ b/doc/files/getslidelowerlinlimit.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getsliderestitutiondirang.html new file mode 100644 index 0000000..9976925 --- /dev/null +++ b/doc/files/getsliderestitutiondirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideRestitutionDirAng +
++ + + \ No newline at end of file diff --git a/doc/files/getsliderestitutiondirang.txt b/doc/files/getsliderestitutiondirang.txt new file mode 100644 index 0000000..c51de77 --- /dev/null +++ b/doc/files/getsliderestitutiondirang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getsliderestitutiondirlin.html new file mode 100644 index 0000000..ad8dd51 --- /dev/null +++ b/doc/files/getsliderestitutiondirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideRestitutionDirLin +
++ + + \ No newline at end of file diff --git a/doc/files/getsliderestitutiondirlin.txt b/doc/files/getsliderestitutiondirlin.txt new file mode 100644 index 0000000..de1e80b --- /dev/null +++ b/doc/files/getsliderestitutiondirlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getsliderestitutionlimang.html new file mode 100644 index 0000000..7348673 --- /dev/null +++ b/doc/files/getsliderestitutionlimang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + SetSlideRestitutionLimAng +
++ + + \ No newline at end of file diff --git a/doc/files/getsliderestitutionlimang.txt b/doc/files/getsliderestitutionlimang.txt new file mode 100644 index 0000000..6c3e28a --- /dev/null +++ b/doc/files/getsliderestitutionlimang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getsliderestitutionlimlin.html new file mode 100644 index 0000000..78ff5fd --- /dev/null +++ b/doc/files/getsliderestitutionlimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + SetSlideRestitutionLimLin +
++ + + \ No newline at end of file diff --git a/doc/files/getsliderestitutionlimlin.txt b/doc/files/getsliderestitutionlimlin.txt new file mode 100644 index 0000000..71bedcc --- /dev/null +++ b/doc/files/getsliderestitutionlimlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/getsliderestitutionorthoang.html new file mode 100644 index 0000000..7786ea3 --- /dev/null +++ b/doc/files/getsliderestitutionorthoang.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Angular Motion: In the context of a slider constraint, orthogonal angular motion refers to rotational movement around axes that are perpendicular to the slider's main movement axis. +
++ 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. +
+Related: + SetSlideRestitutionOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/files/getsliderestitutionorthoang.txt b/doc/files/getsliderestitutionorthoang.txt new file mode 100644 index 0000000..f10828c --- /dev/null +++ b/doc/files/getsliderestitutionorthoang.txt @@ -0,0 +1,10 @@ +#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. + +Orthogonal Angular Motion: In the context of a slider constraint, orthogonal angular motion refers to rotational movement around axes that are perpendicular to the slider's main movement axis. + +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.html b/doc/files/getsliderestitutionortholin.html new file mode 100644 index 0000000..3d4d2f7 --- /dev/null +++ b/doc/files/getsliderestitutionortholin.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Linear Motion: In the context of a slider constraint, orthogonal linear motion refers to translational movement along axes that are perpendicular to the main sliding axis of the constraint. +
++ 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. +
+Related: + SetSlideRestitutionOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/files/getsliderestitutionortholin.txt b/doc/files/getsliderestitutionortholin.txt new file mode 100644 index 0000000..5f04fc6 --- /dev/null +++ b/doc/files/getsliderestitutionortholin.txt @@ -0,0 +1,10 @@ +#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. + +Orthogonal Linear Motion: In the context of a slider constraint, orthogonal linear motion refers to translational movement along axes that are perpendicular to the main sliding axis of the constraint. + +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.html b/doc/files/getslidesoftnessdirang.html new file mode 100644 index 0000000..da6acd2 --- /dev/null +++ b/doc/files/getslidesoftnessdirang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidesoftnessdirang.txt b/doc/files/getslidesoftnessdirang.txt new file mode 100644 index 0000000..13fc4aa --- /dev/null +++ b/doc/files/getslidesoftnessdirang.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/getslidesoftnessdirlin.html new file mode 100644 index 0000000..b829876 --- /dev/null +++ b/doc/files/getslidesoftnessdirlin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidesoftnessdirlin.txt b/doc/files/getslidesoftnessdirlin.txt new file mode 100644 index 0000000..0e2d685 --- /dev/null +++ b/doc/files/getslidesoftnessdirlin.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslidesoftnesslimang.html new file mode 100644 index 0000000..b1599c0 --- /dev/null +++ b/doc/files/getslidesoftnesslimang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidesoftnesslimang.txt b/doc/files/getslidesoftnesslimang.txt new file mode 100644 index 0000000..0f7f6bc --- /dev/null +++ b/doc/files/getslidesoftnesslimang.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslidesoftnesslimlin.html new file mode 100644 index 0000000..7f57e4e --- /dev/null +++ b/doc/files/getslidesoftnesslimlin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidesoftnesslimlin.txt b/doc/files/getslidesoftnesslimlin.txt new file mode 100644 index 0000000..f4c4311 --- /dev/null +++ b/doc/files/getslidesoftnesslimlin.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslidesoftnessorthoang.html new file mode 100644 index 0000000..1907905 --- /dev/null +++ b/doc/files/getslidesoftnessorthoang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidesoftnessorthoang.txt b/doc/files/getslidesoftnessorthoang.txt new file mode 100644 index 0000000..5b05e05 --- /dev/null +++ b/doc/files/getslidesoftnessorthoang.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslidesoftnessortholin.html new file mode 100644 index 0000000..e56808a --- /dev/null +++ b/doc/files/getslidesoftnessortholin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslidesoftnessortholin.txt b/doc/files/getslidesoftnessortholin.txt new file mode 100644 index 0000000..b6ea51a --- /dev/null +++ b/doc/files/getslidesoftnessortholin.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslidesolveanglimit.html new file mode 100644 index 0000000..9e15f17 --- /dev/null +++ b/doc/files/getslidesolveanglimit.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getslidesolveanglimit.txt b/doc/files/getslidesolveanglimit.txt new file mode 100644 index 0000000..6e5a1b9 --- /dev/null +++ b/doc/files/getslidesolveanglimit.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getslidesolvelinlimit.html new file mode 100644 index 0000000..475fa51 --- /dev/null +++ b/doc/files/getslidesolvelinlimit.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getslidesolvelinlimit.txt b/doc/files/getslidesolvelinlimit.txt new file mode 100644 index 0000000..0a5d15f --- /dev/null +++ b/doc/files/getslidesolvelinlimit.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getslideupperanglimit.html new file mode 100644 index 0000000..00e8be0 --- /dev/null +++ b/doc/files/getslideupperanglimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslideupperanglimit.txt b/doc/files/getslideupperanglimit.txt new file mode 100644 index 0000000..7fec7a9 --- /dev/null +++ b/doc/files/getslideupperanglimit.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslideupperlinlimit.html new file mode 100644 index 0000000..d818381 --- /dev/null +++ b/doc/files/getslideupperlinlimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/getslideupperlinlimit.txt b/doc/files/getslideupperlinlimit.txt new file mode 100644 index 0000000..6585f0b --- /dev/null +++ b/doc/files/getslideupperlinlimit.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getslideuseframeoffset.html new file mode 100644 index 0000000..ca7d288 --- /dev/null +++ b/doc/files/getslideuseframeoffset.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getslideuseframeoffset.txt b/doc/files/getslideuseframeoffset.txt new file mode 100644 index 0000000..0f1469a --- /dev/null +++ b/doc/files/getslideuseframeoffset.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getsoundvolume.html new file mode 100644 index 0000000..5b57123 --- /dev/null +++ b/doc/files/getsoundvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the given sounds volume. +
++ + + \ No newline at end of file diff --git a/doc/files/getsoundvolume.txt b/doc/files/getsoundvolume.txt new file mode 100644 index 0000000..8f1a716 --- /dev/null +++ b/doc/files/getsoundvolume.txt @@ -0,0 +1,4 @@ +#title GetSoundVolume [RCBasic Doc] +#header function GetSoundVolume(slot) + +Returns the given sounds volume. diff --git a/doc/files/getspriteaabb.html b/doc/files/getspriteaabb.html new file mode 100644 index 0000000..cf0e4b6 --- /dev/null +++ b/doc/files/getspriteaabb.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the axis aligned bounding box for a sprite +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteaabb.txt b/doc/files/getspriteaabb.txt new file mode 100644 index 0000000..82854ad --- /dev/null +++ b/doc/files/getspriteaabb.txt @@ -0,0 +1,4 @@ +#title GetSpriteAABB [RCBasic Doc] +#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/getspriteangulardamping.html b/doc/files/getspriteangulardamping.html new file mode 100644 index 0000000..5f162b7 --- /dev/null +++ b/doc/files/getspriteangulardamping.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a sprite's angular damping +
+Related: + ApplySpriteAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteangulardamping.txt b/doc/files/getspriteangulardamping.txt new file mode 100644 index 0000000..c11cd26 --- /dev/null +++ b/doc/files/getspriteangulardamping.txt @@ -0,0 +1,6 @@ +#title getSpriteAngularDamping [RCBasic Doc] +#header function getSpriteAngularDamping( spr_id) + +Returns a sprite's angular damping + +#ref ApplySpriteAngularDamping diff --git a/doc/files/getspriteangularvelocity.html b/doc/files/getspriteangularvelocity.html new file mode 100644 index 0000000..86ff4b9 --- /dev/null +++ b/doc/files/getspriteangularvelocity.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the angular velocity +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteangularvelocity.txt b/doc/files/getspriteangularvelocity.txt new file mode 100644 index 0000000..643b107 --- /dev/null +++ b/doc/files/getspriteangularvelocity.txt @@ -0,0 +1,4 @@ +#title getSpriteAngularVelocity [RCBasic Doc] +#header function getSpriteAngularVelocity( spr_id) + +Returns the angular velocity diff --git a/doc/files/getspriteanimation.html b/doc/files/getspriteanimation.html new file mode 100644 index 0000000..0c2f637 --- /dev/null +++ b/doc/files/getspriteanimation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the current animation set on a sprite +
+Related: + SetSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteanimation.txt b/doc/files/getspriteanimation.txt new file mode 100644 index 0000000..f1b0da7 --- /dev/null +++ b/doc/files/getspriteanimation.txt @@ -0,0 +1,6 @@ +#title GetSpriteAnimation [RCBasic Doc] +#header Function GetSpriteAnimation(sprite) + +Returns the current animation set on a sprite + +#ref SetSpriteAnimation diff --git a/doc/files/getspriteanimationframe.html b/doc/files/getspriteanimationframe.html new file mode 100644 index 0000000..dcdb858 --- /dev/null +++ b/doc/files/getspriteanimationframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getspriteanimationframe.txt b/doc/files/getspriteanimationframe.txt new file mode 100644 index 0000000..35d0222 --- /dev/null +++ b/doc/files/getspriteanimationframe.txt @@ -0,0 +1,4 @@ +#title GetSpriteAnimationFrame [RCBasic Doc] +#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.html b/doc/files/getspriteanimationlength.html new file mode 100644 index 0000000..8e52551 --- /dev/null +++ b/doc/files/getspriteanimationlength.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of frames in a sprite animation +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteanimationlength.txt b/doc/files/getspriteanimationlength.txt new file mode 100644 index 0000000..9e1a1c3 --- /dev/null +++ b/doc/files/getspriteanimationlength.txt @@ -0,0 +1,4 @@ +#title GetSpriteAnimationLength [RCBasic Doc] +#header Function GetSpriteAnimationLength(sprite, animation) + +Returns the number of frames in a sprite animation diff --git a/doc/files/getspriteanimationspeed.html b/doc/files/getspriteanimationspeed.html new file mode 100644 index 0000000..6da5421 --- /dev/null +++ b/doc/files/getspriteanimationspeed.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the frames per second of a sprite animation +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteanimationspeed.txt b/doc/files/getspriteanimationspeed.txt new file mode 100644 index 0000000..9a73237 --- /dev/null +++ b/doc/files/getspriteanimationspeed.txt @@ -0,0 +1,4 @@ +#title GetSpriteAnimationSpeed [RCBasic Doc] +#header Function GetSpriteAnimationSpeed(sprite, animation) + +Returns the frames per second of a sprite animation diff --git a/doc/files/getspritecenter.html b/doc/files/getspritecenter.html new file mode 100644 index 0000000..4b15521 --- /dev/null +++ b/doc/files/getspritecenter.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a sprites center of mass +
++ + + \ No newline at end of file diff --git a/doc/files/getspritecenter.txt b/doc/files/getspritecenter.txt new file mode 100644 index 0000000..435fadd --- /dev/null +++ b/doc/files/getspritecenter.txt @@ -0,0 +1,4 @@ +#title getSpriteCenter [RCBasic Doc] +#header sub getSpriteCenter( spr_id, ByRef x, ByRef y) + +Returns a sprites center of mass diff --git a/doc/files/getspritecurrentanimationframe.html b/doc/files/getspritecurrentanimationframe.html new file mode 100644 index 0000000..db7b998 --- /dev/null +++ b/doc/files/getspritecurrentanimationframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current frame of a sprite's animation +
++ + + \ No newline at end of file diff --git a/doc/files/getspritecurrentanimationframe.txt b/doc/files/getspritecurrentanimationframe.txt new file mode 100644 index 0000000..ab019af --- /dev/null +++ b/doc/files/getspritecurrentanimationframe.txt @@ -0,0 +1,4 @@ +#title GetSpriteCurrentAnimationFrame [RCBasic Doc] +#header Function GetSpriteCurrentAnimationFrame(sprite) + +Returns the current frame of a sprite's animation diff --git a/doc/files/getspritedensity.html b/doc/files/getspritedensity.html new file mode 100644 index 0000000..5453506 --- /dev/null +++ b/doc/files/getspritedensity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the density of a sprite. Higher density means a heavier sprite. +
+Related: + SetSpriteDensity +
++ + + \ No newline at end of file diff --git a/doc/files/getspritedensity.txt b/doc/files/getspritedensity.txt new file mode 100644 index 0000000..6fb67c7 --- /dev/null +++ b/doc/files/getspritedensity.txt @@ -0,0 +1,6 @@ +#title GetSpriteDensity [RCBasic Doc] +#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.html b/doc/files/getspriteframe.html new file mode 100644 index 0000000..32d375f --- /dev/null +++ b/doc/files/getspriteframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getspriteframe.txt b/doc/files/getspriteframe.txt new file mode 100644 index 0000000..18a3529 --- /dev/null +++ b/doc/files/getspriteframe.txt @@ -0,0 +1,4 @@ +#title GetSpriteFrame [RCBasic Doc] +#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.html b/doc/files/getspritefriction.html new file mode 100644 index 0000000..1c8b2dc --- /dev/null +++ b/doc/files/getspritefriction.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a sprite's friction +
+Related: + GetSpriteFriction +
++ + + \ No newline at end of file diff --git a/doc/files/getspritefriction.txt b/doc/files/getspritefriction.txt new file mode 100644 index 0000000..567f4a1 --- /dev/null +++ b/doc/files/getspritefriction.txt @@ -0,0 +1,7 @@ +#title GetSpriteFriction [RCBasic Doc] +#header function GetSpriteFriction( spr_id ) + +Returns a sprite's friction + +#ref GetSpriteFriction + diff --git a/doc/files/getspritegravityscale.html b/doc/files/getspritegravityscale.html new file mode 100644 index 0000000..6c5c398 --- /dev/null +++ b/doc/files/getspritegravityscale.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a sprite's gravity scale +
+Related: + SetSpriteGravityScale +
++ + + \ No newline at end of file diff --git a/doc/files/getspritegravityscale.txt b/doc/files/getspritegravityscale.txt new file mode 100644 index 0000000..d3c1edb --- /dev/null +++ b/doc/files/getspritegravityscale.txt @@ -0,0 +1,6 @@ +#title getSpriteGravityScale [RCBasic Doc] +#header function getSpriteGravityScale( spr_id) + +Returns a sprite's gravity scale + +#ref SetSpriteGravityScale diff --git a/doc/files/getspriteinertia.html b/doc/files/getspriteinertia.html new file mode 100644 index 0000000..eeb916f --- /dev/null +++ b/doc/files/getspriteinertia.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the rotational inertia of the body about the local origin. +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteinertia.txt b/doc/files/getspriteinertia.txt new file mode 100644 index 0000000..5dbc002 --- /dev/null +++ b/doc/files/getspriteinertia.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getspritelineardamping.html new file mode 100644 index 0000000..afe2642 --- /dev/null +++ b/doc/files/getspritelineardamping.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns a sprite's linear damping value +
+Related: + SetSpriteLinearDamping +
++ + + \ No newline at end of file diff --git a/doc/files/getspritelineardamping.txt b/doc/files/getspritelineardamping.txt new file mode 100644 index 0000000..2e7d8ff --- /dev/null +++ b/doc/files/getspritelineardamping.txt @@ -0,0 +1,6 @@ +#title getSpriteLinearDamping [RCBasic Doc] +#header function getSpriteLinearDamping( spr_id) + +Returns a sprite's linear damping value + +#ref SetSpriteLinearDamping diff --git a/doc/files/getspritelinearvelocity.html b/doc/files/getspritelinearvelocity.html new file mode 100644 index 0000000..f64f442 --- /dev/null +++ b/doc/files/getspritelinearvelocity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets the linear velocity of a sprite +
+Related: + SetSpriteLinearVelocity +
++ + + \ No newline at end of file diff --git a/doc/files/getspritelinearvelocity.txt b/doc/files/getspritelinearvelocity.txt new file mode 100644 index 0000000..6f95fbb --- /dev/null +++ b/doc/files/getspritelinearvelocity.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/getspritelinearvelocityfromlocalpoint.html new file mode 100644 index 0000000..06096bf --- /dev/null +++ b/doc/files/getspritelinearvelocityfromlocalpoint.html @@ -0,0 +1,17 @@ + + +
+ + ++ Get the world velocity of a local point. +
++ + + \ No newline at end of file diff --git a/doc/files/getspritelinearvelocityfromlocalpoint.txt b/doc/files/getspritelinearvelocityfromlocalpoint.txt new file mode 100644 index 0000000..1bc626e --- /dev/null +++ b/doc/files/getspritelinearvelocityfromlocalpoint.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getspritelinearvelocityfromworldpoint.html new file mode 100644 index 0000000..c1c7785 --- /dev/null +++ b/doc/files/getspritelinearvelocityfromworldpoint.html @@ -0,0 +1,17 @@ + + +
+ + ++ Get the world linear velocity of a world point attached to this body. +
++ + + \ No newline at end of file diff --git a/doc/files/getspritelinearvelocityfromworldpoint.txt b/doc/files/getspritelinearvelocityfromworldpoint.txt new file mode 100644 index 0000000..df9ba6e --- /dev/null +++ b/doc/files/getspritelinearvelocityfromworldpoint.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getspritelocalpoint.html new file mode 100644 index 0000000..73801d3 --- /dev/null +++ b/doc/files/getspritelocalpoint.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets a local point relative to the body's origin given a world point. +
++ + + \ No newline at end of file diff --git a/doc/files/getspritelocalpoint.txt b/doc/files/getspritelocalpoint.txt new file mode 100644 index 0000000..b217c77 --- /dev/null +++ b/doc/files/getspritelocalpoint.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getspritelocalvector.html new file mode 100644 index 0000000..65102dd --- /dev/null +++ b/doc/files/getspritelocalvector.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets a local vector given a world vector. +
++ + + \ No newline at end of file diff --git a/doc/files/getspritelocalvector.txt b/doc/files/getspritelocalvector.txt new file mode 100644 index 0000000..f2a4ad3 --- /dev/null +++ b/doc/files/getspritelocalvector.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getspritemass.html new file mode 100644 index 0000000..c008332 --- /dev/null +++ b/doc/files/getspritemass.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the total mass of the body. +
++ + + \ No newline at end of file diff --git a/doc/files/getspritemass.txt b/doc/files/getspritemass.txt new file mode 100644 index 0000000..90de127 --- /dev/null +++ b/doc/files/getspritemass.txt @@ -0,0 +1,4 @@ +#title getSpriteMass [RCBasic Doc] +#header function getSpriteMass( spr_id) + +Returns the total mass of the body. diff --git a/doc/files/getspriteposition.html b/doc/files/getspriteposition.html new file mode 100644 index 0000000..8c53d50 --- /dev/null +++ b/doc/files/getspriteposition.html @@ -0,0 +1,82 @@ + + +
+ + ++ Gets the position of a sprite on the canvas +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("GetSpritePosition", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeX 'Variables to pass into the function for holding the x and y values
+ DIM eyeY
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ destX = 0
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+
+ While Not Key(K_ESCAPE)
+ clearcanvas()
+ Canvas(sCanvas) 'change to the sprite canvas for drawing sprites
+ If SpriteX(eyeSprite) < 450 And destX = 0 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX + 0.5
+ ElseIf SpriteX(eyeSprite) >= 440 And destX = 0 Then
+ destX = 1
+ End If
+
+ If destX = 1 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX - 0.5
+ End If
+
+ GetSpritePosition(eyeSprite, eyeX, eyeY)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("Sprite X: " + STR$(eyeX), 10, 30)
+ DrawText("Sprite Y: " + STR$(eyeY), 10, 50)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + TranslateSprite + SetSpritePosition +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/getspriteposition.txt b/doc/files/getspriteposition.txt
new file mode 100644
index 0000000..d0063b9
--- /dev/null
+++ b/doc/files/getspriteposition.txt
@@ -0,0 +1,70 @@
+#title GetSpritePosition [RCBasic Doc]
+#header Sub GetSpritePosition(sprite, ByRef x, ByRef y)
+
+Gets the position of a sprite on the canvas
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("GetSpritePosition", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eyeX 'Variables to pass into the function for holding the x and y values
+DIM eyeY
+eyeSpriteX = 100
+eyeSpriteY = 100
+destX = 0
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+
+While Not Key(K_ESCAPE)
+clearcanvas()
+ Canvas(sCanvas) 'change to the sprite canvas for drawing sprites
+ If SpriteX(eyeSprite) < 450 And destX = 0 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX + 0.5
+ ElseIf SpriteX(eyeSprite) >= 440 And destX = 0 Then
+ destX = 1
+ End If
+
+ If destX = 1 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX - 0.5
+ End If
+
+ GetSpritePosition(eyeSprite, eyeX, eyeY)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("Sprite X: " + STR$(eyeX), 10, 30)
+ DrawText("Sprite Y: " + STR$(eyeY), 10, 50)
+
+ Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref TranslateSprite SetSpritePosition
diff --git a/doc/files/getspriterestitution.html b/doc/files/getspriterestitution.html
new file mode 100644
index 0000000..a1e2874
--- /dev/null
+++ b/doc/files/getspriterestitution.html
@@ -0,0 +1,20 @@
+
+
+
+ Returns the restitution coefficient for a sprite +
+Related: + SetSpriteRestitution +
++ + + \ No newline at end of file diff --git a/doc/files/getspriterestitution.txt b/doc/files/getspriterestitution.txt new file mode 100644 index 0000000..24abf7e --- /dev/null +++ b/doc/files/getspriterestitution.txt @@ -0,0 +1,6 @@ +#title GetSpriteRestitution [RCBasic Doc] +#header function GetSpriteRestitution( spr_id ) + +Returns the restitution coefficient for a sprite + +#ref SetSpriteRestitution diff --git a/doc/files/getspriterestitutionthreshold.html b/doc/files/getspriterestitutionthreshold.html new file mode 100644 index 0000000..db7b8c3 --- /dev/null +++ b/doc/files/getspriterestitutionthreshold.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the restitution velocity threshold for a sprite +
+Related: + SetSpriteRestitutionThreshold +
++ + + \ No newline at end of file diff --git a/doc/files/getspriterestitutionthreshold.txt b/doc/files/getspriterestitutionthreshold.txt new file mode 100644 index 0000000..a53a583 --- /dev/null +++ b/doc/files/getspriterestitutionthreshold.txt @@ -0,0 +1,6 @@ +#title GetSpriteRestitutionThreshold [RCBasic Doc] +#header function GetSpriteRestitutionThreshold( spr_id ) + +Returns the restitution velocity threshold for a sprite + +#ref SetSpriteRestitutionThreshold diff --git a/doc/files/getspriterotation.html b/doc/files/getspriterotation.html new file mode 100644 index 0000000..a1b8099 --- /dev/null +++ b/doc/files/getspriterotation.html @@ -0,0 +1,78 @@ + + +
+ + ++ Returns the angle the sprite is rotated by +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("GetSpriteRotation", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeAngle 'Variable to hold the sprites angle value
+ DIM displayAngle
+ ReleaseKey = 0
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ 'RotateSprite(eyeSprite, eyeAngle)
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+ Canvas(sCanvas)
+
+ If Key(K_SPACE) And ReleaseKey = 0 Then
+ eyeAngle = 30
+ RotateSprite(eyeSprite, eyeAngle)
+ ReleaseKey = 1
+ ElseIf Not Key(K_SPACE) And ReleaseKey = 1 then
+ ReleaseKey = 0
+ End If
+
+ displayAngle = GetSpriteRotation(eyeSprite)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("Sprite Angle: " + STR$(displayAngle), 10, 30)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + SetSpriteRotation + RotateSprite +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/getspriterotation.txt b/doc/files/getspriterotation.txt
new file mode 100644
index 0000000..21a2c8a
--- /dev/null
+++ b/doc/files/getspriterotation.txt
@@ -0,0 +1,66 @@
+#title GetSpriteRotation [RCBasic Doc]
+#header Function GetSpriteRotation(sprite)
+
+Returns the angle the sprite is rotated by
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("GetSpriteRotation", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eyeAngle 'Variable to hold the sprites angle value
+DIM displayAngle
+ReleaseKey = 0
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, 100, 100)
+
+'RotateSprite(eyeSprite, eyeAngle)
+
+While Not Key(K_ESCAPE)
+ClearCanvas()
+Canvas(sCanvas)
+
+If Key(K_SPACE) And ReleaseKey = 0 Then
+ eyeAngle = 30
+ RotateSprite(eyeSprite, eyeAngle)
+ ReleaseKey = 1
+ElseIf Not Key(K_SPACE) And ReleaseKey = 1 then
+ ReleaseKey = 0
+End If
+
+displayAngle = GetSpriteRotation(eyeSprite)
+Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+DrawText("Sprite Angle: " + STR$(displayAngle), 10, 30)
+
+Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref SetSpriteRotation RotateSprite
diff --git a/doc/files/getspritescale.html b/doc/files/getspritescale.html
new file mode 100644
index 0000000..faffad4
--- /dev/null
+++ b/doc/files/getspritescale.html
@@ -0,0 +1,88 @@
+
+
+
+ Gets the scale of a sprite +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("GetSpriteScale", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeScale 'Variable to hold the sprites scale
+ ReleaseKey = 0
+ eyeScale = 2
+
+ DIM eyeScaleX
+ DIM eyeScaleY
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, 200, 100)
+
+ SetSpriteScale(eyeSprite2, eyeScale, eyeScale)
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+ Canvas(sCanvas)
+
+ If Key(K_UP) And ReleaseKey = 0 Then
+ eyeScale = 1.1
+ ScaleSprite(eyeSprite2, eyeScale, eyeScale)
+ ReleaseKey = 1
+ ElseIf Key(K_DOWN) And ReleaseKey = 0 Then
+ eyeScale = 0.9
+ ScaleSprite(eyeSprite2, eyeScale, eyeScale)
+ ReleaseKey = 1
+ ElseIf Not Key(K_UP) And Not Key(K_DOWN) And ReleaseKey = 1 then
+ ReleaseKey = 0
+ End If
+
+ GetSpriteScale(eyeSprite2, eyeScaleX, eyeScaleY)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("Sprite Scale X: " + STR$(eyeScaleX), 10, 30)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + ScaleSprite + SetSpriteScale +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/getspritescale.txt b/doc/files/getspritescale.txt
new file mode 100644
index 0000000..85c6e63
--- /dev/null
+++ b/doc/files/getspritescale.txt
@@ -0,0 +1,76 @@
+#title GetSpriteScale [RCBasic Doc]
+#header Sub GetSpriteScale(sprite, ByRef x, ByRef y)
+
+Gets the scale of a sprite
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("GetSpriteScale", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eyeScale 'Variable to hold the sprites scale
+ReleaseKey = 0
+eyeScale = 2
+
+DIM eyeScaleX
+DIM eyeScaleY
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, 100, 100)
+
+eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite2, 200, 100)
+
+SetSpriteScale(eyeSprite2, eyeScale, eyeScale)
+
+While Not Key(K_ESCAPE)
+ClearCanvas()
+Canvas(sCanvas)
+
+If Key(K_UP) And ReleaseKey = 0 Then
+ eyeScale = 1.1
+ ScaleSprite(eyeSprite2, eyeScale, eyeScale)
+ ReleaseKey = 1
+ElseIf Key(K_DOWN) And ReleaseKey = 0 Then
+ eyeScale = 0.9
+ ScaleSprite(eyeSprite2, eyeScale, eyeScale)
+ ReleaseKey = 1
+ElseIf Not Key(K_UP) And Not Key(K_DOWN) And ReleaseKey = 1 then
+ ReleaseKey = 0
+End If
+
+GetSpriteScale(eyeSprite2, eyeScaleX, eyeScaleY)
+Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+DrawText("Sprite Scale X: " + STR$(eyeScaleX), 10, 30)
+
+Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref ScaleSprite SetSpriteScale
diff --git a/doc/files/getspritesize.html b/doc/files/getspritesize.html
new file mode 100644
index 0000000..b2baa67
--- /dev/null
+++ b/doc/files/getspritesize.html
@@ -0,0 +1,65 @@
+
+
+
+ Gets the size of a sprite's frames +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("ScaleSprite", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eSpriteWidth
+ DIM eSpriteHeight
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ GetSpriteSize(eyeSprite, eSpriteWidth, eSpriteHeight)
+
+ While Not Key(K_ESCAPE)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("EyeSprite Width " + STR$(eSpriteWidth), 10, 30)
+ DrawText("EyeSprite Height " + STR$(eSpriteHeight), 10, 50)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + CreateSprite +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/getspritesize.txt b/doc/files/getspritesize.txt
new file mode 100644
index 0000000..72f531f
--- /dev/null
+++ b/doc/files/getspritesize.txt
@@ -0,0 +1,54 @@
+#title GetSpriteSize [RCBasic Doc]
+#header Sub GetSpriteSize(sprite, ByRef w, ByRef h)
+
+Gets the size of a sprite's frames
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("ScaleSprite", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eSpriteWidth
+DIM eSpriteHeight
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, 100, 100)
+
+GetSpriteSize(eyeSprite, eSpriteWidth, eSpriteHeight)
+
+While Not Key(K_ESCAPE)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("EyeSprite Width " + STR$(eSpriteWidth), 10, 30)
+ DrawText("EyeSprite Height " + STR$(eSpriteHeight), 10, 50)
+
+ Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref CreateSprite
diff --git a/doc/files/getspritesource.html b/doc/files/getspritesource.html
new file mode 100644
index 0000000..4c649e0
--- /dev/null
+++ b/doc/files/getspritesource.html
@@ -0,0 +1,56 @@
+
+
+
+ Returns the source image the sprite renders its frames from +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("GetSpriteSource", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM frown
+ DIM frownW
+ DIM frownH
+ DIM spSource$
+
+ frowny1 = LoadImage("frowny1.png")
+ frowny2 = LoadImage("frowny2.png")
+ GetImageSize(frown, frownW, frownH)
+
+ frownSprite = CreateSprite(frown, frownW, frownH)
+ SetSpritePosition(frownSprite, 100, 100)
+
+ While Not Key(K_ESCAPE)
+ If KEY(K_SPACE) Then
+ SetSpriteSource(frownSprite, frowny2)
+ End If
+ Update()
+ spSource$ = STR$(GetSpriteSource(frown))
+ Print spSource$
+ Wend
+
Related: + SetSpriteSource + CreateSprite +
++ + + \ No newline at end of file diff --git a/doc/files/getspritesource.txt b/doc/files/getspritesource.txt new file mode 100644 index 0000000..16bba50 --- /dev/null +++ b/doc/files/getspritesource.txt @@ -0,0 +1,43 @@ +#title GetSpriteSource [RCBasic Doc] +#header Function GetSpriteSource(sprite) + +Returns the source image the sprite renders its frames from + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("GetSpriteSource", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM frown +DIM frownW +DIM frownH +DIM spSource$ + +frowny1 = LoadImage("frowny1.png") +frowny2 = LoadImage("frowny2.png") +GetImageSize(frown, frownW, frownH) + +frownSprite = CreateSprite(frown, frownW, frownH) +SetSpritePosition(frownSprite, 100, 100) + +While Not Key(K_ESCAPE) + If KEY(K_SPACE) Then + SetSpriteSource(frownSprite, frowny2) + End If + Update() + spSource$ = STR$(GetSpriteSource(frown)) + Print spSource$ +Wend +#/code + +#image "images/frowny1.png" +#image "images/frowny2.png" + +#ref SetSpriteSource CreateSprite diff --git a/doc/files/getspritetype.html b/doc/files/getspritetype.html new file mode 100644 index 0000000..f64e9e7 --- /dev/null +++ b/doc/files/getspritetype.html @@ -0,0 +1,96 @@ + + +
+ + ++ Returns the collison body type of a sprite. +
++ By default, sprites are dynamic when they are created. +
++ Possible types returned +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("GetSpriteType", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ eyeSprite2X = 400
+ eyeSprite2Y = 125
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ SetSpriteSolid(eyeSprite, 1)
+ SetSpriteType(eyeSprite, SPRITE_TYPE_KINEMATIC)
+
+ 'The flags for each type are SPRITE_TYPE_STATIC = 0
+ ' SPRITE_TYPE_KINEMATIC = 1
+ ' SPRITE_TYPE_DYNAMIC = 2
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y)
+ SetSpriteSolid(eyeSprite2, 1)
+ SetSpriteType(eyeSprite2, SPRITE_TYPE_DYNAMIC)
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+ Canvas(sCanvas)
+
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+
+ DrawText("Sprite on left type: " + STR$(GetSpriteType(eyeSprite)), 10, 30)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + SetSpriteType +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/getspritetype.txt b/doc/files/getspritetype.txt
new file mode 100644
index 0000000..c037a26
--- /dev/null
+++ b/doc/files/getspritetype.txt
@@ -0,0 +1,77 @@
+#title GetSpriteType [RCBasic Doc]
+#header Function GetSpriteType(sprite)
+
+Returns the collison body type of a sprite.
+
+By default, sprites are dynamic when they are created.
+
+Possible types returned
+#list ul
+#li SPRITE_TYPE_STATIC (0)
+#li SPRITE_TYPE_KINEMATIC (1)
+#li SPRITE_TYPE_DYNAMIC (2)
+#/list
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("GetSpriteType", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM eye
+DIM eyeW
+DIM eyeH
+eyeSpriteX = 100
+eyeSpriteY = 100
+eyeSprite2X = 400
+eyeSprite2Y = 125
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+SetSpriteSolid(eyeSprite, 1)
+SetSpriteType(eyeSprite, SPRITE_TYPE_KINEMATIC)
+
+'The flags for each type are SPRITE_TYPE_STATIC = 0
+' SPRITE_TYPE_KINEMATIC = 1
+' SPRITE_TYPE_DYNAMIC = 2
+
+eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y)
+SetSpriteSolid(eyeSprite2, 1)
+SetSpriteType(eyeSprite2, SPRITE_TYPE_DYNAMIC)
+
+While Not Key(K_ESCAPE)
+ ClearCanvas()
+ Canvas(sCanvas)
+
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+
+ DrawText("Sprite on left type: " + STR$(GetSpriteType(eyeSprite)), 10, 30)
+
+ Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref SetSpriteType
diff --git a/doc/files/getspriteworldpoint.html b/doc/files/getspriteworldpoint.html
new file mode 100644
index 0000000..06dea76
--- /dev/null
+++ b/doc/files/getspriteworldpoint.html
@@ -0,0 +1,17 @@
+
+
+
+ Get the world coordinates of a point given the local coordinates. +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteworldpoint.txt b/doc/files/getspriteworldpoint.txt new file mode 100644 index 0000000..fd55b93 --- /dev/null +++ b/doc/files/getspriteworldpoint.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getspriteworldvector.html new file mode 100644 index 0000000..8834504 --- /dev/null +++ b/doc/files/getspriteworldvector.html @@ -0,0 +1,17 @@ + + +
+ + ++ Get the world coordinates of a vector given the local coordinates. +
++ + + \ No newline at end of file diff --git a/doc/files/getspriteworldvector.txt b/doc/files/getspriteworldvector.txt new file mode 100644 index 0000000..746f4ff --- /dev/null +++ b/doc/files/getspriteworldvector.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/getterraincenter.html new file mode 100644 index 0000000..0e86ec9 --- /dev/null +++ b/doc/files/getterraincenter.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the center point of a terrain actor +
++ + + \ No newline at end of file diff --git a/doc/files/getterraincenter.txt b/doc/files/getterraincenter.txt new file mode 100644 index 0000000..8a363cb --- /dev/null +++ b/doc/files/getterraincenter.txt @@ -0,0 +1,4 @@ +#title GetTerrainCenter [RCBasic Doc] +#header sub GetTerrainCenter( actor, ByRef x, ByRef y, ByRef z ) + +Gets the center point of a terrain actor diff --git a/doc/files/getterrainheight.html b/doc/files/getterrainheight.html new file mode 100644 index 0000000..8f84b14 --- /dev/null +++ b/doc/files/getterrainheight.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the height of a terrain patch +
++ + + \ No newline at end of file diff --git a/doc/files/getterrainheight.txt b/doc/files/getterrainheight.txt new file mode 100644 index 0000000..d33750a --- /dev/null +++ b/doc/files/getterrainheight.txt @@ -0,0 +1,4 @@ +#title GetTerrainHeight [RCBasic Doc] +#header function GetTerrainHeight( actor, patchX, patchZ ) + +Returns the height of a terrain patch diff --git a/doc/files/getterrainpatchaabb.html b/doc/files/getterrainpatchaabb.html new file mode 100644 index 0000000..a548878 --- /dev/null +++ b/doc/files/getterrainpatchaabb.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the bounding box of a terrain patch +
++ + + \ No newline at end of file diff --git a/doc/files/getterrainpatchaabb.txt b/doc/files/getterrainpatchaabb.txt new file mode 100644 index 0000000..695cb36 --- /dev/null +++ b/doc/files/getterrainpatchaabb.txt @@ -0,0 +1,4 @@ +#title GetTerrainPatchAABB [RCBasic Doc] +#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.html b/doc/files/getterrainpatchlod.html new file mode 100644 index 0000000..2a6a2f5 --- /dev/null +++ b/doc/files/getterrainpatchlod.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current level of detail for a terrain patch +
++ + + \ No newline at end of file diff --git a/doc/files/getterrainpatchlod.txt b/doc/files/getterrainpatchlod.txt new file mode 100644 index 0000000..5b172f5 --- /dev/null +++ b/doc/files/getterrainpatchlod.txt @@ -0,0 +1,4 @@ +#title GetTerrainPatchLOD [RCBasic Doc] +#header function GetTerrainPatchLOD( actor, patchX, patchZ ) + +Returns the current level of detail for a terrain patch diff --git a/doc/files/gettextheight.html b/doc/files/gettextheight.html new file mode 100644 index 0000000..a13f22e --- /dev/null +++ b/doc/files/gettextheight.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the height of the text if rendered with the current font +
++ + + \ No newline at end of file diff --git a/doc/files/gettextheight.txt b/doc/files/gettextheight.txt new file mode 100644 index 0000000..2dc67ea --- /dev/null +++ b/doc/files/gettextheight.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/gettextsize.html new file mode 100644 index 0000000..33e8e88 --- /dev/null +++ b/doc/files/gettextsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the size of the text if rendered with the current font +
++ + + \ No newline at end of file diff --git a/doc/files/gettextsize.txt b/doc/files/gettextsize.txt new file mode 100644 index 0000000..e37c9d8 --- /dev/null +++ b/doc/files/gettextsize.txt @@ -0,0 +1,4 @@ +#title GetTextSize [RCBasic Doc] +#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.html b/doc/files/gettextwidth.html new file mode 100644 index 0000000..ffa9ecb --- /dev/null +++ b/doc/files/gettextwidth.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the width of the text if rendered with the current font +
++ + + \ No newline at end of file diff --git a/doc/files/gettextwidth.txt b/doc/files/gettextwidth.txt new file mode 100644 index 0000000..65ab5da --- /dev/null +++ b/doc/files/gettextwidth.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/gettile.html new file mode 100644 index 0000000..6051bae --- /dev/null +++ b/doc/files/gettile.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the tile at a specified location on a tilemap +
++ Note: (x, y) is a tile position, not an actual coordinate on the map +
++ + + \ No newline at end of file diff --git a/doc/files/gettile.txt b/doc/files/gettile.txt new file mode 100644 index 0000000..ad29da9 --- /dev/null +++ b/doc/files/gettile.txt @@ -0,0 +1,6 @@ +#title GetTile [RCBasic Doc] +#header Function GetTile(tilemap, x, y) + +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.html b/doc/files/gettileanimationframe.html new file mode 100644 index 0000000..07b94dd --- /dev/null +++ b/doc/files/gettileanimationframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the tile set at a specified frame in a tiles animation +
+Related: + SetTileAnimationFrame +
++ + + \ No newline at end of file diff --git a/doc/files/gettileanimationframe.txt b/doc/files/gettileanimationframe.txt new file mode 100644 index 0000000..3f13e14 --- /dev/null +++ b/doc/files/gettileanimationframe.txt @@ -0,0 +1,6 @@ +#title GetTileAnimationFrame [RCBasic Doc] +#header Function GetTileAnimationFrame(tileset, base_tile, anim_frame) + +Returns the tile set at a specified frame in a tiles animation + +#ref SetTileAnimationFrame diff --git a/doc/files/gettileanimationlength.html b/doc/files/gettileanimationlength.html new file mode 100644 index 0000000..5f10409 --- /dev/null +++ b/doc/files/gettileanimationlength.html @@ -0,0 +1,20 @@ + + +
+ + ++ Return the number of frames in a tile's animation +
+Related: + SetTileAnimationLength +
++ + + \ No newline at end of file diff --git a/doc/files/gettileanimationlength.txt b/doc/files/gettileanimationlength.txt new file mode 100644 index 0000000..46b8653 --- /dev/null +++ b/doc/files/gettileanimationlength.txt @@ -0,0 +1,6 @@ +#title GetTileAnimationLength [RCBasic Doc] +#header Function GetTileAnimationLength(tileset, base_tile) + +Return the number of frames in a tile's animation + +#ref SetTileAnimationLength diff --git a/doc/files/gettileanimationspeed.html b/doc/files/gettileanimationspeed.html new file mode 100644 index 0000000..db21a4a --- /dev/null +++ b/doc/files/gettileanimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the fps of a tile's animation +
+Related: + SetTileAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/files/gettileanimationspeed.txt b/doc/files/gettileanimationspeed.txt new file mode 100644 index 0000000..89edb24 --- /dev/null +++ b/doc/files/gettileanimationspeed.txt @@ -0,0 +1,6 @@ +#title GetTileAnimationSpeed [RCBasic Doc] +#header Function GetTileAnimationSpeed(tileset, base_tile) + +Returns the fps of a tile's animation + +#ref SetTileAnimationSpeed diff --git a/doc/files/gettilemapsize.html b/doc/files/gettilemapsize.html new file mode 100644 index 0000000..d2246dd --- /dev/null +++ b/doc/files/gettilemapsize.html @@ -0,0 +1,21 @@ + + +
+ + ++ Gets the size of a tile map +
+Related: + CreateTileMap + SetTileMapSize +
++ + + \ No newline at end of file diff --git a/doc/files/gettilemapsize.txt b/doc/files/gettilemapsize.txt new file mode 100644 index 0000000..3c7b91d --- /dev/null +++ b/doc/files/gettilemapsize.txt @@ -0,0 +1,6 @@ +#title GetTileMapSize [RCBasic Doc] +#header Sub GetTileMapSize(tilemap, ByRef widthInTiles, ByRef heightInTiles) + +Gets the size of a tile map + +#ref CreateTileMap SetTileMapSize diff --git a/doc/files/gettouch.html b/doc/files/gettouch.html new file mode 100644 index 0000000..59261e5 --- /dev/null +++ b/doc/files/gettouch.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the position and distance of motion of a touch event +
++ + + \ No newline at end of file diff --git a/doc/files/gettouch.txt b/doc/files/gettouch.txt new file mode 100644 index 0000000..72cc13b --- /dev/null +++ b/doc/files/gettouch.txt @@ -0,0 +1,4 @@ +#title GetTouch [RCBasic Doc] +#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.html b/doc/files/gettouchfinger.html new file mode 100644 index 0000000..fdfd6d0 --- /dev/null +++ b/doc/files/gettouchfinger.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the position and pressure of a finger on a touch event +
++ + + \ No newline at end of file diff --git a/doc/files/gettouchfinger.txt b/doc/files/gettouchfinger.txt new file mode 100644 index 0000000..92a2121 --- /dev/null +++ b/doc/files/gettouchfinger.txt @@ -0,0 +1,4 @@ +#title GetTouchFinger [RCBasic Doc] +#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/getvideodrawrect.html b/doc/files/getvideodrawrect.html new file mode 100644 index 0000000..7663421 --- /dev/null +++ b/doc/files/getvideodrawrect.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the position and dimensions of the area video playback is shown at. +
++ + + \ No newline at end of file diff --git a/doc/files/getvideodrawrect.txt b/doc/files/getvideodrawrect.txt new file mode 100644 index 0000000..0f7f377 --- /dev/null +++ b/doc/files/getvideodrawrect.txt @@ -0,0 +1,4 @@ +#title GetVideoDrawRect [RCBasic Doc] +#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.html b/doc/files/getvideoposition.html new file mode 100644 index 0000000..59e3f0c --- /dev/null +++ b/doc/files/getvideoposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current position in the video playback. +
++ + + \ No newline at end of file diff --git a/doc/files/getvideoposition.txt b/doc/files/getvideoposition.txt new file mode 100644 index 0000000..d0b6590 --- /dev/null +++ b/doc/files/getvideoposition.txt @@ -0,0 +1,4 @@ +#title GetVideoPosition [RCBasic Doc] +#header function GetVideoPosition() + +Returns the current position in the video playback. diff --git a/doc/files/getvideosize.html b/doc/files/getvideosize.html new file mode 100644 index 0000000..fbbf168 --- /dev/null +++ b/doc/files/getvideosize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the size of video's frames +
++ + + \ No newline at end of file diff --git a/doc/files/getvideosize.txt b/doc/files/getvideosize.txt new file mode 100644 index 0000000..ccf55ac --- /dev/null +++ b/doc/files/getvideosize.txt @@ -0,0 +1,4 @@ +#title GetVideoSize [RCBasic Doc] +#header sub GetVideoSize(byref w, byref h) + +Gets the size of video's frames diff --git a/doc/files/getvideostats.html b/doc/files/getvideostats.html new file mode 100644 index 0000000..8665598 --- /dev/null +++ b/doc/files/getvideostats.html @@ -0,0 +1,20 @@ + + +
+ + ++ Gets video data from a video file. +
++ 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/files/getvideostats.txt b/doc/files/getvideostats.txt new file mode 100644 index 0000000..f0106c9 --- /dev/null +++ b/doc/files/getvideostats.txt @@ -0,0 +1,6 @@ +#title GetVideoStats [RCBasic Doc] +#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.html b/doc/files/getvideovolume.html new file mode 100644 index 0000000..93bd505 --- /dev/null +++ b/doc/files/getvideovolume.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the volume of a video +
++ Volume can be in a range of 0 to 128 +
+Related: + SetVideoVolume +
++ + + \ No newline at end of file diff --git a/doc/files/getvideovolume.txt b/doc/files/getvideovolume.txt new file mode 100644 index 0000000..1f043e4 --- /dev/null +++ b/doc/files/getvideovolume.txt @@ -0,0 +1,8 @@ +#title GetVideoVolume [RCBasic Doc] +#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/getwatercolor.html b/doc/files/getwatercolor.html new file mode 100644 index 0000000..eb7d869 --- /dev/null +++ b/doc/files/getwatercolor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/getwatercolorblendfactor.html b/doc/files/getwatercolorblendfactor.html new file mode 100644 index 0000000..5c09ccc --- /dev/null +++ b/doc/files/getwatercolorblendfactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/getwaterwaveheight.html b/doc/files/getwaterwaveheight.html new file mode 100644 index 0000000..b5b07f3 --- /dev/null +++ b/doc/files/getwaterwaveheight.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/getwaterwinddirection.html b/doc/files/getwaterwinddirection.html new file mode 100644 index 0000000..5713f7c --- /dev/null +++ b/doc/files/getwaterwinddirection.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/getwaterwindforce.html b/doc/files/getwaterwindforce.html new file mode 100644 index 0000000..0a047b9 --- /dev/null +++ b/doc/files/getwaterwindforce.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/getwindowmaxsize.html b/doc/files/getwindowmaxsize.html new file mode 100644 index 0000000..f7e7ea9 --- /dev/null +++ b/doc/files/getwindowmaxsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the maximum size of a window. +
++ + + \ No newline at end of file diff --git a/doc/files/getwindowmaxsize.txt b/doc/files/getwindowmaxsize.txt new file mode 100644 index 0000000..fe87b92 --- /dev/null +++ b/doc/files/getwindowmaxsize.txt @@ -0,0 +1,4 @@ +#title GetWindowMaxSize [RCBasic Doc] +#header sub GetWindowMaxSize( byref w, byref h) + +Gets the maximum size of a window. diff --git a/doc/files/getwindowminsize.html b/doc/files/getwindowminsize.html new file mode 100644 index 0000000..8c4206e --- /dev/null +++ b/doc/files/getwindowminsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the minimum size of the window. +
++ + + \ No newline at end of file diff --git a/doc/files/getwindowminsize.txt b/doc/files/getwindowminsize.txt new file mode 100644 index 0000000..e06c2b9 --- /dev/null +++ b/doc/files/getwindowminsize.txt @@ -0,0 +1,4 @@ +#title GetWindowMinSize [RCBasic Doc] +#header sub GetWindowMinSize( byref w, byref h) + +Gets the minimum size of the window. diff --git a/doc/files/getwindowmode.html b/doc/files/getwindowmode.html new file mode 100644 index 0000000..6017212 --- /dev/null +++ b/doc/files/getwindowmode.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/getwindowmode.txt b/doc/files/getwindowmode.txt new file mode 100644 index 0000000..2090421 --- /dev/null +++ b/doc/files/getwindowmode.txt @@ -0,0 +1,4 @@ +#title GetWindowMode [RCBasic Doc] +#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.html b/doc/files/getwindowposition.html new file mode 100644 index 0000000..485151d --- /dev/null +++ b/doc/files/getwindowposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the window position. +
++ + + \ No newline at end of file diff --git a/doc/files/getwindowposition.txt b/doc/files/getwindowposition.txt new file mode 100644 index 0000000..c822e1e --- /dev/null +++ b/doc/files/getwindowposition.txt @@ -0,0 +1,4 @@ +#title GetWindowPosition [RCBasic Doc] +#header sub GetWindowPosition( byref x, byref y ) + +Gets the window position. diff --git a/doc/files/getwindowsize.html b/doc/files/getwindowsize.html new file mode 100644 index 0000000..3857c28 --- /dev/null +++ b/doc/files/getwindowsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the size of the window. +
++ + + \ No newline at end of file diff --git a/doc/files/getwindowsize.txt b/doc/files/getwindowsize.txt new file mode 100644 index 0000000..13c1221 --- /dev/null +++ b/doc/files/getwindowsize.txt @@ -0,0 +1,4 @@ +#title GetWindowSize [RCBasic Doc] +#header sub GetWindowSize( byref w, byref h ) + +Gets the size of the window. diff --git a/doc/files/getworld2dautoclearforces.html b/doc/files/getworld2dautoclearforces.html new file mode 100644 index 0000000..5af419d --- /dev/null +++ b/doc/files/getworld2dautoclearforces.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the auto clear forces flag for the active canvas +
+Related: + SetWorld2DAutoClearForces +
++ + + \ No newline at end of file diff --git a/doc/files/getworld2dautoclearforces.txt b/doc/files/getworld2dautoclearforces.txt new file mode 100644 index 0000000..1f345b4 --- /dev/null +++ b/doc/files/getworld2dautoclearforces.txt @@ -0,0 +1,6 @@ +#title GetWorld2DAutoClearForces [RCBasic Doc] +#header function GetWorld2DAutoClearForces() + +Returns the auto clear forces flag for the active canvas + +#ref SetWorld2DAutoClearForces diff --git a/doc/files/getworld2dpositioniterations.html b/doc/files/getworld2dpositioniterations.html new file mode 100644 index 0000000..ffd8ebf --- /dev/null +++ b/doc/files/getworld2dpositioniterations.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the number of position iterations for the position constraint solver +
+Related: + SetWorld2DPositionIterations +
++ + + \ No newline at end of file diff --git a/doc/files/getworld2dpositioniterations.txt b/doc/files/getworld2dpositioniterations.txt new file mode 100644 index 0000000..ee7546c --- /dev/null +++ b/doc/files/getworld2dpositioniterations.txt @@ -0,0 +1,7 @@ +#title GetWorld2DPositionIterations [RCBasic Doc] +#header function GetWorld2DPositionIterations() + +Returns the number of position iterations for the position constraint solver + +#ref SetWorld2DPositionIterations + diff --git a/doc/files/getworld2dtimestep.html b/doc/files/getworld2dtimestep.html new file mode 100644 index 0000000..b84826b --- /dev/null +++ b/doc/files/getworld2dtimestep.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the timestep for the active canvas +
+Related: + SetWorld2DTimeStep +
++ + + \ No newline at end of file diff --git a/doc/files/getworld2dtimestep.txt b/doc/files/getworld2dtimestep.txt new file mode 100644 index 0000000..12796ad --- /dev/null +++ b/doc/files/getworld2dtimestep.txt @@ -0,0 +1,6 @@ +#title GetWorld2DTimeStep [RCBasic Doc] +#header function GetWorld2DTimeStep() + +Returns the timestep for the active canvas + +#ref SetWorld2DTimeStep diff --git a/doc/files/getworld2dvelocityiterations.html b/doc/files/getworld2dvelocityiterations.html new file mode 100644 index 0000000..71f9578 --- /dev/null +++ b/doc/files/getworld2dvelocityiterations.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the number of velocity iterations for the velocity constraint solver +
+Related: + SetWorld2DVelocityIterations +
++ + + \ No newline at end of file diff --git a/doc/files/getworld2dvelocityiterations.txt b/doc/files/getworld2dvelocityiterations.txt new file mode 100644 index 0000000..fbcf0a7 --- /dev/null +++ b/doc/files/getworld2dvelocityiterations.txt @@ -0,0 +1,6 @@ +#title GetWorld2DVelocityIterations [RCBasic Doc] +#header function GetWorld2DVelocityIterations() + +Returns the number of velocity iterations for the velocity constraint solver + +#ref SetWorld2DVelocityIterations diff --git a/doc/files/getworld3dmaxsubsteps.html b/doc/files/getworld3dmaxsubsteps.html new file mode 100644 index 0000000..ea0bf7a --- /dev/null +++ b/doc/files/getworld3dmaxsubsteps.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the maximum substeps in the 3d physics time step +
++ + + \ No newline at end of file diff --git a/doc/files/getworld3dmaxsubsteps.txt b/doc/files/getworld3dmaxsubsteps.txt new file mode 100644 index 0000000..9b869eb --- /dev/null +++ b/doc/files/getworld3dmaxsubsteps.txt @@ -0,0 +1,5 @@ +#title GetWorld3DMaxSubSteps [RCBasic Doc] +#header function GetWorld3DMaxSubSteps() + +Returns the maximum substeps in the 3d physics time step + diff --git a/doc/files/getworld3dtimestep.html b/doc/files/getworld3dtimestep.html new file mode 100644 index 0000000..efa3afc --- /dev/null +++ b/doc/files/getworld3dtimestep.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the timestep of the 3d physics simulation +
++ + + \ No newline at end of file diff --git a/doc/files/getworld3dtimestep.txt b/doc/files/getworld3dtimestep.txt new file mode 100644 index 0000000..3cdd328 --- /dev/null +++ b/doc/files/getworld3dtimestep.txt @@ -0,0 +1,4 @@ +#title GetWorld3DTimeStep [RCBasic Doc] +#header function GetWorld3DTimeStep() + +Returns the timestep of the 3d physics simulation diff --git a/doc/files/getworldtoviewportposition.html b/doc/files/getworldtoviewportposition.html new file mode 100644 index 0000000..30c6a53 --- /dev/null +++ b/doc/files/getworldtoviewportposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ Get the 2D coordinates for the given 3D position on the active canvas +
++ + + \ No newline at end of file diff --git a/doc/files/getworldtoviewportposition.txt b/doc/files/getworldtoviewportposition.txt new file mode 100644 index 0000000..bca3501 --- /dev/null +++ b/doc/files/getworldtoviewportposition.txt @@ -0,0 +1,4 @@ +#title GetWorldToViewportPosition [RCBasic Doc] +#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.html b/doc/files/globalmousex.html new file mode 100644 index 0000000..184093c --- /dev/null +++ b/doc/files/globalmousex.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the absolute X position of the mouse on the display +
+Related: + GlobalMouseY + GetGlobalMouse +
++ + + \ No newline at end of file diff --git a/doc/files/globalmousex.txt b/doc/files/globalmousex.txt new file mode 100644 index 0000000..32ca055 --- /dev/null +++ b/doc/files/globalmousex.txt @@ -0,0 +1,6 @@ +#title GlobalMouseX [RCBasic Doc] +#header function GlobalMouseX() + +Returns the absolute X position of the mouse on the display + +#ref GlobalMouseY GetGlobalMouse diff --git a/doc/files/globalmousey.html b/doc/files/globalmousey.html new file mode 100644 index 0000000..c0e507d --- /dev/null +++ b/doc/files/globalmousey.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the absolute Y position of the mouse on the display +
+Related: + GlobalMouseX + GetGlobalMouse +
++ + + \ No newline at end of file diff --git a/doc/files/globalmousey.txt b/doc/files/globalmousey.txt new file mode 100644 index 0000000..29eaaa7 --- /dev/null +++ b/doc/files/globalmousey.txt @@ -0,0 +1,6 @@ +#title GlobalMouseY [RCBasic Doc] +#header function GlobalMouseY() + +Returns the absolute Y position of the mouse on the display + +#ref GlobalMouseX GetGlobalMouse diff --git a/doc/files/grabinput.html b/doc/files/grabinput.html new file mode 100644 index 0000000..18ec065 --- /dev/null +++ b/doc/files/grabinput.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets whether the currently active window will grab user input +
++ + + \ No newline at end of file diff --git a/doc/files/grabinput.txt b/doc/files/grabinput.txt new file mode 100644 index 0000000..cc59462 --- /dev/null +++ b/doc/files/grabinput.txt @@ -0,0 +1,4 @@ +#title GrabInput [RCBasic Doc] +#header sub GrabInput(flag) + +Sets whether the currently active window will grab user input diff --git a/doc/files/graphics.html b/doc/files/graphics.html new file mode 100644 index 0000000..4e05290 --- /dev/null +++ b/doc/files/graphics.html @@ -0,0 +1,103 @@ + + +
+ + ++ Finally, the reason we are all here. Lets draw pretty pictures on the screen. The first thing we need is a window. To open the graphics window, we need to use OpenWindow(). +
+
+ fullscreen = false
+ vsync = true
+
+ OpenWindow("My Graphics Window", 640, 480, fullscreen, vsync)
+
+ The above code will open a 640 x 480 window with vsync enabled. You can reference OpenWindow() for a little more detail. +
++ If we tried to run the code we have so far, the window would open and immediately close. So next to keep our window open and ensure its getting updated we need to make our render loop. +
+
+ While Not Key(K_ESCAPE)
+ Update() 'This needs to be called every frame to refresh the window and poll events
+ Wend
+
+ So now we have our basic render loop but nothing is being drawn. Now is a good time to explain how RCBasic's graphics system works. RCBasic uses virtual render targets called canvases. There are 3 different types of canvases that are used for rendering depending on what you are trying to do. Here is an overview of the different types of canvases: +
++ For now, lets just use a paint canvas. We use OpenCanvas() to open a paint canvas. Before our render loop, we will open our canvas. +
+
+
+ paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1)
+
+ Canvas(paint_canvas) 'Sets out canvas as the active canvas. This is unnecessary since we only have one canvas but its a good habit to get into to set your desired canvas active before doing anything on it.
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas() 'Clears the canvas every frame. If you have an image that never changes you may not want to do this.
+ Update()
+ Wend
+
+ Here we are opening a canvas for drawing and storing the handle for that canvas in a variable called paint_canvas. Anytime we want to reference that canvas we will use the paint_canvas variable. You can reference OpenCanvas() for more details on how it works. After we opened our canvas, we set it as the active canvas using Canvas(). This was not necessary right now since RCBasic sets the first canvas created as the default canvas but its still a good habit to set a canvas active before doing anything with it to ensure you are targeting the right canvas. +
++ Ok, we have a window and a canvas but we still haven't drawn anything. So lets do that. Inside our render loop, we are going to set our draw color to red and draw a box. +
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+
+ SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red
+ RectFill(20, 20, 50, 50) 'Draws a filled rectangle with the current draw color
+
+ Update()
+ Wend
+
+ So now our finished program looks like this: +
+
+ fullscreen = false
+ vsync = true
+
+ OpenWindow("My Graphics Window", 640, 480, fullscreen, vsync)
+
+ paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1)
+
+ Canvas(paint_canvas)
+
+ While Not Key(K_ESCAPE)
+ ClearCanvas()
+
+ SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red
+ RectFill(20, 20, 50, 50) 'Draws a filled rectangle with the current draw color
+
+ Update()
+ Wend
+
+ 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/files/graphics.txt b/doc/files/graphics.txt new file mode 100644 index 0000000..13e35fe --- /dev/null +++ b/doc/files/graphics.txt @@ -0,0 +1,77 @@ +#title RCBasic Graphics [RCBasic Doc] +#header GRAPHICS + +Finally, the reason we are all here. Lets draw pretty pictures on the screen. The first thing we need is a window. To open the graphics window, we need to use OpenWindow(). +#code +fullscreen = false +vsync = true + +OpenWindow("My Graphics Window", 640, 480, fullscreen, vsync) +#/code + +The above code will open a 640 x 480 window with vsync enabled. You can reference OpenWindow() for a little more detail. + +If we tried to run the code we have so far, the window would open and immediately close. So next to keep our window open and ensure its getting updated we need to make our render loop. +#code +While Not Key(K_ESCAPE) + Update() 'This needs to be called every frame to refresh the window and poll events +Wend +#/code + +So now we have our basic render loop but nothing is being drawn. Now is a good time to explain how RCBasic's graphics system works. RCBasic uses virtual render targets called canvases. There are 3 different types of canvases that are used for rendering depending on what you are trying to do. Here is an overview of the different types of canvases: +#list ul +#li 2D Paint Canvas - This is a canvas for rendering drawing commands (ie. DrawImage, Rect, FloodFill, etc.) +#li Sprite Layer - A canvas for rendering sprites. Sprite canvases will only render sprites but they have infinite 2D space to place sprites in. +#li 3D Canvas - This canvas is a 3D viewport. Each 3D canvas has its own camera so having multiple can impact performance since it re-renders the scene for each 3D canvas. +#/list + +For now, lets just use a paint canvas. We use OpenCanvas() to open a paint canvas. Before our render loop, we will open our canvas. +#code + +paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1) + +Canvas(paint_canvas) 'Sets out canvas as the active canvas. This is unnecessary since we only have one canvas but its a good habit to get into to set your desired canvas active before doing anything on it. + +While Not Key(K_ESCAPE) + ClearCanvas() 'Clears the canvas every frame. If you have an image that never changes you may not want to do this. + Update() +Wend +#/code + +Here we are opening a canvas for drawing and storing the handle for that canvas in a variable called paint_canvas. Anytime we want to reference that canvas we will use the paint_canvas variable. You can reference OpenCanvas() for more details on how it works. After we opened our canvas, we set it as the active canvas using Canvas(). This was not necessary right now since RCBasic sets the first canvas created as the default canvas but its still a good habit to set a canvas active before doing anything with it to ensure you are targeting the right canvas. + +Ok, we have a window and a canvas but we still haven't drawn anything. So lets do that. Inside our render loop, we are going to set our draw color to red and draw a box. + +#code +While Not Key(K_ESCAPE) + ClearCanvas() + + SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red + RectFill(20, 20, 50, 50) 'Draws a filled rectangle with the current draw color + + Update() +Wend +#/code + +So now our finished program looks like this: +#code +fullscreen = false +vsync = true + +OpenWindow("My Graphics Window", 640, 480, fullscreen, vsync) + +paint_canvas = OpenCanvas(640, 480, 0, 0, 640, 480, 1) + +Canvas(paint_canvas) + +While Not Key(K_ESCAPE) + ClearCanvas() + + SetColor( RGB(200, 0, 0) ) 'Sets the drawing color to red + RectFill(20, 20, 50, 50) 'Draws a filled rectangle with the current draw color + + Update() +Wend +#/code + +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. diff --git a/doc/files/gyroname.html b/doc/files/gyroname.html new file mode 100644 index 0000000..c9019d5 --- /dev/null +++ b/doc/files/gyroname.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the name of the gyroscope. +
++ + + \ No newline at end of file diff --git a/doc/files/gyroname.txt b/doc/files/gyroname.txt new file mode 100644 index 0000000..def7938 --- /dev/null +++ b/doc/files/gyroname.txt @@ -0,0 +1,4 @@ +#title GyroName$ [RCBasic Doc] +#header function GyroName$(gyro_num) + +Returns the name of the gyroscope. diff --git a/doc/files/hasclipboardtext.html b/doc/files/hasclipboardtext.html new file mode 100644 index 0000000..ae63ddc --- /dev/null +++ b/doc/files/hasclipboardtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns whether or not there is text in the clipboard. +
++ + + \ No newline at end of file diff --git a/doc/files/hasclipboardtext.txt b/doc/files/hasclipboardtext.txt new file mode 100644 index 0000000..13647b7 --- /dev/null +++ b/doc/files/hasclipboardtext.txt @@ -0,0 +1,4 @@ +#title HasClipboardText [RCBasic Doc] +#header function HasClipboardText() + +Returns whether or not there is text in the clipboard. diff --git a/doc/files/hello_world.html b/doc/files/hello_world.html new file mode 100644 index 0000000..10c7706 --- /dev/null +++ b/doc/files/hello_world.html @@ -0,0 +1,576 @@ + + +
+ + ++ This tutorial is designed to introduce complete newbies to the world of computer programming and specifically programming using RC Basic. This tutorial will not assume any previous programming knowledge and really won't even assume you know much about how a computer works. A basic understanding of 6th Grade Algebra will come in handy but is not necessary. Now that I got that out of the way, lets take our first steps in our journey to becoming computer programmers. +
++ First lets go over the requirements you will need to follow this tutorial. You will need a computer (obviously), RC Basic (yet again obvious, but I had to say it), and the will to learn (not essential but it will definitely help). Ok lets begin. +
++
+
+ Print "Hello World"
+
+ You should see "Hello World" in your console window. Congratulations, you just wrote your first computer program. So lets break this program down into its individual parts. First is the Print command. This is telling the computer to write something to the console (I will be referring to the DOS screen as the console for the rest of this tutorial). And then we have "Hello World". First of all, why is it in quotation marks? The short answer is because it is not a number. We will go over this more in depth later but for now that is all we need to know for right now? Before we move on, use the Print command to write some other stuff to the screen. +
++
+ Look at the following examples. +
+
+ "42"
+ 42
+
+ The first line is a string and the second line is a number. Are you confused yet? The first line has the character "4" and the character "2" in a string and the second line is the number 42. Yes they look the same but the way you perform operations on a string is different than the way you perform operations on numbers. It will make more since with the examples below. +
++ This will add the string "53" to the end of the string "42" and output 4253 to the console. Try it. +
+
+ Print "42" + "53"
+
+ This will will add the number 42 to the number 53 and output 95 to the console. Try it. +
+
+ Print 42 + 53
+
+ The differences between numbers and strings should be starting to clear up a little by now. If you are still a little confused at this point don't worry. This is only an Introduction to programming. If you are able to write some text on the screen and do some simple math by the end of this tutorial you will be ready to continue into the next lesson. +
++ Now we are going to get into operators. I know I said at the beginning of the tutorial I did not expect you to know much but I am assuming you know how to add, subtract, multiply, and divide. We got a brief introduction to the "+" operator in the last example. It is important to note that the "+" operator is the only operator that works on both numbers and strings. +
++ Here is a list of the main string operators. "+": Adds one string to the end of another. This example will output "batman" to the console. +
+
+ Print "bat" + "man"
+
+ Before we continue, lets break down the PRINT statement. It is the simplest way to get text on the screen. PRINT also allows us to output multiple items of different types by separating them with a “;”. +
+
+ Print “Text”; 5+4; “ More Text”;
+
+ ‘Ending Print with a “;” keeps the cursor on the same line in the console.
+
+ Here is a list of the main number operators. "+": Adds two numbers together. This example will output 8 to the console. +
+
+ Print 6 + 2
+
+ "-": Subtracts one number from another. This example will output 4 to the console. +
+
+ Print 6 - 2
+
+ "*": Multiplies two numbers (Note: Multiplication uses an * instead of an x). This example will output 12 to the console. +
+
+ Print 6 * 2
+
+ "/": Divides one number by another. This example will output 3 to the console. +
+
+ Print 6 / 2
+
+ "^": Raises a number to a power. This example will output 36 (6 to the second power) to the console. +
+
+ Print 6 ^ 2
+
+ Both string operators perform the same operation. They will place the characters in the second string at the end of the first string. The number operators perform the same operations they do on a calculator. One more important thing to mention is that the number operators follow the Order of Operations. Take a look at the example below. +
+
+ Print 4+3*2
+
+ In the example above the, following the order of operations PEMDAS (Parenthesis, Exponents, Multiplication, Division, Addition, and Subtraction); 3 is multiplied by 2 which is 6, and then 4 is added to it which is 10. So math is not necessarily done from left to right but it is determined by the order of operations. There is more to the order of operations but we are not going to cover that right now. We covered all of the main operators so before we move on lets look at one more example that uses parenthesis. +
+
+ Print (4+3)*2
+
+ This is almost the same problem as the example before it, but now it groups 4 plus 3 together using parenthesis which means 4 and 3 are added first which will be 7. Then that 7 is multiplied by 2 which is 14. If you do the same problems on a calculator you will get the same answers. Try out a few math problems on your own. +
++ Interacting With The User Up to this point, we have been writing output to the screen. We have been the user as well as the programmer so there was no reason to need to accept input from the screen. But when you write programs that are meant to be used by people other than yourself you will want to get input from the user and process that input to perform some task. So lets dive into some code. For this example we are using the function Input to ask the user "What is your name? " and read what the user types into the console (which should be there name but they can type whatever they want). +
+
+ Input$("What is your name? ")
+
+ You should have seen "What is your name?" and then been able to type something in. You have just received input from the user for the first time. So lets break this line down. First we have the function name Input$. Input$ is a built-in function that prompts the user with something and it returns what the user typed. This is the first time I used the word returns so let me clarify. In the example above lets say you type in Bob for your name. The whole Input$() function call is replaced with "Bob". Take a look at this example. +
++ This line does not prompt anything and just waits for you to type something. We are going to type Bob. +
+
+ Input$("")
+
+ After you enter "Bob" the line above will be replaced with "Bob" and the line will finish processing your commands. +
+
+ "Bob"
+
+ You are probably thinking that is useless. What can we do with a line that just has a string on it. And the answer is you really can't do anything with a line that just has Bob on it. But if we store the string "Bob" we can use it to do other stuff with. +
++ To store "Bob" (or whatever you call yourself) we use something called a variable. You might have seen variables used in math class in school. A variable is just a symbol that holds data. By symbol I don't mean a logo or anything. Just take a look at this example. +
+
+ a = 2
+ b$ = "Bob"
+ batman = 4.5
+ superman$ = "this is just random text"
+
+ This example makes four variables: a, b$, batman, superman$ and stores some data in them. Lets do a break down. +
++ We will start with the variables a and batman. The variables are just storing numbers. We can use variables that store numbers when we have programs that are going to be handling values that change over time. For now lets just do some simple math. Type the variables from the previous example and add the following code and run it. +
+
+ Print a + batman
+
+ This example just adds the values in the variables together and outputs the values to the screen. You can change the value of a variable at any time. This is better explained with another example. +
+
+ a = 5
+ Print a
+ a = 6
+ Print a
+ a = 5 + 6
+ Print a
+
+ What we are doing in the example above is changing the value of a and doing math and storing the value in a. We can also store the value of one variable inside another. Lets Look at another example. +
+
+ a = batman
+ Print a
+ a = a + batman
+ Print a
+
+ The example above will first store the value of batman in the variable a. It will write a to the screen. Then it will add a and batman and store the result in a and write that value to the screen. +
++ Now we are going to take a look at the other two variables we created: the variable b$ and the variable superman$. Did you notice that both of the variables end in a $. There is a reason for that. The $ at the end of the variable name lets the compiler know that these variables are strings. Since these two variables are strings the rules about strings apply to these variables. Look at the following examples. +
+
+ Print b$
+ Print superman$
+ Print b$ + superman$
+
+ The above example writes the value stored in b$ to the screen. Then it writes the value stored in superman$ to the screen. Finally it adds the contents of the superman$ variable to the end of the contents for the b$ variable and writes that to the screen. +
++ Now that we have covered variables, how do we use them with the users input. Well lets look at the Input$() function again. Notice that the function ends in a $. input$() returns a string so it can be used anywhere a string can. Look at this example. +
++ This line does the same thing as the last time we used the Input$() function. The main Difference is now we are storing the value the user enters into the variable name. +
+
+ name$ = Input$("What is your name?")
+
+ This code will store "Bob" or what ever you typed in into the variable name$. Now we can use the name$ as many times as we want anywhere in our program. So now lets make a program that Uses Input$() along with Print. We are going to ask the User for there name and then welcome the User to RC Basic. +
+
+ name$ = Input$("What is your name? ")
+ Print "Hello " + name$ + ". Welcome to RC Basic."
+
+ Lets do our break down again. In the first$ line we create a variable called name$ and call Input$() in it. This will write "What is your name? " to the screen. When the User Enters something, whatever the User types in will replace Input$(). So name$ will be whatever the User types in. On the next line we use Print to write a message to the screen. The only thing different this time is we are adding a variable to our string in Input$(). But remember that our variable is a string and can do anything a string can, so all you are doing is saying "Hello " + the User's name + ". Welcome to RC Basic.". +
++ We have covered a lot in these first few sections so I am going to take this time to challenge you. Write a program that ask the User to type there favorite color in and then tell them what there favorite color is on the next line. +
++ Flow Control Flow control sounds like some really complicated topic. But it will probably make sense almost immediately. So what is flow control? Simply put, flow control is controlling what your program does based on what conditions are met. To control the flow in our programs we will use the If statement. The If statement will allow us to execute a block of code depending on what conditions are met. Let look at the last example from the last segment. +
+
+ name$ = Input$("What is your name? ")
+ Print "Hello " + name$ + ". Welcome to RC Basic."
+
+ To give an idea of how to use the IF statement we are going to extend this program. So lets make the program give a special greeting if Bob is typed in for the name. Look at the following example. +
+
+ name$ = Input$("What is your name? ")
+ Print "Hello " + name$ + ". Welcome to RC Basic."
+
+ If name$ = "Bob" Then
+ Print "We have been expecting you"
+ End If
+
+ This program will do the same thing it did in the last segment but it adds the use of the IF statement. So lets do a quick break down. +
++ This line is saying if name$ has "Bob" stored in it, then run the following code. Each IF statement must end with the THEN statement. +
+
+ If name$ = "Bob" Then
+
+ This line is writing "We have been expecting you" to the screen. +
+
+ Print "We have been expecting you"
+
+ This line is ending the block of code that the IF statement wanted the program to execute and continues the rest of your program. +
++ The block of code started by the IF statement can also be given different conditions to check for and execute a different block of code for each different condition. We are going to take a break from strings and use numbers for our next few examples. We are also going to introduce a few new operators. So lets start by making some number variables. +
+
+ a = 1
+ b = 3
+ c = 5
+
+ Now that we have some variables we are going to make a program that ask the User to enter a number and check if the number is equal to each variable and outputs something different for each one. First I need to cover one very important topic. The Input$() function only takes in a string. So even number that are typed in by the User are treated as strings. So we need to convert the Users input to a number to be able to compare it to another number or do any kind of math with it. To do this we will use the Val() function. The Val() function converts a string to a number. Look at the following example real quick. +
++ This example will convert the string "12" to the number 12. +
+
+ x = Val("12")
+
+ The more programs you write, the more you will get use to converting numbers to strings and strings to numbers. So how do we use Val() with Input$(). Well remember that Input$() can be used anywhere a string can. So instead of putting "12" in Val() like we did in the last example we will simply put Input$() inside Val(). Make sure your program has the variables a, b, and c we created earlier and add this. +
+
+ d = Val( Input$("Enter a number: ") )
+
+ The code above is creating a variable called d. Then it uses the Val() function to convert the string returned by Input$() into a number. The string returned by Input$() is what ever the User types in. Now that we have gotten a number from the User lets compare that number to the variables we made earlier. +
+
+ If d = a Then
+ Print "You typed the A value"
+
+ ElseIf d = b Then
+ Print "That is B"
+
+ ElseIf d = c Then
+ Print "That would be C"
+
+ Else
+ Print "You did not type any of the numbers"
+
+ End If
+
+ Lets do a break down. This is starting a multi-layered If statement block. It should be fairly simple to understand. We are going to go through each line and examine what is happening step by step. +
++ This line is starting your If block by comparing d(which is what the User typed in) to the variable a. If the two variables are equal then it will output "You typed the A value" to the console. +
+
+ If d = a Then
+ Print "You typed the A value"
+
+ This line will compare d and b if d wasn't equal to a. If the value stored in d is equal to the value stored in b then it will output "That is B" to the console. +
+
+ ElseIf d = b Then
+ Print "That is B"
+
+ This line will compare d and c if d wasn't equal to a or b. If d is equal to c then "That would be C" is output to the console. +
+
+ ElseIf d = c Then
+ Print "That would be C"
+
+ This line will output "You did not type any of the numbers" if none of the previous conditions were met. +
+
+ Else
+ Print "You did not type any of the numbers"
+
+ And finally this line will end the If block and finish running the rest of the program. +
+
+ End If
+
+ Now we are going to play with a few other operators for numbers only. In addition to being able to compare if two numbers are equal we can also compare if one number is greater than another, less than another, not equal to another, greater than or equal to another, etc. Here is a list of comparisons we can do with numbers. +
++ Given we have two number stored in variables a and b. +
++ •.a = b : Test if a is equal to b +
++ •.a < b : Test if a is less than b +
++ •.a > b : Test if a is greater than b +
++ •.a <= b : Test if a is less than or equal to b +
++ •.a >= b : Test if a is greater than or equal to b +
++ •.a <> b : Test if a is not equal to b +
++ Here is a few examples of doing some of these comparisons with a IF statement. +
+
+ If a = b Then
+ 'Code to execute
+ End If
+
+ If a < b Then
+ 'Code to execute
+ End If
+
+ If a <> b Then
+ 'Code to execute
+ End If
+
+ These other comparisons are pretty straight forward. To try these out we are going to make a program that ask the User to enter a number. If the number is less than or equal to 10 then "Low" will be output to the console. If the number is greater than 10 then we will check if the number is greater than 20. If it is then then "High" will be output to the console. If neither of these conditions are true then "Mid" will be output to the console. First we need to get a number from the User. Remember we need to use the Val() function to convert the User's input from a string to a number. +
++ Here is where we take the User's input and convert it to a number. The Input$() function will get replaced with what the User types in so we simply use the Val() function to convert Input$() to a number. +
+
+ user_num = Val( Input$("Enter a number: ") )
+
+ We start our If block by comparing user_num (Our input from the User in the previous line) to the number 10. If the user_num variable is less than or equal to 10 then we use the Print statement to write "Low" to the console. +
+
+ If user_num <= 10 Then
+ Print "Low"
+
+ If the previous comparison is false then we compare the user_num variable to 20. If user_num is greater than 20 then we will write "High" to the console. +
+
+ ElseIf user_num > 20 Then
+ Print "High"
+
+ Finally, if none of the previous conditions are true we will write "Mid" to the console. +
+
+ Else
+ Print "Mid"
+
+ End If
+
+ Our complete program looks like this. +
+
+ user_num = Val( Input$("Enter a number: ") )
+
+ If user_num <= 10 Then
+ Print "Low"
+
+ ElseIf user_num > 20 Then
+ Print "High"
+
+ Else
+ Print "Mid"
+
+ End If
+
+ The last thing we will cover on flow control is the keywords AND, OR, XOR, and NOT. These 4 keywords are actually operators that can be used for more specific comparisons. We will start with the AND operator. The AND operator will compare the conditions to its left and its right. If both conditions are true the AND operator sets the whole expression as true. I already know you didn't understand that explanation so it will probably be easier to show you. Just look at this example. +
++ This code will write "This is true" to the console because 1 is equal to 1 and 4 is greater than 2. Yes it is that simple. +
+
+ If 1=1 AND 4>2 Then
+ Print "This is true"
+ End If
+
+ The OR statement will set the whole expression it is being used in if at least one of the conditions is true. Here is an example of OR. +
++ This code will write "This is true" to the console because although 1 is not equal to 2, 5 is less than or equal to 6. +
+
+ If 1=2 AND 5<6 Then
+ Print "This is true"
+ End If
+
+ The XOR statement is like the OR statement with one major difference. With XOR, one of the conditions in the expression has to be true and the other has to be false. Here is an example of XOR. +
++ This code will write "This is true" to the console because 1 is equal to 1 and 2 is equal to 2 ( 2 <> 2 is false because 2=2. Remember <> is the NOT EQUAL operator). Basically one condition in the XOR expression has to be true and the other has to be false otherwise the whole expression is false. If this is slightly confusing don't worry. In my 15+ years of programming experience I have never once used this operator. +
+
+ If 1=1 XOR 2 <> 2 Then
+ Print "This is true"
+ End If
+
+ The last of these special operators we will cover is NOT. This one will be extremely simple to understand. Basically if an expression is true it becomes false and if an expression is false it becomes true. +
++ This code will write "This is true" to the screen because the expression 1=3 is false. The NOT statement reverses the false and makes it true. +
+
+ If NOT (1=3) Then
+ Print "This is true"
+ End If
+
+ Lets go over one more program before we move on to the next segment. We will ask the User for a number from 1 to 10. If the User enters 3 or 4 then we will write "Good Answer" to the console. If the User enters a number greater than 5 and less than 9 (Basically 6, 7, or 8) then we will write "Choice numbers" to the console. If the User types in any other number then we will write "Maybe next time" to the console. +
++ Here we are asking the User to enter a number from 1 to 10 using the Input$() function. Input$() returns a string so we have to store it in a string variable. +
+
+ user_in$ = Input$("Enter a number from 1 to 10: ")
+
+ Then we convert the string the User entered into a string using the Val() function. Note: We are using a string variable inside the Val() function instead of using Input$() inside it this time. I am showing it this way to get you used to the idea that Val() takes a string. It can be a string variable, string function, or just a regular string between quotation marks. +
+
+ num = Val(user_in$)
+
+ In the first line of this piece of code we are comparing the variable num (which is the number the User entered) to the number 3 and we compare the variable num to the number 4. If the variable num is equal to the number 3 or 4 then we write "Good Answer" to the console. +
+
+ If num = 3 OR num = 4 Then
+ Print "Good Answer"
+
+ This block of code compares the variable num to the number 5 and the number 9 if the previous If condition was false. If num is greater than 5 and num is less than 9 then we write "Choice numbers" to the console. +
+
+ ElseIf num > 5 AND num < 9 Then
+ Print "Choice numbers"
+
+ Finally this last bit of code will write "Maybe next time" to the console if none of the previous IF conditions were true. It then ends the IF block. +
+
+ Else
+ Print "Maybe next time"
+
+ End If
+
+
+ function_name ( argument1, argument2, ..etc ) - A function can have no arguments or several arguments. Arguments in a function can be numbers or strings, it just depends on what function you are using. So lets look at a few different functions to see how other functions are used. +
++ Abs() returns the Absolute value of a number. +
+
+ Abs( -4 )
+
+ Date$() returns the current date as a string. +
+
+ Date$()
+
+ UCase$() returns the argument you give it as an all uppercase string. +
+
+ UCase$("Hello World")
+
+ As you can see there are different functions to accomplish different task. You can learn more functions by looking in the RC Basic reference manual located in the Docs folder in the rcbasic directory. +
++
+ We are going to cover two types of loops. The first one we are going over is the FOR loop. For loops are used when you want to cycle through a block of code a set number of times. Lets just dive into the code. +
++ Type this code into your editor and run it. +
+
+ For i = 1 to 10
+ Print i
+ Next
+
+ The code in the example above writes the numbers 1 to 10 in the console. The FOR loop starts with a variable, which in this case is i. We set it with an initial value of 1 and tell the computer to loop the code between the FOR line and the NEXT line until i is equal to 10. When the NEXT statement is reached, i is increased by 1 and the program goes back to the start of the loop. That is how the FOR loop works in a nutshell. There is some extra control we can take over the For loop with the STEP statement. With the STEP statement we can change the amount the variable in the For line increases by. Look at the following example. +
++ This code will write the even numbers from 2 to 10 to the console. +
+
+ For i = 2 to 10 Step 2
+ Print i
+ Next
+
+ The last loop we are covering in this tutorial is the WHILE loop. The WHILE loop will loop through a block of code while a certain condition is true. Look at the following example. +
+
+ i = 1
+ While i <= 10
+ Print i
+ i = i + 1
+ Wend
+
+ In the example above we are doing a little bit more than we have been doing up to this point. First we are creating a variable called i. We start a While loop that compares i to the number 10. If i is less than or equal to 10 then we write the value stored in i to the console. Then we get to the line i = i + 1. This line is making i equal to the value stored in i plus 1. Basically we are increasing i by 1. The WEND line goes back to the start of the WHILE block where it compares i to 10 and if it is less than or equal to 10 it repeats the block of code again. +
++ Now for some challenges. +
++ 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/files/hello_world.txt b/doc/files/hello_world.txt new file mode 100644 index 0000000..37ea09b --- /dev/null +++ b/doc/files/hello_world.txt @@ -0,0 +1,440 @@ +#title RCBasic First Program [RCBasic Doc] +#header YOUR FIRST PROGRAM + + +This tutorial is designed to introduce complete newbies to the world of computer programming and specifically programming using RC Basic. This tutorial will not assume any previous programming knowledge and really won't even assume you know much about how a computer works. A basic understanding of 6th Grade Algebra will come in handy but is not necessary. Now that I got that out of the way, lets take our first steps in our journey to becoming computer programmers. + +First lets go over the requirements you will need to follow this tutorial. You will need a computer (obviously), RC Basic (yet again obvious, but I had to say it), and the will to learn (not essential but it will definitely help). Ok lets begin. + +
+ Returns a hexadecimal representation of a number. +
++ + + \ No newline at end of file diff --git a/doc/files/hex.txt b/doc/files/hex.txt new file mode 100644 index 0000000..f7382e4 --- /dev/null +++ b/doc/files/hex.txt @@ -0,0 +1,4 @@ +#title Hex$ [RCBasic Doc] +#header function Hex$(n) + +Returns a hexadecimal representation of a number. diff --git a/doc/files/hexval.html b/doc/files/hexval.html new file mode 100644 index 0000000..ea343cf --- /dev/null +++ b/doc/files/hexval.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the integer value of a hexadecimal string. +
++ + + \ No newline at end of file diff --git a/doc/files/hexval.txt b/doc/files/hexval.txt new file mode 100644 index 0000000..59e7935 --- /dev/null +++ b/doc/files/hexval.txt @@ -0,0 +1,4 @@ +#title HexVal [RCBasic Doc] +#header function HexVal(n$) + +Returns the integer value of a hexadecimal string. diff --git a/doc/files/hidemouse.html b/doc/files/hidemouse.html new file mode 100644 index 0000000..9278c3a --- /dev/null +++ b/doc/files/hidemouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Makes the mouse cursor invisible. +
++ + + \ No newline at end of file diff --git a/doc/files/hidemouse.txt b/doc/files/hidemouse.txt new file mode 100644 index 0000000..7979f54 --- /dev/null +++ b/doc/files/hidemouse.txt @@ -0,0 +1,4 @@ +#title HideMouse [RCBasic Doc] +#header sub HideMouse() + +Makes the mouse cursor invisible. diff --git a/doc/files/hidewindow.html b/doc/files/hidewindow.html new file mode 100644 index 0000000..8a08ec0 --- /dev/null +++ b/doc/files/hidewindow.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the window invisible. +
+Related: + ShowWindow + WindowIsVisible +
++ + + \ No newline at end of file diff --git a/doc/files/hidewindow.txt b/doc/files/hidewindow.txt new file mode 100644 index 0000000..8b92349 --- /dev/null +++ b/doc/files/hidewindow.txt @@ -0,0 +1,6 @@ +#title HideWindow [RCBasic Doc] +#header sub HideWindow( ) + +Sets the window invisible. + +#ref ShowWindow WindowIsVisible diff --git a/doc/files/imageexists.html b/doc/files/imageexists.html new file mode 100644 index 0000000..38f81a8 --- /dev/null +++ b/doc/files/imageexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if img is associated with an allocated image in memory +
++ + + \ No newline at end of file diff --git a/doc/files/imageexists.txt b/doc/files/imageexists.txt new file mode 100644 index 0000000..2f62b66 --- /dev/null +++ b/doc/files/imageexists.txt @@ -0,0 +1,4 @@ +#title ImageExists [RCBasic Doc] +#header function ImageExists(img) + +Returns true if img is associated with an allocated image in memory diff --git a/doc/files/incrementmatrixcolumns.html b/doc/files/incrementmatrixcolumns.html new file mode 100644 index 0000000..296bbe5 --- /dev/null +++ b/doc/files/incrementmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/incrementmatrixcolumns.txt b/doc/files/incrementmatrixcolumns.txt new file mode 100644 index 0000000..e4d1124 --- /dev/null +++ b/doc/files/incrementmatrixcolumns.txt @@ -0,0 +1,4 @@ +#title IncrementMatrixColumns [RCBasic Doc] +#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.html b/doc/files/incrementmatrixrows.html new file mode 100644 index 0000000..7342dee --- /dev/null +++ b/doc/files/incrementmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/incrementmatrixrows.txt b/doc/files/incrementmatrixrows.txt new file mode 100644 index 0000000..e7634d8 --- /dev/null +++ b/doc/files/incrementmatrixrows.txt @@ -0,0 +1,4 @@ +#title IncrementMatrixRows [RCBasic Doc] +#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.html b/doc/files/inkey.html new file mode 100644 index 0000000..f5fc3ee --- /dev/null +++ b/doc/files/inkey.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the character value of the key that was pressed. +
++ + + \ No newline at end of file diff --git a/doc/files/inkey.txt b/doc/files/inkey.txt new file mode 100644 index 0000000..65f8d0d --- /dev/null +++ b/doc/files/inkey.txt @@ -0,0 +1,4 @@ +#title InKey [RCBasic Doc] +#header function InKey() + +Returns the character value of the key that was pressed. diff --git a/doc/files/input.html b/doc/files/input.html new file mode 100644 index 0000000..9299c02 --- /dev/null +++ b/doc/files/input.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns user input from the console +
++ + + \ No newline at end of file diff --git a/doc/files/input.txt b/doc/files/input.txt new file mode 100644 index 0000000..87f735c --- /dev/null +++ b/doc/files/input.txt @@ -0,0 +1,4 @@ +#title Input$ [RCBasic Doc] +#header function Input$(prompt$) + +Returns user input from the console diff --git a/doc/files/insert.html b/doc/files/insert.html new file mode 100644 index 0000000..96c239e --- /dev/null +++ b/doc/files/insert.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a string containing str_to_insert$ inserted into src$ at a given position +
++ + + \ No newline at end of file diff --git a/doc/files/insert.txt b/doc/files/insert.txt new file mode 100644 index 0000000..b79be67 --- /dev/null +++ b/doc/files/insert.txt @@ -0,0 +1,4 @@ +#title Insert$ [RCBasic Doc] +#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.html b/doc/files/insertmatrixcolumns.html new file mode 100644 index 0000000..e1320fb --- /dev/null +++ b/doc/files/insertmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ Insert a number of empty columns into matrix mA starting at the specified column. +
++ + + \ No newline at end of file diff --git a/doc/files/insertmatrixcolumns.txt b/doc/files/insertmatrixcolumns.txt new file mode 100644 index 0000000..ce15daa --- /dev/null +++ b/doc/files/insertmatrixcolumns.txt @@ -0,0 +1,4 @@ +#title InsertMatrixColumns [RCBasic Doc] +#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.html b/doc/files/insertmatrixrows.html new file mode 100644 index 0000000..3769471 --- /dev/null +++ b/doc/files/insertmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ Insert a number of empty rows into matrix mA starting at the specified row. +
++ + + \ No newline at end of file diff --git a/doc/files/insertmatrixrows.txt b/doc/files/insertmatrixrows.txt new file mode 100644 index 0000000..a2c82d9 --- /dev/null +++ b/doc/files/insertmatrixrows.txt @@ -0,0 +1,4 @@ +#title InsertMatrixRows [RCBasic Doc] +#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.html b/doc/files/instr.html new file mode 100644 index 0000000..1d9ec84 --- /dev/null +++ b/doc/files/instr.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/instr.txt b/doc/files/instr.txt new file mode 100644 index 0000000..0494250 --- /dev/null +++ b/doc/files/instr.txt @@ -0,0 +1,4 @@ +#title InStr [RCBasic Doc] +#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.html b/doc/files/int.html new file mode 100644 index 0000000..91dc96c --- /dev/null +++ b/doc/files/int.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a number converted to an integer. +
++ + + \ No newline at end of file diff --git a/doc/files/int.txt b/doc/files/int.txt new file mode 100644 index 0000000..42a718e --- /dev/null +++ b/doc/files/int.txt @@ -0,0 +1,4 @@ +#title Int [RCBasic Doc] +#header function Int(n) + +Returns a number converted to an integer. diff --git a/doc/files/integrateactorvelocities.html b/doc/files/integrateactorvelocities.html new file mode 100644 index 0000000..f70a3d7 --- /dev/null +++ b/doc/files/integrateactorvelocities.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/integrateactorvelocities.txt b/doc/files/integrateactorvelocities.txt new file mode 100644 index 0000000..3ed735d --- /dev/null +++ b/doc/files/integrateactorvelocities.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/interpolate.html new file mode 100644 index 0000000..ce13906 --- /dev/null +++ b/doc/files/interpolate.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/interpolate.txt b/doc/files/interpolate.txt new file mode 100644 index 0000000..149e3b0 --- /dev/null +++ b/doc/files/interpolate.txt @@ -0,0 +1,4 @@ +#title Interpolate [RCBasic Doc] +#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/intro.html b/doc/files/intro.html new file mode 100644 index 0000000..57af014 --- /dev/null +++ b/doc/files/intro.html @@ -0,0 +1,20 @@ + + +
+ + ++ First I would like to say thank you for taking an interest in RCBASIC ( I use all caps because I think it looks more retro that way). RCBASIC is a variant of the BASIC programming language. It consist of a compiler, interpreter, and a code editor. This version of BASIC was mostly influenced by sdlBasic and QBasic. My main reason for writing this software was just to have fun and challenge myself. This language is not as full featured as C++ or Java but you can still create some awesome stuff with it. I hope you have as much fun using this software as I had making it. +
++ Rodney Cunningham (aka. n00b) +
++ + + \ No newline at end of file diff --git a/doc/files/intro.txt b/doc/files/intro.txt new file mode 100644 index 0000000..dde19f4 --- /dev/null +++ b/doc/files/intro.txt @@ -0,0 +1,6 @@ +#title Introduction to RCBasic [RCBasic Doc] +#header INTRODUCTION TO RCBASIC + + First I would like to say thank you for taking an interest in RCBASIC ( I use all caps because I think it looks more retro that way). RCBASIC is a variant of the BASIC programming language. It consist of a compiler, interpreter, and a code editor. This version of BASIC was mostly influenced by sdlBasic and QBasic. My main reason for writing this software was just to have fun and challenge myself. This language is not as full featured as C++ or Java but you can still create some awesome stuff with it. I hope you have as much fun using this software as I had making it. + + Rodney Cunningham (aka. n00b) diff --git a/doc/files/invertmatrix.html b/doc/files/invertmatrix.html new file mode 100644 index 0000000..f53a454 --- /dev/null +++ b/doc/files/invertmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores the inverse matrix of mA in mB +
++ + + \ No newline at end of file diff --git a/doc/files/invertmatrix.txt b/doc/files/invertmatrix.txt new file mode 100644 index 0000000..a5a2c40 --- /dev/null +++ b/doc/files/invertmatrix.txt @@ -0,0 +1,4 @@ +#title InvertMatrix [RCBasic Doc] +#header function InvertMatrix(mA, mB) + +Stores the inverse matrix of mA in mB diff --git a/doc/files/io.html b/doc/files/io.html new file mode 100644 index 0000000..247ada9 --- /dev/null +++ b/doc/files/io.html @@ -0,0 +1,41 @@ + + +
+ + ++ RC BASIC has two ways of getting output to a text console. The first way is the PRINT keyword shown here: +
+
+ Print "HELLO WORLD"
+ Print 5
+
+ You can also use a ";" to output multiple values or to prevent PRINT from going to a new-line in its output. +
+
+ Print "This is line 1. ";
+ Print "This is still line 1. Value="; 4+5; " This is the end of line 1"
+ Print "Line 2 start"
+
+ You can also use the FPrint() sub routine to do the same thing as PRINT. It was added back in RCBasic v1.0 since PRINT was not able to stop new-line after its output back then. This is a legacy hold over and does not really add any new functionality. +
++ To get input from the user you would use the INPUT$ function. INPUT$ will display a prompt to the user and then get input from the console. +
+
+ USER_NAME$ = INPUT$("WHAT IS YOUR NAME? ")
+
+ 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/files/io.txt b/doc/files/io.txt new file mode 100644 index 0000000..cb35c1d --- /dev/null +++ b/doc/files/io.txt @@ -0,0 +1,25 @@ +#title RCBasic I/O [RCBasic Doc] +#header INPUT/OUTPUT + +RC BASIC has two ways of getting output to a text console. The first way is the PRINT keyword shown here: +#code +Print "HELLO WORLD" +Print 5 +#/code + +You can also use a ";" to output multiple values or to prevent PRINT from going to a new-line in its output. +#code +Print "This is line 1. "; +Print "This is still line 1. Value="; 4+5; " This is the end of line 1" +Print "Line 2 start" +#/code + +You can also use the FPrint() sub routine to do the same thing as PRINT. It was added back in RCBasic v1.0 since PRINT was not able to stop new-line after its output back then. This is a legacy hold over and does not really add any new functionality. + + +To get input from the user you would use the INPUT$ function. INPUT$ will display a prompt to the user and then get input from the console. +#code +USER_NAME$ = INPUT$("WHAT IS YOUR NAME? ") +#/code + +The above example will ask the user WHAT IS YOUR NAME? and then store whatever the user types in into the variable USER_NAME$. diff --git a/doc/files/isequalmatrix.html b/doc/files/isequalmatrix.html new file mode 100644 index 0000000..56eda92 --- /dev/null +++ b/doc/files/isequalmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if matrix mA is within tolerance of matrix mB +
++ + + \ No newline at end of file diff --git a/doc/files/isequalmatrix.txt b/doc/files/isequalmatrix.txt new file mode 100644 index 0000000..8a45e97 --- /dev/null +++ b/doc/files/isequalmatrix.txt @@ -0,0 +1,4 @@ +#title IsEqualMatrix [RCBasic Doc] +#header function IsEqualMatrix(mA, mB, tolerance) + +Returns true if matrix mA is within tolerance of matrix mB diff --git a/doc/files/joinmatrixcolumns.html b/doc/files/joinmatrixcolumns.html new file mode 100644 index 0000000..5a58658 --- /dev/null +++ b/doc/files/joinmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ Appends the columns in matrix mB below matrix mA. +
++ + + \ No newline at end of file diff --git a/doc/files/joinmatrixcolumns.txt b/doc/files/joinmatrixcolumns.txt new file mode 100644 index 0000000..5d2266b --- /dev/null +++ b/doc/files/joinmatrixcolumns.txt @@ -0,0 +1,4 @@ +#title JoinMatrixColumns [RCBasic Doc] +#header sub JoinMatrixColumns(mA, mB, mC) + +Appends the columns in matrix mB below matrix mA. diff --git a/doc/files/joinmatrixrows.html b/doc/files/joinmatrixrows.html new file mode 100644 index 0000000..d7f605d --- /dev/null +++ b/doc/files/joinmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ Appends the rows in matrix mB onto the right of matrix mA. +
++ + + \ No newline at end of file diff --git a/doc/files/joinmatrixrows.txt b/doc/files/joinmatrixrows.txt new file mode 100644 index 0000000..b75bbca --- /dev/null +++ b/doc/files/joinmatrixrows.txt @@ -0,0 +1,4 @@ +#title JoinMatrixRows [RCBasic Doc] +#header sub JoinMatrixRows(mA, mB, mC) + +Appends the rows in matrix mB onto the right of matrix mA. diff --git a/doc/files/jointislimitenabled.html b/doc/files/jointislimitenabled.html new file mode 100644 index 0000000..2c2acc0 --- /dev/null +++ b/doc/files/jointislimitenabled.html @@ -0,0 +1,35 @@ + + +
+ + ++ Returns whether or not the joint limit is enabled +
++ Used with +
+Related: + EnableJointLimit + SetJointLimits +
++ + + \ No newline at end of file diff --git a/doc/files/jointislimitenabled.txt b/doc/files/jointislimitenabled.txt new file mode 100644 index 0000000..1d744cc --- /dev/null +++ b/doc/files/jointislimitenabled.txt @@ -0,0 +1,13 @@ +#title jointIsLimitEnabled [RCBasic Doc] +#header function jointIsLimitEnabled( joint_id) + +Returns whether or not the joint limit is enabled + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref EnableJointLimit SetJointLimits diff --git a/doc/files/jointmotorisenabled.html b/doc/files/jointmotorisenabled.html new file mode 100644 index 0000000..21c38d7 --- /dev/null +++ b/doc/files/jointmotorisenabled.html @@ -0,0 +1,34 @@ + + +
+ + ++ Returns whether or not the joint motor is enabled +
++ Used with +
+Related: + EnableJointMotor +
++ + + \ No newline at end of file diff --git a/doc/files/jointmotorisenabled.txt b/doc/files/jointmotorisenabled.txt new file mode 100644 index 0000000..991e120 --- /dev/null +++ b/doc/files/jointmotorisenabled.txt @@ -0,0 +1,13 @@ +#title jointMotorIsEnabled [RCBasic Doc] +#header function jointMotorIsEnabled( joint_id) + +Returns whether or not the joint motor is enabled + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref EnableJointMotor diff --git a/doc/files/joyaxis.html b/doc/files/joyaxis.html new file mode 100644 index 0000000..7c8ee90 --- /dev/null +++ b/doc/files/joyaxis.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the value of an axis on a joystick. +
++ + + \ No newline at end of file diff --git a/doc/files/joyaxis.txt b/doc/files/joyaxis.txt new file mode 100644 index 0000000..7234801 --- /dev/null +++ b/doc/files/joyaxis.txt @@ -0,0 +1,4 @@ +#title JoyAxis [RCBasic Doc] +#header function JoyAxis(joy_num, joy_axis) + +Returns the value of an axis on a joystick. diff --git a/doc/files/joybutton.html b/doc/files/joybutton.html new file mode 100644 index 0000000..0d1d73f --- /dev/null +++ b/doc/files/joybutton.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the given button was pressed and false otherwise. +
++ + + \ No newline at end of file diff --git a/doc/files/joybutton.txt b/doc/files/joybutton.txt new file mode 100644 index 0000000..7aacab7 --- /dev/null +++ b/doc/files/joybutton.txt @@ -0,0 +1,4 @@ +#title JoyButton [RCBasic Doc] +#header function JoyButton(joy_num, joy_button) + +Returns true if the given button was pressed and false otherwise. diff --git a/doc/files/joyhat.html b/doc/files/joyhat.html new file mode 100644 index 0000000..cd392c8 --- /dev/null +++ b/doc/files/joyhat.html @@ -0,0 +1,49 @@ + + +
+ + ++ Returns the position of the Hat. +
++ Possible Hat Positions +
++ + + \ No newline at end of file diff --git a/doc/files/joyhat.txt b/doc/files/joyhat.txt new file mode 100644 index 0000000..5276fd1 --- /dev/null +++ b/doc/files/joyhat.txt @@ -0,0 +1,17 @@ +#title JoyHat [RCBasic Doc] +#header function JoyHat(joy_num, joy_hat) + +Returns the position of the Hat. + +Possible Hat Positions +#list ul +#li HAT_CENTERED +#li HAT_LEFT +#li HAT_RIGHT +#li HAT_UP +#li HAT_DOWN +#li HAT_RIGHTUP +#li HAT_RIGHTDOWN +#li HAT_LEFTUP +#li HAT_LEFTDOWN +#/list diff --git a/doc/files/joyname.html b/doc/files/joyname.html new file mode 100644 index 0000000..8b84cc5 --- /dev/null +++ b/doc/files/joyname.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the joystick name. +
++ + + \ No newline at end of file diff --git a/doc/files/joyname.txt b/doc/files/joyname.txt new file mode 100644 index 0000000..ba4df21 --- /dev/null +++ b/doc/files/joyname.txt @@ -0,0 +1,4 @@ +#title JoyName$ [RCBasic Doc] +#header function JoyName$(joy_num) + +Returns the joystick name. diff --git a/doc/files/joyrumbleplay.html b/doc/files/joyrumbleplay.html new file mode 100644 index 0000000..8b9bf12 --- /dev/null +++ b/doc/files/joyrumbleplay.html @@ -0,0 +1,25 @@ + + +
+ + ++ Rumbles a joystick at a specified strength for the specifed duration. +
++ + + \ No newline at end of file diff --git a/doc/files/joyrumbleplay.txt b/doc/files/joyrumbleplay.txt new file mode 100644 index 0000000..c015106 --- /dev/null +++ b/doc/files/joyrumbleplay.txt @@ -0,0 +1,9 @@ +#title JoyRumblePlay [RCBasic Doc] +#header sub JoyRumblePlay(joy_num, strength, duration) + +Rumbles a joystick at a specified strength for the specifed duration. + +#list ul +#li Strength - A value between 0 and 1 +#li Duration - Value is in milliseconds +#/list diff --git a/doc/files/joyrumblestop.html b/doc/files/joyrumblestop.html new file mode 100644 index 0000000..1d0f439 --- /dev/null +++ b/doc/files/joyrumblestop.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stops the rumble on a joystick +
++ + + \ No newline at end of file diff --git a/doc/files/joyrumblestop.txt b/doc/files/joyrumblestop.txt new file mode 100644 index 0000000..5096027 --- /dev/null +++ b/doc/files/joyrumblestop.txt @@ -0,0 +1,4 @@ +#title JoyRumbleStop [RCBasic Doc] +#header sub JoyRumbleStop(joy_num) + +Stops the rumble on a joystick diff --git a/doc/files/joystickisconnected.html b/doc/files/joystickisconnected.html new file mode 100644 index 0000000..02a0f3e --- /dev/null +++ b/doc/files/joystickisconnected.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if joystick is connected, or false if it isn't. +
++ + + \ No newline at end of file diff --git a/doc/files/joystickisconnected.txt b/doc/files/joystickisconnected.txt new file mode 100644 index 0000000..7b7db7a --- /dev/null +++ b/doc/files/joystickisconnected.txt @@ -0,0 +1,4 @@ +#title JoystickIsConnected [RCBasic Doc] +#header function JoystickIsConnected(joy_num) + +Returns true if joystick is connected, or false if it isn't. diff --git a/doc/files/joystickishaptic.html b/doc/files/joystickishaptic.html new file mode 100644 index 0000000..9f8da8a --- /dev/null +++ b/doc/files/joystickishaptic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if joystick has the ability to rumble. +
++ + + \ No newline at end of file diff --git a/doc/files/joystickishaptic.txt b/doc/files/joystickishaptic.txt new file mode 100644 index 0000000..96948a6 --- /dev/null +++ b/doc/files/joystickishaptic.txt @@ -0,0 +1,4 @@ +#title JoystickIsHaptic [RCBasic Doc] +#header function JoystickIsHaptic(joy_num) + +Returns true if joystick has the ability to rumble. diff --git a/doc/files/key.html b/doc/files/key.html new file mode 100644 index 0000000..48ec475 --- /dev/null +++ b/doc/files/key.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the given key was pressed and false otherwise. +
++ + + \ No newline at end of file diff --git a/doc/files/key.txt b/doc/files/key.txt new file mode 100644 index 0000000..970bd9e --- /dev/null +++ b/doc/files/key.txt @@ -0,0 +1,4 @@ +#title Key [RCBasic Doc] +#header function Key(key_code) + +Returns true if the given key was pressed and false otherwise. diff --git a/doc/files/lcase.html b/doc/files/lcase.html new file mode 100644 index 0000000..e0fdcff --- /dev/null +++ b/doc/files/lcase.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ converted to a completely lower-case string +
++ + + \ No newline at end of file diff --git a/doc/files/lcase.txt b/doc/files/lcase.txt new file mode 100644 index 0000000..240b219 --- /dev/null +++ b/doc/files/lcase.txt @@ -0,0 +1,4 @@ +#title LCase$ [RCBasic Doc] +#header function LCase$(src$) + +Returns src$ converted to a completely lower-case string diff --git a/doc/files/left.html b/doc/files/left.html new file mode 100644 index 0000000..0cfc9c1 --- /dev/null +++ b/doc/files/left.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/left.txt b/doc/files/left.txt new file mode 100644 index 0000000..e6cc52e --- /dev/null +++ b/doc/files/left.txt @@ -0,0 +1,4 @@ +#title Left$ [RCBasic Doc] +#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.html b/doc/files/len.html new file mode 100644 index 0000000..206d9ed --- /dev/null +++ b/doc/files/len.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the number of characters in the given string +
++ Note: This function is the exact same as Length() +
+Related: + Length +
++ + + \ No newline at end of file diff --git a/doc/files/len.txt b/doc/files/len.txt new file mode 100644 index 0000000..edac124 --- /dev/null +++ b/doc/files/len.txt @@ -0,0 +1,8 @@ +#title Len [RCBasic Doc] +#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.html b/doc/files/length.html new file mode 100644 index 0000000..80ff13f --- /dev/null +++ b/doc/files/length.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns the number of characters in the given string +
++ Note: This function is the exact same as Len() +
+Related: + Length +
++ + + \ No newline at end of file diff --git a/doc/files/length.txt b/doc/files/length.txt new file mode 100644 index 0000000..aedb7b1 --- /dev/null +++ b/doc/files/length.txt @@ -0,0 +1,8 @@ +#title Length [RCBasic Doc] +#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/license.html b/doc/files/license.html new file mode 100644 index 0000000..6481455 --- /dev/null +++ b/doc/files/license.html @@ -0,0 +1,32 @@ + + +
+ + ++ RCBasic is available under the zlib license : +
++ This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. +
++ Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: +
++ 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. +
++ 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. +
++ 3. This notice may not be removed or altered from any source distribution. +
++ + + \ No newline at end of file diff --git a/doc/files/license.txt b/doc/files/license.txt new file mode 100644 index 0000000..bec8934 --- /dev/null +++ b/doc/files/license.txt @@ -0,0 +1,23 @@ +#title RCBasic License [RCBasic Doc] +#header LICENSE + + RCBasic is available under the zlib license : + +This software is provided 'as-is', without any express or implied +warranty. In no event will the authors be held liable for any damages +arising from the use of this software. + +Permission is granted to anyone to use this software for any purpose, +including commercial applications, and to alter it and redistribute it +freely, subject to the following restrictions: + +1. The origin of this software must not be misrepresented; you must not +claim that you wrote the original software. If you use this software +in a product, an acknowledgment in the product documentation would be +appreciated but is not required. + +2. Altered source versions must be plainly marked as such, and must not be +misrepresented as being the original software. + +3. This notice may not be removed or altered from any source distribution. + diff --git a/doc/files/lightiscastingshadow.html b/doc/files/lightiscastingshadow.html new file mode 100644 index 0000000..9203c78 --- /dev/null +++ b/doc/files/lightiscastingshadow.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if shadow casting is enabled for the given light +
+Related: + SetLightShadowCast +
++ + + \ No newline at end of file diff --git a/doc/files/lightiscastingshadow.txt b/doc/files/lightiscastingshadow.txt new file mode 100644 index 0000000..41e92ff --- /dev/null +++ b/doc/files/lightiscastingshadow.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/line.html new file mode 100644 index 0000000..337dbc8 --- /dev/null +++ b/doc/files/line.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a line +
++ + + \ No newline at end of file diff --git a/doc/files/line.txt b/doc/files/line.txt new file mode 100644 index 0000000..bf6c840 --- /dev/null +++ b/doc/files/line.txt @@ -0,0 +1,4 @@ +#title Line [RCBasic Doc] +#header sub Line(x1, y1, x2, y2) + +Draws a line diff --git a/doc/files/line3d.html b/doc/files/line3d.html new file mode 100644 index 0000000..2fb3b2a --- /dev/null +++ b/doc/files/line3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a line in 3D space +
++ + + \ No newline at end of file diff --git a/doc/files/line3d.txt b/doc/files/line3d.txt new file mode 100644 index 0000000..a9ce8a9 --- /dev/null +++ b/doc/files/line3d.txt @@ -0,0 +1,4 @@ +#title Line3D [RCBasic Doc] +#header sub Line3D(x1, y1, z1, x2, y2, z2) + +Draws a line in 3D space diff --git a/doc/files/loadan8.html b/doc/files/loadan8.html new file mode 100644 index 0000000..a9091b8 --- /dev/null +++ b/doc/files/loadan8.html @@ -0,0 +1,20 @@ + + +
+ + ++ Loads an an8 project and returns an id that can be used in LoadMeshFromAN8() +
+Related: + LoadMeshFromAN8 +
++ + + \ No newline at end of file diff --git a/doc/files/loadan8.txt b/doc/files/loadan8.txt new file mode 100644 index 0000000..634043e --- /dev/null +++ b/doc/files/loadan8.txt @@ -0,0 +1,6 @@ +#title LoadAN8 [RCBasic Doc] +#header Function LoadAN8( an8_file$ ) + +Loads an an8 project and returns an id that can be used in LoadMeshFromAN8() + +#ref LoadMeshFromAN8 diff --git a/doc/files/loadfont.html b/doc/files/loadfont.html new file mode 100644 index 0000000..7f6dbc9 --- /dev/null +++ b/doc/files/loadfont.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a font id for a font with glyphs of font_size +
++ + + \ No newline at end of file diff --git a/doc/files/loadfont.txt b/doc/files/loadfont.txt new file mode 100644 index 0000000..3b94b01 --- /dev/null +++ b/doc/files/loadfont.txt @@ -0,0 +1,4 @@ +#title LoadFont [RCBasic Doc] +#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.html b/doc/files/loadimage.html new file mode 100644 index 0000000..134134d --- /dev/null +++ b/doc/files/loadimage.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns an image id for an image loaded into memory +
++ + + \ No newline at end of file diff --git a/doc/files/loadimage.txt b/doc/files/loadimage.txt new file mode 100644 index 0000000..e196891 --- /dev/null +++ b/doc/files/loadimage.txt @@ -0,0 +1,4 @@ +#title LoadImage [RCBasic Doc] +#header function LoadImage( img$ ) + +Returns an image id for an image loaded into memory diff --git a/doc/files/loadimageex.html b/doc/files/loadimageex.html new file mode 100644 index 0000000..261dc7d --- /dev/null +++ b/doc/files/loadimageex.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns an image id for an image loaded into memory +
++ + + \ No newline at end of file diff --git a/doc/files/loadimageex.txt b/doc/files/loadimageex.txt new file mode 100644 index 0000000..548970b --- /dev/null +++ b/doc/files/loadimageex.txt @@ -0,0 +1,4 @@ +#title LoadImageEx [RCBasic Doc] +#header function LoadImageEx(img$, colkey) + +Returns an image id for an image loaded into memory diff --git a/doc/files/loadmesh.html b/doc/files/loadmesh.html new file mode 100644 index 0000000..70bc16d --- /dev/null +++ b/doc/files/loadmesh.html @@ -0,0 +1,95 @@ + + +
+ + ++ Returns a mesh id for the loaded mesh +
++ Supported formats +
+Related: + LoadMeshFromArchive +
++ + + \ No newline at end of file diff --git a/doc/files/loadmesh.txt b/doc/files/loadmesh.txt new file mode 100644 index 0000000..528026b --- /dev/null +++ b/doc/files/loadmesh.txt @@ -0,0 +1,36 @@ +#title LoadMesh [RCBasic Doc] +#header function LoadMesh( mesh_file$ ) + +Returns a mesh id for the loaded mesh + +Supported formats +#list ul +#li Animated objects: + #list ul + #li B3D files (.b3d, r, skeleton) + #li Microsoft DirectX (.x, r) (binary & text, skeleton) + #li Milkshape (.ms3d, r, skeleton) + #li Quake 3 models (.md3, r, morph) + #li Quake 2 models (.md2, r, morph) + #/list +#li Static objects: + #list ul + #li Irrlicht scenes (.irr, r/w) + #li Irrlicht static meshes (.irrmesh, r/w) + #li 3D Studio meshes (.3ds, r) + #li Alias Wavefront Maya (.obj, r/w) + #li Lightwave Objects (.lwo, r) + #li COLLADA 1.4 (.xml, .dae, r/w) + #li OGRE meshes (.mesh, r) + #li My3DTools 3 (.my3D, r) + #li Pulsar LMTools (.lmts, r) + #li Quake 3 levels (.bsp, r) + #li DeleD (.dmf, r) + #li FSRad oct (.oct, r) + #li Cartography shop 4 (.csm, r) + #li STL 3D files (.stl, r/w) + #li PLY 3D files (.ply, r/w) + #/list +#/list + +#ref LoadMeshFromArchive diff --git a/doc/files/loadmeshfroman8.html b/doc/files/loadmeshfroman8.html new file mode 100644 index 0000000..dbc4486 --- /dev/null +++ b/doc/files/loadmeshfroman8.html @@ -0,0 +1,25 @@ + + +
+ + ++ 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 +
+Related: + LoadAN8 + LoadMesh + LoadMeshFromArchive +
++ + + \ No newline at end of file diff --git a/doc/files/loadmeshfroman8.txt b/doc/files/loadmeshfroman8.txt new file mode 100644 index 0000000..952142b --- /dev/null +++ b/doc/files/loadmeshfroman8.txt @@ -0,0 +1,8 @@ +#title LoadMeshFromAN8 [RCBasic Doc] +#header Function LoadMeshFromAN8(an8_project, an8_scene$) + +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.html b/doc/files/loadmeshfromarchive.html new file mode 100644 index 0000000..52eb137 --- /dev/null +++ b/doc/files/loadmeshfromarchive.html @@ -0,0 +1,95 @@ + + +
+ + ++ Returns a mesh id for the loaded mesh from an archive (*.zip, *.pak, etc.) +
++ Supported formats +
+Related: + LoadMesh +
++ + + \ No newline at end of file diff --git a/doc/files/loadmeshfromarchive.txt b/doc/files/loadmeshfromarchive.txt new file mode 100644 index 0000000..709103e --- /dev/null +++ b/doc/files/loadmeshfromarchive.txt @@ -0,0 +1,36 @@ +#title LoadMeshFromArchive [RCBasic Doc] +#header function LoadMeshFromArchive( archive$, mesh_file$ ) + +Returns a mesh id for the loaded mesh from an archive (*.zip, *.pak, etc.) + +Supported formats +#list ul +#li Animated objects: + #list ul + #li B3D files (.b3d, r, skeleton) + #li Microsoft DirectX (.x, r) (binary & text, skeleton) + #li Milkshape (.ms3d, r, skeleton) + #li Quake 3 models (.md3, r, morph) + #li Quake 2 models (.md2, r, morph) + #/list +#li Static objects: + #list ul + #li Irrlicht scenes (.irr, r/w) + #li Irrlicht static meshes (.irrmesh, r/w) + #li 3D Studio meshes (.3ds, r) + #li Alias Wavefront Maya (.obj, r/w) + #li Lightwave Objects (.lwo, r) + #li COLLADA 1.4 (.xml, .dae, r/w) + #li OGRE meshes (.mesh, r) + #li My3DTools 3 (.my3D, r) + #li Pulsar LMTools (.lmts, r) + #li Quake 3 levels (.bsp, r) + #li DeleD (.dmf, r) + #li FSRad oct (.oct, r) + #li Cartography shop 4 (.csm, r) + #li STL 3D files (.stl, r/w) + #li PLY 3D files (.ply, r/w) + #/list +#/list + +#ref LoadMesh diff --git a/doc/files/loadmusic.html b/doc/files/loadmusic.html new file mode 100644 index 0000000..92857fb --- /dev/null +++ b/doc/files/loadmusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Loads a music track +
++ + + \ No newline at end of file diff --git a/doc/files/loadmusic.txt b/doc/files/loadmusic.txt new file mode 100644 index 0000000..ffb8ddc --- /dev/null +++ b/doc/files/loadmusic.txt @@ -0,0 +1,4 @@ +#title LoadMusic [RCBasic Doc] +#header sub LoadMusic(music_file$) + +Loads a music track diff --git a/doc/files/loadsound.html b/doc/files/loadsound.html new file mode 100644 index 0000000..0f3cd47 --- /dev/null +++ b/doc/files/loadsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns an id for a loaded audio track +
++ + + \ No newline at end of file diff --git a/doc/files/loadsound.txt b/doc/files/loadsound.txt new file mode 100644 index 0000000..539ae23 --- /dev/null +++ b/doc/files/loadsound.txt @@ -0,0 +1,4 @@ +#title LoadSound [RCBasic Doc] +#header function LoadSound(snd_file$) + +Returns an id for a loaded audio track diff --git a/doc/files/loadvideo.html b/doc/files/loadvideo.html new file mode 100644 index 0000000..1ee8c1e --- /dev/null +++ b/doc/files/loadvideo.html @@ -0,0 +1,17 @@ + + +
+ + ++ Loads a video track +
++ + + \ No newline at end of file diff --git a/doc/files/loadvideo.txt b/doc/files/loadvideo.txt new file mode 100644 index 0000000..122d0d1 --- /dev/null +++ b/doc/files/loadvideo.txt @@ -0,0 +1,4 @@ +#title LoadVideo [RCBasic Doc] +#header sub LoadVideo(vid$) + +Loads a video track diff --git a/doc/files/log.html b/doc/files/log.html new file mode 100644 index 0000000..772da3a --- /dev/null +++ b/doc/files/log.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the logarithm of a number. +
++ + + \ No newline at end of file diff --git a/doc/files/log.txt b/doc/files/log.txt new file mode 100644 index 0000000..1cf5563 --- /dev/null +++ b/doc/files/log.txt @@ -0,0 +1,4 @@ +#title Log [RCBasic Doc] +#header function Log(n) + +Returns the logarithm of a number. diff --git a/doc/files/loopactoranimation.html b/doc/files/loopactoranimation.html new file mode 100644 index 0000000..4f2c970 --- /dev/null +++ b/doc/files/loopactoranimation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Enables or disables actor animation loop +
++ + + \ No newline at end of file diff --git a/doc/files/loopactoranimation.txt b/doc/files/loopactoranimation.txt new file mode 100644 index 0000000..e4343a2 --- /dev/null +++ b/doc/files/loopactoranimation.txt @@ -0,0 +1,4 @@ +#title LoopActorAnimation [RCBasic Doc] +#header sub LoopActorAnimation( actor, flag ) + +Enables or disables actor animation loop diff --git a/doc/files/loops.html b/doc/files/loops.html new file mode 100644 index 0000000..8faa18e --- /dev/null +++ b/doc/files/loops.html @@ -0,0 +1,83 @@ + + +
+ + ++ RC BASIC has 3 types of loops: FOR, WHILE, and DO. +
++ The FOR loop repeats a block of code and increments a counter each time it finishes the block between FOR and NEXT. When the counter reaches a certain value the FOR loop stops. +
+
+ For I = 1 To 5
+ Print I
+ Next
+
+ The above code will output the numbers 1 to 5 to the console. Optionally you could use the STEP keyword to set the number that the counter will increase by. Look at the following: +
+
+ For I = 1 To 5 Step 2
+ Print I
+ Next
+
+ The above code will output the numbers 1, 3, and 5 to the console. The STEP keyword increases I by 2 each time through the FOR loop. +
++ WHILE loops will execute a block of code while a certain condition is true. +
+
+ I = 0
+ While I < 5
+ Print I
+ I = I + 1
+ Wend
+
+ The above code will output the numbers 0 to 4. It will not output the number 5 because if ( I < 5 ) is false the loop will not repeat. +
++ The DO loop is similar to the WHILE loop with an exception. The WHILE loop checks for the loop condition at the start of the loop but the DO loop checks for the loop condition at the end of the loop. What this means is that a WHILE loop will never execute if the condition is false at the start but the DO loop is guaranteed to execute at least once before it checks if the condition was true or not. +
++ The DO loop is also unique in that it has 3 different forms. Here is the simplest form of the DO loop. +
+
+ Do
+ Print "HELLO WORLD"
+ Loop
+
+ The code above will continue to output HELLO WORLD to the console infinitely. +
+
+ I = 0
+ Do
+ Print I
+ I = I + 1
+ Loop While I < 5
+
+ The above code will output the numbers 0 to 4 to the console. This form of the DO loop will continue to loop while the loop condition is true. +
+
+ I = 0
+ Do
+ Print I
+ I = I + 1
+ Loop Until I = 5
+
+ 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/files/loops.txt b/doc/files/loops.txt new file mode 100644 index 0000000..28f76ec --- /dev/null +++ b/doc/files/loops.txt @@ -0,0 +1,61 @@ +#title RCBasic Loops [RCBasic Doc] +#header LOOPS + +RC BASIC has 3 types of loops: FOR, WHILE, and DO. + +The FOR loop repeats a block of code and increments a counter each time it finishes the block between FOR and NEXT. When the counter reaches a certain value the FOR loop stops. +#code +For I = 1 To 5 + Print I +Next +#/code + +The above code will output the numbers 1 to 5 to the console. Optionally you could use the STEP keyword to set the number that the counter will increase by. Look at the following: +#code +For I = 1 To 5 Step 2 + Print I +Next +#/code + +The above code will output the numbers 1, 3, and 5 to the console. The STEP keyword increases I by 2 each time through the FOR loop. + +WHILE loops will execute a block of code while a certain condition is true. +#code +I = 0 +While I < 5 + Print I + I = I + 1 +Wend +#/code + +The above code will output the numbers 0 to 4. It will not output the number 5 because if ( I < 5 ) is false the loop will not repeat. + +The DO loop is similar to the WHILE loop with an exception. The WHILE loop checks for the loop condition at the start of the loop but the DO loop checks for the loop condition at the end of the loop. What this means is that a WHILE loop will never execute if the condition is false at the start but the DO loop is guaranteed to execute at least once before it checks if the condition was true or not. + +The DO loop is also unique in that it has 3 different forms. Here is the simplest form of the DO loop. +#code +Do + Print "HELLO WORLD" +Loop +#/code + +The code above will continue to output HELLO WORLD to the console infinitely. +#code +I = 0 +Do + Print I + I = I + 1 +Loop While I < 5 +#/code + +The above code will output the numbers 0 to 4 to the console. This form of the DO loop will continue to loop while the loop condition is true. + +#code +I = 0 +Do + Print I + I = I + 1 +Loop Until I = 5 +#/code + +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. diff --git a/doc/files/ltrim.html b/doc/files/ltrim.html new file mode 100644 index 0000000..ef3f472 --- /dev/null +++ b/doc/files/ltrim.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns src$ with all the spaces before the first non-space character removed. +
++ + + \ No newline at end of file diff --git a/doc/files/ltrim.txt b/doc/files/ltrim.txt new file mode 100644 index 0000000..c6cdb3c --- /dev/null +++ b/doc/files/ltrim.txt @@ -0,0 +1,6 @@ +#title LTrim$ [RCBasic Doc] +#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.html b/doc/files/makedir.html new file mode 100644 index 0000000..79585d6 --- /dev/null +++ b/doc/files/makedir.html @@ -0,0 +1,17 @@ + + +
+ + ++ Creates a new directory. +
++ + + \ No newline at end of file diff --git a/doc/files/makedir.txt b/doc/files/makedir.txt new file mode 100644 index 0000000..98c60c8 --- /dev/null +++ b/doc/files/makedir.txt @@ -0,0 +1,4 @@ +#title MakeDir [RCBasic Doc] +#header function MakeDir(p$) + +Creates a new directory. diff --git a/doc/files/materialexists.html b/doc/files/materialexists.html new file mode 100644 index 0000000..19dd058 --- /dev/null +++ b/doc/files/materialexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the material id is an existing material +
++ + + \ No newline at end of file diff --git a/doc/files/materialexists.txt b/doc/files/materialexists.txt new file mode 100644 index 0000000..f18ad2c --- /dev/null +++ b/doc/files/materialexists.txt @@ -0,0 +1,4 @@ +#title MaterialExists [RCBasic Doc] +#header function MaterialExists( material ) + +Returns true if the material id is an existing material diff --git a/doc/files/materialisaplhablend.html b/doc/files/materialisaplhablend.html new file mode 100644 index 0000000..638739e --- /dev/null +++ b/doc/files/materialisaplhablend.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if alpha blending is enabled for a material +
++ + + \ No newline at end of file diff --git a/doc/files/materialisaplhablend.txt b/doc/files/materialisaplhablend.txt new file mode 100644 index 0000000..01037bf --- /dev/null +++ b/doc/files/materialisaplhablend.txt @@ -0,0 +1,4 @@ +#title MaterialIsAplhaBlend [RCBasic Doc] +#header function MaterialIsAplhaBlend( material_id) + +Returns true if alpha blending is enabled for a material diff --git a/doc/files/materialisgouraudshaded.html b/doc/files/materialisgouraudshaded.html new file mode 100644 index 0000000..5e9c3d8 --- /dev/null +++ b/doc/files/materialisgouraudshaded.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if material is set to goraud shading +
++ + + \ No newline at end of file diff --git a/doc/files/materialisgouraudshaded.txt b/doc/files/materialisgouraudshaded.txt new file mode 100644 index 0000000..be61944 --- /dev/null +++ b/doc/files/materialisgouraudshaded.txt @@ -0,0 +1,4 @@ +#title MaterialIsGouraudShaded [RCBasic Doc] +#header function MaterialIsGouraudShaded( material_id ) + +Returns true if material is set to goraud shading diff --git a/doc/files/materialislit.html b/doc/files/materialislit.html new file mode 100644 index 0000000..8d8cccb --- /dev/null +++ b/doc/files/materialislit.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if a material is affected by lights in the scene +
+Related: + SetMaterialLighting +
++ + + \ No newline at end of file diff --git a/doc/files/materialislit.txt b/doc/files/materialislit.txt new file mode 100644 index 0000000..42ad3c8 --- /dev/null +++ b/doc/files/materialislit.txt @@ -0,0 +1,6 @@ +#title MaterialIsLit [RCBasic Doc] +#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.html b/doc/files/materialisnormalized.html new file mode 100644 index 0000000..97072ff --- /dev/null +++ b/doc/files/materialisnormalized.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if material has normalized normals +
++ + + \ No newline at end of file diff --git a/doc/files/materialisnormalized.txt b/doc/files/materialisnormalized.txt new file mode 100644 index 0000000..8fa2590 --- /dev/null +++ b/doc/files/materialisnormalized.txt @@ -0,0 +1,4 @@ +#title MaterialIsNormalized [RCBasic Doc] +#header function MaterialIsNormalized( material_id ) + +Returns true if material has normalized normals diff --git a/doc/files/materialispointcloud.html b/doc/files/materialispointcloud.html new file mode 100644 index 0000000..e978c96 --- /dev/null +++ b/doc/files/materialispointcloud.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if material is set to render with point cloud +
++ + + \ No newline at end of file diff --git a/doc/files/materialispointcloud.txt b/doc/files/materialispointcloud.txt new file mode 100644 index 0000000..5796a38 --- /dev/null +++ b/doc/files/materialispointcloud.txt @@ -0,0 +1,4 @@ +#title MaterialIsPointCloud [RCBasic Doc] +#header function MaterialIsPointCloud( material_id ) + +Returns true if material is set to render with point cloud diff --git a/doc/files/materialistransparent.html b/doc/files/materialistransparent.html new file mode 100644 index 0000000..5dc3329 --- /dev/null +++ b/doc/files/materialistransparent.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if material is transparent +
++ + + \ No newline at end of file diff --git a/doc/files/materialistransparent.txt b/doc/files/materialistransparent.txt new file mode 100644 index 0000000..5e2d102 --- /dev/null +++ b/doc/files/materialistransparent.txt @@ -0,0 +1,4 @@ +#title MaterialIsTransparent [RCBasic Doc] +#header function MaterialIsTransparent( material_id) + +Returns true if material is transparent diff --git a/doc/files/materialiswireframe.html b/doc/files/materialiswireframe.html new file mode 100644 index 0000000..4aa8ba5 --- /dev/null +++ b/doc/files/materialiswireframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the material is rendered with non-filled triangles +
++ + + \ No newline at end of file diff --git a/doc/files/materialiswireframe.txt b/doc/files/materialiswireframe.txt new file mode 100644 index 0000000..391e01b --- /dev/null +++ b/doc/files/materialiswireframe.txt @@ -0,0 +1,4 @@ +#title MaterialIsWireframe [RCBasic Doc] +#header function MaterialIsWireframe( material_id ) + +Returns true if the material is rendered with non-filled triangles diff --git a/doc/files/matrixfrombuffer.html b/doc/files/matrixfrombuffer.html new file mode 100644 index 0000000..09bf0eb --- /dev/null +++ b/doc/files/matrixfrombuffer.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/matrixfrombuffer.txt b/doc/files/matrixfrombuffer.txt new file mode 100644 index 0000000..a65d2a3 --- /dev/null +++ b/doc/files/matrixfrombuffer.txt @@ -0,0 +1,6 @@ +#title MatrixFromBuffer [RCBasic Doc] +#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.html b/doc/files/matrixvalue.html new file mode 100644 index 0000000..af8f0a5 --- /dev/null +++ b/doc/files/matrixvalue.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the value stored at the given row and column in the matrix +
++ + + \ No newline at end of file diff --git a/doc/files/matrixvalue.txt b/doc/files/matrixvalue.txt new file mode 100644 index 0000000..a6240ad --- /dev/null +++ b/doc/files/matrixvalue.txt @@ -0,0 +1,4 @@ +#title MatrixValue [RCBasic Doc] +#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.html b/doc/files/max.html new file mode 100644 index 0000000..6624701 --- /dev/null +++ b/doc/files/max.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the highest of two numbers. +
+Related: + Min +
++ + + \ No newline at end of file diff --git a/doc/files/max.txt b/doc/files/max.txt new file mode 100644 index 0000000..31553d6 --- /dev/null +++ b/doc/files/max.txt @@ -0,0 +1,6 @@ +#title Max [RCBasic Doc] +#header function Max(a, b) + +Returns the highest of two numbers. + +#ref Min diff --git a/doc/files/maximizewindow.html b/doc/files/maximizewindow.html new file mode 100644 index 0000000..9de4ccd --- /dev/null +++ b/doc/files/maximizewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Maximizes the window +
++ + + \ No newline at end of file diff --git a/doc/files/maximizewindow.txt b/doc/files/maximizewindow.txt new file mode 100644 index 0000000..112c9e6 --- /dev/null +++ b/doc/files/maximizewindow.txt @@ -0,0 +1,4 @@ +#title MaximizeWindow [RCBasic Doc] +#header sub MaximizeWindow() + +Maximizes the window diff --git a/doc/files/messagebox.html b/doc/files/messagebox.html new file mode 100644 index 0000000..d7b1f94 --- /dev/null +++ b/doc/files/messagebox.html @@ -0,0 +1,17 @@ + + +
+ + ++ Displays a message box +
++ + + \ No newline at end of file diff --git a/doc/files/messagebox.txt b/doc/files/messagebox.txt new file mode 100644 index 0000000..0097a88 --- /dev/null +++ b/doc/files/messagebox.txt @@ -0,0 +1,4 @@ +#title MessageBox [RCBasic Doc] +#header function MessageBox(title$, msg$) + +Displays a message box diff --git a/doc/files/mid.html b/doc/files/mid.html new file mode 100644 index 0000000..d772a11 --- /dev/null +++ b/doc/files/mid.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a substring n characters long starting at start pos. +
++ + + \ No newline at end of file diff --git a/doc/files/mid.txt b/doc/files/mid.txt new file mode 100644 index 0000000..353ca46 --- /dev/null +++ b/doc/files/mid.txt @@ -0,0 +1,4 @@ +#title Mid$ [RCBasic Doc] +#header function Mid$(src$, start, n) + +Returns a substring n characters long starting at start pos. diff --git a/doc/files/min.html b/doc/files/min.html new file mode 100644 index 0000000..04397c2 --- /dev/null +++ b/doc/files/min.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the lowest of two numbers. +
+Related: + Max +
++ + + \ No newline at end of file diff --git a/doc/files/min.txt b/doc/files/min.txt new file mode 100644 index 0000000..a734025 --- /dev/null +++ b/doc/files/min.txt @@ -0,0 +1,7 @@ +#title Min [RCBasic Doc] +#header function Min(a, b) + +Returns the lowest of two numbers. + +#ref Max + diff --git a/doc/files/minimizewindow.html b/doc/files/minimizewindow.html new file mode 100644 index 0000000..c8fec6c --- /dev/null +++ b/doc/files/minimizewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Minimizes the window +
++ + + \ No newline at end of file diff --git a/doc/files/minimizewindow.txt b/doc/files/minimizewindow.txt new file mode 100644 index 0000000..3bbbc5a --- /dev/null +++ b/doc/files/minimizewindow.txt @@ -0,0 +1,4 @@ +#title MinimizeWindow [RCBasic Doc] +#header sub MinimizeWindow() + +Minimizes the window diff --git a/doc/files/mousebutton.html b/doc/files/mousebutton.html new file mode 100644 index 0000000..c3e33ee --- /dev/null +++ b/doc/files/mousebutton.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if mouse button is pressed +
++ + + \ No newline at end of file diff --git a/doc/files/mousebutton.txt b/doc/files/mousebutton.txt new file mode 100644 index 0000000..01f12e8 --- /dev/null +++ b/doc/files/mousebutton.txt @@ -0,0 +1,4 @@ +#title MouseButton [RCBasic Doc] +#header function MouseButton(mb) + +Returns true if mouse button is pressed diff --git a/doc/files/mouseisvisible.html b/doc/files/mouseisvisible.html new file mode 100644 index 0000000..cabdca0 --- /dev/null +++ b/doc/files/mouseisvisible.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns true if mouse cursor is shown +
+Related: + ShowMouse + HideMouse +
++ + + \ No newline at end of file diff --git a/doc/files/mouseisvisible.txt b/doc/files/mouseisvisible.txt new file mode 100644 index 0000000..bedf245 --- /dev/null +++ b/doc/files/mouseisvisible.txt @@ -0,0 +1,6 @@ +#title MouseIsVisible [RCBasic Doc] +#header function MouseIsVisible() + +Returns true if mouse cursor is shown + +#ref ShowMouse HideMouse diff --git a/doc/files/mousewheelx.html b/doc/files/mousewheelx.html new file mode 100644 index 0000000..54151f6 --- /dev/null +++ b/doc/files/mousewheelx.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the value of the x axis on the mouse wheel +
++ + + \ No newline at end of file diff --git a/doc/files/mousewheelx.txt b/doc/files/mousewheelx.txt new file mode 100644 index 0000000..2f86834 --- /dev/null +++ b/doc/files/mousewheelx.txt @@ -0,0 +1,4 @@ +#title MouseWheelX [RCBasic Doc] +#header function MouseWheelX() + +Returns the value of the x axis on the mouse wheel diff --git a/doc/files/mousewheely.html b/doc/files/mousewheely.html new file mode 100644 index 0000000..2dcfa4f --- /dev/null +++ b/doc/files/mousewheely.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the value of the y axis on the mouse wheel +
++ + + \ No newline at end of file diff --git a/doc/files/mousewheely.txt b/doc/files/mousewheely.txt new file mode 100644 index 0000000..d7af7ae --- /dev/null +++ b/doc/files/mousewheely.txt @@ -0,0 +1,4 @@ +#title MouseWheelY [RCBasic Doc] +#header function MouseWheelY() + +Returns the value of the y axis on the mouse wheel diff --git a/doc/files/mousex.html b/doc/files/mousex.html new file mode 100644 index 0000000..4c1bd58 --- /dev/null +++ b/doc/files/mousex.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the mouse x position +
++ + + \ No newline at end of file diff --git a/doc/files/mousex.txt b/doc/files/mousex.txt new file mode 100644 index 0000000..4fc5a2b --- /dev/null +++ b/doc/files/mousex.txt @@ -0,0 +1,4 @@ +#title MouseX [RCBasic Doc] +#header function MouseX() + +Returns the mouse x position diff --git a/doc/files/mousey.html b/doc/files/mousey.html new file mode 100644 index 0000000..eef1ed6 --- /dev/null +++ b/doc/files/mousey.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the mouse y position +
++ + + \ No newline at end of file diff --git a/doc/files/mousey.txt b/doc/files/mousey.txt new file mode 100644 index 0000000..a919394 --- /dev/null +++ b/doc/files/mousey.txt @@ -0,0 +1,4 @@ +#title MouseY [RCBasic Doc] +#header function MouseY() + +Returns the mouse y position diff --git a/doc/files/movefile.html b/doc/files/movefile.html new file mode 100644 index 0000000..3360ea1 --- /dev/null +++ b/doc/files/movefile.html @@ -0,0 +1,20 @@ + + +
+ + ++ Moves a file on the system. +
++ 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/files/movefile.txt b/doc/files/movefile.txt new file mode 100644 index 0000000..c4bffa3 --- /dev/null +++ b/doc/files/movefile.txt @@ -0,0 +1,6 @@ +#title MoveFile [RCBasic Doc] +#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.html b/doc/files/multiplymatrix.html new file mode 100644 index 0000000..1e90784 --- /dev/null +++ b/doc/files/multiplymatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Multiply matrix mA and mB and store the result in mC +
++ + + \ No newline at end of file diff --git a/doc/files/multiplymatrix.txt b/doc/files/multiplymatrix.txt new file mode 100644 index 0000000..fd14713 --- /dev/null +++ b/doc/files/multiplymatrix.txt @@ -0,0 +1,4 @@ +#title MultiplyMatrix [RCBasic Doc] +#header function MultiplyMatrix(mA, mB, mC) + +Multiply matrix mA and mB and store the result in mC diff --git a/doc/files/musicexists.html b/doc/files/musicexists.html new file mode 100644 index 0000000..b93109c --- /dev/null +++ b/doc/files/musicexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if there is a music track loaded +
++ + + \ No newline at end of file diff --git a/doc/files/musicexists.txt b/doc/files/musicexists.txt new file mode 100644 index 0000000..f6ec489 --- /dev/null +++ b/doc/files/musicexists.txt @@ -0,0 +1,4 @@ +#title MusicExists [RCBasic Doc] +#header function MusicExists() + +Returns true if there is a music track loaded diff --git a/doc/files/musicisplaying.html b/doc/files/musicisplaying.html new file mode 100644 index 0000000..92448dd --- /dev/null +++ b/doc/files/musicisplaying.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the music track is currently playing +
++ + + \ No newline at end of file diff --git a/doc/files/musicisplaying.txt b/doc/files/musicisplaying.txt new file mode 100644 index 0000000..dd79f4e --- /dev/null +++ b/doc/files/musicisplaying.txt @@ -0,0 +1,4 @@ +#title MusicIsPlaying [RCBasic Doc] +#header function MusicIsPlaying() + +Returns true if the music track is currently playing diff --git a/doc/files/numaccels.html b/doc/files/numaccels.html new file mode 100644 index 0000000..eb309ec --- /dev/null +++ b/doc/files/numaccels.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of accelerometer sensors detected +
++ + + \ No newline at end of file diff --git a/doc/files/numaccels.txt b/doc/files/numaccels.txt new file mode 100644 index 0000000..43a105a --- /dev/null +++ b/doc/files/numaccels.txt @@ -0,0 +1,4 @@ +#title NumAccels [RCBasic Doc] +#header function NumAccels() + +Returns the number of accelerometer sensors detected diff --git a/doc/files/numactoranimationloops.html b/doc/files/numactoranimationloops.html new file mode 100644 index 0000000..faa1a31 --- /dev/null +++ b/doc/files/numactoranimationloops.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the total number of loops the actor is set to repeat the animation for +
++ + + \ No newline at end of file diff --git a/doc/files/numactoranimationloops.txt b/doc/files/numactoranimationloops.txt new file mode 100644 index 0000000..2a55245 --- /dev/null +++ b/doc/files/numactoranimationloops.txt @@ -0,0 +1,5 @@ +#title NumActorAnimationLoops [RCBasic Doc] +#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.html b/doc/files/numberarraycopy.html new file mode 100644 index 0000000..b904d54 --- /dev/null +++ b/doc/files/numberarraycopy.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayCopy() +
+Related: + ArrayCopy +
++ + + \ No newline at end of file diff --git a/doc/files/numberarraycopy.txt b/doc/files/numberarraycopy.txt new file mode 100644 index 0000000..720d28a --- /dev/null +++ b/doc/files/numberarraycopy.txt @@ -0,0 +1,9 @@ +#title NumberArrayCopy [RCBasic Doc] +#header sub NumberArrayCopy(ByRef src, ByRef dst) + +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/numberarraydim.html b/doc/files/numberarraydim.html new file mode 100644 index 0000000..ef20de6 --- /dev/null +++ b/doc/files/numberarraydim.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayDim() +
+Related: + ArrayDim +
++ + + \ No newline at end of file diff --git a/doc/files/numberarraydim.txt b/doc/files/numberarraydim.txt new file mode 100644 index 0000000..30253df --- /dev/null +++ b/doc/files/numberarraydim.txt @@ -0,0 +1,9 @@ +#title NumberArrayDim [RCBasic Doc] +#header function NumberArrayDim(Byref id) + +This function is exists to be internally called by the runtime but should not be called directly. + +Use ArrayDim() + +#ref ArrayDim + diff --git a/doc/files/numberarrayfill.html b/doc/files/numberarrayfill.html new file mode 100644 index 0000000..75c5692 --- /dev/null +++ b/doc/files/numberarrayfill.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayFill() +
+Related: + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/files/numberarrayfill.txt b/doc/files/numberarrayfill.txt new file mode 100644 index 0000000..5c87a7e --- /dev/null +++ b/doc/files/numberarrayfill.txt @@ -0,0 +1,8 @@ +#title NumberArrayFill [RCBasic Doc] +#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.html b/doc/files/numberarraysize.html new file mode 100644 index 0000000..f58f8d9 --- /dev/null +++ b/doc/files/numberarraysize.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArraySize() +
+Related: + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/files/numberarraysize.txt b/doc/files/numberarraysize.txt new file mode 100644 index 0000000..01f5990 --- /dev/null +++ b/doc/files/numberarraysize.txt @@ -0,0 +1,9 @@ +#title NumberArraySize [RCBasic Doc] +#header function NumberArraySize(Byref id, array_dim) + +This function is exists to be internally called by the runtime but should not be called directly. + +Use ArraySize() + +#ref ArraySize + diff --git a/doc/files/numcommands.html b/doc/files/numcommands.html new file mode 100644 index 0000000..4ed7c27 --- /dev/null +++ b/doc/files/numcommands.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of command line arguments passed to the program on start +
++ + + \ No newline at end of file diff --git a/doc/files/numcommands.txt b/doc/files/numcommands.txt new file mode 100644 index 0000000..85cf745 --- /dev/null +++ b/doc/files/numcommands.txt @@ -0,0 +1,5 @@ +#title NumCommands [RCBasic Doc] +#header function NumCommands() + +Returns the number of command line arguments passed to the program on start + diff --git a/doc/files/numcpus.html b/doc/files/numcpus.html new file mode 100644 index 0000000..c55826f --- /dev/null +++ b/doc/files/numcpus.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of CPUs (ie. cores) available +
++ + + \ No newline at end of file diff --git a/doc/files/numcpus.txt b/doc/files/numcpus.txt new file mode 100644 index 0000000..557269e --- /dev/null +++ b/doc/files/numcpus.txt @@ -0,0 +1,6 @@ +#title NumCPUs [RCBasic Doc] +#header function NumCPUs() + +Returns the number of CPUs (ie. cores) available + + diff --git a/doc/files/numfingers.html b/doc/files/numfingers.html new file mode 100644 index 0000000..7a34f2b --- /dev/null +++ b/doc/files/numfingers.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of fingers detected in the current touch event +
++ + + \ No newline at end of file diff --git a/doc/files/numfingers.txt b/doc/files/numfingers.txt new file mode 100644 index 0000000..d270146 --- /dev/null +++ b/doc/files/numfingers.txt @@ -0,0 +1,4 @@ +#title NumFingers [RCBasic Doc] +#header function NumFingers() + +Returns the number of fingers detected in the current touch event diff --git a/doc/files/numgyros.html b/doc/files/numgyros.html new file mode 100644 index 0000000..94b5eed --- /dev/null +++ b/doc/files/numgyros.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number Gyros detected in the current touch event +
++ + + \ No newline at end of file diff --git a/doc/files/numgyros.txt b/doc/files/numgyros.txt new file mode 100644 index 0000000..f2d2eb6 --- /dev/null +++ b/doc/files/numgyros.txt @@ -0,0 +1,4 @@ +#title NumGyros [RCBasic Doc] +#header function NumGyros() + +Returns the number Gyros detected in the current touch event diff --git a/doc/files/numjoyaxes.html b/doc/files/numjoyaxes.html new file mode 100644 index 0000000..21e6653 --- /dev/null +++ b/doc/files/numjoyaxes.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/numjoyaxes.txt b/doc/files/numjoyaxes.txt new file mode 100644 index 0000000..757d235 --- /dev/null +++ b/doc/files/numjoyaxes.txt @@ -0,0 +1,6 @@ +#title NumJoyAxes [RCBasic Doc] +#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.html b/doc/files/numjoybuttons.html new file mode 100644 index 0000000..9c34d32 --- /dev/null +++ b/doc/files/numjoybuttons.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of buttons on a joystick +
++ + + \ No newline at end of file diff --git a/doc/files/numjoybuttons.txt b/doc/files/numjoybuttons.txt new file mode 100644 index 0000000..a1c10d8 --- /dev/null +++ b/doc/files/numjoybuttons.txt @@ -0,0 +1,4 @@ +#title NumJoyButtons [RCBasic Doc] +#header function NumJoyButtons(joy_num) + +Returns the number of buttons on a joystick diff --git a/doc/files/numjoyhats.html b/doc/files/numjoyhats.html new file mode 100644 index 0000000..86c63ca --- /dev/null +++ b/doc/files/numjoyhats.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of hats on a joystick +
++ + + \ No newline at end of file diff --git a/doc/files/numjoyhats.txt b/doc/files/numjoyhats.txt new file mode 100644 index 0000000..29cc237 --- /dev/null +++ b/doc/files/numjoyhats.txt @@ -0,0 +1,4 @@ +#title NumJoyHats [RCBasic Doc] +#header function NumJoyHats(joy_num) + +Returns the number of hats on a joystick diff --git a/doc/files/numjoysticks.html b/doc/files/numjoysticks.html new file mode 100644 index 0000000..3b1500e --- /dev/null +++ b/doc/files/numjoysticks.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of joysticks detected +
++ + + \ No newline at end of file diff --git a/doc/files/numjoysticks.txt b/doc/files/numjoysticks.txt new file mode 100644 index 0000000..3285626 --- /dev/null +++ b/doc/files/numjoysticks.txt @@ -0,0 +1,4 @@ +#title NumJoysticks [RCBasic Doc] +#header function NumJoysticks() + +Returns the number of joysticks detected diff --git a/doc/files/numjoytrackballs.html b/doc/files/numjoytrackballs.html new file mode 100644 index 0000000..6eed02e --- /dev/null +++ b/doc/files/numjoytrackballs.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of trackballs detected on a joystick +
++ + + \ No newline at end of file diff --git a/doc/files/numjoytrackballs.txt b/doc/files/numjoytrackballs.txt new file mode 100644 index 0000000..9c62b54 --- /dev/null +++ b/doc/files/numjoytrackballs.txt @@ -0,0 +1,4 @@ +#title NumJoyTrackBalls [RCBasic Doc] +#header function NumJoyTrackBalls(joy_num) + +Returns the number of trackballs detected on a joystick diff --git a/doc/files/numsoundchannels.html b/doc/files/numsoundchannels.html new file mode 100644 index 0000000..5bb039d --- /dev/null +++ b/doc/files/numsoundchannels.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of sound channels available +
++ + + \ No newline at end of file diff --git a/doc/files/numsoundchannels.txt b/doc/files/numsoundchannels.txt new file mode 100644 index 0000000..8f09479 --- /dev/null +++ b/doc/files/numsoundchannels.txt @@ -0,0 +1,4 @@ +#title NumSoundChannels [RCBasic Doc] +#header function NumSoundChannels() + +Returns the number of sound channels available diff --git a/doc/files/numspriteanimationloops.html b/doc/files/numspriteanimationloops.html new file mode 100644 index 0000000..678cf7a --- /dev/null +++ b/doc/files/numspriteanimationloops.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the number of animation loops the actor has set +
+Related: + SetSpriteAnimationLoops + SetSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/files/numspriteanimationloops.txt b/doc/files/numspriteanimationloops.txt new file mode 100644 index 0000000..60b408f --- /dev/null +++ b/doc/files/numspriteanimationloops.txt @@ -0,0 +1,6 @@ +#title NumSpriteAnimationLoops [RCBasic Doc] +#header Function NumSpriteAnimationLoops(sprite) + +Returns the number of animation loops the actor has set + +#ref SetSpriteAnimationLoops SetSpriteAnimation diff --git a/doc/files/opencanvas.html b/doc/files/opencanvas.html new file mode 100644 index 0000000..a455282 --- /dev/null +++ b/doc/files/opencanvas.html @@ -0,0 +1,35 @@ + + +
+ + ++ Returns a canvas for 2D drawing and text rendering +
+Related: + OpenCanvas3D + OpenCanvasSpriteLayer +
++ + + \ No newline at end of file diff --git a/doc/files/opencanvas.txt b/doc/files/opencanvas.txt new file mode 100644 index 0000000..7a6c65a --- /dev/null +++ b/doc/files/opencanvas.txt @@ -0,0 +1,13 @@ +#title OpenCanvas [RCBasic Doc] +#header function OpenCanvas( w, h, viewport_x, viewport_y, viewport_w, viewport_h, mode) + +Returns a canvas for 2D drawing and text rendering + +#list ul +#li w, h - The full size of the canvas +#li viewport_x, viewport_y - Where to show the canvas in the window +#li viewport_w, viewport_h - The size of the viewport. For example, a 100 x 100 viewport means that no matter how big the canvas is, only an area of 100 x 100 pixels is displayed. +#li mode - Set this to 0 for a solid canvas and 1 for a color keyed canvas. +#/list + +#ref OpenCanvas3D OpenCanvasSpriteLayer diff --git a/doc/files/opencanvas3d.html b/doc/files/opencanvas3d.html new file mode 100644 index 0000000..eb07abb --- /dev/null +++ b/doc/files/opencanvas3d.html @@ -0,0 +1,30 @@ + + +
+ + ++ Returns a 3D Canvas for viewing the scene. +
++ Returns -1 if canvas could not be created. +
++ Note: Each 3D canvas has its own camera so you need to make sure you have the canvas active before doing anything with the camera +
++ Note: 2D drawing commands do not work on 3D canvases. You need to open a 2D canvas for drawing images. +
+Related: + OpenCanvas + OpenCanvasSpriteLayer +
++ + + \ No newline at end of file diff --git a/doc/files/opencanvas3d.txt b/doc/files/opencanvas3d.txt new file mode 100644 index 0000000..a8ab92b --- /dev/null +++ b/doc/files/opencanvas3d.txt @@ -0,0 +1,12 @@ +#title OpenCanvas3D [RCBasic Doc] +#header function OpenCanvas3D( viewport_x, viewport_y, viewport_w, viewport_h, mode) + +Returns a 3D Canvas for viewing the scene. + +Returns -1 if canvas could not be created. + +Note: Each 3D canvas has its own camera so you need to make sure you have the canvas active before doing anything with the camera + +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.html b/doc/files/opencanvasspritelayer.html new file mode 100644 index 0000000..eb20172 --- /dev/null +++ b/doc/files/opencanvasspritelayer.html @@ -0,0 +1,27 @@ + + +
+ + ++ Returns a sprite layer. These canvases are used for rendering sprites with the integrated physics engine. +
++ Returns -1 if canvas could not be created. +
++ Note: Sprite Layer must be active when creating sprites. +
+Related: + OpenCanvas + OpenCanvas3D +
++ + + \ No newline at end of file diff --git a/doc/files/opencanvasspritelayer.txt b/doc/files/opencanvasspritelayer.txt new file mode 100644 index 0000000..0ba5a75 --- /dev/null +++ b/doc/files/opencanvasspritelayer.txt @@ -0,0 +1,10 @@ +#title OpenCanvasSpriteLayer [RCBasic Doc] +#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. + +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.html b/doc/files/openfile.html new file mode 100644 index 0000000..09cb0dd --- /dev/null +++ b/doc/files/openfile.html @@ -0,0 +1,66 @@ + + +
+ + ++ Returns an ID for an open file to read or write. +
++ Returns -1 if the file could not be opened. +
++ Possible Text Modes +
+
+
Possible Binary Modes
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/openfile.txt b/doc/files/openfile.txt
new file mode 100644
index 0000000..a63d51f
--- /dev/null
+++ b/doc/files/openfile.txt
@@ -0,0 +1,26 @@
+#title OpenFile [RCBasic Doc]
+#header function OpenFile(fileName$, mode)
+
+Returns an ID for an open file to read or write.
+
+Returns -1 if the file could not be opened.
+
+Possible Text Modes
+#list ul
+#li TEXT_INPUT - Open a file for reading text. The file must already exist.
+#li TEXT_OUTPUT - Open a new file for writing text. If the file already exist it will be overwritten.
+#li TEXT_APPEND - Opens a file for appending text to the end of the file. A file will be created if it doesn't already exist.
+#li TEXT_INPUT_PLUS - Opens a file for reading and writing text. The file must already exist.
+#li TEXT_OUTPUT_PLUS - Opens a file for both reading and writing. If the file already exist it will be overwritten.
+#li TEXT_APPEND_PLUS - Opens a file for reading and appending text to the end of the file.
+#/list
+
+Possible Binary Modes
+#list ul
+#li BINARY_INPUT - Open a file for reading binary data. The file must already exist.
+#li BINARY_OUTPUT - Open a new file for writing binary data. If the file already exist it will be overwritten.
+#li BINARY_APPEND - Opens a file for appending binary data to the end of the file. A file will be created if it doesn't already exist.
+#li BINARY_INPUT_PLUS - Opens a file for reading and writing binary data. The file must already exist.
+#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.html b/doc/files/openspritecanvas.html
new file mode 100644
index 0000000..bb95fec
--- /dev/null
+++ b/doc/files/openspritecanvas.html
@@ -0,0 +1,14 @@
+
+
+
+ + + \ No newline at end of file diff --git a/doc/files/openspritecanvas.txt b/doc/files/openspritecanvas.txt new file mode 100644 index 0000000..b88914e --- /dev/null +++ b/doc/files/openspritecanvas.txt @@ -0,0 +1,4 @@ +#title OpenSpriteCanvas [RCBasic Doc] +#header function OpenSpriteCanvas(w, h, viewport_x, viewport_y, viewport_w, viewport_h) + + diff --git a/doc/files/openurl.html b/doc/files/openurl.html new file mode 100644 index 0000000..b4847a2 --- /dev/null +++ b/doc/files/openurl.html @@ -0,0 +1,17 @@ + + +
+ + ++ Opens a URL in the internet browser +
++ + + \ No newline at end of file diff --git a/doc/files/openurl.txt b/doc/files/openurl.txt new file mode 100644 index 0000000..debc20e --- /dev/null +++ b/doc/files/openurl.txt @@ -0,0 +1,4 @@ +#title OpenURL [RCBasic Doc] +#header function OpenURL(url$) + +Opens a URL in the internet browser diff --git a/doc/files/openwindow.html b/doc/files/openwindow.html new file mode 100644 index 0000000..0948563 --- /dev/null +++ b/doc/files/openwindow.html @@ -0,0 +1,23 @@ + + +
+ + ++ Opens a graphics window +
++ Returns true if window was opened and false if a window could not be opened +
+Related: + OpenWindowEx +
++ + + \ No newline at end of file diff --git a/doc/files/openwindow.txt b/doc/files/openwindow.txt new file mode 100644 index 0000000..c37f5c7 --- /dev/null +++ b/doc/files/openwindow.txt @@ -0,0 +1,8 @@ +#title OpenWindow [RCBasic Doc] +#header Function OpenWindow( title$, w, h, fullscreen, vsync ) + +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.html b/doc/files/openwindowex.html new file mode 100644 index 0000000..b6b2d15 --- /dev/null +++ b/doc/files/openwindowex.html @@ -0,0 +1,54 @@ + + +
+ + ++ Opens a graphics window +
++ Returns true if window was opened and false if a window could not be opened +
+Related: + OpenWindow + WindowMode +
++ + + \ No newline at end of file diff --git a/doc/files/openwindowex.txt b/doc/files/openwindowex.txt new file mode 100644 index 0000000..5c19c1b --- /dev/null +++ b/doc/files/openwindowex.txt @@ -0,0 +1,24 @@ +#title OpenWindowEx [RCBasic Doc] +#header function OpenWindowEx(title$, x, y, w, h, mode, aa, stencil_buffer, vsync) + +Opens a graphics window + +Returns true if window was opened and false if a window could not be opened + +#list ul +# x, y - The position on the display where the window will be drawn + #list ul + #li WINDOWPOS_CENTERED can be used to center the window + #/list +#li w, h - The size of the window +#li mode - Refer to WindowMode() for values that can be set +#li aa - The level of AntiAliasing + #list ul + #li A value of 0 means no AntiAliasing which can improve performance + #li If the value selected is not supported then a lower value will be selected internally + #/list +#li stencil_buffer (true / false) - determines whether stencil buffer will be used for shadows +#li vsync - determines if vsync will be enabled for the window +#/list + +#ref OpenWindow WindowMode diff --git a/doc/files/orbit.html b/doc/files/orbit.html new file mode 100644 index 0000000..cdd1f2d --- /dev/null +++ b/doc/files/orbit.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the value of the bitwise OR operation on the operands A and B +
++ + + \ No newline at end of file diff --git a/doc/files/orbit.txt b/doc/files/orbit.txt new file mode 100644 index 0000000..060ba7b --- /dev/null +++ b/doc/files/orbit.txt @@ -0,0 +1,6 @@ +#title OrBit [RCBasic Doc] +#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.html b/doc/files/os.html new file mode 100644 index 0000000..49d8c68 --- /dev/null +++ b/doc/files/os.html @@ -0,0 +1,43 @@ + + +
+ + ++ Returns the runtimes native operating system. +
++ Possible Return Values +
++ 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" +
++ + + \ No newline at end of file diff --git a/doc/files/os.txt b/doc/files/os.txt new file mode 100644 index 0000000..bd56b8b --- /dev/null +++ b/doc/files/os.txt @@ -0,0 +1,16 @@ +#title OS$ [RCBasic Doc] +#header function OS$() + +Returns the runtimes native operating system. + +Possible Return Values +#list ul +#li WINDOWS +#li LINUX +#li MAC +#li ANDROID +#li IOS +#li WEB +#/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.html b/doc/files/particleisusingeverymeshvertex.html new file mode 100644 index 0000000..89b49fd --- /dev/null +++ b/doc/files/particleisusingeverymeshvertex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if emitter emits min<->max particles for every vertex or to pick min<->max vertices. +
+Related: + useParticleEveryMeshVertex +
++ + + \ No newline at end of file diff --git a/doc/files/particleisusingeverymeshvertex.txt b/doc/files/particleisusingeverymeshvertex.txt new file mode 100644 index 0000000..4a8a5e8 --- /dev/null +++ b/doc/files/particleisusingeverymeshvertex.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/particleisusingnormaldirection.html new file mode 100644 index 0000000..1ca0214 --- /dev/null +++ b/doc/files/particleisusingnormaldirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns true if particle emitter is using vertex normal for direction, or direction specified. +
+Related: + useParticleNormalDirection +
++ + + \ No newline at end of file diff --git a/doc/files/particleisusingnormaldirection.txt b/doc/files/particleisusingnormaldirection.txt new file mode 100644 index 0000000..339c504 --- /dev/null +++ b/doc/files/particleisusingnormaldirection.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/particleisusingoutlineonly.html new file mode 100644 index 0000000..ac8c2f7 --- /dev/null +++ b/doc/files/particleisusingoutlineonly.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns true if not using draw points inside the cylinder +
++ Note: Only applies to cylinder emitter +
+Related: + useParticleOutlineOnly +
++ + + \ No newline at end of file diff --git a/doc/files/particleisusingoutlineonly.txt b/doc/files/particleisusingoutlineonly.txt new file mode 100644 index 0000000..1d1fd92 --- /dev/null +++ b/doc/files/particleisusingoutlineonly.txt @@ -0,0 +1,9 @@ +#title particleIsUsingOutlineOnly [RCBasic Doc] +#header function particleIsUsingOutlineOnly( actor) + +Returns true if not using draw points inside the cylinder + +Note: Only applies to cylinder emitter + +#ref useParticleOutlineOnly + diff --git a/doc/files/pausemusic.html b/doc/files/pausemusic.html new file mode 100644 index 0000000..0bc4b09 --- /dev/null +++ b/doc/files/pausemusic.html @@ -0,0 +1,21 @@ + + +
+ + ++ Pauses the currently loaded music track. Unlike StopMusic(), paused music can be resumed from its current position. +
+Related: + ResumeMusic + StopMusic +
++ + + \ No newline at end of file diff --git a/doc/files/pausemusic.txt b/doc/files/pausemusic.txt new file mode 100644 index 0000000..575b954 --- /dev/null +++ b/doc/files/pausemusic.txt @@ -0,0 +1,6 @@ +#title PauseMusic [RCBasic Doc] +#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.html b/doc/files/pausesound.html new file mode 100644 index 0000000..004094c --- /dev/null +++ b/doc/files/pausesound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Pauses a sound at its current position. +
++ + + \ No newline at end of file diff --git a/doc/files/pausesound.txt b/doc/files/pausesound.txt new file mode 100644 index 0000000..f23cd3f --- /dev/null +++ b/doc/files/pausesound.txt @@ -0,0 +1,4 @@ +#title PauseSound [RCBasic Doc] +#header sub PauseSound(channel) + +Pauses a sound at its current position. diff --git a/doc/files/pausevideo.html b/doc/files/pausevideo.html new file mode 100644 index 0000000..302c6e2 --- /dev/null +++ b/doc/files/pausevideo.html @@ -0,0 +1,17 @@ + + +
+ + ++ Pauses the currently loaded video track +
++ + + \ No newline at end of file diff --git a/doc/files/pausevideo.txt b/doc/files/pausevideo.txt new file mode 100644 index 0000000..735af3c --- /dev/null +++ b/doc/files/pausevideo.txt @@ -0,0 +1,4 @@ +#title PauseVideo [RCBasic Doc] +#header sub PauseVideo() + +Pauses the currently loaded video track diff --git a/doc/files/playmusic.html b/doc/files/playmusic.html new file mode 100644 index 0000000..30508cc --- /dev/null +++ b/doc/files/playmusic.html @@ -0,0 +1,26 @@ + + +
+ + ++ Plays music for set number of loops. +
++ Note: If you only want to play the music once, set this to 0. +
++ Note: Set this to -1 to play infinitely. +
+Related: + StopMusic +
++ + + \ No newline at end of file diff --git a/doc/files/playmusic.txt b/doc/files/playmusic.txt new file mode 100644 index 0000000..121969f --- /dev/null +++ b/doc/files/playmusic.txt @@ -0,0 +1,10 @@ +#title PlayMusic [RCBasic Doc] +#header sub PlayMusic(mLoops) + +Plays music for set number of loops. + +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.html b/doc/files/playsound.html new file mode 100644 index 0000000..2ea7d2a --- /dev/null +++ b/doc/files/playsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Plays a sound on the given channel for the given number of loops. +
++ + + \ No newline at end of file diff --git a/doc/files/playsound.txt b/doc/files/playsound.txt new file mode 100644 index 0000000..e059fd0 --- /dev/null +++ b/doc/files/playsound.txt @@ -0,0 +1,4 @@ +#title PlaySound [RCBasic Doc] +#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.html b/doc/files/playsoundtimed.html new file mode 100644 index 0000000..24df3ab --- /dev/null +++ b/doc/files/playsoundtimed.html @@ -0,0 +1,17 @@ + + +
+ + ++ Plays sound for a given number of loops until the given number of milliseconds is reached. +
++ + + \ No newline at end of file diff --git a/doc/files/playsoundtimed.txt b/doc/files/playsoundtimed.txt new file mode 100644 index 0000000..87fa8ca --- /dev/null +++ b/doc/files/playsoundtimed.txt @@ -0,0 +1,4 @@ +#title PlaySoundTimed [RCBasic Doc] +#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.html b/doc/files/playvideo.html new file mode 100644 index 0000000..23a21b6 --- /dev/null +++ b/doc/files/playvideo.html @@ -0,0 +1,26 @@ + + +
+ + ++ Plays the currently loaded video for a set number of loops. +
++ Note: Set this to 0 to play the video once. +
++ Note: Set this to -1 to the video infinitely. +
+Related: + StopVideo +
++ + + \ No newline at end of file diff --git a/doc/files/playvideo.txt b/doc/files/playvideo.txt new file mode 100644 index 0000000..a8e5604 --- /dev/null +++ b/doc/files/playvideo.txt @@ -0,0 +1,10 @@ +#title PlayVideo [RCBasic Doc] +#header sub PlayVideo(vLoops) + +Plays the currently loaded video for a set number of loops. + +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.html b/doc/files/pointinquad.html new file mode 100644 index 0000000..e6dbc63 --- /dev/null +++ b/doc/files/pointinquad.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the point (px, py) is in the quad (x1, y1) to (x4, y4) +
++ + + \ No newline at end of file diff --git a/doc/files/pointinquad.txt b/doc/files/pointinquad.txt new file mode 100644 index 0000000..32c7678 --- /dev/null +++ b/doc/files/pointinquad.txt @@ -0,0 +1,4 @@ +#title PointInQuad [RCBasic Doc] +#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.html b/doc/files/pointintri.html new file mode 100644 index 0000000..5d3ea4a --- /dev/null +++ b/doc/files/pointintri.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the point (px, py) is in the quad (x1, y1) to (x3, y3) +
++ + + \ No newline at end of file diff --git a/doc/files/pointintri.txt b/doc/files/pointintri.txt new file mode 100644 index 0000000..b4878da --- /dev/null +++ b/doc/files/pointintri.txt @@ -0,0 +1,4 @@ +#title PointInTri [RCBasic Doc] +#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.html b/doc/files/poly.html new file mode 100644 index 0000000..5aee9d4 --- /dev/null +++ b/doc/files/poly.html @@ -0,0 +1,33 @@ + + +
+ + ++ Draws a polygon +
+
+ Dim x[3], y[3]
+ x[0] = 50 : y[0] = 50
+ x[1] = 90 : y[1] = 90
+ x[2] = 10 : y[1] = 90
+
+ Poly(3, x, y) 'Draws a triangle
+
+ + + \ No newline at end of file diff --git a/doc/files/poly.txt b/doc/files/poly.txt new file mode 100644 index 0000000..b3601ed --- /dev/null +++ b/doc/files/poly.txt @@ -0,0 +1,18 @@ +#title Poly [RCBasic Doc] +#header sub Poly(n, byref x, byref y) + +Draws a polygon + +#list ul +#li n - Number of points in the polygon +#li x, y - Array where the points are stored +#/list + +#code +Dim x[3], y[3] +x[0] = 50 : y[0] = 50 +x[1] = 90 : y[1] = 90 +x[2] = 10 : y[1] = 90 + +Poly(3, x, y) 'Draws a triangle +#/code diff --git a/doc/files/pop_n.html b/doc/files/pop_n.html new file mode 100644 index 0000000..10b41bd --- /dev/null +++ b/doc/files/pop_n.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes the top number off a number stack and returns it +
+Related: + Push_N +
++ + + \ No newline at end of file diff --git a/doc/files/pop_n.txt b/doc/files/pop_n.txt new file mode 100644 index 0000000..c4a67bd --- /dev/null +++ b/doc/files/pop_n.txt @@ -0,0 +1,6 @@ +#title Pop_N [RCBasic Doc] +#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.html b/doc/files/pop_s.html new file mode 100644 index 0000000..c710f63 --- /dev/null +++ b/doc/files/pop_s.html @@ -0,0 +1,20 @@ + + +
+ + ++ Removes the top string off a string stack and returns it +
+Related: + Push_S +
++ + + \ No newline at end of file diff --git a/doc/files/pop_s.txt b/doc/files/pop_s.txt new file mode 100644 index 0000000..86bf546 --- /dev/null +++ b/doc/files/pop_s.txt @@ -0,0 +1,7 @@ +#title Pop_S$ [RCBasic Doc] +#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/prefpath.html b/doc/files/prefpath.html new file mode 100644 index 0000000..9294b7b --- /dev/null +++ b/doc/files/prefpath.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the preferred path for storing files. +
++ + + \ No newline at end of file diff --git a/doc/files/prefpath.txt b/doc/files/prefpath.txt new file mode 100644 index 0000000..417b467 --- /dev/null +++ b/doc/files/prefpath.txt @@ -0,0 +1,4 @@ +#title PrefPath$ [RCBasic Doc] +#header function PrefPath$(org_name$, app_name$) + +Returns the preferred path for storing files. diff --git a/doc/files/preupdate.html b/doc/files/preupdate.html new file mode 100644 index 0000000..b52ca13 --- /dev/null +++ b/doc/files/preupdate.html @@ -0,0 +1,23 @@ + + +
+ + ++ Processes physics for sprites and actors. +
++ This is useful if you need to know the post solve positions and rotations prior to drawing them. +
+Related: + Update +
++ + + \ No newline at end of file diff --git a/doc/files/preupdate.txt b/doc/files/preupdate.txt new file mode 100644 index 0000000..8c9a5c1 --- /dev/null +++ b/doc/files/preupdate.txt @@ -0,0 +1,8 @@ +#title PreUpdate [RCBasic Doc] +#header Sub PreUpdate( ) + +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.html b/doc/files/pset.html new file mode 100644 index 0000000..dca51ca --- /dev/null +++ b/doc/files/pset.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a pixel +
++ + + \ No newline at end of file diff --git a/doc/files/pset.txt b/doc/files/pset.txt new file mode 100644 index 0000000..ac27150 --- /dev/null +++ b/doc/files/pset.txt @@ -0,0 +1,4 @@ +#title Pset [RCBasic Doc] +#header sub Pset(x,y) + +Draws a pixel diff --git a/doc/files/push_n.html b/doc/files/push_n.html new file mode 100644 index 0000000..8573bfe --- /dev/null +++ b/doc/files/push_n.html @@ -0,0 +1,20 @@ + + +
+ + ++ Pushes a number onto a number stack +
+Related: + Pop_N +
++ + + \ No newline at end of file diff --git a/doc/files/push_n.txt b/doc/files/push_n.txt new file mode 100644 index 0000000..9b32151 --- /dev/null +++ b/doc/files/push_n.txt @@ -0,0 +1,8 @@ +#title Push_N [RCBasic Doc] +#header sub Push_N( num_stack, n ) + +Pushes a number onto a number stack + +#ref Pop_N + + diff --git a/doc/files/push_s.html b/doc/files/push_s.html new file mode 100644 index 0000000..72b28f3 --- /dev/null +++ b/doc/files/push_s.html @@ -0,0 +1,20 @@ + + +
+ + ++ Pushes a string onto a string stack +
+Related: + Pop_S +
++ + + \ No newline at end of file diff --git a/doc/files/push_s.txt b/doc/files/push_s.txt new file mode 100644 index 0000000..17004a0 --- /dev/null +++ b/doc/files/push_s.txt @@ -0,0 +1,7 @@ +#title Push_S [RCBasic Doc] +#header sub Push_S( str_stack, s$ ) + +Pushes a string onto a string stack + +#ref Pop_S + diff --git a/doc/files/queryaudiospec.html b/doc/files/queryaudiospec.html new file mode 100644 index 0000000..019d57a --- /dev/null +++ b/doc/files/queryaudiospec.html @@ -0,0 +1,17 @@ + + +
+ + ++ Gets the frequency, output format, and number of channels for the audio device being used. +
++ + + \ No newline at end of file diff --git a/doc/files/queryaudiospec.txt b/doc/files/queryaudiospec.txt new file mode 100644 index 0000000..edd5606 --- /dev/null +++ b/doc/files/queryaudiospec.txt @@ -0,0 +1,4 @@ +#title QueryAudioSpec [RCBasic Doc] +#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.html b/doc/files/radians.html new file mode 100644 index 0000000..bda2bd4 --- /dev/null +++ b/doc/files/radians.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns an angle converted from degrees to radians +
++ + + \ No newline at end of file diff --git a/doc/files/radians.txt b/doc/files/radians.txt new file mode 100644 index 0000000..5573725 --- /dev/null +++ b/doc/files/radians.txt @@ -0,0 +1,4 @@ +#title Radians [RCBasic Doc] +#header function Radians(d) + +Returns an angle converted from degrees to radians diff --git a/doc/files/raisewindow.html b/doc/files/raisewindow.html new file mode 100644 index 0000000..dad4828 --- /dev/null +++ b/doc/files/raisewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Places the current window on top of the other windows. +
++ + + \ No newline at end of file diff --git a/doc/files/raisewindow.txt b/doc/files/raisewindow.txt new file mode 100644 index 0000000..7ed4d2b --- /dev/null +++ b/doc/files/raisewindow.txt @@ -0,0 +1,4 @@ +#title RaiseWindow [RCBasic Doc] +#header sub RaiseWindow( ) + +Places the current window on top of the other windows. diff --git a/doc/files/rand.html b/doc/files/rand.html new file mode 100644 index 0000000..33190bf --- /dev/null +++ b/doc/files/rand.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a random number between 0 and n. +
++ + + \ No newline at end of file diff --git a/doc/files/rand.txt b/doc/files/rand.txt new file mode 100644 index 0000000..9db4f9b --- /dev/null +++ b/doc/files/rand.txt @@ -0,0 +1,4 @@ +#title Rand [RCBasic Doc] +#header function Rand(n) + +Returns a random number between 0 and n. diff --git a/doc/files/randomize.html b/doc/files/randomize.html new file mode 100644 index 0000000..704a9f1 --- /dev/null +++ b/doc/files/randomize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Seeds the random number generator +
++ + + \ No newline at end of file diff --git a/doc/files/randomize.txt b/doc/files/randomize.txt new file mode 100644 index 0000000..a6ac4f6 --- /dev/null +++ b/doc/files/randomize.txt @@ -0,0 +1,4 @@ +#title Randomize [RCBasic Doc] +#header function Randomize(n) + +Seeds the random number generator diff --git a/doc/files/randomizematrix.html b/doc/files/randomizematrix.html new file mode 100644 index 0000000..2e3d9ba --- /dev/null +++ b/doc/files/randomizematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores random values between vmin and vmax in the matrix mA +
++ + + \ No newline at end of file diff --git a/doc/files/randomizematrix.txt b/doc/files/randomizematrix.txt new file mode 100644 index 0000000..abc73bc --- /dev/null +++ b/doc/files/randomizematrix.txt @@ -0,0 +1,4 @@ +#title RandomizeMatrix [RCBasic Doc] +#header sub RandomizeMatrix(mA, vmin, vmax) + +Stores random values between vmin and vmax in the matrix mA diff --git a/doc/files/readbyte.html b/doc/files/readbyte.html new file mode 100644 index 0000000..fc629ef --- /dev/null +++ b/doc/files/readbyte.html @@ -0,0 +1,17 @@ + + +
+ + ++ Reads a byte from a file. +
++ + + \ No newline at end of file diff --git a/doc/files/readbyte.txt b/doc/files/readbyte.txt new file mode 100644 index 0000000..e3cbda4 --- /dev/null +++ b/doc/files/readbyte.txt @@ -0,0 +1,4 @@ +#title ReadByte [RCBasic Doc] +#header function ReadByte(stream) + +Reads a byte from a file. diff --git a/doc/files/readbytebuffer.html b/doc/files/readbytebuffer.html new file mode 100644 index 0000000..81f9ac9 --- /dev/null +++ b/doc/files/readbytebuffer.html @@ -0,0 +1,31 @@ + + +
+ + ++ Reads a number of bytes from a file stream to an array. +
+Related: + ReadByte +
++ + + \ No newline at end of file diff --git a/doc/files/readbytebuffer.txt b/doc/files/readbytebuffer.txt new file mode 100644 index 0000000..ab58c7a --- /dev/null +++ b/doc/files/readbytebuffer.txt @@ -0,0 +1,12 @@ +#title ReadByteBuffer [RCBasic Doc] +#header function ReadByteBuffer(stream, ByRef buf, buf_size) + +Reads a number of bytes from a file stream to an array. + +#list ul +#li stream - A open file +#li buffer - An array of bytes +#li buffer_size - The number of bytes to write from buffer (This should be less than size of the buffer) +#/list + +#ref ReadByte diff --git a/doc/files/readinput_gettext.html b/doc/files/readinput_gettext.html new file mode 100644 index 0000000..74d9ff9 --- /dev/null +++ b/doc/files/readinput_gettext.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/readinput_gettext.txt b/doc/files/readinput_gettext.txt new file mode 100644 index 0000000..1139505 --- /dev/null +++ b/doc/files/readinput_gettext.txt @@ -0,0 +1,4 @@ +#title ReadInput_GetText$ [RCBasic Doc] +#header function ReadInput_GetText$() + + diff --git a/doc/files/readinput_settext.html b/doc/files/readinput_settext.html new file mode 100644 index 0000000..8bf830d --- /dev/null +++ b/doc/files/readinput_settext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the text in the ReadInput buffer. +
++ + + \ No newline at end of file diff --git a/doc/files/readinput_settext.txt b/doc/files/readinput_settext.txt new file mode 100644 index 0000000..c6a3bd3 --- /dev/null +++ b/doc/files/readinput_settext.txt @@ -0,0 +1,4 @@ +#title ReadInput_SetText [RCBasic Doc] +#header sub ReadInput_SetText(txt$) + +Sets the text in the ReadInput buffer. diff --git a/doc/files/readinput_start.html b/doc/files/readinput_start.html new file mode 100644 index 0000000..ef7d4c9 --- /dev/null +++ b/doc/files/readinput_start.html @@ -0,0 +1,17 @@ + + +
+ + ++ Start reading input from the keyboard. +
++ + + \ No newline at end of file diff --git a/doc/files/readinput_start.txt b/doc/files/readinput_start.txt new file mode 100644 index 0000000..865b75c --- /dev/null +++ b/doc/files/readinput_start.txt @@ -0,0 +1,4 @@ +#title ReadInput_Start [RCBasic Doc] +#header sub ReadInput_Start() + +Start reading input from the keyboard. diff --git a/doc/files/readinput_stop.html b/doc/files/readinput_stop.html new file mode 100644 index 0000000..daa4832 --- /dev/null +++ b/doc/files/readinput_stop.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stops reading input from the keyboard. +
++ + + \ No newline at end of file diff --git a/doc/files/readinput_stop.txt b/doc/files/readinput_stop.txt new file mode 100644 index 0000000..b896369 --- /dev/null +++ b/doc/files/readinput_stop.txt @@ -0,0 +1,4 @@ +#title ReadInput_Stop [RCBasic Doc] +#header sub ReadInput_Stop() + +Stops reading input from the keyboard. diff --git a/doc/files/readinput_text.html b/doc/files/readinput_text.html new file mode 100644 index 0000000..d7cf0c5 --- /dev/null +++ b/doc/files/readinput_text.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the text read from the keyboard. +
++ + + \ No newline at end of file diff --git a/doc/files/readinput_text.txt b/doc/files/readinput_text.txt new file mode 100644 index 0000000..4a5bd2e --- /dev/null +++ b/doc/files/readinput_text.txt @@ -0,0 +1,4 @@ +#title ReadInput_Text$ [RCBasic Doc] +#header function ReadInput_Text$() + +Returns the text read from the keyboard. diff --git a/doc/files/readinput_togglebackspace.html b/doc/files/readinput_togglebackspace.html new file mode 100644 index 0000000..5e944f6 --- /dev/null +++ b/doc/files/readinput_togglebackspace.html @@ -0,0 +1,17 @@ + + +
+ + ++ Determines whether the backspace is applied during ReadInput events. +
++ + + \ No newline at end of file diff --git a/doc/files/readinput_togglebackspace.txt b/doc/files/readinput_togglebackspace.txt new file mode 100644 index 0000000..cc017bc --- /dev/null +++ b/doc/files/readinput_togglebackspace.txt @@ -0,0 +1,4 @@ +#title ReadInput_ToggleBackspace [RCBasic Doc] +#header sub ReadInput_ToggleBackspace(flag) + +Determines whether the backspace is applied during ReadInput events. diff --git a/doc/files/readline.html b/doc/files/readline.html new file mode 100644 index 0000000..0ddb1ec --- /dev/null +++ b/doc/files/readline.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current line in the file. +
++ + + \ No newline at end of file diff --git a/doc/files/readline.txt b/doc/files/readline.txt new file mode 100644 index 0000000..a2fd4b2 --- /dev/null +++ b/doc/files/readline.txt @@ -0,0 +1,4 @@ +#title ReadLine$ [RCBasic Doc] +#header function ReadLine$(stream) + +Returns the current line in the file. diff --git a/doc/files/rect.html b/doc/files/rect.html new file mode 100644 index 0000000..0f4b6d8 --- /dev/null +++ b/doc/files/rect.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a rectangle to the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/rect.txt b/doc/files/rect.txt new file mode 100644 index 0000000..d9ff719 --- /dev/null +++ b/doc/files/rect.txt @@ -0,0 +1,4 @@ +#title Rect [RCBasic Doc] +#header sub Rect(x, y, w, h) + +Draws a rectangle to the current canvas. diff --git a/doc/files/rectfill.html b/doc/files/rectfill.html new file mode 100644 index 0000000..12826a9 --- /dev/null +++ b/doc/files/rectfill.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a filled rectangle on the current canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/rectfill.txt b/doc/files/rectfill.txt new file mode 100644 index 0000000..13f6ec0 --- /dev/null +++ b/doc/files/rectfill.txt @@ -0,0 +1,4 @@ +#title RectFill [RCBasic Doc] +#header sub RectFill(x, y, w, h) + +Draws a filled rectangle on the current canvas. diff --git a/doc/files/removeactorshadow.html b/doc/files/removeactorshadow.html new file mode 100644 index 0000000..77422f1 --- /dev/null +++ b/doc/files/removeactorshadow.html @@ -0,0 +1,20 @@ + + +
+ + ++ Stops shadow casting on an actor +
+Related: + AddActorShadow +
++ + + \ No newline at end of file diff --git a/doc/files/removeactorshadow.txt b/doc/files/removeactorshadow.txt new file mode 100644 index 0000000..5802d7f --- /dev/null +++ b/doc/files/removeactorshadow.txt @@ -0,0 +1,6 @@ +#title RemoveActorShadow [RCBasic Doc] +#header sub RemoveActorShadow( actor ) + +Stops shadow casting on an actor + +#ref AddActorShadow diff --git a/doc/files/removedir.html b/doc/files/removedir.html new file mode 100644 index 0000000..1afb098 --- /dev/null +++ b/doc/files/removedir.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a directory. +
++ + + \ No newline at end of file diff --git a/doc/files/removedir.txt b/doc/files/removedir.txt new file mode 100644 index 0000000..0c202c2 --- /dev/null +++ b/doc/files/removedir.txt @@ -0,0 +1,4 @@ +#title RemoveDir [RCBasic Doc] +#header function RemoveDir(p$) + +Removes a directory. diff --git a/doc/files/removefile.html b/doc/files/removefile.html new file mode 100644 index 0000000..b784ad4 --- /dev/null +++ b/doc/files/removefile.html @@ -0,0 +1,17 @@ + + +
+ + ++ Removes a file. +
++ + + \ No newline at end of file diff --git a/doc/files/removefile.txt b/doc/files/removefile.txt new file mode 100644 index 0000000..eae2249 --- /dev/null +++ b/doc/files/removefile.txt @@ -0,0 +1,4 @@ +#title RemoveFile [RCBasic Doc] +#header function RemoveFile(fileName$) + +Removes a file. diff --git a/doc/files/removescenesky.html b/doc/files/removescenesky.html new file mode 100644 index 0000000..4a780b1 --- /dev/null +++ b/doc/files/removescenesky.html @@ -0,0 +1,22 @@ + + +
+ + ++ Removes the sky from the current 3D scene +
+Related: + AddSceneSkyBox + AddSceneSkyDome + AddSceneSkyDomeEx +
++ + + \ No newline at end of file diff --git a/doc/files/removescenesky.txt b/doc/files/removescenesky.txt new file mode 100644 index 0000000..58061fd --- /dev/null +++ b/doc/files/removescenesky.txt @@ -0,0 +1,6 @@ +#title RemoveSceneSky [RCBasic Doc] +#header sub RemoveSceneSky( ) + +Removes the sky from the current 3D scene + +#ref AddSceneSkyBox AddSceneSkyDome AddSceneSkyDomeEx diff --git a/doc/files/renamefile.html b/doc/files/renamefile.html new file mode 100644 index 0000000..afd1e17 --- /dev/null +++ b/doc/files/renamefile.html @@ -0,0 +1,17 @@ + + +
+ + ++ Renames src$ file to dst$ file. +
++ + + \ No newline at end of file diff --git a/doc/files/renamefile.txt b/doc/files/renamefile.txt new file mode 100644 index 0000000..66f49e6 --- /dev/null +++ b/doc/files/renamefile.txt @@ -0,0 +1,4 @@ +#title RenameFile [RCBasic Doc] +#header function RenameFile(src$, dst$) + +Renames src$ file to dst$ file. diff --git a/doc/files/replace.html b/doc/files/replace.html new file mode 100644 index 0000000..944c221 --- /dev/null +++ b/doc/files/replace.html @@ -0,0 +1,17 @@ + + +
+ + ++ Replaces all occurrences of tgt$ with rpc$. +
++ + + \ No newline at end of file diff --git a/doc/files/replace.txt b/doc/files/replace.txt new file mode 100644 index 0000000..3f86bc7 --- /dev/null +++ b/doc/files/replace.txt @@ -0,0 +1,4 @@ +#title Replace$ [RCBasic Doc] +#header function Replace$(src$, tgt$, rpc$) + +Replaces all occurrences of tgt$ with rpc$. diff --git a/doc/files/replacesubstr.html b/doc/files/replacesubstr.html new file mode 100644 index 0000000..6d6cd59 --- /dev/null +++ b/doc/files/replacesubstr.html @@ -0,0 +1,17 @@ + + +
+ + ++ Overwrites the characters at the given position in src$ with rpc$. +
++ + + \ No newline at end of file diff --git a/doc/files/replacesubstr.txt b/doc/files/replacesubstr.txt new file mode 100644 index 0000000..c84ae31 --- /dev/null +++ b/doc/files/replacesubstr.txt @@ -0,0 +1,4 @@ +#title ReplaceSubstr$ [RCBasic Doc] +#header function ReplaceSubstr$(src$, rpc$, pos) + +Overwrites the characters at the given position in src$ with rpc$. diff --git a/doc/files/restorewindow.html b/doc/files/restorewindow.html new file mode 100644 index 0000000..049b24d --- /dev/null +++ b/doc/files/restorewindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Restores the window if minimized +
++ + + \ No newline at end of file diff --git a/doc/files/restorewindow.txt b/doc/files/restorewindow.txt new file mode 100644 index 0000000..5419b9c --- /dev/null +++ b/doc/files/restorewindow.txt @@ -0,0 +1,4 @@ +#title RestoreWindow [RCBasic Doc] +#header sub RestoreWindow( ) + +Restores the window if minimized diff --git a/doc/files/resumemusic.html b/doc/files/resumemusic.html new file mode 100644 index 0000000..769b616 --- /dev/null +++ b/doc/files/resumemusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Resumes playing music. +
++ + + \ No newline at end of file diff --git a/doc/files/resumemusic.txt b/doc/files/resumemusic.txt new file mode 100644 index 0000000..adb9e0f --- /dev/null +++ b/doc/files/resumemusic.txt @@ -0,0 +1,4 @@ +#title ResumeMusic [RCBasic Doc] +#header sub ResumeMusic() + +Resumes playing music. diff --git a/doc/files/resumesound.html b/doc/files/resumesound.html new file mode 100644 index 0000000..c4cda35 --- /dev/null +++ b/doc/files/resumesound.html @@ -0,0 +1,20 @@ + + +
+ + ++ Resumes playing sound on the given channel. +
+Related: + PauseSound +
++ + + \ No newline at end of file diff --git a/doc/files/resumesound.txt b/doc/files/resumesound.txt new file mode 100644 index 0000000..d36255d --- /dev/null +++ b/doc/files/resumesound.txt @@ -0,0 +1,6 @@ +#title ResumeSound [RCBasic Doc] +#header sub ResumeSound(channel) + +Resumes playing sound on the given channel. + +#ref PauseSound diff --git a/doc/files/resumevideo.html b/doc/files/resumevideo.html new file mode 100644 index 0000000..2b97a66 --- /dev/null +++ b/doc/files/resumevideo.html @@ -0,0 +1,20 @@ + + +
+ + ++ Resumes the video +
+Related: + PauseVideo +
++ + + \ No newline at end of file diff --git a/doc/files/resumevideo.txt b/doc/files/resumevideo.txt new file mode 100644 index 0000000..4c6e534 --- /dev/null +++ b/doc/files/resumevideo.txt @@ -0,0 +1,6 @@ +#title ResumeVideo [RCBasic Doc] +#header sub ResumeVideo() + +Resumes the video + +#ref PauseVideo diff --git a/doc/files/reverse.html b/doc/files/reverse.html new file mode 100644 index 0000000..b9103fc --- /dev/null +++ b/doc/files/reverse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with the characters in reverse order. +
++ + + \ No newline at end of file diff --git a/doc/files/reverse.txt b/doc/files/reverse.txt new file mode 100644 index 0000000..973346b --- /dev/null +++ b/doc/files/reverse.txt @@ -0,0 +1,4 @@ +#title Reverse$ [RCBasic Doc] +#header function Reverse$(src$) + +Returns src$ with the characters in reverse order. diff --git a/doc/files/rewindmusic.html b/doc/files/rewindmusic.html new file mode 100644 index 0000000..98096ee --- /dev/null +++ b/doc/files/rewindmusic.html @@ -0,0 +1,17 @@ + + +
+ + ++ Rewinds the music track. +
++ + + \ No newline at end of file diff --git a/doc/files/rewindmusic.txt b/doc/files/rewindmusic.txt new file mode 100644 index 0000000..7873e4d --- /dev/null +++ b/doc/files/rewindmusic.txt @@ -0,0 +1,4 @@ +#title RewindMusic [RCBasic Doc] +#header sub RewindMusic() + +Rewinds the music track. diff --git a/doc/files/rgb.html b/doc/files/rgb.html new file mode 100644 index 0000000..c953bb1 --- /dev/null +++ b/doc/files/rgb.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a 32-bit color value. +
++ + + \ No newline at end of file diff --git a/doc/files/rgb.txt b/doc/files/rgb.txt new file mode 100644 index 0000000..26ad391 --- /dev/null +++ b/doc/files/rgb.txt @@ -0,0 +1,4 @@ +#title RGB [RCBasic Doc] +#header function RGB(r,g,b) + +Returns a 32-bit color value. diff --git a/doc/files/rgba.html b/doc/files/rgba.html new file mode 100644 index 0000000..e190b43 --- /dev/null +++ b/doc/files/rgba.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a 32-bit color value. +
++ + + \ No newline at end of file diff --git a/doc/files/rgba.txt b/doc/files/rgba.txt new file mode 100644 index 0000000..5b0f46c --- /dev/null +++ b/doc/files/rgba.txt @@ -0,0 +1,4 @@ +#title RGBA [RCBasic Doc] +#header function RGBA(r,g,b,a) + +Returns a 32-bit color value. diff --git a/doc/files/right.html b/doc/files/right.html new file mode 100644 index 0000000..bb0ad52 --- /dev/null +++ b/doc/files/right.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns n number of characters from the right side of src$. +
++ + + \ No newline at end of file diff --git a/doc/files/right.txt b/doc/files/right.txt new file mode 100644 index 0000000..c27c1e7 --- /dev/null +++ b/doc/files/right.txt @@ -0,0 +1,4 @@ +#title Right$ [RCBasic Doc] +#header function Right$(src$, n) + +Returns n number of characters from the right side of src$. diff --git a/doc/files/rotateactor.html b/doc/files/rotateactor.html new file mode 100644 index 0000000..be24335 --- /dev/null +++ b/doc/files/rotateactor.html @@ -0,0 +1,21 @@ + + +
+ + ++ Rotates and actor a given number of degrees from its current orientation +
+Related: + SetActorRotation + GetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/files/rotateactor.txt b/doc/files/rotateactor.txt new file mode 100644 index 0000000..bea4d34 --- /dev/null +++ b/doc/files/rotateactor.txt @@ -0,0 +1,6 @@ +#title RotateActor [RCBasic Doc] +#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.html b/doc/files/rotatecamera.html new file mode 100644 index 0000000..c8d27af --- /dev/null +++ b/doc/files/rotatecamera.html @@ -0,0 +1,21 @@ + + +
+ + ++ Rotates the camera a given number of degrees from its current orientation +
+Related: + SetCameraRotation + GetCameraRotation +
++ + + \ No newline at end of file diff --git a/doc/files/rotatecamera.txt b/doc/files/rotatecamera.txt new file mode 100644 index 0000000..d4ce338 --- /dev/null +++ b/doc/files/rotatecamera.txt @@ -0,0 +1,6 @@ +#title RotateCamera [RCBasic Doc] +#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.html b/doc/files/rotatesprite.html new file mode 100644 index 0000000..9e36a04 --- /dev/null +++ b/doc/files/rotatesprite.html @@ -0,0 +1,63 @@ + + +
+ + ++ Sets the angle the sprite is rotated by relative to its current rotation +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("RotateSprite", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeAngle 'Variable to hold the sprites angle value
+ eyeAngle = 250
+ ReleaseKey = 0
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ 'RotateSprite(eyeSprite, eyeAngle)
+
+ While Not Key(K_ESCAPE)
+ 'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called.
+
+ If Key(K_SPACE) And ReleaseKey = 0 Then
+ eyeAngle = 30
+ RotateSprite(eyeSprite, eyeAngle)
+ ReleaseKey = 1
+ ElseIf Not Key(K_SPACE) And ReleaseKey = 1 then
+ ReleaseKey = 0
+ End If
+
+ Update() 'Update automatically deals with drawing the sprites on the sprite canvas.
+ Wend
+
Related: + SetSpriteRotation + GetSpriteRotation +
++ + + \ No newline at end of file diff --git a/doc/files/rotatesprite.txt b/doc/files/rotatesprite.txt new file mode 100644 index 0000000..7eebdfa --- /dev/null +++ b/doc/files/rotatesprite.txt @@ -0,0 +1,50 @@ +#title RotateSprite [RCBasic Doc] +#header Sub RotateSprite(sprite, angle) + +Sets the angle the sprite is rotated by relative to its current rotation + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("RotateSprite", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +DIM eyeAngle 'Variable to hold the sprites angle value +eyeAngle = 250 +ReleaseKey = 0 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, 100, 100) + +'RotateSprite(eyeSprite, eyeAngle) + +While Not Key(K_ESCAPE) +'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called. + +If Key(K_SPACE) And ReleaseKey = 0 Then + eyeAngle = 30 + RotateSprite(eyeSprite, eyeAngle) + ReleaseKey = 1 +ElseIf Not Key(K_SPACE) And ReleaseKey = 1 then + ReleaseKey = 0 +End If + +Update() 'Update automatically deals with drawing the sprites on the sprite canvas. +Wend +#/code + +#image "images/theEye.png" + +#ref SetSpriteRotation GetSpriteRotation diff --git a/doc/files/round.html b/doc/files/round.html new file mode 100644 index 0000000..c150be5 --- /dev/null +++ b/doc/files/round.html @@ -0,0 +1,17 @@ + + +
+ + ++ Rounds n to the nearest whole number. +
++ + + \ No newline at end of file diff --git a/doc/files/round.txt b/doc/files/round.txt new file mode 100644 index 0000000..2ede955 --- /dev/null +++ b/doc/files/round.txt @@ -0,0 +1,4 @@ +#title Round [RCBasic Doc] +#header function Round(n) + +Rounds n to the nearest whole number. diff --git a/doc/files/rtrim.html b/doc/files/rtrim.html new file mode 100644 index 0000000..2cfea1a --- /dev/null +++ b/doc/files/rtrim.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with all the spaces after the last non-space character removed. +
++ + + \ No newline at end of file diff --git a/doc/files/rtrim.txt b/doc/files/rtrim.txt new file mode 100644 index 0000000..e184ddc --- /dev/null +++ b/doc/files/rtrim.txt @@ -0,0 +1,4 @@ +#title Rtrim$ [RCBasic Doc] +#header function Rtrim$(src$) + +Returns src$ with all the spaces after the last non-space character removed. diff --git a/doc/files/runtime.html b/doc/files/runtime.html new file mode 100644 index 0000000..7d6a8d3 --- /dev/null +++ b/doc/files/runtime.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the path to the RCBasic runtime that launched the current program +
++ + + \ No newline at end of file diff --git a/doc/files/runtime.txt b/doc/files/runtime.txt new file mode 100644 index 0000000..0e834dd --- /dev/null +++ b/doc/files/runtime.txt @@ -0,0 +1,4 @@ +#title Runtime$ [RCBasic Doc] +#header function Runtime$() + +Returns the path to the RCBasic runtime that launched the current program diff --git a/doc/files/runtime_utility_message.html b/doc/files/runtime_utility_message.html new file mode 100644 index 0000000..aad9ddb --- /dev/null +++ b/doc/files/runtime_utility_message.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/runtime_utility_message.txt b/doc/files/runtime_utility_message.txt new file mode 100644 index 0000000..6d9adb7 --- /dev/null +++ b/doc/files/runtime_utility_message.txt @@ -0,0 +1,6 @@ +#title Runtime_Utility_Message$ [RCBasic Doc] +#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/scalarmatrix.html b/doc/files/scalarmatrix.html new file mode 100644 index 0000000..e268c19 --- /dev/null +++ b/doc/files/scalarmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Multiplies values in matrix mA by scalar value and stores the results in mB +
++ + + \ No newline at end of file diff --git a/doc/files/scalarmatrix.txt b/doc/files/scalarmatrix.txt new file mode 100644 index 0000000..a68839f --- /dev/null +++ b/doc/files/scalarmatrix.txt @@ -0,0 +1,4 @@ +#title ScalarMatrix [RCBasic Doc] +#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.html b/doc/files/scalarmatrixcolumns.html new file mode 100644 index 0000000..447d3b9 --- /dev/null +++ b/doc/files/scalarmatrixcolumns.html @@ -0,0 +1,17 @@ + + +
+ + ++ Multiplies values in the specified columns of matrix mA by scalar value and stores the results in mB +
++ + + \ No newline at end of file diff --git a/doc/files/scalarmatrixcolumns.txt b/doc/files/scalarmatrixcolumns.txt new file mode 100644 index 0000000..1385975 --- /dev/null +++ b/doc/files/scalarmatrixcolumns.txt @@ -0,0 +1,4 @@ +#title ScalarMatrixColumns [RCBasic Doc] +#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.html b/doc/files/scalarmatrixrows.html new file mode 100644 index 0000000..4f6d033 --- /dev/null +++ b/doc/files/scalarmatrixrows.html @@ -0,0 +1,17 @@ + + +
+ + ++ Multiplies values in the specified rows of matrix mA by scalar value and stores the results in mB +
++ + + \ No newline at end of file diff --git a/doc/files/scalarmatrixrows.txt b/doc/files/scalarmatrixrows.txt new file mode 100644 index 0000000..c2ce85b --- /dev/null +++ b/doc/files/scalarmatrixrows.txt @@ -0,0 +1,4 @@ +#title ScalarMatrixRows [RCBasic Doc] +#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.html b/doc/files/scaleactor.html new file mode 100644 index 0000000..2fdd549 --- /dev/null +++ b/doc/files/scaleactor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Multiplies the actor's current scale by the vector given +
+Related: + SetActorScale +
++ + + \ No newline at end of file diff --git a/doc/files/scaleactor.txt b/doc/files/scaleactor.txt new file mode 100644 index 0000000..7889025 --- /dev/null +++ b/doc/files/scaleactor.txt @@ -0,0 +1,6 @@ +#title ScaleActor [RCBasic Doc] +#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.html b/doc/files/scalesprite.html new file mode 100644 index 0000000..ab5e780 --- /dev/null +++ b/doc/files/scalesprite.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the scale of a sprite relative to its current scale +
+Related: + SetSpriteScale + GetSpriteScale +
++ + + \ No newline at end of file diff --git a/doc/files/scalesprite.txt b/doc/files/scalesprite.txt new file mode 100644 index 0000000..bf23b2e --- /dev/null +++ b/doc/files/scalesprite.txt @@ -0,0 +1,6 @@ +#title ScaleSprite [RCBasic Doc] +#header Sub ScaleSprite(sprite, x, y) + +Sets the scale of a sprite relative to its current scale + +#ref SetSpriteScale GetSpriteScale diff --git a/doc/files/scaleterraintexture.html b/doc/files/scaleterraintexture.html new file mode 100644 index 0000000..5d85779 --- /dev/null +++ b/doc/files/scaleterraintexture.html @@ -0,0 +1,25 @@ + + +
+ + ++ Scales the base texture, similar to makePlanarTextureMapping. +
++ + + \ No newline at end of file diff --git a/doc/files/scaleterraintexture.txt b/doc/files/scaleterraintexture.txt new file mode 100644 index 0000000..ac4b9d4 --- /dev/null +++ b/doc/files/scaleterraintexture.txt @@ -0,0 +1,9 @@ +#title ScaleTerrainTexture [RCBasic Doc] +#header sub ScaleTerrainTexture( actor, scale, scale2 ) + +Scales the base texture, similar to makePlanarTextureMapping. + +#list ul +#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/scope.html b/doc/files/scope.html new file mode 100644 index 0000000..4ea7241 --- /dev/null +++ b/doc/files/scope.html @@ -0,0 +1,30 @@ + + +
+ + ++ Scope refers to where you are able to access a variable. Basically variables cannot be accessed from outside the scope they are created in. Look at the following: +
+
+ A = 5
+
+ While A < 10
+ B = 1 '----- B is created inside this loop and cannot be accessed outside of this loop
+ A = A + 1 '----- A was created before this loop started so it will be able to be used after this loop ends
+ Wend
+
+ Print B
+
+ 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/files/scope.txt b/doc/files/scope.txt new file mode 100644 index 0000000..45f9b63 --- /dev/null +++ b/doc/files/scope.txt @@ -0,0 +1,16 @@ +#title RCBasic Scope [RCBasic Doc] +#header SCOPE + +Scope refers to where you are able to access a variable. Basically variables cannot be accessed from outside the scope they are created in. Look at the following: +#code +A = 5 + +While A < 10 + B = 1 '----- B is created inside this loop and cannot be accessed outside of this loop + A = A + 1 '----- A was created before this loop started so it will be able to be used after this loop ends +Wend + +Print B +#/code + +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. diff --git a/doc/files/seek.html b/doc/files/seek.html new file mode 100644 index 0000000..b4d0282 --- /dev/null +++ b/doc/files/seek.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the position within a file to read from or write to. +
+Related: + Tell +
++ + + \ No newline at end of file diff --git a/doc/files/seek.txt b/doc/files/seek.txt new file mode 100644 index 0000000..d702020 --- /dev/null +++ b/doc/files/seek.txt @@ -0,0 +1,6 @@ +#title Seek [RCBasic Doc] +#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.html b/doc/files/setactorangularfactor.html new file mode 100644 index 0000000..8edd8fc --- /dev/null +++ b/doc/files/setactorangularfactor.html @@ -0,0 +1,25 @@ + + +
+ + ++ Sets an actor's angular factor. +
++ The angular factor determines how the actor responds to angular velocity or torque. +
+Related: + GetActorAngularFactor + SetActorAngularFactor + SetActorLinearFactor +
++ + + \ No newline at end of file diff --git a/doc/files/setactorangularfactor.txt b/doc/files/setactorangularfactor.txt new file mode 100644 index 0000000..f24d283 --- /dev/null +++ b/doc/files/setactorangularfactor.txt @@ -0,0 +1,9 @@ +#title SetActorAngularFactor [RCBasic Doc] +#header sub SetActorAngularFactor( actor, x, y, z) + +Sets an actor's angular factor. + +The angular factor determines how the actor responds to angular velocity or torque. + +#ref GetActorAngularFactor SetActorAngularFactor SetActorLinearFactor + diff --git a/doc/files/setactorangularvelocitylocal.html b/doc/files/setactorangularvelocitylocal.html new file mode 100644 index 0000000..dd326d2 --- /dev/null +++ b/doc/files/setactorangularvelocitylocal.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityWorld + GetActorAngularVelocityLocal + SetActorAngularVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/files/setactorangularvelocitylocal.txt b/doc/files/setactorangularvelocitylocal.txt new file mode 100644 index 0000000..1038b4a --- /dev/null +++ b/doc/files/setactorangularvelocitylocal.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setactorangularvelocityworld.html new file mode 100644 index 0000000..568a1fd --- /dev/null +++ b/doc/files/setactorangularvelocityworld.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets an actor's Angular Velocity +
+Related: + GetActorAngularVelocityWorld + GetActorAngularVelocityLocal + SetActorAngularVelocityLocal +
++ + + \ No newline at end of file diff --git a/doc/files/setactorangularvelocityworld.txt b/doc/files/setactorangularvelocityworld.txt new file mode 100644 index 0000000..25b406e --- /dev/null +++ b/doc/files/setactorangularvelocityworld.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/setactoranimation.html new file mode 100644 index 0000000..572de60 --- /dev/null +++ b/doc/files/setactoranimation.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the current animation for an actor to start playing +
++ Notes on num_loops +
+Related: + CreateActorAnimation +
++ + + \ No newline at end of file diff --git a/doc/files/setactoranimation.txt b/doc/files/setactoranimation.txt new file mode 100644 index 0000000..721398b --- /dev/null +++ b/doc/files/setactoranimation.txt @@ -0,0 +1,12 @@ +#title SetActorAnimation [RCBasic Doc] +#header sub SetActorAnimation( actor, animation, num_loops) + +Sets the current animation for an actor to start playing + +Notes on num_loops +#list ol +#li num_loops is the number of times to loop the animation after its done playing. To play the animation once, set num_loops to 0. +#li To loop an animation infinitely, set num_loops to -1 +#/list + +#ref CreateActorAnimation diff --git a/doc/files/setactoranimationframes.html b/doc/files/setactoranimationframes.html new file mode 100644 index 0000000..2e1687e --- /dev/null +++ b/doc/files/setactoranimationframes.html @@ -0,0 +1,20 @@ + + +
+ + ++ Changes the frames that plays in an actor's animation +
+Related: + CreateActorAnimation +
++ + + \ No newline at end of file diff --git a/doc/files/setactoranimationframes.txt b/doc/files/setactoranimationframes.txt new file mode 100644 index 0000000..4339f60 --- /dev/null +++ b/doc/files/setactoranimationframes.txt @@ -0,0 +1,6 @@ +#title SetActorAnimationFrames [RCBasic Doc] +#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.html b/doc/files/setactoranimationspeed.html new file mode 100644 index 0000000..20d9ced --- /dev/null +++ b/doc/files/setactoranimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Set the FPS of an actor animation +
+Related: + GetActorAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/files/setactoranimationspeed.txt b/doc/files/setactoranimationspeed.txt new file mode 100644 index 0000000..e5e785c --- /dev/null +++ b/doc/files/setactoranimationspeed.txt @@ -0,0 +1,6 @@ +#title SetActorAnimationSpeed [RCBasic Doc] +#header sub SetActorAnimationSpeed( actor, animation, speed ) + +Set the FPS of an actor animation + +#ref GetActorAnimationSpeed diff --git a/doc/files/setactorautoculling.html b/doc/files/setactorautoculling.html new file mode 100644 index 0000000..b7bc3d6 --- /dev/null +++ b/doc/files/setactorautoculling.html @@ -0,0 +1,40 @@ + + +
+ + ++ Sets the automatic culling state for an actor +
++ Possible Culling States +
+Related: + GetActorAutoCulling +
++ + + \ No newline at end of file diff --git a/doc/files/setactorautoculling.txt b/doc/files/setactorautoculling.txt new file mode 100644 index 0000000..ce727d7 --- /dev/null +++ b/doc/files/setactorautoculling.txt @@ -0,0 +1,15 @@ +#title SetActorAutoCulling [RCBasic Doc] +#header sub SetActorAutoCulling( actor, cull_type ) + +Sets the automatic culling state for an actor + +Possible Culling States +#list +#li AUTOCULLING_OFF +#li AUTOCULLING_BOX +#li AUTOCULLING_FRUSTUM_BOX +#li AUTOCULLING_FRUSTUM_SPHERE +#li AUTOCULLING_OCC_QUERY +#/list + +#ref GetActorAutoCulling diff --git a/doc/files/setactorcollisionshape.html b/doc/files/setactorcollisionshape.html new file mode 100644 index 0000000..762c079 --- /dev/null +++ b/doc/files/setactorcollisionshape.html @@ -0,0 +1,49 @@ + + +
+ + ++ Sets the actor's collision shape +
++ Shape Types: +
+Related: + GetActorCollisionShape +
++ + + \ No newline at end of file diff --git a/doc/files/setactorcollisionshape.txt b/doc/files/setactorcollisionshape.txt new file mode 100644 index 0000000..2863723 --- /dev/null +++ b/doc/files/setactorcollisionshape.txt @@ -0,0 +1,18 @@ +#title SetActorCollisionShape [RCBasic Doc] +#header sub SetActorCollisionShape( actor, shape_type, mass) + +Sets the actor's collision shape + +Shape Types: +#list ul +#li SHAPE_TYPE_NONE +#li SHAPE_TYPE_BOX +#li SHAPE_TYPE_SPHERE +#li SHAPE_TYPE_CYLINDER +#li SHAPE_TYPE_CAPSULE +#li SHAPE_TYPE_CONE +#li SHAPE_TYPE_CONVEXHULL +#li SHAPE_TYPE_TRIMESH +#/list + +#ref GetActorCollisionShape diff --git a/doc/files/setactordamping.html b/doc/files/setactordamping.html new file mode 100644 index 0000000..decd63e --- /dev/null +++ b/doc/files/setactordamping.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the linear and angular damping for an actor +
+Related: + GetActorLinearDamping + GetActorAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/files/setactordamping.txt b/doc/files/setactordamping.txt new file mode 100644 index 0000000..40737d5 --- /dev/null +++ b/doc/files/setactordamping.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setactorframe.html new file mode 100644 index 0000000..abca648 --- /dev/null +++ b/doc/files/setactorframe.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the current frame of an actor +
++ Note: This function will set the actor's animation to 0 which is a default 1 frame animation that is created when the actor is created. +
+Related: + GetActorFrame +
++ + + \ No newline at end of file diff --git a/doc/files/setactorframe.txt b/doc/files/setactorframe.txt new file mode 100644 index 0000000..b38a8a0 --- /dev/null +++ b/doc/files/setactorframe.txt @@ -0,0 +1,9 @@ +#title SetActorFrame [RCBasic Doc] +#header sub SetActorFrame( actor, frame ) + +Sets the current frame of an actor + +Note: This function will set the actor's animation to 0 which is a default 1 frame animation that is created when the actor is created. + + +#ref GetActorFrame diff --git a/doc/files/setactorgravity.html b/doc/files/setactorgravity.html new file mode 100644 index 0000000..707fdf7 --- /dev/null +++ b/doc/files/setactorgravity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the gravity vector of an actor. +
+Related: + SetGravity3D +
++ + + \ No newline at end of file diff --git a/doc/files/setactorgravity.txt b/doc/files/setactorgravity.txt new file mode 100644 index 0000000..67bbb97 --- /dev/null +++ b/doc/files/setactorgravity.txt @@ -0,0 +1,6 @@ +#title SetActorGravity [RCBasic Doc] +#header sub SetActorGravity( actor, x, y, z ) + +Sets the gravity vector of an actor. + +#ref SetGravity3D diff --git a/doc/files/setactorinverseinertiadiaglocal.html b/doc/files/setactorinverseinertiadiaglocal.html new file mode 100644 index 0000000..1d4290f --- /dev/null +++ b/doc/files/setactorinverseinertiadiaglocal.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetActorInverseInertiaDiagLocal +
++ + + \ No newline at end of file diff --git a/doc/files/setactorinverseinertiadiaglocal.txt b/doc/files/setactorinverseinertiadiaglocal.txt new file mode 100644 index 0000000..cc428ef --- /dev/null +++ b/doc/files/setactorinverseinertiadiaglocal.txt @@ -0,0 +1,6 @@ +#title SetActorInverseInertiaDiagLocal [RCBasic Doc] +#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.html b/doc/files/setactorlinearfactor.html new file mode 100644 index 0000000..b4b4961 --- /dev/null +++ b/doc/files/setactorlinearfactor.html @@ -0,0 +1,25 @@ + + +
+ + ++ Sets an actor's linear factor. +
++ The linear factor determines how the actor responds to linear velocity or force. +
+Related: + GetActorLinearFactor + SetActorAngularFactor + GetActorAngularFactor +
++ + + \ No newline at end of file diff --git a/doc/files/setactorlinearfactor.txt b/doc/files/setactorlinearfactor.txt new file mode 100644 index 0000000..836a22f --- /dev/null +++ b/doc/files/setactorlinearfactor.txt @@ -0,0 +1,9 @@ +#title SetActorLinearFactor [RCBasic Doc] +#header sub SetActorLinearFactor( actor, x, y, z) + +Sets an actor's linear factor. + +The linear factor determines how the actor responds to linear velocity or force. + +#ref GetActorLinearFactor SetActorAngularFactor GetActorAngularFactor + diff --git a/doc/files/setactorlinearvelocitylocal.html b/doc/files/setactorlinearvelocitylocal.html new file mode 100644 index 0000000..40bddcc --- /dev/null +++ b/doc/files/setactorlinearvelocitylocal.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets actor's linear velocity +
+Related: + GetActorLinearVelocityLocal + SetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/files/setactorlinearvelocitylocal.txt b/doc/files/setactorlinearvelocitylocal.txt new file mode 100644 index 0000000..a662ba8 --- /dev/null +++ b/doc/files/setactorlinearvelocitylocal.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setactorlinearvelocityworld.html new file mode 100644 index 0000000..c98f700 --- /dev/null +++ b/doc/files/setactorlinearvelocityworld.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets actor's linear velocity +
+Related: + SetActorLinearVelocityLocal + GetActorLinearVelocityWorld +
++ + + \ No newline at end of file diff --git a/doc/files/setactorlinearvelocityworld.txt b/doc/files/setactorlinearvelocityworld.txt new file mode 100644 index 0000000..eaf790a --- /dev/null +++ b/doc/files/setactorlinearvelocityworld.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/setactormassproperties.html new file mode 100644 index 0000000..1453fc5 --- /dev/null +++ b/doc/files/setactormassproperties.html @@ -0,0 +1,40 @@ + + +
+ + ++ 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. +
++ Mass +
++ Inertial +
+Related: + GetActorLocalInertia + GetActorInverseMass +
++ + + \ No newline at end of file diff --git a/doc/files/setactormassproperties.txt b/doc/files/setactormassproperties.txt new file mode 100644 index 0000000..8ed0140 --- /dev/null +++ b/doc/files/setactormassproperties.txt @@ -0,0 +1,17 @@ +#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. + +Mass +#list ul +#li The mass of an actor defines how much it resists changes in its motion when forces are applied. A heavier object will require more force to accelerate or decelerate compared to a lighter object. +#/list + +Inertial +#list ul +#li The local inertia is a vector that represents how the mass is distributed within the actor relative to its center of mass. It affects how the actor resists rotational forces (torques). +#li An object with a larger inertia value along a specific axis will rotate more slowly when a torque is applied in that direction, and vice versa. +#/list + +#ref GetActorLocalInertia GetActorInverseMass diff --git a/doc/files/setactormaterial.html b/doc/files/setactormaterial.html new file mode 100644 index 0000000..cbc4d92 --- /dev/null +++ b/doc/files/setactormaterial.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + GetActorMaterial +
++ + + \ No newline at end of file diff --git a/doc/files/setactormaterial.txt b/doc/files/setactormaterial.txt new file mode 100644 index 0000000..29ce970 --- /dev/null +++ b/doc/files/setactormaterial.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setactormaterialflag.html new file mode 100644 index 0000000..f7bb01b --- /dev/null +++ b/doc/files/setactormaterialflag.html @@ -0,0 +1,89 @@ + + +
+ + ++ Sets the value of an actor's material flag. +
++ Note: The material on this would be material 0. To set other material flag's you need to get a reference to the actor's material with GetActorMaterial(). +
++ Possible values for flag: +
+Related: + GetActorMaterialFlag + GetActorMaterial +
++ + + \ No newline at end of file diff --git a/doc/files/setactormaterialflag.txt b/doc/files/setactormaterialflag.txt new file mode 100644 index 0000000..96ebeff --- /dev/null +++ b/doc/files/setactormaterialflag.txt @@ -0,0 +1,32 @@ +#title setActorMaterialFlag [RCBasic Doc] +#header sub setActorMaterialFlag( actor, flag, flag_value) + +Sets the value of an actor's material flag. + +Note: The material on this would be material 0. To set other material flag's you need to get a reference to the actor's material with GetActorMaterial(). + +Possible values for flag: +#list +#li MATERIAL_FLAG_WIREFRAME +#li MATERIAL_FLAG_POINTCLOUD +#li MATERIAL_FLAG_GOURAUD_SHADING +#li MATERIAL_FLAG_LIGHTING +#li MATERIAL_FLAG_ZBUFFER +#li MATERIAL_FLAG_ZWRITE_ENABLE +#li MATERIAL_FLAG_BACK_FACE_CULLING +#li MATERIAL_FLAG_FRONT_FACE_CULLING +#li MATERIAL_FLAG_BILINEAR_FILTER +#li MATERIAL_FLAG_TRILINEAR_FILTER +#li MATERIAL_FLAG_ANISOTROPIC_FILTER +#li MATERIAL_FLAG_FOG_ENABLE +#li MATERIAL_FLAG_NORMALIZE_NORMALS +#li MATERIAL_FLAG_TEXTURE_WRAP +#li MATERIAL_FLAG_ANTI_ALIASING +#li MATERIAL_FLAG_COLOR_MASK +#li MATERIAL_FLAG_COLOR_MATERIAL +#li MATERIAL_FLAG_USE_MIP_MAPS +#li MATERIAL_FLAG_BLEND_OPERATION +#li MATERIAL_FLAG_POLYGON_OFFSET +#/list + +#ref GetActorMaterialFlag GetActorMaterial diff --git a/doc/files/setactormaterialtype.html b/doc/files/setactormaterialtype.html new file mode 100644 index 0000000..d0d5809 --- /dev/null +++ b/doc/files/setactormaterialtype.html @@ -0,0 +1,104 @@ + + +
+ + ++ Sets the material type of an actor material +
++ Note: This will set material 0. If your actor has more than one material you need to get a reference to the actor material with GetActorMaterial() to set them. +
++ Possible material types +
+Related: + GetActorMaterialType + GetActorMaterial +
++ + + \ No newline at end of file diff --git a/doc/files/setactormaterialtype.txt b/doc/files/setactormaterialtype.txt new file mode 100644 index 0000000..5289e2e --- /dev/null +++ b/doc/files/setactormaterialtype.txt @@ -0,0 +1,37 @@ +#title setActorMaterialType [RCBasic Doc] +#header sub setActorMaterialType( actor, material_type) + +Sets the material type of an actor material + +Note: This will set material 0. If your actor has more than one material you need to get a reference to the actor material with GetActorMaterial() to set them. + +Possible material types +#list ul +#li MATERIAL_TYPE_SOLID +#li MATERIAL_TYPE_SOLID_2_LAYER +#li MATERIAL_TYPE_LIGHTMAP +#li MATERIAL_TYPE_LIGHTMAP_ADD +#li MATERIAL_TYPE_LIGHTMAP_M2 +#li MATERIAL_TYPE_LIGHTMAP_M4 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M2 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M4 +#li MATERIAL_TYPE_DETAIL_MAP +#li MATERIAL_TYPE_SPHERE_MAP +#li MATERIAL_TYPE_REFLECTION_2_LAYER +#li MATERIAL_TYPE_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL_REF +#li MATERIAL_TYPE_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_TRANSPARENT_REFLECTION_2_LAYER +#li MATERIAL_TYPE_NORMAL_MAP_SOLID +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_PARALLAX_MAP_SOLID +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_ONETEXTURE_BLEND +#li MATERIAL_TYPE_FORCE_32BIT +#/list + +#ref GetActorMaterialType GetActorMaterial diff --git a/doc/files/setactormd2animation.html b/doc/files/setactormd2animation.html new file mode 100644 index 0000000..66e48bf --- /dev/null +++ b/doc/files/setactormd2animation.html @@ -0,0 +1,88 @@ + + +
+ + ++ Sets the current animation for an *.md2 model +
++ Possible Animations +
+Related: + SetActorMD2AnimationByName +
++ + + \ No newline at end of file diff --git a/doc/files/setactormd2animation.txt b/doc/files/setactormd2animation.txt new file mode 100644 index 0000000..b90d1fe --- /dev/null +++ b/doc/files/setactormd2animation.txt @@ -0,0 +1,31 @@ +#title SetActorMD2Animation [RCBasic Doc] +#header sub SetActorMD2Animation( actor, anim ) + +Sets the current animation for an *.md2 model + +Possible Animations +#list ul +#li MD2_ANIMATION_STAND +#li MD2_ANIMATION_RUN +#li MD2_ANIMATION_ATTACK +#li MD2_ANIMATION_PAIN_A +#li MD2_ANIMATION_PAIN_B +#li MD2_ANIMATION_PAIN_C +#li MD2_ANIMATION_JUMP +#li MD2_ANIMATION_FLIP +#li MD2_ANIMATION_SALUTE +#li MD2_ANIMATION_FALLBACK +#li MD2_ANIMATION_WAVE +#li MD2_ANIMATION_POINT +#li MD2_ANIMATION_CROUCH_STAND +#li MD2_ANIMATION_CROUCH_WALK +#li MD2_ANIMATION_CROUCH_ATTACK +#li MD2_ANIMATION_CROUCH_PAIN +#li MD2_ANIMATION_CROUCH_DEATH +#li MD2_ANIMATION_DEATH_FALLBACK +#li MD2_ANIMATION_DEATH_FALLFORWARD +#li MD2_ANIMATION_DEATH_FALLBACKSLOW +#li MD2_ANIMATION_BOOM +#/list + +#ref SetActorMD2AnimationByName diff --git a/doc/files/setactormd2animationbyname.html b/doc/files/setactormd2animationbyname.html new file mode 100644 index 0000000..2f1b6f6 --- /dev/null +++ b/doc/files/setactormd2animationbyname.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the current animation for an *.md2 model +
+Related: + SetActorMD2Animation +
++ + + \ No newline at end of file diff --git a/doc/files/setactormd2animationbyname.txt b/doc/files/setactormd2animationbyname.txt new file mode 100644 index 0000000..46e598d --- /dev/null +++ b/doc/files/setactormd2animationbyname.txt @@ -0,0 +1,7 @@ +#title SetActorMD2AnimationByName [RCBasic Doc] +#header sub SetActorMD2AnimationByName( actor, anim_name$ ) + +Sets the current animation for an *.md2 model + +#ref SetActorMD2Animation + diff --git a/doc/files/setactorposition.html b/doc/files/setactorposition.html new file mode 100644 index 0000000..ee1d056 --- /dev/null +++ b/doc/files/setactorposition.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets the absolute position of an actor +
+Related: + TranslateActorLocal + TranslateActorWorld + GetActorPosition +
++ + + \ No newline at end of file diff --git a/doc/files/setactorposition.txt b/doc/files/setactorposition.txt new file mode 100644 index 0000000..5ca46d9 --- /dev/null +++ b/doc/files/setactorposition.txt @@ -0,0 +1,6 @@ +#title SetActorPosition [RCBasic Doc] +#header sub SetActorPosition( actor, x, y, z ) + +Sets the absolute position of an actor + +#ref TranslateActorLocal TranslateActorWorld GetActorPosition diff --git a/doc/files/setactorrotation.html b/doc/files/setactorrotation.html new file mode 100644 index 0000000..70af4ed --- /dev/null +++ b/doc/files/setactorrotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the rotation of an actor around each axis +
+Related: + RotateActor + GetActorRotation +
++ + + \ No newline at end of file diff --git a/doc/files/setactorrotation.txt b/doc/files/setactorrotation.txt new file mode 100644 index 0000000..b0db8eb --- /dev/null +++ b/doc/files/setactorrotation.txt @@ -0,0 +1,6 @@ +#title SetActorRotation [RCBasic Doc] +#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.html b/doc/files/setactorscale.html new file mode 100644 index 0000000..f115673 --- /dev/null +++ b/doc/files/setactorscale.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the scale of an actor +
+Related: + ScaleActor + GetActorScale +
++ + + \ No newline at end of file diff --git a/doc/files/setactorscale.txt b/doc/files/setactorscale.txt new file mode 100644 index 0000000..f76d172 --- /dev/null +++ b/doc/files/setactorscale.txt @@ -0,0 +1,6 @@ +#title SetActorScale [RCBasic Doc] +#header sub SetActorScale( actor, x, y, z ) + +Sets the scale of an actor + +#ref ScaleActor GetActorScale diff --git a/doc/files/setactorsleepstate.html b/doc/files/setactorsleepstate.html new file mode 100644 index 0000000..968f735 --- /dev/null +++ b/doc/files/setactorsleepstate.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setactorsleepstate.txt b/doc/files/setactorsleepstate.txt new file mode 100644 index 0000000..6fdf632 --- /dev/null +++ b/doc/files/setactorsleepstate.txt @@ -0,0 +1,4 @@ +#title SetActorSleepState [RCBasic Doc] +#header sub SetActorSleepState(actor, state) + + diff --git a/doc/files/setactorsleepthresholds.html b/doc/files/setactorsleepthresholds.html new file mode 100644 index 0000000..cd19c17 --- /dev/null +++ b/doc/files/setactorsleepthresholds.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the linear and angular deactivation thresholds for an actor +
+Related: + GetActorLinearSleepThreshold + GetActorAngularSleepThreshold +
++ + + \ No newline at end of file diff --git a/doc/files/setactorsleepthresholds.txt b/doc/files/setactorsleepthresholds.txt new file mode 100644 index 0000000..d6d9fed --- /dev/null +++ b/doc/files/setactorsleepthresholds.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setactorsolid.html new file mode 100644 index 0000000..71f6cb0 --- /dev/null +++ b/doc/files/setactorsolid.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets whether an actor has physics and collision response applied to it +
++ Note: Collision detection will still work for non solid actors +
+Related: + ActorIsSolid +
++ + + \ No newline at end of file diff --git a/doc/files/setactorsolid.txt b/doc/files/setactorsolid.txt new file mode 100644 index 0000000..b0d24c7 --- /dev/null +++ b/doc/files/setactorsolid.txt @@ -0,0 +1,8 @@ +#title SetActorSolid [RCBasic Doc] +#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.html b/doc/files/setactortexture.html new file mode 100644 index 0000000..35d04be --- /dev/null +++ b/doc/files/setactortexture.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the texture for an actor's default material +
++ Note: Generally you want to use texture layer 0 +
++ + + \ No newline at end of file diff --git a/doc/files/setactortexture.txt b/doc/files/setactortexture.txt new file mode 100644 index 0000000..d80baf8 --- /dev/null +++ b/doc/files/setactortexture.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setactorvisible.html new file mode 100644 index 0000000..7892e26 --- /dev/null +++ b/doc/files/setactorvisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether the actor is visible in the scene +
+Related: + ActorIsVisible +
++ + + \ No newline at end of file diff --git a/doc/files/setactorvisible.txt b/doc/files/setactorvisible.txt new file mode 100644 index 0000000..fb889ba --- /dev/null +++ b/doc/files/setactorvisible.txt @@ -0,0 +1,6 @@ +#title SetActorVisible [RCBasic Doc] +#header sub SetActorVisible( actor, flag ) + +Sets whether the actor is visible in the scene + +#ref ActorIsVisible diff --git a/doc/files/setbilinearfilter.html b/doc/files/setbilinearfilter.html new file mode 100644 index 0000000..7c903d9 --- /dev/null +++ b/doc/files/setbilinearfilter.html @@ -0,0 +1,17 @@ + + +
+ + ++ Enables or disables the bilinear filter for drawing 2D images +
++ + + \ No newline at end of file diff --git a/doc/files/setbilinearfilter.txt b/doc/files/setbilinearfilter.txt new file mode 100644 index 0000000..9722876 --- /dev/null +++ b/doc/files/setbilinearfilter.txt @@ -0,0 +1,4 @@ +#title setBilinearFilter [RCBasic Doc] +#header sub setBilinearFilter( flag ) + +Enables or disables the bilinear filter for drawing 2D images diff --git a/doc/files/setblendmode.html b/doc/files/setblendmode.html new file mode 100644 index 0000000..4e1c251 --- /dev/null +++ b/doc/files/setblendmode.html @@ -0,0 +1,58 @@ + + +
+ + ++ Sets the current blend mode +
++ Note: Only applies to 2D image drawing commands +
++ Possible Blend Modes +
+Related: + SetBlendMode +
++ + + \ No newline at end of file diff --git a/doc/files/setblendmode.txt b/doc/files/setblendmode.txt new file mode 100644 index 0000000..66d69a8 --- /dev/null +++ b/doc/files/setblendmode.txt @@ -0,0 +1,23 @@ +#title SetBlendMode [RCBasic Doc] +#header sub SetBlendMode( blend_mode ) + +Sets the current blend mode + +Note: Only applies to 2D image drawing commands + +Possible Blend Modes +#list ul +#li BLEND_MODE_NONE +#li BLEND_MODE_ADD +#li BLEND_MODE_SUBTRACT +#li BLEND_MODE_REVSUBTRACT +#li BLEND_MODE_MIN +#li BLEND_MODE_MAX +#li BLEND_MODE_MIN_FACTOR +#li BLEND_MODE_MAX_FACTOR +#li BLEND_MODE_MIN_ALPHA +#li BLEND_MODE_MAX_ALPHA +#/list + +#ref SetBlendMode + diff --git a/doc/files/setcameraaspectratio.html b/doc/files/setcameraaspectratio.html new file mode 100644 index 0000000..19ce197 --- /dev/null +++ b/doc/files/setcameraaspectratio.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the aspect ratio for the active canvas camera +
+Related: + GetCameraAspectRatio +
++ + + \ No newline at end of file diff --git a/doc/files/setcameraaspectratio.txt b/doc/files/setcameraaspectratio.txt new file mode 100644 index 0000000..f18b53b --- /dev/null +++ b/doc/files/setcameraaspectratio.txt @@ -0,0 +1,6 @@ +#title SetCameraAspectRatio [RCBasic Doc] +#header sub SetCameraAspectRatio( aspect ) + +Sets the aspect ratio for the active canvas camera + +#ref GetCameraAspectRatio diff --git a/doc/files/setcamerafarvalue.html b/doc/files/setcamerafarvalue.html new file mode 100644 index 0000000..74ded46 --- /dev/null +++ b/doc/files/setcamerafarvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the distance to the camera far plane +
+Related: + GetCameraFarValue +
++ + + \ No newline at end of file diff --git a/doc/files/setcamerafarvalue.txt b/doc/files/setcamerafarvalue.txt new file mode 100644 index 0000000..a8d0231 --- /dev/null +++ b/doc/files/setcamerafarvalue.txt @@ -0,0 +1,6 @@ +#title SetCameraFarValue [RCBasic Doc] +#header sub SetCameraFarValue( zf ) + +Sets the distance to the camera far plane + +#ref GetCameraFarValue diff --git a/doc/files/setcamerafov.html b/doc/files/setcamerafov.html new file mode 100644 index 0000000..30660fb --- /dev/null +++ b/doc/files/setcamerafov.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the camera's field of view +
+Related: + GetCameraFOV +
++ + + \ No newline at end of file diff --git a/doc/files/setcamerafov.txt b/doc/files/setcamerafov.txt new file mode 100644 index 0000000..19caf7d --- /dev/null +++ b/doc/files/setcamerafov.txt @@ -0,0 +1,6 @@ +#title SetCameraFOV [RCBasic Doc] +#header sub SetCameraFOV( fov ) + +Sets the camera's field of view + +#ref GetCameraFOV diff --git a/doc/files/setcameranearvalue.html b/doc/files/setcameranearvalue.html new file mode 100644 index 0000000..f2645fe --- /dev/null +++ b/doc/files/setcameranearvalue.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the distance of the camera near plane +
+Related: + GetCameraNearValue +
++ + + \ No newline at end of file diff --git a/doc/files/setcameranearvalue.txt b/doc/files/setcameranearvalue.txt new file mode 100644 index 0000000..d70f896 --- /dev/null +++ b/doc/files/setcameranearvalue.txt @@ -0,0 +1,6 @@ +#title SetCameraNearValue [RCBasic Doc] +#header sub SetCameraNearValue( zn ) + +Sets the distance of the camera near plane + +#ref GetCameraNearValue diff --git a/doc/files/setcameraposition.html b/doc/files/setcameraposition.html new file mode 100644 index 0000000..8c3277f --- /dev/null +++ b/doc/files/setcameraposition.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the absolute position of the camera in the scene +
+Related: + TranslateCamera + GetCameraPosition +
++ + + \ No newline at end of file diff --git a/doc/files/setcameraposition.txt b/doc/files/setcameraposition.txt new file mode 100644 index 0000000..96eb8db --- /dev/null +++ b/doc/files/setcameraposition.txt @@ -0,0 +1,6 @@ +#title SetCameraPosition [RCBasic Doc] +#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.html b/doc/files/setcameraprojectionmatrix.html new file mode 100644 index 0000000..528fb55 --- /dev/null +++ b/doc/files/setcameraprojectionmatrix.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the camera projection matrix for the active canvas +
++ Possible values for projection_type +
+Related: + GetCameraProjectionMatrix +
++ + + \ No newline at end of file diff --git a/doc/files/setcameraprojectionmatrix.txt b/doc/files/setcameraprojectionmatrix.txt new file mode 100644 index 0000000..dd73637 --- /dev/null +++ b/doc/files/setcameraprojectionmatrix.txt @@ -0,0 +1,12 @@ +#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.html b/doc/files/setcamerarotation.html new file mode 100644 index 0000000..9b26220 --- /dev/null +++ b/doc/files/setcamerarotation.html @@ -0,0 +1,21 @@ + + +
+ + ++ Sets the rotation of the camera around each axis +
+Related: + RotateCamera + GetCameraRotation +
++ + + \ No newline at end of file diff --git a/doc/files/setcamerarotation.txt b/doc/files/setcamerarotation.txt new file mode 100644 index 0000000..9cbc9f3 --- /dev/null +++ b/doc/files/setcamerarotation.txt @@ -0,0 +1,6 @@ +#title SetCameraRotation [RCBasic Doc] +#header sub SetCameraRotation( x, y, z) + +Sets the rotation of the camera around each axis + +#ref RotateCamera GetCameraRotation diff --git a/doc/files/setcanvas3d.html b/doc/files/setcanvas3d.html new file mode 100644 index 0000000..51e5bc0 --- /dev/null +++ b/doc/files/setcanvas3d.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setcanvasalpha.html b/doc/files/setcanvasalpha.html new file mode 100644 index 0000000..07d853e --- /dev/null +++ b/doc/files/setcanvasalpha.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the alpha blending value for a canvas +
++ + + \ No newline at end of file diff --git a/doc/files/setcanvasalpha.txt b/doc/files/setcanvasalpha.txt new file mode 100644 index 0000000..80b4aef --- /dev/null +++ b/doc/files/setcanvasalpha.txt @@ -0,0 +1,4 @@ +#title SetCanvasAlpha [RCBasic Doc] +#header sub SetCanvasAlpha(c_num, a) + +Sets the alpha blending value for a canvas diff --git a/doc/files/setcanvascolormod.html b/doc/files/setcanvascolormod.html new file mode 100644 index 0000000..a931c8f --- /dev/null +++ b/doc/files/setcanvascolormod.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the color modulation value for a canvas +
++ + + \ No newline at end of file diff --git a/doc/files/setcanvascolormod.txt b/doc/files/setcanvascolormod.txt new file mode 100644 index 0000000..c03eaba --- /dev/null +++ b/doc/files/setcanvascolormod.txt @@ -0,0 +1,4 @@ +#title SetCanvasColorMod [RCBasic Doc] +#header sub SetCanvasColorMod(c_num, c) + +Sets the color modulation value for a canvas diff --git a/doc/files/setcanvasoffset.html b/doc/files/setcanvasoffset.html new file mode 100644 index 0000000..e28e19f --- /dev/null +++ b/doc/files/setcanvasoffset.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the offset of a canvas +
++ The canvas offset is what part of the canvas is visible during rendering. +
+Related: + GetCanvasOffset +
++ + + \ No newline at end of file diff --git a/doc/files/setcanvasoffset.txt b/doc/files/setcanvasoffset.txt new file mode 100644 index 0000000..57fa5fa --- /dev/null +++ b/doc/files/setcanvasoffset.txt @@ -0,0 +1,8 @@ +#title SetCanvasOffset [RCBasic Doc] +#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.html b/doc/files/setcanvasphysics2d.html new file mode 100644 index 0000000..4479a6d --- /dev/null +++ b/doc/files/setcanvasphysics2d.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setcanvasphysics2d.txt b/doc/files/setcanvasphysics2d.txt new file mode 100644 index 0000000..3396833 --- /dev/null +++ b/doc/files/setcanvasphysics2d.txt @@ -0,0 +1,4 @@ +#title SetCanvasPhysics2D [RCBasic Doc] +#header sub SetCanvasPhysics2D(c_num, state) + + diff --git a/doc/files/setcanvasviewport.html b/doc/files/setcanvasviewport.html new file mode 100644 index 0000000..e7c3277 --- /dev/null +++ b/doc/files/setcanvasviewport.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the position and size of a canvas viewport +
+Related: + GetCanvasViewport +
++ + + \ No newline at end of file diff --git a/doc/files/setcanvasviewport.txt b/doc/files/setcanvasviewport.txt new file mode 100644 index 0000000..8b7afa6 --- /dev/null +++ b/doc/files/setcanvasviewport.txt @@ -0,0 +1,7 @@ +#title SetCanvasViewport [RCBasic Doc] +#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.html b/doc/files/setcanvasvisible.html new file mode 100644 index 0000000..c7e7553 --- /dev/null +++ b/doc/files/setcanvasvisible.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether a canvas is shown or not. +
+Related: + CanvasIsVisible +
++ + + \ No newline at end of file diff --git a/doc/files/setcanvasvisible.txt b/doc/files/setcanvasvisible.txt new file mode 100644 index 0000000..7d88749 --- /dev/null +++ b/doc/files/setcanvasvisible.txt @@ -0,0 +1,6 @@ +#title SetCanvasVisible [RCBasic Doc] +#header sub SetCanvasVisible(c_num, flag) + +Sets whether a canvas is shown or not. + +#ref CanvasIsVisible diff --git a/doc/files/setcanvasz.html b/doc/files/setcanvasz.html new file mode 100644 index 0000000..acc6547 --- /dev/null +++ b/doc/files/setcanvasz.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + SetCanvasZ +
++ + + \ No newline at end of file diff --git a/doc/files/setcanvasz.txt b/doc/files/setcanvasz.txt new file mode 100644 index 0000000..77d9ef4 --- /dev/null +++ b/doc/files/setcanvasz.txt @@ -0,0 +1,8 @@ +#title SetCanvasZ [RCBasic Doc] +#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.html b/doc/files/setchanneldistance.html new file mode 100644 index 0000000..492e331 --- /dev/null +++ b/doc/files/setchanneldistance.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/setchanneldistance.txt b/doc/files/setchanneldistance.txt new file mode 100644 index 0000000..1936dd3 --- /dev/null +++ b/doc/files/setchanneldistance.txt @@ -0,0 +1,6 @@ +#title SetChannelDistance [RCBasic Doc] +#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.html b/doc/files/setchannelpanning.html new file mode 100644 index 0000000..fcce1d4 --- /dev/null +++ b/doc/files/setchannelpanning.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/setchannelpanning.txt b/doc/files/setchannelpanning.txt new file mode 100644 index 0000000..64788b9 --- /dev/null +++ b/doc/files/setchannelpanning.txt @@ -0,0 +1,7 @@ +#title SetChannelPanning [RCBasic Doc] +#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.html b/doc/files/setchannelspaceposition.html new file mode 100644 index 0000000..e26faca --- /dev/null +++ b/doc/files/setchannelspaceposition.html @@ -0,0 +1,24 @@ + + +
+ + ++ Simulates audio in 3D space +
++ Angle 0 is in front of the listener and increases clockwise +
+Related: + SetChannelDistance + SetChannelPanning +
++ + + \ No newline at end of file diff --git a/doc/files/setchannelspaceposition.txt b/doc/files/setchannelspaceposition.txt new file mode 100644 index 0000000..670c73d --- /dev/null +++ b/doc/files/setchannelspaceposition.txt @@ -0,0 +1,8 @@ +#title SetChannelSpacePosition [RCBasic Doc] +#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.html b/doc/files/setchannelvolume.html new file mode 100644 index 0000000..2da40fe --- /dev/null +++ b/doc/files/setchannelvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the volume of the audio on a channel +
++ + + \ No newline at end of file diff --git a/doc/files/setchannelvolume.txt b/doc/files/setchannelvolume.txt new file mode 100644 index 0000000..98670a2 --- /dev/null +++ b/doc/files/setchannelvolume.txt @@ -0,0 +1,4 @@ +#title SetChannelVolume [RCBasic Doc] +#header sub SetChannelVolume(channel, vol) + +Sets the volume of the audio on a channel diff --git a/doc/files/setclearcolor.html b/doc/files/setclearcolor.html new file mode 100644 index 0000000..e01229f --- /dev/null +++ b/doc/files/setclearcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the color that a canvas is cleared to on ClearCanvas() +
+Related: + ClearCanvas +
++ + + \ No newline at end of file diff --git a/doc/files/setclearcolor.txt b/doc/files/setclearcolor.txt new file mode 100644 index 0000000..aa84c34 --- /dev/null +++ b/doc/files/setclearcolor.txt @@ -0,0 +1,6 @@ +#title SetClearColor [RCBasic Doc] +#header sub SetClearColor(c) + +Sets the color that a canvas is cleared to on ClearCanvas() + +#ref ClearCanvas diff --git a/doc/files/setclipboardtext.html b/doc/files/setclipboardtext.html new file mode 100644 index 0000000..ed45c23 --- /dev/null +++ b/doc/files/setclipboardtext.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the clipboard text. +
++ + + \ No newline at end of file diff --git a/doc/files/setclipboardtext.txt b/doc/files/setclipboardtext.txt new file mode 100644 index 0000000..2a338f1 --- /dev/null +++ b/doc/files/setclipboardtext.txt @@ -0,0 +1,4 @@ +#title SetClipboardText [RCBasic Doc] +#header sub SetClipboardText(txt$) + +Sets the clipboard text. diff --git a/doc/files/setcolor.html b/doc/files/setcolor.html new file mode 100644 index 0000000..21734b7 --- /dev/null +++ b/doc/files/setcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the current draw color +
++ + + \ No newline at end of file diff --git a/doc/files/setcolor.txt b/doc/files/setcolor.txt new file mode 100644 index 0000000..0896c08 --- /dev/null +++ b/doc/files/setcolor.txt @@ -0,0 +1,4 @@ +#title SetColor [RCBasic Doc] +#header sub SetColor(c) + +Sets the current draw color diff --git a/doc/files/setconedamping.html b/doc/files/setconedamping.html new file mode 100644 index 0000000..cca7c29 --- /dev/null +++ b/doc/files/setconedamping.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/setconedamping.txt b/doc/files/setconedamping.txt new file mode 100644 index 0000000..81032dd --- /dev/null +++ b/doc/files/setconedamping.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/setconefixthresh.html new file mode 100644 index 0000000..f73d70c --- /dev/null +++ b/doc/files/setconefixthresh.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
++ 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. +
+Related: + GetConeFixThresh +
++ + + \ No newline at end of file diff --git a/doc/files/setconefixthresh.txt b/doc/files/setconefixthresh.txt new file mode 100644 index 0000000..5b6a06a --- /dev/null +++ b/doc/files/setconefixthresh.txt @@ -0,0 +1,9 @@ +#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. + +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 GetConeFixThresh + diff --git a/doc/files/setconelimit.html b/doc/files/setconelimit.html new file mode 100644 index 0000000..e884fad --- /dev/null +++ b/doc/files/setconelimit.html @@ -0,0 +1,29 @@ + + +
+ + ++ 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. +
++ Softness: Determines how soft or hard the constraint limits are. A value of 1.0 means the limits are hard, while lower values make the limit softer, allowing some flexibility. +
++ Bias Factor: This parameter defines how quickly the constraint should try to correct errors that bring it near or beyond the limit. +
++ Relaxation Factor: This affects how fast the constraint will "relax" after reaching its limit, allowing it to stabilize after hitting the constraint. +
+Related: + GetConeLimit +
++ + + \ No newline at end of file diff --git a/doc/files/setconelimit.txt b/doc/files/setconelimit.txt new file mode 100644 index 0000000..74ee324 --- /dev/null +++ b/doc/files/setconelimit.txt @@ -0,0 +1,12 @@ +#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. + +Softness: Determines how soft or hard the constraint limits are. A value of 1.0 means the limits are hard, while lower values make the limit softer, allowing some flexibility. + +Bias Factor: This parameter defines how quickly the constraint should try to correct errors that bring it near or beyond the limit. + +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.html b/doc/files/setconstraintangularonly.html new file mode 100644 index 0000000..0b47bc6 --- /dev/null +++ b/doc/files/setconstraintangularonly.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the hinge constraint to limit only angular motion while allowing unrestricted linear (translational) motion. +
+Related: + GetConstraintAngularOnly +
++ + + \ No newline at end of file diff --git a/doc/files/setconstraintangularonly.txt b/doc/files/setconstraintangularonly.txt new file mode 100644 index 0000000..9ba0fae --- /dev/null +++ b/doc/files/setconstraintangularonly.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setconstraintbreakingimpulsethreshold.html new file mode 100644 index 0000000..8068509 --- /dev/null +++ b/doc/files/setconstraintbreakingimpulsethreshold.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetConstraintBreakingImpulseThreshold +
++ + + \ No newline at end of file diff --git a/doc/files/setconstraintbreakingimpulsethreshold.txt b/doc/files/setconstraintbreakingimpulsethreshold.txt new file mode 100644 index 0000000..a546aa4 --- /dev/null +++ b/doc/files/setconstraintbreakingimpulsethreshold.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/setconstraintframes.html new file mode 100644 index 0000000..faca0ba --- /dev/null +++ b/doc/files/setconstraintframes.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/setconstraintframes.txt b/doc/files/setconstraintframes.txt new file mode 100644 index 0000000..0a260b4 --- /dev/null +++ b/doc/files/setconstraintframes.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setconstraintsolveriterations.html new file mode 100644 index 0000000..5e5a03d --- /dev/null +++ b/doc/files/setconstraintsolveriterations.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/setconstraintsolveriterations.txt b/doc/files/setconstraintsolveriterations.txt new file mode 100644 index 0000000..b714f72 --- /dev/null +++ b/doc/files/setconstraintsolveriterations.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/setenv.html new file mode 100644 index 0000000..558774f --- /dev/null +++ b/doc/files/setenv.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the value of an environment variable +
+Related: + Env$ +
++ + + \ No newline at end of file diff --git a/doc/files/setenv.txt b/doc/files/setenv.txt new file mode 100644 index 0000000..7c62e28 --- /dev/null +++ b/doc/files/setenv.txt @@ -0,0 +1,6 @@ +#title SetEnv [RCBasic Doc] +#header sub SetEnv(var$, value$) + +Sets the value of an environment variable + +#ref Env$ diff --git a/doc/files/setfont.html b/doc/files/setfont.html new file mode 100644 index 0000000..168aee5 --- /dev/null +++ b/doc/files/setfont.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the active font for text rendering +
+Related: + DrawText +
++ + + \ No newline at end of file diff --git a/doc/files/setfont.txt b/doc/files/setfont.txt new file mode 100644 index 0000000..19fcfb9 --- /dev/null +++ b/doc/files/setfont.txt @@ -0,0 +1,6 @@ +#title SetFont [RCBasic Doc] +#header sub SetFont(fnt_id) + +Sets the active font for text rendering + +#ref DrawText diff --git a/doc/files/setgravity2d.html b/doc/files/setgravity2d.html new file mode 100644 index 0000000..e231e64 --- /dev/null +++ b/doc/files/setgravity2d.html @@ -0,0 +1,20 @@ + + +
+ + ++ Use this function for setting the global gravity vector. A sprite canvas layer must be active. +
+Related: + GetGravity2D +
++ + + \ No newline at end of file diff --git a/doc/files/setgravity2d.txt b/doc/files/setgravity2d.txt new file mode 100644 index 0000000..c3a667d --- /dev/null +++ b/doc/files/setgravity2d.txt @@ -0,0 +1,6 @@ +#title SetGravity2D [RCBasic Doc] +#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.html b/doc/files/setgravity3d.html new file mode 100644 index 0000000..0859ac0 --- /dev/null +++ b/doc/files/setgravity3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the world gravity +
++ + + \ No newline at end of file diff --git a/doc/files/setgravity3d.txt b/doc/files/setgravity3d.txt new file mode 100644 index 0000000..ea6372b --- /dev/null +++ b/doc/files/setgravity3d.txt @@ -0,0 +1,4 @@ +#title SetGravity3D [RCBasic Doc] +#header sub SetGravity3D(x, y, z) + +Sets the world gravity diff --git a/doc/files/sethingeaxis.html b/doc/files/sethingeaxis.html new file mode 100644 index 0000000..cf8117a --- /dev/null +++ b/doc/files/sethingeaxis.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/sethingeaxis.txt b/doc/files/sethingeaxis.txt new file mode 100644 index 0000000..ae9a408 --- /dev/null +++ b/doc/files/sethingeaxis.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/sethingelimit.html new file mode 100644 index 0000000..ae1849f --- /dev/null +++ b/doc/files/sethingelimit.html @@ -0,0 +1,43 @@ + + +
+ + ++ 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. +
++ By default, if no limits are applied, the hinge can rotate freely around the axis. +
+Related: + GetHingeLimitBiasFactor + GetHingeLimitRelaxationFactor + GetHingeLimitSign + GetHingeSolveLimit +
++ + + \ No newline at end of file diff --git a/doc/files/sethingelimit.txt b/doc/files/sethingelimit.txt new file mode 100644 index 0000000..ac0c24f --- /dev/null +++ b/doc/files/sethingelimit.txt @@ -0,0 +1,16 @@ +#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. + +By default, if no limits are applied, the hinge can rotate freely around the axis. + +#list ul +#li low: This is the minimum angular limit. It defines the smallest angle that the hinge can rotate to in the negative direction. +#li high: This is the maximum angular limit. It defines the largest angle that the hinge can rotate to in the positive direction. +#li softness: Controls how "soft" the limit is. A value closer to 0 results in a hard limit (instant stop when the limit is reached), while a value closer to 1 allows some "give" before the limit fully takes effect, making the motion smoother as the limit is approached. +#li bias_factor: Helps to correct drift or penetration by applying a correction bias when the hinge reaches the limit. A higher value will apply a stronger bias to correct errors in the position. +#li relaxation_factor: Controls how the hinge behaves once the limit is reached. A value closer to 1 results in faster relaxation after hitting the limit, while a lower value makes the motion more rigid. +#/list + +#ref GetHingeLimitBiasFactor GetHingeLimitRelaxationFactor GetHingeLimitSign GetHingeSolveLimit diff --git a/doc/files/setidentitymatrix.html b/doc/files/setidentitymatrix.html new file mode 100644 index 0000000..a737be0 --- /dev/null +++ b/doc/files/setidentitymatrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/setidentitymatrix.txt b/doc/files/setidentitymatrix.txt new file mode 100644 index 0000000..c6b8898 --- /dev/null +++ b/doc/files/setidentitymatrix.txt @@ -0,0 +1,6 @@ +#title SetIdentityMatrix [RCBasic Doc] +#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.html b/doc/files/setimagealpha.html new file mode 100644 index 0000000..43ea08b --- /dev/null +++ b/doc/files/setimagealpha.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the alpha blending value for an image. This value only applies in 2D drawing commands. +
+Related: + GetImageAlpha +
++ + + \ No newline at end of file diff --git a/doc/files/setimagealpha.txt b/doc/files/setimagealpha.txt new file mode 100644 index 0000000..e147dc8 --- /dev/null +++ b/doc/files/setimagealpha.txt @@ -0,0 +1,6 @@ +#title SetImageAlpha [RCBasic Doc] +#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.html b/doc/files/setimagecolormod.html new file mode 100644 index 0000000..1e1caa4 --- /dev/null +++ b/doc/files/setimagecolormod.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the color modulation vlaue for an image +
++ + + \ No newline at end of file diff --git a/doc/files/setimagecolormod.txt b/doc/files/setimagecolormod.txt new file mode 100644 index 0000000..3bdeb4a --- /dev/null +++ b/doc/files/setimagecolormod.txt @@ -0,0 +1,4 @@ +#title SetImageColorMod [RCBasic Doc] +#header sub SetImageColorMod(img_id, c) + +Sets the color modulation vlaue for an image diff --git a/doc/files/setjointangularoffset.html b/doc/files/setjointangularoffset.html new file mode 100644 index 0000000..30c9ed2 --- /dev/null +++ b/doc/files/setjointangularoffset.html @@ -0,0 +1,23 @@ + + +
+ + ++ Set the target angular offset +
++ Used with Motor Joint +
+Related: + GetJointAngularOffset +
++ + + \ No newline at end of file diff --git a/doc/files/setjointangularoffset.txt b/doc/files/setjointangularoffset.txt new file mode 100644 index 0000000..3526c80 --- /dev/null +++ b/doc/files/setjointangularoffset.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointcorrectionfactor.html new file mode 100644 index 0000000..4e332c1 --- /dev/null +++ b/doc/files/setjointcorrectionfactor.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + GetJointCorrectionFactor +
++ + + \ No newline at end of file diff --git a/doc/files/setjointcorrectionfactor.txt b/doc/files/setjointcorrectionfactor.txt new file mode 100644 index 0000000..acc09d6 --- /dev/null +++ b/doc/files/setjointcorrectionfactor.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointdamping.html new file mode 100644 index 0000000..e0387a2 --- /dev/null +++ b/doc/files/setjointdamping.html @@ -0,0 +1,34 @@ + + +
+ + ++ Sets the damping value for a joint +
++ Used with +
+Related: + GetJointDamping +
++ + + \ No newline at end of file diff --git a/doc/files/setjointdamping.txt b/doc/files/setjointdamping.txt new file mode 100644 index 0000000..1c72164 --- /dev/null +++ b/doc/files/setjointdamping.txt @@ -0,0 +1,13 @@ +#title setJointDamping [RCBasic Doc] +#header sub setJointDamping( joint_id, damping) + +Sets the damping value for a joint + +Used with +#list ul +#li Distance Joint +#li Weld Joint +#li Wheel Joint +#/list + +#ref GetJointDamping diff --git a/doc/files/setjointlength.html b/doc/files/setjointlength.html new file mode 100644 index 0000000..9e4c2c3 --- /dev/null +++ b/doc/files/setjointlength.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + GetJointLength +
++ + + \ No newline at end of file diff --git a/doc/files/setjointlength.txt b/doc/files/setjointlength.txt new file mode 100644 index 0000000..fcffa10 --- /dev/null +++ b/doc/files/setjointlength.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointlimits.html new file mode 100644 index 0000000..78a2412 --- /dev/null +++ b/doc/files/setjointlimits.html @@ -0,0 +1,35 @@ + + +
+ + ++ Sets the minimum and maximum limits, restricting how far or how much rotation the connected bodies can move relative to each other. +
++ Used with +
+Related: + GetJointLowerLimit + GetJointUpperLimit +
++ + + \ No newline at end of file diff --git a/doc/files/setjointlimits.txt b/doc/files/setjointlimits.txt new file mode 100644 index 0000000..5abb74a --- /dev/null +++ b/doc/files/setjointlimits.txt @@ -0,0 +1,13 @@ +#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. + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref GetJointLowerLimit GetJointUpperLimit diff --git a/doc/files/setjointlinearoffset.html b/doc/files/setjointlinearoffset.html new file mode 100644 index 0000000..a38112c --- /dev/null +++ b/doc/files/setjointlinearoffset.html @@ -0,0 +1,23 @@ + + +
+ + ++ Specify a target position offset for the connected bodies relative to each other. +
++ Used with Motor Joints +
+Related: + GetJointLinearOffset +
++ + + \ No newline at end of file diff --git a/doc/files/setjointlinearoffset.txt b/doc/files/setjointlinearoffset.txt new file mode 100644 index 0000000..876b534 --- /dev/null +++ b/doc/files/setjointlinearoffset.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointmaxforce.html new file mode 100644 index 0000000..da1b6e0 --- /dev/null +++ b/doc/files/setjointmaxforce.html @@ -0,0 +1,28 @@ + + +
+ + ++ 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. +
++ Used with +
++ + + \ No newline at end of file diff --git a/doc/files/setjointmaxforce.txt b/doc/files/setjointmaxforce.txt new file mode 100644 index 0000000..c19b8fd --- /dev/null +++ b/doc/files/setjointmaxforce.txt @@ -0,0 +1,10 @@ +#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. + +Used with +#list ul +#li Motor Joint +#li Friction Joint +#/list diff --git a/doc/files/setjointmaxlength.html b/doc/files/setjointmaxlength.html new file mode 100644 index 0000000..14f5418 --- /dev/null +++ b/doc/files/setjointmaxlength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Set the maximum allowable length between two connected bodies +
++ Used with Distance Joint +
+Related: + SetJointMinLength +
++ + + \ No newline at end of file diff --git a/doc/files/setjointmaxlength.txt b/doc/files/setjointmaxlength.txt new file mode 100644 index 0000000..5abf701 --- /dev/null +++ b/doc/files/setjointmaxlength.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointmaxmotorforce.html new file mode 100644 index 0000000..2eec341 --- /dev/null +++ b/doc/files/setjointmaxmotorforce.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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 +
+Related: + GetJointMaxMotorForce +
++ + + \ No newline at end of file diff --git a/doc/files/setjointmaxmotorforce.txt b/doc/files/setjointmaxmotorforce.txt new file mode 100644 index 0000000..806e70c --- /dev/null +++ b/doc/files/setjointmaxmotorforce.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointmaxmotortorque.html new file mode 100644 index 0000000..e523045 --- /dev/null +++ b/doc/files/setjointmaxmotortorque.html @@ -0,0 +1,31 @@ + + +
+ + ++ 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. +
++ Used with +
+Related: + GetJointMaxMotorTorque +
++ + + \ No newline at end of file diff --git a/doc/files/setjointmaxmotortorque.txt b/doc/files/setjointmaxmotortorque.txt new file mode 100644 index 0000000..37923dd --- /dev/null +++ b/doc/files/setjointmaxmotortorque.txt @@ -0,0 +1,12 @@ +#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. + +Used with +#list ul +#li Revolute Joint +#li Wheel Joint +#/list + +#ref GetJointMaxMotorTorque diff --git a/doc/files/setjointmaxtorque.html b/doc/files/setjointmaxtorque.html new file mode 100644 index 0000000..6efd262 --- /dev/null +++ b/doc/files/setjointmaxtorque.html @@ -0,0 +1,31 @@ + + +
+ + ++ 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. +
++ Used with +
+Related: + GetJointMaxTorque +
++ + + \ No newline at end of file diff --git a/doc/files/setjointmaxtorque.txt b/doc/files/setjointmaxtorque.txt new file mode 100644 index 0000000..c071c7b --- /dev/null +++ b/doc/files/setjointmaxtorque.txt @@ -0,0 +1,12 @@ +#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. + +Used with +#list ul +#li Friction Joint +#li Motor Joint +#/list + +#ref GetJointMaxTorque diff --git a/doc/files/setjointminlength.html b/doc/files/setjointminlength.html new file mode 100644 index 0000000..6a211d6 --- /dev/null +++ b/doc/files/setjointminlength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Set the minimum allowable length between two connected bodies +
++ Used with Distance Joint +
+Related: + SetJointMaxLength +
++ + + \ No newline at end of file diff --git a/doc/files/setjointminlength.txt b/doc/files/setjointminlength.txt new file mode 100644 index 0000000..7ea77e7 --- /dev/null +++ b/doc/files/setjointminlength.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointmotorspeed.html new file mode 100644 index 0000000..c422a78 --- /dev/null +++ b/doc/files/setjointmotorspeed.html @@ -0,0 +1,34 @@ + + +
+ + ++ 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. +
++ Used with +
+Related: + GetJointMotorSpeed +
++ + + \ No newline at end of file diff --git a/doc/files/setjointmotorspeed.txt b/doc/files/setjointmotorspeed.txt new file mode 100644 index 0000000..7ddbc14 --- /dev/null +++ b/doc/files/setjointmotorspeed.txt @@ -0,0 +1,13 @@ +#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. + +Used with +#list ul +#li Prismatic Joint +#li Revolute Joint +#li Wheel Joint +#/list + +#ref GetJointMotorSpeed diff --git a/doc/files/setjointorigin.html b/doc/files/setjointorigin.html new file mode 100644 index 0000000..e10355f --- /dev/null +++ b/doc/files/setjointorigin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/setjointorigin.txt b/doc/files/setjointorigin.txt new file mode 100644 index 0000000..ed28eb7 --- /dev/null +++ b/doc/files/setjointorigin.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setjointratio.html new file mode 100644 index 0000000..7f3805e --- /dev/null +++ b/doc/files/setjointratio.html @@ -0,0 +1,23 @@ + + +
+ + ++ Determines how much one joint’s movement affects the other, enabling complex, synchronized motion. +
++ Used with Gear Joints +
+Related: + GetJointRatio +
++ + + \ No newline at end of file diff --git a/doc/files/setjointratio.txt b/doc/files/setjointratio.txt new file mode 100644 index 0000000..449f53c --- /dev/null +++ b/doc/files/setjointratio.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setjointstiffness.html new file mode 100644 index 0000000..8d0aa77 --- /dev/null +++ b/doc/files/setjointstiffness.html @@ -0,0 +1,34 @@ + + +
+ + ++ Sets how rigid a joint is +
++ Used with: +
+Related: + GetJointStiffness +
++ + + \ No newline at end of file diff --git a/doc/files/setjointstiffness.txt b/doc/files/setjointstiffness.txt new file mode 100644 index 0000000..58cbdd3 --- /dev/null +++ b/doc/files/setjointstiffness.txt @@ -0,0 +1,13 @@ +#title setJointStiffness [RCBasic Doc] +#header sub setJointStiffness( joint_id, stiffness) + +Sets how rigid a joint is + +Used with: +#list ul +#li Distance Joint +#li Weld Joint +#li Wheel Join +#/list + +#ref GetJointStiffness diff --git a/doc/files/setlightambientcolor.html b/doc/files/setlightambientcolor.html new file mode 100644 index 0000000..cc6293a --- /dev/null +++ b/doc/files/setlightambientcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the ambient color for a light +
++ + + \ No newline at end of file diff --git a/doc/files/setlightambientcolor.txt b/doc/files/setlightambientcolor.txt new file mode 100644 index 0000000..ea60d05 --- /dev/null +++ b/doc/files/setlightambientcolor.txt @@ -0,0 +1,4 @@ +#title SetLightAmbientColor [RCBasic Doc] +#header sub SetLightAmbientColor( actor, color ) + +Sets the ambient color for a light diff --git a/doc/files/setlightattenuation.html b/doc/files/setlightattenuation.html new file mode 100644 index 0000000..4982366 --- /dev/null +++ b/doc/files/setlightattenuation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the light strength fading over distance. Overrident by setting radius. +
++ + + \ No newline at end of file diff --git a/doc/files/setlightattenuation.txt b/doc/files/setlightattenuation.txt new file mode 100644 index 0000000..5c1f9ba --- /dev/null +++ b/doc/files/setlightattenuation.txt @@ -0,0 +1,4 @@ +#title SetLightAttenuation [RCBasic Doc] +#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.html b/doc/files/setlightdiffusecolor.html new file mode 100644 index 0000000..b412acf --- /dev/null +++ b/doc/files/setlightdiffusecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets a light's diffuse color +
++ + + \ No newline at end of file diff --git a/doc/files/setlightdiffusecolor.txt b/doc/files/setlightdiffusecolor.txt new file mode 100644 index 0000000..cf3ab36 --- /dev/null +++ b/doc/files/setlightdiffusecolor.txt @@ -0,0 +1,4 @@ +#title SetLightDiffuseColor [RCBasic Doc] +#header sub SetLightDiffuseColor( actor, color ) + +Sets a light's diffuse color diff --git a/doc/files/setlightfalloff.html b/doc/files/setlightfalloff.html new file mode 100644 index 0000000..deb7f5e --- /dev/null +++ b/doc/files/setlightfalloff.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the strength decrease between the inner and outer cone of a light +
++ Note: Only applies to spot lights +
++ + + \ No newline at end of file diff --git a/doc/files/setlightfalloff.txt b/doc/files/setlightfalloff.txt new file mode 100644 index 0000000..3a1c116 --- /dev/null +++ b/doc/files/setlightfalloff.txt @@ -0,0 +1,6 @@ +#title SetLightFalloff [RCBasic Doc] +#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.html b/doc/files/setlightinnercone.html new file mode 100644 index 0000000..5a79e57 --- /dev/null +++ b/doc/files/setlightinnercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the inner cone of a spot light +
++ + + \ No newline at end of file diff --git a/doc/files/setlightinnercone.txt b/doc/files/setlightinnercone.txt new file mode 100644 index 0000000..a00f77e --- /dev/null +++ b/doc/files/setlightinnercone.txt @@ -0,0 +1,4 @@ +#title SetLightInnerCone [RCBasic Doc] +#header sub SetLightInnerCone( actor, angle ) + +Sets the inner cone of a spot light diff --git a/doc/files/setlightoutercone.html b/doc/files/setlightoutercone.html new file mode 100644 index 0000000..a4bc1fc --- /dev/null +++ b/doc/files/setlightoutercone.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the outer cone of a spot light +
++ + + \ No newline at end of file diff --git a/doc/files/setlightoutercone.txt b/doc/files/setlightoutercone.txt new file mode 100644 index 0000000..efbe80c --- /dev/null +++ b/doc/files/setlightoutercone.txt @@ -0,0 +1,5 @@ +#title SetLightOuterCone [RCBasic Doc] +#header sub SetLightOuterCone( actor, angle) + +Sets the outer cone of a spot light + diff --git a/doc/files/setlightradius.html b/doc/files/setlightradius.html new file mode 100644 index 0000000..fdb58a2 --- /dev/null +++ b/doc/files/setlightradius.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the radius of a light +
+Related: + GetLightRadius +
++ + + \ No newline at end of file diff --git a/doc/files/setlightradius.txt b/doc/files/setlightradius.txt new file mode 100644 index 0000000..df66c2c --- /dev/null +++ b/doc/files/setlightradius.txt @@ -0,0 +1,6 @@ +#title SetLightRadius [RCBasic Doc] +#header sub SetLightRadius( actor, radius ) + +Sets the radius of a light + +#ref GetLightRadius diff --git a/doc/files/setlightshadowcast.html b/doc/files/setlightshadowcast.html new file mode 100644 index 0000000..e90f2de --- /dev/null +++ b/doc/files/setlightshadowcast.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether a light will cast shadows on actors that have shadows enabled +
+Related: + AddActorShadow +
++ + + \ No newline at end of file diff --git a/doc/files/setlightshadowcast.txt b/doc/files/setlightshadowcast.txt new file mode 100644 index 0000000..78fc4ab --- /dev/null +++ b/doc/files/setlightshadowcast.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setlightspecularcolor.html new file mode 100644 index 0000000..9fd9afe --- /dev/null +++ b/doc/files/setlightspecularcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the specular color of a light +
++ + + \ No newline at end of file diff --git a/doc/files/setlightspecularcolor.txt b/doc/files/setlightspecularcolor.txt new file mode 100644 index 0000000..2c4f4ff --- /dev/null +++ b/doc/files/setlightspecularcolor.txt @@ -0,0 +1,4 @@ +#title SetLightSpecularColor [RCBasic Doc] +#header sub SetLightSpecularColor( actor, color ) + +Sets the specular color of a light diff --git a/doc/files/setlighttype.html b/doc/files/setlighttype.html new file mode 100644 index 0000000..6894a19 --- /dev/null +++ b/doc/files/setlighttype.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the type of light +
++ Possible Light Types +
+Related: + SetLightType +
+ + + \ No newline at end of file diff --git a/doc/files/setlighttype.txt b/doc/files/setlighttype.txt new file mode 100644 index 0000000..81194cd --- /dev/null +++ b/doc/files/setlighttype.txt @@ -0,0 +1,14 @@ +#title setLightType [RCBasic Doc] +#header sub setLightType( actor, light_type ) + +Sets the type of light + +Possible Light Types +#list ul +#li LIGHT_TYPE_POINT +#li LIGHT_TYPE_DIRECTIONAL +#li LIGHT_TYPE_SPOT +#/light + +#ref SetLightType + diff --git a/doc/files/setmaterialambientcolor.html b/doc/files/setmaterialambientcolor.html new file mode 100644 index 0000000..46f78ef --- /dev/null +++ b/doc/files/setmaterialambientcolor.html @@ -0,0 +1,17 @@ + + + + + ++ Sets the ambient color of a material +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialambientcolor.txt b/doc/files/setmaterialambientcolor.txt new file mode 100644 index 0000000..d1bd02f --- /dev/null +++ b/doc/files/setmaterialambientcolor.txt @@ -0,0 +1,4 @@ +#title setMaterialAmbientColor [RCBasic Doc] +#header sub setMaterialAmbientColor( material_id, color) + +Sets the ambient color of a material diff --git a/doc/files/setmaterialantialiasing.html b/doc/files/setmaterialantialiasing.html new file mode 100644 index 0000000..b8a2218 --- /dev/null +++ b/doc/files/setmaterialantialiasing.html @@ -0,0 +1,46 @@ + + +
+ + ++ Sets the anti-aliasing mode for the material +
++ Possible modes returned +
+Related: + GetMaterialAntiAliasing +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialantialiasing.txt b/doc/files/setmaterialantialiasing.txt new file mode 100644 index 0000000..623d69a --- /dev/null +++ b/doc/files/setmaterialantialiasing.txt @@ -0,0 +1,17 @@ +#title setMaterialAntiAliasing [RCBasic Doc] +#header sub setMaterialAntiAliasing( material_id, aa) + +Sets the anti-aliasing mode for the material + +Possible modes returned +#list +#li AA_MODE_OFF=0, +#li AA_MODE_SIMPLE=1, +#li AA_MODE_QUALITY=3, +#li AA_MODE_LINE_SMOOTH=4, +#li AA_MODE_POINT_SMOOTH=8, +#li AA_MODE_FULL_BASIC=15, +#li AA_MODE_ALPHA_TO_COVERAGE=16 +#/list + +#ref GetMaterialAntiAliasing diff --git a/doc/files/setmaterialbackfaceculling.html b/doc/files/setmaterialbackfaceculling.html new file mode 100644 index 0000000..a5cc25e --- /dev/null +++ b/doc/files/setmaterialbackfaceculling.html @@ -0,0 +1,20 @@ + + +
+ + ++ Enables or disables material backface culling +
+Related: + GetMaterialBackfaceCulling +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialbackfaceculling.txt b/doc/files/setmaterialbackfaceculling.txt new file mode 100644 index 0000000..5d4e682 --- /dev/null +++ b/doc/files/setmaterialbackfaceculling.txt @@ -0,0 +1,6 @@ +#title setMaterialBackfaceCulling [RCBasic Doc] +#header sub setMaterialBackfaceCulling( material_id, flag) + +Enables or disables material backface culling + +#ref GetMaterialBackfaceCulling diff --git a/doc/files/setmaterialblendfactor.html b/doc/files/setmaterialblendfactor.html new file mode 100644 index 0000000..b30bdc4 --- /dev/null +++ b/doc/files/setmaterialblendfactor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the blend factor for a material +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialblendfactor.txt b/doc/files/setmaterialblendfactor.txt new file mode 100644 index 0000000..78dc552 --- /dev/null +++ b/doc/files/setmaterialblendfactor.txt @@ -0,0 +1,6 @@ +#title setMaterialBlendFactor [RCBasic Doc] +#header sub setMaterialBlendFactor( material_id, bf) + +Sets the blend factor for a material + + diff --git a/doc/files/setmaterialblendmode.html b/doc/files/setmaterialblendmode.html new file mode 100644 index 0000000..0c46af5 --- /dev/null +++ b/doc/files/setmaterialblendmode.html @@ -0,0 +1,55 @@ + + +
+ + ++ Sets a material's blend mode +
++ Possible Blend Modes +
+Related: + SetMaterialBlendMode +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialblendmode.txt b/doc/files/setmaterialblendmode.txt new file mode 100644 index 0000000..15f7c6c --- /dev/null +++ b/doc/files/setmaterialblendmode.txt @@ -0,0 +1,21 @@ +#title setMaterialBlendMode [RCBasic Doc] +#header sub setMaterialBlendMode( material_id, blend_mode) + +Sets a material's blend mode + +Possible Blend Modes +#list ul +#li BLEND_MODE_NONE +#li BLEND_MODE_ADD +#li BLEND_MODE_SUBTRACT +#li BLEND_MODE_REVSUBTRACT +#li BLEND_MODE_MIN +#li BLEND_MODE_MAX +#li BLEND_MODE_MIN_FACTOR +#li BLEND_MODE_MAX_FACTOR +#li BLEND_MODE_MIN_ALPHA +#li BLEND_MODE_MAX_ALPHA +#/list + +#ref SetMaterialBlendMode + diff --git a/doc/files/setmaterialcolormask.html b/doc/files/setmaterialcolormask.html new file mode 100644 index 0000000..240a9ca --- /dev/null +++ b/doc/files/setmaterialcolormask.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets a color mask for a material +
+Related: + GetMaterialColorMask +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialcolormask.txt b/doc/files/setmaterialcolormask.txt new file mode 100644 index 0000000..9192bb0 --- /dev/null +++ b/doc/files/setmaterialcolormask.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setmaterialcolormode.html new file mode 100644 index 0000000..fb42bb5 --- /dev/null +++ b/doc/files/setmaterialcolormode.html @@ -0,0 +1,43 @@ + + +
+ + ++ Sets the color mode of a material +
++ Possible modes +
+Related: + GetMaterialColorMode +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialcolormode.txt b/doc/files/setmaterialcolormode.txt new file mode 100644 index 0000000..689374e --- /dev/null +++ b/doc/files/setmaterialcolormode.txt @@ -0,0 +1,16 @@ +#title setMaterialColorMode [RCBasic Doc] +#header sub setMaterialColorMode( material_id, color_mode) + +Sets the color mode of a material + +Possible modes +#list ul +#li COLOR_MODE_NONE +#li COLOR_MODE_DIFFUSE +#li COLOR_MODE_AMBIENT +#li COLOR_MODE_EMISSIVE +#li COLOR_MODE_SPECULAR +#li COLOR_MODE_DIFFUSE_AND_AMBIENT +#/list + +#ref GetMaterialColorMode diff --git a/doc/files/setmaterialdiffusecolor.html b/doc/files/setmaterialdiffusecolor.html new file mode 100644 index 0000000..45eb2d9 --- /dev/null +++ b/doc/files/setmaterialdiffusecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Set's a material's diffuse color +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialdiffusecolor.txt b/doc/files/setmaterialdiffusecolor.txt new file mode 100644 index 0000000..fa00546 --- /dev/null +++ b/doc/files/setmaterialdiffusecolor.txt @@ -0,0 +1,4 @@ +#title setMaterialDiffuseColor [RCBasic Doc] +#header sub setMaterialDiffuseColor( material_id, color) + +Set's a material's diffuse color diff --git a/doc/files/setmaterialemissivecolor.html b/doc/files/setmaterialemissivecolor.html new file mode 100644 index 0000000..df51ebf --- /dev/null +++ b/doc/files/setmaterialemissivecolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Set's a material's emissive color +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialemissivecolor.txt b/doc/files/setmaterialemissivecolor.txt new file mode 100644 index 0000000..ce348a8 --- /dev/null +++ b/doc/files/setmaterialemissivecolor.txt @@ -0,0 +1,4 @@ +#title setMaterialEmissiveColor [RCBasic Doc] +#header sub setMaterialEmissiveColor( material_id, color) + +Set's a material's emissive color diff --git a/doc/files/setmaterialflag.html b/doc/files/setmaterialflag.html new file mode 100644 index 0000000..728f4fb --- /dev/null +++ b/doc/files/setmaterialflag.html @@ -0,0 +1,86 @@ + + +
+ + ++ Sets the value of the specified material flag +
++ Possible values for flag: +
+Related: + GetMaterialFlag + GetActorMaterialFlag +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialflag.txt b/doc/files/setmaterialflag.txt new file mode 100644 index 0000000..197b44b --- /dev/null +++ b/doc/files/setmaterialflag.txt @@ -0,0 +1,30 @@ +#title setMaterialFlag [RCBasic Doc] +#header sub setMaterialFlag( material_id, material_flag, f_value) + +Sets the value of the specified material flag + +Possible values for flag: +#list +#li MATERIAL_FLAG_WIREFRAME +#li MATERIAL_FLAG_POINTCLOUD +#li MATERIAL_FLAG_GOURAUD_SHADING +#li MATERIAL_FLAG_LIGHTING +#li MATERIAL_FLAG_ZBUFFER +#li MATERIAL_FLAG_ZWRITE_ENABLE +#li MATERIAL_FLAG_BACK_FACE_CULLING +#li MATERIAL_FLAG_FRONT_FACE_CULLING +#li MATERIAL_FLAG_BILINEAR_FILTER +#li MATERIAL_FLAG_TRILINEAR_FILTER +#li MATERIAL_FLAG_ANISOTROPIC_FILTER +#li MATERIAL_FLAG_FOG_ENABLE +#li MATERIAL_FLAG_NORMALIZE_NORMALS +#li MATERIAL_FLAG_TEXTURE_WRAP +#li MATERIAL_FLAG_ANTI_ALIASING +#li MATERIAL_FLAG_COLOR_MASK +#li MATERIAL_FLAG_COLOR_MATERIAL +#li MATERIAL_FLAG_USE_MIP_MAPS +#li MATERIAL_FLAG_BLEND_OPERATION +#li MATERIAL_FLAG_POLYGON_OFFSET +#/list + +#ref GetMaterialFlag GetActorMaterialFlag diff --git a/doc/files/setmaterialfog.html b/doc/files/setmaterialfog.html new file mode 100644 index 0000000..b15ec5d --- /dev/null +++ b/doc/files/setmaterialfog.html @@ -0,0 +1,17 @@ + + +
+ + ++ Enables or disables fog +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialfog.txt b/doc/files/setmaterialfog.txt new file mode 100644 index 0000000..c829adb --- /dev/null +++ b/doc/files/setmaterialfog.txt @@ -0,0 +1,4 @@ +#title setMaterialFog [RCBasic Doc] +#header sub setMaterialFog( material_id, flag) + +Enables or disables fog diff --git a/doc/files/setmaterialfrontfaceculling.html b/doc/files/setmaterialfrontfaceculling.html new file mode 100644 index 0000000..75e2008 --- /dev/null +++ b/doc/files/setmaterialfrontfaceculling.html @@ -0,0 +1,17 @@ + + +
+ + ++ Enables or disables front face culling +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialfrontfaceculling.txt b/doc/files/setmaterialfrontfaceculling.txt new file mode 100644 index 0000000..b2229bd --- /dev/null +++ b/doc/files/setmaterialfrontfaceculling.txt @@ -0,0 +1,4 @@ +#title setMaterialFrontfaceCulling [RCBasic Doc] +#header sub setMaterialFrontFaceCulling( material_id, flag) + +Enables or disables front face culling diff --git a/doc/files/setmaterialgouraudshading.html b/doc/files/setmaterialgouraudshading.html new file mode 100644 index 0000000..a1493f2 --- /dev/null +++ b/doc/files/setmaterialgouraudshading.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether material will use gourad shading or flat shading +
++ True for goraud, False for flat +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialgouraudshading.txt b/doc/files/setmaterialgouraudshading.txt new file mode 100644 index 0000000..17d3ccd --- /dev/null +++ b/doc/files/setmaterialgouraudshading.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setmateriallighting.html new file mode 100644 index 0000000..727e318 --- /dev/null +++ b/doc/files/setmateriallighting.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets whether material will be lighted or not +
++ + + \ No newline at end of file diff --git a/doc/files/setmateriallighting.txt b/doc/files/setmateriallighting.txt new file mode 100644 index 0000000..e5f1fa2 --- /dev/null +++ b/doc/files/setmateriallighting.txt @@ -0,0 +1,4 @@ +#title setMaterialLighting [RCBasic Doc] +#header sub setMaterialLighting( material_id, flag) + +Sets whether material will be lighted or not diff --git a/doc/files/setmaterialnormalize.html b/doc/files/setmaterialnormalize.html new file mode 100644 index 0000000..64a1396 --- /dev/null +++ b/doc/files/setmaterialnormalize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets whether normals should be normalized +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialnormalize.txt b/doc/files/setmaterialnormalize.txt new file mode 100644 index 0000000..4a76e85 --- /dev/null +++ b/doc/files/setmaterialnormalize.txt @@ -0,0 +1,4 @@ +#title setMaterialNormalize [RCBasic Doc] +#header sub setMaterialNormalize( material_id, flag) + +Sets whether normals should be normalized diff --git a/doc/files/setmaterialpointcloud.html b/doc/files/setmaterialpointcloud.html new file mode 100644 index 0000000..b39615a --- /dev/null +++ b/doc/files/setmaterialpointcloud.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets whether material is drawn as a point cloud or filled triangles +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialpointcloud.txt b/doc/files/setmaterialpointcloud.txt new file mode 100644 index 0000000..84cac48 --- /dev/null +++ b/doc/files/setmaterialpointcloud.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/setmaterialshininess.html new file mode 100644 index 0000000..10b96ab --- /dev/null +++ b/doc/files/setmaterialshininess.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the size of specular highlights +
++ Values range from 0 to 128 +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialshininess.txt b/doc/files/setmaterialshininess.txt new file mode 100644 index 0000000..47266f3 --- /dev/null +++ b/doc/files/setmaterialshininess.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setmaterialspecularcolor.html new file mode 100644 index 0000000..3a85dbe --- /dev/null +++ b/doc/files/setmaterialspecularcolor.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the specular color of a material +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialspecularcolor.txt b/doc/files/setmaterialspecularcolor.txt new file mode 100644 index 0000000..ee0bb31 --- /dev/null +++ b/doc/files/setmaterialspecularcolor.txt @@ -0,0 +1,4 @@ +#title setMaterialSpecularColor [RCBasic Doc] +#header sub setMaterialSpecularColor( material_id, color) + +Sets the specular color of a material diff --git a/doc/files/setmaterialtexture.html b/doc/files/setmaterialtexture.html new file mode 100644 index 0000000..428687e --- /dev/null +++ b/doc/files/setmaterialtexture.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the texture on a specified texture level of a material +
++ Note: Generally you want to just set level 0 +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialtexture.txt b/doc/files/setmaterialtexture.txt new file mode 100644 index 0000000..cff7695 --- /dev/null +++ b/doc/files/setmaterialtexture.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setmaterialtexturecanvas.html new file mode 100644 index 0000000..3ba3dc7 --- /dev/null +++ b/doc/files/setmaterialtexturecanvas.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets a material's texture source as a canvas. +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialtexturecanvas.txt b/doc/files/setmaterialtexturecanvas.txt new file mode 100644 index 0000000..8f4424c --- /dev/null +++ b/doc/files/setmaterialtexturecanvas.txt @@ -0,0 +1,5 @@ +#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.html b/doc/files/setmaterialthickness.html new file mode 100644 index 0000000..c1f3700 --- /dev/null +++ b/doc/files/setmaterialthickness.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the thickness of non 3d elements +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialthickness.txt b/doc/files/setmaterialthickness.txt new file mode 100644 index 0000000..798efab --- /dev/null +++ b/doc/files/setmaterialthickness.txt @@ -0,0 +1,4 @@ +#title setMaterialThickness [RCBasic Doc] +#header sub setMaterialThickness( material_id, thickness) + +Sets the thickness of non 3d elements diff --git a/doc/files/setmaterialtype.html b/doc/files/setmaterialtype.html new file mode 100644 index 0000000..5029ffa --- /dev/null +++ b/doc/files/setmaterialtype.html @@ -0,0 +1,100 @@ + + +
+ + ++ Sets the material type +
++ Possible material types +
+Related: + GetMaterialType +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialtype.txt b/doc/files/setmaterialtype.txt new file mode 100644 index 0000000..01b4013 --- /dev/null +++ b/doc/files/setmaterialtype.txt @@ -0,0 +1,35 @@ +#title SetMaterialType [RCBasic Doc] +#header sub SetMaterialType( material_id, mat_type) + +Sets the material type + +Possible material types +#list ul +#li MATERIAL_TYPE_SOLID +#li MATERIAL_TYPE_SOLID_2_LAYER +#li MATERIAL_TYPE_LIGHTMAP +#li MATERIAL_TYPE_LIGHTMAP_ADD +#li MATERIAL_TYPE_LIGHTMAP_M2 +#li MATERIAL_TYPE_LIGHTMAP_M4 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M2 +#li MATERIAL_TYPE_LIGHTMAP_LIGHTING_M4 +#li MATERIAL_TYPE_DETAIL_MAP +#li MATERIAL_TYPE_SPHERE_MAP +#li MATERIAL_TYPE_REFLECTION_2_LAYER +#li MATERIAL_TYPE_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL +#li MATERIAL_TYPE_TRANSPARENT_ALPHA_CHANNEL_REF +#li MATERIAL_TYPE_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_TRANSPARENT_REFLECTION_2_LAYER +#li MATERIAL_TYPE_NORMAL_MAP_SOLID +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_NORMAL_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_PARALLAX_MAP_SOLID +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_ADD_COLOR +#li MATERIAL_TYPE_PARALLAX_MAP_TRANSPARENT_VERTEX_ALPHA +#li MATERIAL_TYPE_ONETEXTURE_BLEND +#li MATERIAL_TYPE_FORCE_32BIT +#/list + +#ref GetMaterialType diff --git a/doc/files/setmaterialwireframe.html b/doc/files/setmaterialwireframe.html new file mode 100644 index 0000000..cdfb95c --- /dev/null +++ b/doc/files/setmaterialwireframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets whether a material is draw as unfilled triangles or filled triangles +
++ + + \ No newline at end of file diff --git a/doc/files/setmaterialwireframe.txt b/doc/files/setmaterialwireframe.txt new file mode 100644 index 0000000..191516f --- /dev/null +++ b/doc/files/setmaterialwireframe.txt @@ -0,0 +1,4 @@ +#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.html b/doc/files/setmatrixrotation.html new file mode 100644 index 0000000..b60280f --- /dev/null +++ b/doc/files/setmatrixrotation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the rotation vector of a matrix +
++ + + \ No newline at end of file diff --git a/doc/files/setmatrixrotation.txt b/doc/files/setmatrixrotation.txt new file mode 100644 index 0000000..77bef19 --- /dev/null +++ b/doc/files/setmatrixrotation.txt @@ -0,0 +1,4 @@ +#title SetMatrixRotation [RCBasic Doc] +#header sub SetMatrixRotation( mA, x, y, z ) + +Sets the rotation vector of a matrix diff --git a/doc/files/setmatrixscale.html b/doc/files/setmatrixscale.html new file mode 100644 index 0000000..1d596aa --- /dev/null +++ b/doc/files/setmatrixscale.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the scale vector of a matrix +
++ + + \ No newline at end of file diff --git a/doc/files/setmatrixscale.txt b/doc/files/setmatrixscale.txt new file mode 100644 index 0000000..07db979 --- /dev/null +++ b/doc/files/setmatrixscale.txt @@ -0,0 +1,4 @@ +#title SetMatrixScale [RCBasic Doc] +#header sub SetMatrixScale( mA, x, y, z ) + +Sets the scale vector of a matrix diff --git a/doc/files/setmatrixtranslation.html b/doc/files/setmatrixtranslation.html new file mode 100644 index 0000000..addc06f --- /dev/null +++ b/doc/files/setmatrixtranslation.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the translation vector of a matrix +
++ + + \ No newline at end of file diff --git a/doc/files/setmatrixtranslation.txt b/doc/files/setmatrixtranslation.txt new file mode 100644 index 0000000..c127048 --- /dev/null +++ b/doc/files/setmatrixtranslation.txt @@ -0,0 +1,4 @@ +#title SetMatrixTranslation [RCBasic Doc] +#header sub SetMatrixTranslation( mA, x, y, z ) + +Sets the translation vector of a matrix diff --git a/doc/files/setmatrixvalue.html b/doc/files/setmatrixvalue.html new file mode 100644 index 0000000..fb53102 --- /dev/null +++ b/doc/files/setmatrixvalue.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the value of a cell in a matrix +
++ + + \ No newline at end of file diff --git a/doc/files/setmatrixvalue.txt b/doc/files/setmatrixvalue.txt new file mode 100644 index 0000000..6eb5d4f --- /dev/null +++ b/doc/files/setmatrixvalue.txt @@ -0,0 +1,4 @@ +#title SetMatrixValue [RCBasic Doc] +#header sub SetMatrixValue(mA, r, c, v) + +Sets the value of a cell in a matrix diff --git a/doc/files/setmaxparticlespersecond.html b/doc/files/setmaxparticlespersecond.html new file mode 100644 index 0000000..395147f --- /dev/null +++ b/doc/files/setmaxparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets the max number of particles emitted per second +
+Related: + GetMaxParticlesPerSecond + GetMinParticlesPerSecond + SetMinParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/files/setmaxparticlespersecond.txt b/doc/files/setmaxparticlespersecond.txt new file mode 100644 index 0000000..3dc47d4 --- /dev/null +++ b/doc/files/setmaxparticlespersecond.txt @@ -0,0 +1,7 @@ +#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/setminparticlespersecond.html b/doc/files/setminparticlespersecond.html new file mode 100644 index 0000000..d5a8b1d --- /dev/null +++ b/doc/files/setminparticlespersecond.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets the max number of particles emitted per second +
+Related: + SetMaxParticlesPerSecond + GetMinParticlesPerSecond + SetMaxParticlesPerSecond +
++ + + \ No newline at end of file diff --git a/doc/files/setminparticlespersecond.txt b/doc/files/setminparticlespersecond.txt new file mode 100644 index 0000000..cf33b9a --- /dev/null +++ b/doc/files/setminparticlespersecond.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/setmouserelative.html new file mode 100644 index 0000000..f85d444 --- /dev/null +++ b/doc/files/setmouserelative.html @@ -0,0 +1,17 @@ + + +
+ + ++ Constrains the mouse to the window +
++ + + \ No newline at end of file diff --git a/doc/files/setmouserelative.txt b/doc/files/setmouserelative.txt new file mode 100644 index 0000000..1638c8b --- /dev/null +++ b/doc/files/setmouserelative.txt @@ -0,0 +1,4 @@ +#title SetMouseRelative [RCBasic Doc] +#header sub SetMouseRelative(flag) + +Constrains the mouse to the window diff --git a/doc/files/setmousezone.html b/doc/files/setmousezone.html new file mode 100644 index 0000000..784a62e --- /dev/null +++ b/doc/files/setmousezone.html @@ -0,0 +1,17 @@ + + +
+ + ++ Constrains the mouse to a specified area of the window +
++ + + \ No newline at end of file diff --git a/doc/files/setmousezone.txt b/doc/files/setmousezone.txt new file mode 100644 index 0000000..06ec454 --- /dev/null +++ b/doc/files/setmousezone.txt @@ -0,0 +1,4 @@ +#title SetMouseZone [RCBasic Doc] +#header sub SetMouseZone(x, y, w, h) + +Constrains the mouse to a specified area of the window diff --git a/doc/files/setmusicposition.html b/doc/files/setmusicposition.html new file mode 100644 index 0000000..5770617 --- /dev/null +++ b/doc/files/setmusicposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the position of the loaded music track +
++ + + \ No newline at end of file diff --git a/doc/files/setmusicposition.txt b/doc/files/setmusicposition.txt new file mode 100644 index 0000000..c06dd89 --- /dev/null +++ b/doc/files/setmusicposition.txt @@ -0,0 +1,4 @@ +#title SetMusicPosition [RCBasic Doc] +#header sub SetMusicPosition(pos) + +Sets the position of the loaded music track diff --git a/doc/files/setmusicvolume.html b/doc/files/setmusicvolume.html new file mode 100644 index 0000000..e9bc35d --- /dev/null +++ b/doc/files/setmusicvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the volume of the loaded music track +
++ + + \ No newline at end of file diff --git a/doc/files/setmusicvolume.txt b/doc/files/setmusicvolume.txt new file mode 100644 index 0000000..777769e --- /dev/null +++ b/doc/files/setmusicvolume.txt @@ -0,0 +1,4 @@ +#title SetMusicVolume [RCBasic Doc] +#header sub SetMusicVolume(vol) + +Sets the volume of the loaded music track diff --git a/doc/files/setparticlebox.html b/doc/files/setparticlebox.html new file mode 100644 index 0000000..aeb4177 --- /dev/null +++ b/doc/files/setparticlebox.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the bounding box for a particle emitter +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlebox.txt b/doc/files/setparticlebox.txt new file mode 100644 index 0000000..35215ec --- /dev/null +++ b/doc/files/setparticlebox.txt @@ -0,0 +1,5 @@ +#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.html b/doc/files/setparticlecenter.html new file mode 100644 index 0000000..c7cde86 --- /dev/null +++ b/doc/files/setparticlecenter.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the center of a particle emitter +
++ Note: applies to Sphere, Cylinder, and Ring emitters +
+Related: + GetParticleCenter +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlecenter.txt b/doc/files/setparticlecenter.txt new file mode 100644 index 0000000..3859c9e --- /dev/null +++ b/doc/files/setparticlecenter.txt @@ -0,0 +1,9 @@ +#title setParticleCenter [RCBasic Doc] +#header sub setParticleCenter( actor, x, y, z) + +Sets the center of a particle emitter + +Note: applies to Sphere, Cylinder, and Ring emitters + +#ref GetParticleCenter + diff --git a/doc/files/setparticledirection.html b/doc/files/setparticledirection.html new file mode 100644 index 0000000..c4385f6 --- /dev/null +++ b/doc/files/setparticledirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the direction of a particle emitter +
+Related: + GetParticleDirection +
++ + + \ No newline at end of file diff --git a/doc/files/setparticledirection.txt b/doc/files/setparticledirection.txt new file mode 100644 index 0000000..42c79b9 --- /dev/null +++ b/doc/files/setparticledirection.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/setparticlelength.html new file mode 100644 index 0000000..f7623d2 --- /dev/null +++ b/doc/files/setparticlelength.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the length of a cylinder particle emitter +
++ Note: Only applies to cylinder particles +
+Related: + GetParticleLength +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlelength.txt b/doc/files/setparticlelength.txt new file mode 100644 index 0000000..1eb5940 --- /dev/null +++ b/doc/files/setparticlelength.txt @@ -0,0 +1,9 @@ +#title setParticleLength [RCBasic Doc] +#header sub setParticleLength( actor, p_len) + +Sets the length of a cylinder particle emitter + +Note: Only applies to cylinder particles + +#ref GetParticleLength + diff --git a/doc/files/setparticlemaxangle.html b/doc/files/setparticlemaxangle.html new file mode 100644 index 0000000..95f204d --- /dev/null +++ b/doc/files/setparticlemaxangle.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the max angle of particle emission +
+Related: + GetParticleMaxAngle +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlemaxangle.txt b/doc/files/setparticlemaxangle.txt new file mode 100644 index 0000000..eb3a012 --- /dev/null +++ b/doc/files/setparticlemaxangle.txt @@ -0,0 +1,6 @@ +#title setParticleMaxAngle [RCBasic Doc] +#header sub setParticleMaxAngle( actor, maxAngle) + +Sets the max angle of particle emission + +#ref GetParticleMaxAngle diff --git a/doc/files/setparticlemaxlife.html b/doc/files/setparticlemaxlife.html new file mode 100644 index 0000000..d636ab5 --- /dev/null +++ b/doc/files/setparticlemaxlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the max life of the particle emission +
++ Note: maxLife is in milliseconds +
+Related: + GetParticleMaxLife +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlemaxlife.txt b/doc/files/setparticlemaxlife.txt new file mode 100644 index 0000000..488b93f --- /dev/null +++ b/doc/files/setparticlemaxlife.txt @@ -0,0 +1,9 @@ +#title setParticleMaxLife [RCBasic Doc] +#header sub setParticleMaxLife( actor, maxLife) + +Sets the max life of the particle emission + +Note: maxLife is in milliseconds + +#ref GetParticleMaxLife + diff --git a/doc/files/setparticlemaxstartcolor.html b/doc/files/setparticlemaxstartcolor.html new file mode 100644 index 0000000..cc22d19 --- /dev/null +++ b/doc/files/setparticlemaxstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets max starting color for particles +
+Related: + SetParticleMaxStartColor +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlemaxstartcolor.txt b/doc/files/setparticlemaxstartcolor.txt new file mode 100644 index 0000000..4296f0e --- /dev/null +++ b/doc/files/setparticlemaxstartcolor.txt @@ -0,0 +1,6 @@ +#title setParticleMaxStartColor [RCBasic Doc] +#header sub setParticleMaxStartColor( actor, color) + +Sets max starting color for particles + +#ref SetParticleMaxStartColor diff --git a/doc/files/setparticlemaxstartsize.html b/doc/files/setparticlemaxstartsize.html new file mode 100644 index 0000000..333289d --- /dev/null +++ b/doc/files/setparticlemaxstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the max start size for the particles +
+Related: + SetParticleMaxStartSize +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlemaxstartsize.txt b/doc/files/setparticlemaxstartsize.txt new file mode 100644 index 0000000..996c988 --- /dev/null +++ b/doc/files/setparticlemaxstartsize.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setparticlemesh.html new file mode 100644 index 0000000..b5d20bf --- /dev/null +++ b/doc/files/setparticlemesh.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the mesh for a mesh particle emitter +
++ Note: Only applies to mesh emitter +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlemesh.txt b/doc/files/setparticlemesh.txt new file mode 100644 index 0000000..28d9a13 --- /dev/null +++ b/doc/files/setparticlemesh.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setparticleminlife.html new file mode 100644 index 0000000..fca52ad --- /dev/null +++ b/doc/files/setparticleminlife.html @@ -0,0 +1,23 @@ + + +
+ + ++ Set the min life of particles +
++ Note: minLife is in milliseconds +
+Related: + SetParticleMinLife +
++ + + \ No newline at end of file diff --git a/doc/files/setparticleminlife.txt b/doc/files/setparticleminlife.txt new file mode 100644 index 0000000..6331569 --- /dev/null +++ b/doc/files/setparticleminlife.txt @@ -0,0 +1,9 @@ +#title setParticleMinLife [RCBasic Doc] +#header sub setParticleMinLife( actor, minLife) + +Set the min life of particles + +Note: minLife is in milliseconds + +#ref SetParticleMinLife + diff --git a/doc/files/setparticleminstartcolor.html b/doc/files/setparticleminstartcolor.html new file mode 100644 index 0000000..75d3b1b --- /dev/null +++ b/doc/files/setparticleminstartcolor.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the min start color for particles +
+Related: + GetParticleMinStartColor +
++ + + \ No newline at end of file diff --git a/doc/files/setparticleminstartcolor.txt b/doc/files/setparticleminstartcolor.txt new file mode 100644 index 0000000..6c16274 --- /dev/null +++ b/doc/files/setparticleminstartcolor.txt @@ -0,0 +1,7 @@ +#title setParticleMinStartColor [RCBasic Doc] +#header sub setParticleMinStartColor( actor, color) + +Sets the min start color for particles + +#ref GetParticleMinStartColor + diff --git a/doc/files/setparticleminstartsize.html b/doc/files/setparticleminstartsize.html new file mode 100644 index 0000000..0d11976 --- /dev/null +++ b/doc/files/setparticleminstartsize.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the min start size for particle emitter +
+Related: + GetParticleMinStartSize +
++ + + \ No newline at end of file diff --git a/doc/files/setparticleminstartsize.txt b/doc/files/setparticleminstartsize.txt new file mode 100644 index 0000000..50eb0f6 --- /dev/null +++ b/doc/files/setparticleminstartsize.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/setparticlenormal.html new file mode 100644 index 0000000..02298b6 --- /dev/null +++ b/doc/files/setparticlenormal.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the normal of a particle emitter +
++ Note: Only applies to cylinder particle emitter +
+Related: + GetParticleNormal +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlenormal.txt b/doc/files/setparticlenormal.txt new file mode 100644 index 0000000..a33d0e5 --- /dev/null +++ b/doc/files/setparticlenormal.txt @@ -0,0 +1,9 @@ +#title setParticleNormal [RCBasic Doc] +#header sub setParticleNormal( actor, x, y, z) + +Sets the normal of a particle emitter + +Note: Only applies to cylinder particle emitter + +#ref GetParticleNormal + diff --git a/doc/files/setparticlenormaldirectionmod.html b/doc/files/setparticlenormaldirectionmod.html new file mode 100644 index 0000000..f685ae2 --- /dev/null +++ b/doc/files/setparticlenormaldirectionmod.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the normal direction modifier for a particle emitter +
++ Note: Only applies to mesh particle emitter +
+Related: + GetParticleNormalDirectionMod +
++ + + \ No newline at end of file diff --git a/doc/files/setparticlenormaldirectionmod.txt b/doc/files/setparticlenormaldirectionmod.txt new file mode 100644 index 0000000..43eb58d --- /dev/null +++ b/doc/files/setparticlenormaldirectionmod.txt @@ -0,0 +1,9 @@ +#title setParticleNormalDirectionMod [RCBasic Doc] +#header sub setParticleNormalDirectionMod( actor, nd_mod) + +Sets the normal direction modifier for a particle emitter + +Note: Only applies to mesh particle emitter + +#ref GetParticleNormalDirectionMod + diff --git a/doc/files/setparticleradius.html b/doc/files/setparticleradius.html new file mode 100644 index 0000000..389b3de --- /dev/null +++ b/doc/files/setparticleradius.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the radius of a particle emitter +
++ Note: Only applies to Sphere, Cylinder, and Ring emitters +
+Related: + SetParticleRadius +
++ + + \ No newline at end of file diff --git a/doc/files/setparticleradius.txt b/doc/files/setparticleradius.txt new file mode 100644 index 0000000..78c148a --- /dev/null +++ b/doc/files/setparticleradius.txt @@ -0,0 +1,9 @@ +#title setParticleRadius [RCBasic Doc] +#header sub setParticleRadius( actor, radius) + +Sets the radius of a particle emitter + +Note: Only applies to Sphere, Cylinder, and Ring emitters + +#ref SetParticleRadius + diff --git a/doc/files/setparticleringthickness.html b/doc/files/setparticleringthickness.html new file mode 100644 index 0000000..d65bb93 --- /dev/null +++ b/doc/files/setparticleringthickness.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the thickness of a ring emitter +
++ Note: Only applies to ring emitter +
+Related: + GetParticleRingThickness +
++ + + \ No newline at end of file diff --git a/doc/files/setparticleringthickness.txt b/doc/files/setparticleringthickness.txt new file mode 100644 index 0000000..c08615b --- /dev/null +++ b/doc/files/setparticleringthickness.txt @@ -0,0 +1,9 @@ +#title setParticleRingThickness [RCBasic Doc] +#header sub setParticleRingThickness( actor, ringThickness) + +Sets the thickness of a ring emitter + +Note: Only applies to ring emitter + +#ref GetParticleRingThickness + diff --git a/doc/files/setpointpivota.html b/doc/files/setpointpivota.html new file mode 100644 index 0000000..6c1c183 --- /dev/null +++ b/doc/files/setpointpivota.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotA + SetPointPivotB +
++ + + \ No newline at end of file diff --git a/doc/files/setpointpivota.txt b/doc/files/setpointpivota.txt new file mode 100644 index 0000000..ab8b377 --- /dev/null +++ b/doc/files/setpointpivota.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setpointpivotb.html new file mode 100644 index 0000000..cb75d1d --- /dev/null +++ b/doc/files/setpointpivotb.html @@ -0,0 +1,21 @@ + + +
+ + ++ 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. +
+Related: + GetPointPivotA + SetPointPivotB +
++ + + \ No newline at end of file diff --git a/doc/files/setpointpivotb.txt b/doc/files/setpointpivotb.txt new file mode 100644 index 0000000..275a6b8 --- /dev/null +++ b/doc/files/setpointpivotb.txt @@ -0,0 +1,7 @@ +#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/setprojectionmatrix.html b/doc/files/setprojectionmatrix.html new file mode 100644 index 0000000..6eebabc --- /dev/null +++ b/doc/files/setprojectionmatrix.html @@ -0,0 +1,31 @@ + + +
+ + ++ Sets the camera projection matrix for the active canvas +
++ Possible values for projection_type +
+Related: + GetProjectionMatrix +
++ + + \ No newline at end of file diff --git a/doc/files/setprojectionmatrix.txt b/doc/files/setprojectionmatrix.txt new file mode 100644 index 0000000..fe36659 --- /dev/null +++ b/doc/files/setprojectionmatrix.txt @@ -0,0 +1,12 @@ +#title SetProjectionMatrix [RCBasic Doc] +#header Sub SetProjectionMatrix(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 GetProjectionMatrix diff --git a/doc/files/setscenefog.html b/doc/files/setscenefog.html new file mode 100644 index 0000000..dc08ca1 --- /dev/null +++ b/doc/files/setscenefog.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setscenefog.txt b/doc/files/setscenefog.txt new file mode 100644 index 0000000..e1a9dec --- /dev/null +++ b/doc/files/setscenefog.txt @@ -0,0 +1,4 @@ +#title SetSceneFog [RCBasic Doc] +#header Sub SetSceneFog (color, fog_type, start_val, end_val, density, pixelFog, rangeFog) + + diff --git a/doc/files/setslidedampingdirang.html b/doc/files/setslidedampingdirang.html new file mode 100644 index 0000000..4a6c3fa --- /dev/null +++ b/doc/files/setslidedampingdirang.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/setslidedampingdirang.txt b/doc/files/setslidedampingdirang.txt new file mode 100644 index 0000000..ff4580b --- /dev/null +++ b/doc/files/setslidedampingdirang.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setslidedampingdirlin.html new file mode 100644 index 0000000..069b735 --- /dev/null +++ b/doc/files/setslidedampingdirlin.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/setslidedampingdirlin.txt b/doc/files/setslidedampingdirlin.txt new file mode 100644 index 0000000..2949b56 --- /dev/null +++ b/doc/files/setslidedampingdirlin.txt @@ -0,0 +1,5 @@ +#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.html b/doc/files/setslidedampinglimang.html new file mode 100644 index 0000000..f52aa50 --- /dev/null +++ b/doc/files/setslidedampinglimang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingLimAng +
++ + + \ No newline at end of file diff --git a/doc/files/setslidedampinglimang.txt b/doc/files/setslidedampinglimang.txt new file mode 100644 index 0000000..868cd93 --- /dev/null +++ b/doc/files/setslidedampinglimang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setslidedampinglimlin.html new file mode 100644 index 0000000..28636a7 --- /dev/null +++ b/doc/files/setslidedampinglimlin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingLimLin +
++ + + \ No newline at end of file diff --git a/doc/files/setslidedampinglimlin.txt b/doc/files/setslidedampinglimlin.txt new file mode 100644 index 0000000..783dfb7 --- /dev/null +++ b/doc/files/setslidedampinglimlin.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/setslidedampingorthoang.html new file mode 100644 index 0000000..b0a69df --- /dev/null +++ b/doc/files/setslidedampingorthoang.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/files/setslidedampingorthoang.txt b/doc/files/setslidedampingorthoang.txt new file mode 100644 index 0000000..0c41854 --- /dev/null +++ b/doc/files/setslidedampingorthoang.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setslidedampingortholin.html new file mode 100644 index 0000000..a65a902 --- /dev/null +++ b/doc/files/setslidedampingortholin.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
+Related: + GetSlideDampingOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/files/setslidedampingortholin.txt b/doc/files/setslidedampingortholin.txt new file mode 100644 index 0000000..d1b741c --- /dev/null +++ b/doc/files/setslidedampingortholin.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setslideloweranglimit.html new file mode 100644 index 0000000..279bd9d --- /dev/null +++ b/doc/files/setslideloweranglimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideLowerAngLimit +
++ + + \ No newline at end of file diff --git a/doc/files/setslideloweranglimit.txt b/doc/files/setslideloweranglimit.txt new file mode 100644 index 0000000..656e6b5 --- /dev/null +++ b/doc/files/setslideloweranglimit.txt @@ -0,0 +1,8 @@ +#title SetSlideLowerAngLimit [RCBasic Doc] +#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.html b/doc/files/setslidelowerlinlimit.html new file mode 100644 index 0000000..2c53377 --- /dev/null +++ b/doc/files/setslidelowerlinlimit.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideLowerLinLimit +
++ + + \ No newline at end of file diff --git a/doc/files/setslidelowerlinlimit.txt b/doc/files/setslidelowerlinlimit.txt new file mode 100644 index 0000000..84f67f5 --- /dev/null +++ b/doc/files/setslidelowerlinlimit.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setsliderestitutiondirang.html new file mode 100644 index 0000000..be7d1dd --- /dev/null +++ b/doc/files/setsliderestitutiondirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideRestitutionDirAng +
++ + + \ No newline at end of file diff --git a/doc/files/setsliderestitutiondirang.txt b/doc/files/setsliderestitutiondirang.txt new file mode 100644 index 0000000..4fa9e21 --- /dev/null +++ b/doc/files/setsliderestitutiondirang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setsliderestitutiondirlin.html new file mode 100644 index 0000000..0af7708 --- /dev/null +++ b/doc/files/setsliderestitutiondirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetSlideRestitutionDirLin +
++ + + \ No newline at end of file diff --git a/doc/files/setsliderestitutiondirlin.txt b/doc/files/setsliderestitutiondirlin.txt new file mode 100644 index 0000000..28e1eee --- /dev/null +++ b/doc/files/setsliderestitutiondirlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setsliderestitutionlimang.html new file mode 100644 index 0000000..955b9a3 --- /dev/null +++ b/doc/files/setsliderestitutionlimang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + GetSlideRestitutionLimAng +
++ + + \ No newline at end of file diff --git a/doc/files/setsliderestitutionlimang.txt b/doc/files/setsliderestitutionlimang.txt new file mode 100644 index 0000000..f819d63 --- /dev/null +++ b/doc/files/setsliderestitutionlimang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setsliderestitutionlimlin.html new file mode 100644 index 0000000..4747276 --- /dev/null +++ b/doc/files/setsliderestitutionlimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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). +
+Related: + GetSlideRestitutionLimLin +
++ + + \ No newline at end of file diff --git a/doc/files/setsliderestitutionlimlin.txt b/doc/files/setsliderestitutionlimlin.txt new file mode 100644 index 0000000..7d58d50 --- /dev/null +++ b/doc/files/setsliderestitutionlimlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setsliderestitutionorthoang.html new file mode 100644 index 0000000..2e877cd --- /dev/null +++ b/doc/files/setsliderestitutionorthoang.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Angular Motion: In the context of a slider constraint, orthogonal angular motion refers to rotational movement around axes that are perpendicular to the slider's main movement axis. +
++ 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. +
+Related: + GetSlideRestitutionOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/files/setsliderestitutionorthoang.txt b/doc/files/setsliderestitutionorthoang.txt new file mode 100644 index 0000000..30b7767 --- /dev/null +++ b/doc/files/setsliderestitutionorthoang.txt @@ -0,0 +1,10 @@ +#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. + +Orthogonal Angular Motion: In the context of a slider constraint, orthogonal angular motion refers to rotational movement around axes that are perpendicular to the slider's main movement axis. + +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.html b/doc/files/setsliderestitutionortholin.html new file mode 100644 index 0000000..8ee4b4c --- /dev/null +++ b/doc/files/setsliderestitutionortholin.html @@ -0,0 +1,26 @@ + + +
+ + ++ 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. +
++ Orthogonal Linear Motion: In the context of a slider constraint, orthogonal linear motion refers to translational movement along axes that are perpendicular to the main sliding axis of the constraint. +
++ 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. +
+Related: + GetSlideRestitutionOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/files/setsliderestitutionortholin.txt b/doc/files/setsliderestitutionortholin.txt new file mode 100644 index 0000000..3cd9aa8 --- /dev/null +++ b/doc/files/setsliderestitutionortholin.txt @@ -0,0 +1,10 @@ +#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. + +Orthogonal Linear Motion: In the context of a slider constraint, orthogonal linear motion refers to translational movement along axes that are perpendicular to the main sliding axis of the constraint. + +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.html b/doc/files/setslidesoftnessdirang.html new file mode 100644 index 0000000..b2080b3 --- /dev/null +++ b/doc/files/setslidesoftnessdirang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessDirAng +
++ + + \ No newline at end of file diff --git a/doc/files/setslidesoftnessdirang.txt b/doc/files/setslidesoftnessdirang.txt new file mode 100644 index 0000000..8daf00e --- /dev/null +++ b/doc/files/setslidesoftnessdirang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setslidesoftnessdirlin.html new file mode 100644 index 0000000..910a7af --- /dev/null +++ b/doc/files/setslidesoftnessdirlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessDirLin +
++ + + \ No newline at end of file diff --git a/doc/files/setslidesoftnessdirlin.txt b/doc/files/setslidesoftnessdirlin.txt new file mode 100644 index 0000000..e82c723 --- /dev/null +++ b/doc/files/setslidesoftnessdirlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setslidesoftnesslimang.html new file mode 100644 index 0000000..7e873fa --- /dev/null +++ b/doc/files/setslidesoftnesslimang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessLimAng +
++ + + \ No newline at end of file diff --git a/doc/files/setslidesoftnesslimang.txt b/doc/files/setslidesoftnesslimang.txt new file mode 100644 index 0000000..d806c20 --- /dev/null +++ b/doc/files/setslidesoftnesslimang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setslidesoftnesslimlin.html new file mode 100644 index 0000000..b6bbce0 --- /dev/null +++ b/doc/files/setslidesoftnesslimlin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessLimLin +
++ + + \ No newline at end of file diff --git a/doc/files/setslidesoftnesslimlin.txt b/doc/files/setslidesoftnesslimlin.txt new file mode 100644 index 0000000..7461c5b --- /dev/null +++ b/doc/files/setslidesoftnesslimlin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setslidesoftnessorthoang.html new file mode 100644 index 0000000..cad7674 --- /dev/null +++ b/doc/files/setslidesoftnessorthoang.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessOrthoAng +
++ + + \ No newline at end of file diff --git a/doc/files/setslidesoftnessorthoang.txt b/doc/files/setslidesoftnessorthoang.txt new file mode 100644 index 0000000..bc33d25 --- /dev/null +++ b/doc/files/setslidesoftnessorthoang.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setslidesoftnessortholin.html new file mode 100644 index 0000000..a48db4b --- /dev/null +++ b/doc/files/setslidesoftnessortholin.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + GetSlideSoftnessOrthoLin +
++ + + \ No newline at end of file diff --git a/doc/files/setslidesoftnessortholin.txt b/doc/files/setslidesoftnessortholin.txt new file mode 100644 index 0000000..f2f2ad8 --- /dev/null +++ b/doc/files/setslidesoftnessortholin.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/setslideupperanglimit.html new file mode 100644 index 0000000..927a49c --- /dev/null +++ b/doc/files/setslideupperanglimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/setslideupperanglimit.txt b/doc/files/setslideupperanglimit.txt new file mode 100644 index 0000000..469d8da --- /dev/null +++ b/doc/files/setslideupperanglimit.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setslideupperlinlimit.html new file mode 100644 index 0000000..957fe31 --- /dev/null +++ b/doc/files/setslideupperlinlimit.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/setslideupperlinlimit.txt b/doc/files/setslideupperlinlimit.txt new file mode 100644 index 0000000..42d58c1 --- /dev/null +++ b/doc/files/setslideupperlinlimit.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setsoundchannels.html new file mode 100644 index 0000000..e1374e8 --- /dev/null +++ b/doc/files/setsoundchannels.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the maximum number of sound channels. +
++ + + \ No newline at end of file diff --git a/doc/files/setsoundchannels.txt b/doc/files/setsoundchannels.txt new file mode 100644 index 0000000..9300d13 --- /dev/null +++ b/doc/files/setsoundchannels.txt @@ -0,0 +1,4 @@ +#title SetSoundChannels [RCBasic Doc] +#header sub SetSoundChannels(max_channels) + +Sets the maximum number of sound channels. diff --git a/doc/files/setsoundvolume.html b/doc/files/setsoundvolume.html new file mode 100644 index 0000000..07a5d38 --- /dev/null +++ b/doc/files/setsoundvolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the volume of a sound +
++ + + \ No newline at end of file diff --git a/doc/files/setsoundvolume.txt b/doc/files/setsoundvolume.txt new file mode 100644 index 0000000..fafb922 --- /dev/null +++ b/doc/files/setsoundvolume.txt @@ -0,0 +1,4 @@ +#title SetSoundVolume [RCBasic Doc] +#header sub SetSoundVolume(snd, vol) + +Sets the volume of a sound diff --git a/doc/files/setspriteangulardamping.html b/doc/files/setspriteangulardamping.html new file mode 100644 index 0000000..f30c4ab --- /dev/null +++ b/doc/files/setspriteangulardamping.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets a sprite's angular damping +
+Related: + GetSpriteAngularDamping +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteangulardamping.txt b/doc/files/setspriteangulardamping.txt new file mode 100644 index 0000000..72d034e --- /dev/null +++ b/doc/files/setspriteangulardamping.txt @@ -0,0 +1,6 @@ +#title setSpriteAngularDamping [RCBasic Doc] +#header sub setSpriteAngularDamping( spr_id, angularDamping) + +Sets a sprite's angular damping + +#ref GetSpriteAngularDamping diff --git a/doc/files/setspriteangularvelocity.html b/doc/files/setspriteangularvelocity.html new file mode 100644 index 0000000..ace9ee9 --- /dev/null +++ b/doc/files/setspriteangularvelocity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the angular velocity of a sprite +
+Related: + GetSpriteAngularVelocity +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteangularvelocity.txt b/doc/files/setspriteangularvelocity.txt new file mode 100644 index 0000000..0ceda48 --- /dev/null +++ b/doc/files/setspriteangularvelocity.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setspriteanimation.html new file mode 100644 index 0000000..026c7da --- /dev/null +++ b/doc/files/setspriteanimation.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the current animation for a sprite +
++ Note: Once an animation is set, it will automatically start +
+Related: + GetSpriteAnimation +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteanimation.txt b/doc/files/setspriteanimation.txt new file mode 100644 index 0000000..9a4666d --- /dev/null +++ b/doc/files/setspriteanimation.txt @@ -0,0 +1,8 @@ +#title SetSpriteAnimation [RCBasic Doc] +#header Sub SetSpriteAnimation(sprite, animation) + +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.html b/doc/files/setspriteanimationframe.html new file mode 100644 index 0000000..1975a65 --- /dev/null +++ b/doc/files/setspriteanimationframe.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets a frame in a sprite animation +
+Related: + GetSpriteAnimationFrame +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteanimationframe.txt b/doc/files/setspriteanimationframe.txt new file mode 100644 index 0000000..825a242 --- /dev/null +++ b/doc/files/setspriteanimationframe.txt @@ -0,0 +1,6 @@ +#title SetSpriteAnimationFrame [RCBasic Doc] +#header Sub SetSpriteAnimationFrame(sprite, animation, anim_frame, frame) + +Sets a frame in a sprite animation + +#ref GetSpriteAnimationFrame diff --git a/doc/files/setspriteanimationlength.html b/doc/files/setspriteanimationlength.html new file mode 100644 index 0000000..85e21a6 --- /dev/null +++ b/doc/files/setspriteanimationlength.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of frames in a sprite animation +
+Related: + GetSpriteAnimationLength +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteanimationlength.txt b/doc/files/setspriteanimationlength.txt new file mode 100644 index 0000000..7af2d54 --- /dev/null +++ b/doc/files/setspriteanimationlength.txt @@ -0,0 +1,6 @@ +#title SetSpriteAnimationLength [RCBasic Doc] +#header Sub SetSpriteAnimationLength(sprite, animation, anim_length) + +Sets the number of frames in a sprite animation + +#ref GetSpriteAnimationLength diff --git a/doc/files/setspriteanimationloops.html b/doc/files/setspriteanimationloops.html new file mode 100644 index 0000000..e8d9898 --- /dev/null +++ b/doc/files/setspriteanimationloops.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of animation loops for the sprite +
+Related: + NumSpriteAnimationLoops +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteanimationloops.txt b/doc/files/setspriteanimationloops.txt new file mode 100644 index 0000000..ccbae78 --- /dev/null +++ b/doc/files/setspriteanimationloops.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setspriteanimationspeed.html new file mode 100644 index 0000000..84924cf --- /dev/null +++ b/doc/files/setspriteanimationspeed.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the speed in frames per second for a sprite animation +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteanimationspeed.txt b/doc/files/setspriteanimationspeed.txt new file mode 100644 index 0000000..116738c --- /dev/null +++ b/doc/files/setspriteanimationspeed.txt @@ -0,0 +1,4 @@ +#title SetSpriteAnimationSpeed [RCBasic Doc] +#header Sub SetSpriteAnimationSpeed(sprite, animation, speed) + +Sets the speed in frames per second for a sprite animation diff --git a/doc/files/setspriteawake.html b/doc/files/setspriteawake.html new file mode 100644 index 0000000..1314f9e --- /dev/null +++ b/doc/files/setspriteawake.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets a sprite's sleep state +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteawake.txt b/doc/files/setspriteawake.txt new file mode 100644 index 0000000..b665762 --- /dev/null +++ b/doc/files/setspriteawake.txt @@ -0,0 +1,4 @@ +#title setSpriteAwake [RCBasic Doc] +#header sub setSpriteAwake( spr_id, flag) + +Sets a sprite's sleep state diff --git a/doc/files/setspritebullet.html b/doc/files/setspritebullet.html new file mode 100644 index 0000000..badf52c --- /dev/null +++ b/doc/files/setspritebullet.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets whether body has continuous collision detection +
++ Note: Useful for fast moving objects +
+Related: + SpriteIsBullet +
++ + + \ No newline at end of file diff --git a/doc/files/setspritebullet.txt b/doc/files/setspritebullet.txt new file mode 100644 index 0000000..cc9ee69 --- /dev/null +++ b/doc/files/setspritebullet.txt @@ -0,0 +1,8 @@ +#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/setspritedensity.html b/doc/files/setspritedensity.html new file mode 100644 index 0000000..4912d66 --- /dev/null +++ b/doc/files/setspritedensity.html @@ -0,0 +1,23 @@ + + +
+ + ++ Sets the density of a sprite. Higher density means a heavier sprite. +
++ Density is used to calculate mass for a sprite. +
+Related: + GetSpriteDensity +
++ + + \ No newline at end of file diff --git a/doc/files/setspritedensity.txt b/doc/files/setspritedensity.txt new file mode 100644 index 0000000..fcbff6a --- /dev/null +++ b/doc/files/setspritedensity.txt @@ -0,0 +1,9 @@ +#title SetSpriteDensity [RCBasic Doc] +#header sub SetSpriteDensity( spr_id, density ) + +Sets the density of a sprite. Higher density means a heavier sprite. + +Density is used to calculate mass for a sprite. + +#ref GetSpriteDensity + diff --git a/doc/files/setspritefixedrotation.html b/doc/files/setspritefixedrotation.html new file mode 100644 index 0000000..59b1b60 --- /dev/null +++ b/doc/files/setspritefixedrotation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Prevents sprite from being rotated by any forces applied to it +
+Related: + spriteIsFixedRotation +
++ + + \ No newline at end of file diff --git a/doc/files/setspritefixedrotation.txt b/doc/files/setspritefixedrotation.txt new file mode 100644 index 0000000..ada3364 --- /dev/null +++ b/doc/files/setspritefixedrotation.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setspriteframe.html new file mode 100644 index 0000000..48a4752 --- /dev/null +++ b/doc/files/setspriteframe.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets a sprite to a frame in its frame sheet +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteframe.txt b/doc/files/setspriteframe.txt new file mode 100644 index 0000000..96633de --- /dev/null +++ b/doc/files/setspriteframe.txt @@ -0,0 +1,4 @@ +#title SetSpriteFrame [RCBasic Doc] +#header Sub SetSpriteFrame(sprite, frame) + +Sets a sprite to a frame in its frame sheet diff --git a/doc/files/setspritefriction.html b/doc/files/setspritefriction.html new file mode 100644 index 0000000..abaeac8 --- /dev/null +++ b/doc/files/setspritefriction.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets a sprite's friction +
+Related: + GetSpriteFriction +
++ + + \ No newline at end of file diff --git a/doc/files/setspritefriction.txt b/doc/files/setspritefriction.txt new file mode 100644 index 0000000..c3f5f8c --- /dev/null +++ b/doc/files/setspritefriction.txt @@ -0,0 +1,6 @@ +#title SetSpriteFriction [RCBasic Doc] +#header sub SetSpriteFriction( spr_id, friction ) + +Sets a sprite's friction + +#ref GetSpriteFriction diff --git a/doc/files/setspritegravityscale.html b/doc/files/setspritegravityscale.html new file mode 100644 index 0000000..19cff02 --- /dev/null +++ b/doc/files/setspritegravityscale.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the affect of gravity on a sprite +
+Related: + GetSpriteGravityScale +
++ + + \ No newline at end of file diff --git a/doc/files/setspritegravityscale.txt b/doc/files/setspritegravityscale.txt new file mode 100644 index 0000000..1cad17c --- /dev/null +++ b/doc/files/setspritegravityscale.txt @@ -0,0 +1,6 @@ +#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/setspritelineardamping.html b/doc/files/setspritelineardamping.html new file mode 100644 index 0000000..929c854 --- /dev/null +++ b/doc/files/setspritelineardamping.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the linear damping of a sprite +
+Related: + GetSpriteLinearDamping +
++ + + \ No newline at end of file diff --git a/doc/files/setspritelineardamping.txt b/doc/files/setspritelineardamping.txt new file mode 100644 index 0000000..b1f2db8 --- /dev/null +++ b/doc/files/setspritelineardamping.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setspritelinearvelocity.html new file mode 100644 index 0000000..3009a35 --- /dev/null +++ b/doc/files/setspritelinearvelocity.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets a sprite's linear velocity +
+Related: + GetSpriteLinearVelocity +
++ + + \ No newline at end of file diff --git a/doc/files/setspritelinearvelocity.txt b/doc/files/setspritelinearvelocity.txt new file mode 100644 index 0000000..b519c20 --- /dev/null +++ b/doc/files/setspritelinearvelocity.txt @@ -0,0 +1,6 @@ +#title setSpriteLinearVelocity [RCBasic Doc] +#header sub setSpriteLinearVelocity( spr_id, x, y) + +Sets a sprite's linear velocity + +#ref GetSpriteLinearVelocity diff --git a/doc/files/setspriteposition.html b/doc/files/setspriteposition.html new file mode 100644 index 0000000..24a9aae --- /dev/null +++ b/doc/files/setspriteposition.html @@ -0,0 +1,59 @@ + + +
+ + ++ Sets the position of the sprite in the canvas +
++ Note: This is canvas position and not screen position +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpritePosition", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) 'Position on the canvas the sprite will initially be drawn.
+
+ speed = 0.4
+
+ While Not Key(K_ESCAPE)
+
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX + speed 'Speed will be added to sprites X position, sprite will move to the right gradually
+
+ Update()
+ Wend
+
Related: + OpenCanvasSpriteLayer + CreateSprite +
++ + + \ No newline at end of file diff --git a/doc/files/setspriteposition.txt b/doc/files/setspriteposition.txt new file mode 100644 index 0000000..4296279 --- /dev/null +++ b/doc/files/setspriteposition.txt @@ -0,0 +1,45 @@ +#title SetSpritePosition [RCBasic Doc] +#header Sub SetSpritePosition( sprite, x, y ) + +Sets the position of the sprite in the canvas + +Note: This is canvas position and not screen position + +#code + isFullScreen = false + vSync = true + winWidth = 640 + winHeight = 480 + canViewPortX = 0 + canViewPortY = 0 + + OpenWindow("SetSpritePosition", winWidth, winHeight, isFullScreen, vSync) + sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) + Canvas(sCanvas) + + DIM eye + DIM eyeW + DIM eyeH + eyeSpriteX = 100 + eyeSpriteY = 100 + + eye = LoadImage("theEye.png") + GetImageSize(eye, eyeW, eyeH) + + eyeSprite = CreateSprite(eye, eyeW, eyeH) + SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) 'Position on the canvas the sprite will initially be drawn. + + speed = 0.4 + + While Not Key(K_ESCAPE) + + SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) + eyeSpriteX = eyeSpriteX + speed 'Speed will be added to sprites X position, sprite will move to the right gradually + + Update() + Wend +#/code + +#image "images/theEye.png" + +#ref OpenCanvasSpriteLayer CreateSprite diff --git a/doc/files/setspriterestitution.html b/doc/files/setspriterestitution.html new file mode 100644 index 0000000..f279e4e --- /dev/null +++ b/doc/files/setspriterestitution.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the restitution coefficient for a sprite +
+Related: + GetSpriteRestitution +
++ + + \ No newline at end of file diff --git a/doc/files/setspriterestitution.txt b/doc/files/setspriterestitution.txt new file mode 100644 index 0000000..c907b2e --- /dev/null +++ b/doc/files/setspriterestitution.txt @@ -0,0 +1,7 @@ +#title SetSpriteRestitution [RCBasic Doc] +#header sub SetSpriteRestitution( spr_id, restitution ) + +Sets the restitution coefficient for a sprite + +#ref GetSpriteRestitution + diff --git a/doc/files/setspriterestitutionthreshold.html b/doc/files/setspriterestitutionthreshold.html new file mode 100644 index 0000000..07c8353 --- /dev/null +++ b/doc/files/setspriterestitutionthreshold.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the restitution threshold for a sprite. +
+Related: + GetSpriteRestitutionThreshold +
++ + + \ No newline at end of file diff --git a/doc/files/setspriterestitutionthreshold.txt b/doc/files/setspriterestitutionthreshold.txt new file mode 100644 index 0000000..02e539d --- /dev/null +++ b/doc/files/setspriterestitutionthreshold.txt @@ -0,0 +1,6 @@ +#title SetSpriteRestitutionThreshold [RCBasic Doc] +#header sub SetSpriteRestitutionThreshold( spr_id, threshold ) + +Sets the restitution threshold for a sprite. + +#ref GetSpriteRestitutionThreshold diff --git a/doc/files/setspriterotation.html b/doc/files/setspriterotation.html new file mode 100644 index 0000000..1063e8d --- /dev/null +++ b/doc/files/setspriterotation.html @@ -0,0 +1,55 @@ + + +
+ + ++ Sets the angle the sprite is rotated by +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteRotation", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeAngle 'Variable to hold the sprites angle value
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ While Not Key(K_ESCAPE)
+ 'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called.
+
+ SetSpriteRotation(eyeSprite, eyeAngle)
+
+ eyeAngle = eyeAngle + 0.3
+
+ Update() 'Update automatically deals with drawing the sprites on the sprite canvas.
+ Wend
+
Related: + GetSpriteRotation + RotateSprite +
++ + + \ No newline at end of file diff --git a/doc/files/setspriterotation.txt b/doc/files/setspriterotation.txt new file mode 100644 index 0000000..842bbd2 --- /dev/null +++ b/doc/files/setspriterotation.txt @@ -0,0 +1,43 @@ +#title SetSpriteRotation [RCBasic Doc] +#header Sub SetSpriteRotation(sprite, angle) + +Sets the angle the sprite is rotated by + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteRotation", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +DIM eyeAngle 'Variable to hold the sprites angle value + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, 100, 100) + +While Not Key(K_ESCAPE) +'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called. + +SetSpriteRotation(eyeSprite, eyeAngle) + +eyeAngle = eyeAngle + 0.3 + +Update() 'Update automatically deals with drawing the sprites on the sprite canvas. +Wend +#/code + +#image "images/theEye.png" + +#ref GetSpriteRotation RotateSprite + diff --git a/doc/files/setspritescale.html b/doc/files/setspritescale.html new file mode 100644 index 0000000..297da88 --- /dev/null +++ b/doc/files/setspritescale.html @@ -0,0 +1,56 @@ + + +
+ + ++ Sets the scale of a sprite +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteScale", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeScale 'Variable to hold the sprites scale
+ eyeScale = 2
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, 200, 100)
+
+ SetSpriteScale(eyeSprite2, eyeScale, eyeScale)
+
+ While Not Key(K_ESCAPE)
+
+ Update()
+ Wend
+
Related: + ScaleSprite + GetSpriteScale +
++ + + \ No newline at end of file diff --git a/doc/files/setspritescale.txt b/doc/files/setspritescale.txt new file mode 100644 index 0000000..4b022c2 --- /dev/null +++ b/doc/files/setspritescale.txt @@ -0,0 +1,43 @@ +#title SetSpriteScale [RCBasic Doc] +#header Sub SetSpriteScale(sprite, x, y) + +Sets the scale of a sprite + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteScale", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +DIM eyeScale 'Variable to hold the sprites scale +eyeScale = 2 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, 100, 100) + +eyeSprite2 = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite2, 200, 100) + +SetSpriteScale(eyeSprite2, eyeScale, eyeScale) + +While Not Key(K_ESCAPE) + +Update() +Wend +#/code + +#image "images/theEye.png" + +#ref ScaleSprite GetSpriteScale diff --git a/doc/files/setspritesleepallowed.html b/doc/files/setspritesleepallowed.html new file mode 100644 index 0000000..77305f3 --- /dev/null +++ b/doc/files/setspritesleepallowed.html @@ -0,0 +1,22 @@ + + +
+ + ++ Sets whether the sprite is allowed to go to sleep when it's at rest +
+Related: + SetSpriteAwake + SpriteIsAwake + SpriteIsSleepAllowed +
++ + + \ No newline at end of file diff --git a/doc/files/setspritesleepallowed.txt b/doc/files/setspritesleepallowed.txt new file mode 100644 index 0000000..d79be31 --- /dev/null +++ b/doc/files/setspritesleepallowed.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/setspritesolid.html new file mode 100644 index 0000000..fb94111 --- /dev/null +++ b/doc/files/setspritesolid.html @@ -0,0 +1,60 @@ + + +
+ + ++ Sets whether a sprite has physics and collision response enabled +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteSolid", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ eyeSprite2X = 400
+ eyeSprite2Y = 125
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ SetSpriteSolid(eyeSprite, 1) 'Setting the sprites as solid means they can collide with one another.
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y)
+ SetSpriteSolid(eyeSprite2, 1)
+
+ While Not Key(K_ESCAPE)
+
+ SetSpriteLinearVelocity(eyeSprite, 30, 0)
+ eyeSpriteX = eyeSpriteX + 0.5
+
+ Update()
+ Wend
+
Related: + SpriteIsSolid +
++ + + \ No newline at end of file diff --git a/doc/files/setspritesolid.txt b/doc/files/setspritesolid.txt new file mode 100644 index 0000000..ffab8c6 --- /dev/null +++ b/doc/files/setspritesolid.txt @@ -0,0 +1,49 @@ +#title SetSpriteSolid [RCBasic Doc] +#header Sub SetSpriteSolid(sprite, flag) + +Sets whether a sprite has physics and collision response enabled + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteSolid", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +eyeSpriteX = 100 +eyeSpriteY = 100 +eyeSprite2X = 400 +eyeSprite2Y = 125 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) +SetSpriteSolid(eyeSprite, 1) 'Setting the sprites as solid means they can collide with one another. + +eyeSprite2 = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y) +SetSpriteSolid(eyeSprite2, 1) + +While Not Key(K_ESCAPE) + + SetSpriteLinearVelocity(eyeSprite, 30, 0) + eyeSpriteX = eyeSpriteX + 0.5 + + Update() +Wend +#/code + +#image "images/theEye.png" + +#ref SpriteIsSolid + diff --git a/doc/files/setspritesource.html b/doc/files/setspritesource.html new file mode 100644 index 0000000..3c673f7 --- /dev/null +++ b/doc/files/setspritesource.html @@ -0,0 +1,55 @@ + + +
+ + ++ Changes the image source for a sprite frame sheet +
++ Note: This needs to be the same size as the current image source or you will have rendering issues +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteSource", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM frown
+ DIM frownW
+ DIM frownH
+
+ frowny1 = LoadImage("frowny1.png")
+ frowny2 = LoadImage("frowny2.png")
+ GetImageSize(frown, frownW, frownH)
+
+ frownSprite = CreateSprite(frown, frownW, frownH)
+ SetSpritePosition(frownSprite, 100, 100)
+
+ While Not Key(K_ESCAPE)
+ If KEY(K_SPACE) Then
+ SetSpriteSource(frownSprite, frowny2)
+ End If
+ Update()
+ Wend
+
Related: + GetSpriteSource +
++ + + \ No newline at end of file diff --git a/doc/files/setspritesource.txt b/doc/files/setspritesource.txt new file mode 100644 index 0000000..8b6b529 --- /dev/null +++ b/doc/files/setspritesource.txt @@ -0,0 +1,42 @@ +#title SetSpriteSource [RCBasic Doc] +#header Sub SetSpriteSource(sprite, img) + +Changes the image source for a sprite frame sheet + +Note: This needs to be the same size as the current image source or you will have rendering issues + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteSource", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM frown +DIM frownW +DIM frownH + +frowny1 = LoadImage("frowny1.png") +frowny2 = LoadImage("frowny2.png") +GetImageSize(frown, frownW, frownH) + +frownSprite = CreateSprite(frown, frownW, frownH) +SetSpritePosition(frownSprite, 100, 100) + +While Not Key(K_ESCAPE) + If KEY(K_SPACE) Then + SetSpriteSource(frownSprite, frowny2) + End If + Update() +Wend +#/code + +#image "images/frowny1.png" +#image "images/frowny2.png" + +#ref GetSpriteSource diff --git a/doc/files/setspritetype.html b/doc/files/setspritetype.html new file mode 100644 index 0000000..f2cf80b --- /dev/null +++ b/doc/files/setspritetype.html @@ -0,0 +1,169 @@ + + +
+ + ++ Sets the type of collision body a sprite has +
++ Here is an example of SPRITE_TYPE_DYNAMIC: +
+
+ 'This is showing SPRITE_TYPE_DYNAMIC
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteType_Dynamic", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ eyeSprite2X = 400
+ eyeSprite2Y = 125
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ SetSpriteSolid(eyeSprite, 1)
+
+ 'When Sprites are created and physics activated there "type" is Dyanmic by default
+ 'The sprites have collision and physics activated, so they can move and react to other bodies.
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y)
+ SetSpriteSolid(eyeSprite2, 1)
+
+ While Not Key(K_ESCAPE)
+
+ SetSpriteLinearVelocity(eyeSprite, 80, 0)
+
+ Update()
+ Wend
+
+ Here is an example of SPRITE_TYPE_STATIC: +
+
+ 'This is showing SPRITE_TYPE_STATIC
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteType_Static", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ eyeSprite2X = 400
+ eyeSprite2Y = 125
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ SetSpriteSolid(eyeSprite, 1)
+
+ 'When Sprites are created and physics activated there "type" is Dyanmic by default
+ 'The sprites have collision and physics activated, so they can move and react to other bodies.
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y)
+ SetSpriteSolid(eyeSprite2, 1)
+ SetSpriteType(eyeSprite2, SPRITE_TYPE_STATIC) 'When a sprite is made solid nothing can move it
+
+ While Not Key(K_ESCAPE)
+
+ SetSpriteLinearVelocity(eyeSprite, 80, 0)
+
+ Update()
+ Wend
+
+ Finally here is an example of SPRITE_TYPE_KINEMATIC: +
+
+ 'This is showing SPRITE_TYPE_KINEMATIC
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteType_Kinematic", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ eyeSprite2X = 400
+ eyeSprite2Y = 125
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ SetSpriteSolid(eyeSprite, 1)
+ SetSpriteType(eyeSprite, SPRITE_TYPE_KINEMATIC) 'KINEMATIC type makes the sprite able to be moved, but it does not react to dynamic bodies.
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y)
+ SetSpriteSolid(eyeSprite2, 1)
+
+ While Not Key(K_ESCAPE)
+
+ SetSpriteLinearVelocity(eyeSprite, 80, 0)
+
+ Update()
+ Wend
+
Related: + GetSpriteType +
++ + + \ No newline at end of file diff --git a/doc/files/setspritetype.txt b/doc/files/setspritetype.txt new file mode 100644 index 0000000..20ae6a2 --- /dev/null +++ b/doc/files/setspritetype.txt @@ -0,0 +1,151 @@ +#title SetSpriteType [RCBasic Doc] +#header Sub SetSpriteType(sprite, sprite_type) + +Sets the type of collision body a sprite has + +#list ul +#li SPRITE_TYPE_STATIC +#li SPRITE_TYPE_KINEMATIC +#li SPRITE_TYPE_DYNAMIC +#/list + +Here is an example of SPRITE_TYPE_DYNAMIC: + +#code +'This is showing SPRITE_TYPE_DYNAMIC + +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteType_Dynamic", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +eyeSpriteX = 100 +eyeSpriteY = 100 +eyeSprite2X = 400 +eyeSprite2Y = 125 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) +SetSpriteSolid(eyeSprite, 1) + +'When Sprites are created and physics activated there "type" is Dyanmic by default +'The sprites have collision and physics activated, so they can move and react to other bodies. + +eyeSprite2 = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y) +SetSpriteSolid(eyeSprite2, 1) + +While Not Key(K_ESCAPE) + + SetSpriteLinearVelocity(eyeSprite, 80, 0) + + Update() +Wend +#/code + +Here is an example of SPRITE_TYPE_STATIC: + +#code +'This is showing SPRITE_TYPE_STATIC + +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteType_Static", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +eyeSpriteX = 100 +eyeSpriteY = 100 +eyeSprite2X = 400 +eyeSprite2Y = 125 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) +SetSpriteSolid(eyeSprite, 1) + +'When Sprites are created and physics activated there "type" is Dyanmic by default +'The sprites have collision and physics activated, so they can move and react to other bodies. + +eyeSprite2 = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y) +SetSpriteSolid(eyeSprite2, 1) +SetSpriteType(eyeSprite2, SPRITE_TYPE_STATIC) 'When a sprite is made solid nothing can move it + +While Not Key(K_ESCAPE) + + SetSpriteLinearVelocity(eyeSprite, 80, 0) + + Update() +Wend +#/code + +Finally here is an example of SPRITE_TYPE_KINEMATIC: + +#code +'This is showing SPRITE_TYPE_KINEMATIC + +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteType_Kinematic", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +eyeSpriteX = 100 +eyeSpriteY = 100 +eyeSprite2X = 400 +eyeSprite2Y = 125 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) +SetSpriteSolid(eyeSprite, 1) +SetSpriteType(eyeSprite, SPRITE_TYPE_KINEMATIC) 'KINEMATIC type makes the sprite able to be moved, but it does not react to dynamic bodies. + +eyeSprite2 = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y) +SetSpriteSolid(eyeSprite2, 1) + +While Not Key(K_ESCAPE) + + SetSpriteLinearVelocity(eyeSprite, 80, 0) + + Update() +Wend +#/code + +#image "images/theEye.png" + +#ref GetSpriteType diff --git a/doc/files/setspritevisible.html b/doc/files/setspritevisible.html new file mode 100644 index 0000000..73a26ce --- /dev/null +++ b/doc/files/setspritevisible.html @@ -0,0 +1,53 @@ + + +
+ + ++ Set the sprite visible with the flAG +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteVisible", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM spriteTimer : spriteTimer = Timer()
+ DIM spriteTimerDiff : spriteTimerDiff = 2000
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ While Not Key(K_ESCAPE)
+ If Timer() - spriteTimer > spriteTimerDiff Then
+ SetSpriteVisible(eyeSprite, 0) 'Set sprite visible flag to 0 or false and it will become not visible
+ Print ("Function Called")
+ End If
+ Update()
+ Wend
+
Related: + SetSpriteVisible +
++ + + \ No newline at end of file diff --git a/doc/files/setspritevisible.txt b/doc/files/setspritevisible.txt new file mode 100644 index 0000000..ee5e2c6 --- /dev/null +++ b/doc/files/setspritevisible.txt @@ -0,0 +1,41 @@ +#title SetSpriteVisible [RCBasic Doc] +#header Function SetSpriteVisible(sprite, flag) + +Set the sprite visible with the flAG + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteVisible", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +DIM spriteTimer : spriteTimer = Timer() +DIM spriteTimerDiff : spriteTimerDiff = 2000 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, 100, 100) + +While Not Key(K_ESCAPE) + If Timer() - spriteTimer > spriteTimerDiff Then + SetSpriteVisible(eyeSprite, 0) 'Set sprite visible flag to 0 or false and it will become not visible + Print ("Function Called") + End If + Update() +Wend +#/code + +#image "images/theEye.png" + +#ref SetSpriteVisible diff --git a/doc/files/setspritez.html b/doc/files/setspritez.html new file mode 100644 index 0000000..f2b726d --- /dev/null +++ b/doc/files/setspritez.html @@ -0,0 +1,71 @@ + + +
+ + ++ Sets the drawing priority for sprites. +
++ Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("ScaleSprite", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM sword
+ DIM swordW
+ DIM swordH
+ ReleaseKey = 0
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ sword = LoadImage("sword.png")
+ GetImageSize(sword, swordW, swordH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+ SetSpriteZ(eyeSprite, 1)
+
+ swordSprite = CreateSprite(sword, swordW, swordH)
+ SetSpritePosition(swordSprite, 89, 75)
+ SetSpriteZ(swordSprite, 5)
+
+ While Not Key(K_ESCAPE)
+
+ If Key(K_SPACE) And ReleaseKey = 0 Then
+ SetSpriteZ(eyeSprite, 10) 'This will cause the eye to be drawn behind the sword
+ ReleaseKey = 1
+ ElseIf Not Key(K_UP) And Not Key(K_DOWN) And ReleaseKey = 1 then
+ ReleaseKey = 0
+ End If
+
+ Update()
+ Wend
+
Related: + SpriteZ +
++ + + \ No newline at end of file diff --git a/doc/files/setspritez.txt b/doc/files/setspritez.txt new file mode 100644 index 0000000..95ed333 --- /dev/null +++ b/doc/files/setspritez.txt @@ -0,0 +1,60 @@ +#title SetSpriteZ [RCBasic Doc] +#header Sub SetSpriteZ(sprite, z) + +Sets the drawing priority for sprites. + +Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("ScaleSprite", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +DIM sword +DIM swordW +DIM swordH +ReleaseKey = 0 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +sword = LoadImage("sword.png") +GetImageSize(sword, swordW, swordH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, 100, 100) +SetSpriteZ(eyeSprite, 1) + +swordSprite = CreateSprite(sword, swordW, swordH) +SetSpritePosition(swordSprite, 89, 75) +SetSpriteZ(swordSprite, 5) + +While Not Key(K_ESCAPE) + +If Key(K_SPACE) And ReleaseKey = 0 Then + SetSpriteZ(eyeSprite, 10) 'This will cause the eye to be drawn behind the sword + ReleaseKey = 1 +ElseIf Not Key(K_UP) And Not Key(K_DOWN) And ReleaseKey = 1 then + ReleaseKey = 0 +End If + +Update() +Wend +#/code + +#image "images/theEye.png" + +#image "images/sword.png" + +#ref SpriteZ + diff --git a/doc/files/setterraincameramovementdelta.html b/doc/files/setterraincameramovementdelta.html new file mode 100644 index 0000000..0a89d1c --- /dev/null +++ b/doc/files/setterraincameramovementdelta.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the movement camera threshold. +
++ 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/files/setterraincameramovementdelta.txt b/doc/files/setterraincameramovementdelta.txt new file mode 100644 index 0000000..a58e436 --- /dev/null +++ b/doc/files/setterraincameramovementdelta.txt @@ -0,0 +1,7 @@ +#title SetTerrainCameraMovementDelta [RCBasic Doc] +#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.html b/doc/files/setterraincamerarotationdelta.html new file mode 100644 index 0000000..12b1fdb --- /dev/null +++ b/doc/files/setterraincamerarotationdelta.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the rotation camera threshold. +
++ 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/files/setterraincamerarotationdelta.txt b/doc/files/setterraincamerarotationdelta.txt new file mode 100644 index 0000000..90bde83 --- /dev/null +++ b/doc/files/setterraincamerarotationdelta.txt @@ -0,0 +1,7 @@ +#title SetTerrainCameraRotationDelta [RCBasic Doc] +#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.html b/doc/files/setterrainloddistance.html new file mode 100644 index 0000000..17c8168 --- /dev/null +++ b/doc/files/setterrainloddistance.html @@ -0,0 +1,17 @@ + + +
+ + ++ Override the default generation of distance thresholds. +
++ + + \ No newline at end of file diff --git a/doc/files/setterrainloddistance.txt b/doc/files/setterrainloddistance.txt new file mode 100644 index 0000000..3dfaadd --- /dev/null +++ b/doc/files/setterrainloddistance.txt @@ -0,0 +1,4 @@ +#title SetTerrainLODDistance [RCBasic Doc] +#header sub SetTerrainLODDistance( actor, LOD, distance ) + +Override the default generation of distance thresholds. diff --git a/doc/files/setterrainpatchlod.html b/doc/files/setterrainpatchlod.html new file mode 100644 index 0000000..8d7bdb2 --- /dev/null +++ b/doc/files/setterrainpatchlod.html @@ -0,0 +1,17 @@ + + +
+ + ++ Manually sets the LOD of a patch. +
++ + + \ No newline at end of file diff --git a/doc/files/setterrainpatchlod.txt b/doc/files/setterrainpatchlod.txt new file mode 100644 index 0000000..f880bfa --- /dev/null +++ b/doc/files/setterrainpatchlod.txt @@ -0,0 +1,4 @@ +#title SetTerrainPatchLOD [RCBasic Doc] +#header sub SetTerrainPatchLOD( actor, patchX, patchZ, LOD ) + +Manually sets the LOD of a patch. diff --git a/doc/files/settile.html b/doc/files/settile.html new file mode 100644 index 0000000..9b0c3e8 --- /dev/null +++ b/doc/files/settile.html @@ -0,0 +1,17 @@ + + +
+ + ++ Places a tile on a tilemap +
++ + + \ No newline at end of file diff --git a/doc/files/settile.txt b/doc/files/settile.txt new file mode 100644 index 0000000..7714702 --- /dev/null +++ b/doc/files/settile.txt @@ -0,0 +1,5 @@ +#title SetTile [RCBasic Doc] +#header Sub SetTile(tilemap, tile, x, y) + +Places a tile on a tilemap + diff --git a/doc/files/settileanimationframe.html b/doc/files/settileanimationframe.html new file mode 100644 index 0000000..9dd63d1 --- /dev/null +++ b/doc/files/settileanimationframe.html @@ -0,0 +1,34 @@ + + +
+ + ++ Sets a frame of animation for a tile +
++ Parameters: +
++ + + \ No newline at end of file diff --git a/doc/files/settileanimationframe.txt b/doc/files/settileanimationframe.txt new file mode 100644 index 0000000..c222a2a --- /dev/null +++ b/doc/files/settileanimationframe.txt @@ -0,0 +1,12 @@ +#title SetTileAnimationFrame [RCBasic Doc] +#header Sub SetTileAnimationFrame(tileset, base_tile, anim_frame, tile) + +Sets a frame of animation for a tile + +Parameters: +#list ul +#li tileset - The tileset that the base_tile is in +#li base_tile - The tile with the frame of animation being set +#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.html b/doc/files/settileanimationlength.html new file mode 100644 index 0000000..d86a5e3 --- /dev/null +++ b/doc/files/settileanimationlength.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of frames in a tile's animation +
+Related: + GetTileAnimationLength +
++ + + \ No newline at end of file diff --git a/doc/files/settileanimationlength.txt b/doc/files/settileanimationlength.txt new file mode 100644 index 0000000..82b841d --- /dev/null +++ b/doc/files/settileanimationlength.txt @@ -0,0 +1,6 @@ +#title SetTileAnimationLength [RCBasic Doc] +#header Sub SetTileAnimationLength(tileset, base_tile, num_frames) + +Sets the number of frames in a tile's animation + +#ref GetTileAnimationLength diff --git a/doc/files/settileanimationspeed.html b/doc/files/settileanimationspeed.html new file mode 100644 index 0000000..027f3d1 --- /dev/null +++ b/doc/files/settileanimationspeed.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the speed of a tile's animation +
+Related: + GetTileAnimationSpeed +
++ + + \ No newline at end of file diff --git a/doc/files/settileanimationspeed.txt b/doc/files/settileanimationspeed.txt new file mode 100644 index 0000000..b767b1a --- /dev/null +++ b/doc/files/settileanimationspeed.txt @@ -0,0 +1,6 @@ +#title SetTileAnimationSpeed [RCBasic Doc] +#header Sub SetTileAnimationSpeed(tileset, base_tile, speed) + +Sets the speed of a tile's animation + +#ref GetTileAnimationSpeed diff --git a/doc/files/settilemapsize.html b/doc/files/settilemapsize.html new file mode 100644 index 0000000..5aedd8d --- /dev/null +++ b/doc/files/settilemapsize.html @@ -0,0 +1,21 @@ + + +
+ + ++ Resize a tile map +
+Related: + CreateTileMap + GetTileMapSize +
++ + + \ No newline at end of file diff --git a/doc/files/settilemapsize.txt b/doc/files/settilemapsize.txt new file mode 100644 index 0000000..c1e7e3e --- /dev/null +++ b/doc/files/settilemapsize.txt @@ -0,0 +1,6 @@ +#title SetTileMapSize [RCBasic Doc] +#header Sub SetTileMapSize(tilemap, widthInTiles, heightInTiles) + +Resize a tile map + +#ref CreateTileMap GetTileMapSize diff --git a/doc/files/setup.html b/doc/files/setup.html new file mode 100644 index 0000000..472dfec --- /dev/null +++ b/doc/files/setup.html @@ -0,0 +1,60 @@ + + +
+ + ++ 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. +
++
+ 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. +
++
+ rcbasic_build myprogram.bas
+
+ Once you have a *.cbc file you can pass it to rcbasic to run it. +
+
+ rcbasic 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
+
+
+ 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/files/setup.txt b/doc/files/setup.txt new file mode 100644 index 0000000..f8fe786 --- /dev/null +++ b/doc/files/setup.txt @@ -0,0 +1,46 @@ +#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. + +
+ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/setvideodrawrect.txt b/doc/files/setvideodrawrect.txt new file mode 100644 index 0000000..9c7b6d0 --- /dev/null +++ b/doc/files/setvideodrawrect.txt @@ -0,0 +1,6 @@ +#title SetVideoDrawRect [RCBasic Doc] +#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.html b/doc/files/setvideoposition.html new file mode 100644 index 0000000..b9864fc --- /dev/null +++ b/doc/files/setvideoposition.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the position within the current video in milliseconds +
+Related: + GetVideoPosition +
++ + + \ No newline at end of file diff --git a/doc/files/setvideoposition.txt b/doc/files/setvideoposition.txt new file mode 100644 index 0000000..53d0f61 --- /dev/null +++ b/doc/files/setvideoposition.txt @@ -0,0 +1,6 @@ +#title SetVideoPosition [RCBasic Doc] +#header sub SetVideoPosition(pos) + +Sets the position within the current video in milliseconds + +#ref GetVideoPosition diff --git a/doc/files/setvideovolume.html b/doc/files/setvideovolume.html new file mode 100644 index 0000000..3315799 --- /dev/null +++ b/doc/files/setvideovolume.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the volume of the video track +
++ + + \ No newline at end of file diff --git a/doc/files/setvideovolume.txt b/doc/files/setvideovolume.txt new file mode 100644 index 0000000..3615e0d --- /dev/null +++ b/doc/files/setvideovolume.txt @@ -0,0 +1,4 @@ +#title SetVideoVolume [RCBasic Doc] +#header sub SetVideoVolume( vol ) + +Sets the volume of the video track diff --git a/doc/files/setwatercolor.html b/doc/files/setwatercolor.html new file mode 100644 index 0000000..c5e2f82 --- /dev/null +++ b/doc/files/setwatercolor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setwatercolorblendfactor.html b/doc/files/setwatercolorblendfactor.html new file mode 100644 index 0000000..864ce48 --- /dev/null +++ b/doc/files/setwatercolorblendfactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setwaterwaveheight.html b/doc/files/setwaterwaveheight.html new file mode 100644 index 0000000..015f34f --- /dev/null +++ b/doc/files/setwaterwaveheight.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setwaterwinddirection.html b/doc/files/setwaterwinddirection.html new file mode 100644 index 0000000..dd717fc --- /dev/null +++ b/doc/files/setwaterwinddirection.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setwaterwindforce.html b/doc/files/setwaterwindforce.html new file mode 100644 index 0000000..7c81415 --- /dev/null +++ b/doc/files/setwaterwindforce.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setwindowalwaysontop.html b/doc/files/setwindowalwaysontop.html new file mode 100644 index 0000000..51cd0a2 --- /dev/null +++ b/doc/files/setwindowalwaysontop.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the window as the highest priority on the display. +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowalwaysontop.txt b/doc/files/setwindowalwaysontop.txt new file mode 100644 index 0000000..444102d --- /dev/null +++ b/doc/files/setwindowalwaysontop.txt @@ -0,0 +1,4 @@ +#title SetWindowAlwaysOnTop [RCBasic Doc] +#header sub SetWindowAlwaysOnTop( flag ) + +Sets the window as the highest priority on the display. diff --git a/doc/files/setwindowautoclose.html b/doc/files/setwindowautoclose.html new file mode 100644 index 0000000..cae6f61 --- /dev/null +++ b/doc/files/setwindowautoclose.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets whether the close button on the window closes it. +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowautoclose.txt b/doc/files/setwindowautoclose.txt new file mode 100644 index 0000000..56dcf92 --- /dev/null +++ b/doc/files/setwindowautoclose.txt @@ -0,0 +1,4 @@ +#title SetWindowAutoClose [RCBasic Doc] +#header sub SetWindowAutoClose( exit_on_close ) + +Sets whether the close button on the window closes it. diff --git a/doc/files/setwindowbordered.html b/doc/files/setwindowbordered.html new file mode 100644 index 0000000..838eee9 --- /dev/null +++ b/doc/files/setwindowbordered.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether the window has a border or not. +
+Related: + WindowIsBordered +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowbordered.txt b/doc/files/setwindowbordered.txt new file mode 100644 index 0000000..d01da10 --- /dev/null +++ b/doc/files/setwindowbordered.txt @@ -0,0 +1,6 @@ +#title SetWindowBordered [RCBasic Doc] +#header sub SetWindowBordered( flag) + +Sets whether the window has a border or not. + +#ref WindowIsBordered diff --git a/doc/files/setwindowfullscreen.html b/doc/files/setwindowfullscreen.html new file mode 100644 index 0000000..f853b17 --- /dev/null +++ b/doc/files/setwindowfullscreen.html @@ -0,0 +1,17 @@ + + +
+ + ++ You will never guess what this does +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowfullscreen.txt b/doc/files/setwindowfullscreen.txt new file mode 100644 index 0000000..b89ffd2 --- /dev/null +++ b/doc/files/setwindowfullscreen.txt @@ -0,0 +1,4 @@ +#title SetWindowFullscreen [RCBasic Doc] +#header sub SetWindowFullscreen( flag) + +You will never guess what this does diff --git a/doc/files/setwindowicon.html b/doc/files/setwindowicon.html new file mode 100644 index 0000000..daf713a --- /dev/null +++ b/doc/files/setwindowicon.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the icon that is displayed on the window border +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowicon.txt b/doc/files/setwindowicon.txt new file mode 100644 index 0000000..12ba367 --- /dev/null +++ b/doc/files/setwindowicon.txt @@ -0,0 +1,4 @@ +#title SetWindowIcon [RCBasic Doc] +#header sub SetWindowIcon( img ) + +Sets the icon that is displayed on the window border diff --git a/doc/files/setwindowmaxsize.html b/doc/files/setwindowmaxsize.html new file mode 100644 index 0000000..68bff67 --- /dev/null +++ b/doc/files/setwindowmaxsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the max size for a resizable window +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowmaxsize.txt b/doc/files/setwindowmaxsize.txt new file mode 100644 index 0000000..13f6edc --- /dev/null +++ b/doc/files/setwindowmaxsize.txt @@ -0,0 +1,4 @@ +#title SetWindowMaxSize [RCBasic Doc] +#header sub SetWindowMaxSize( w, h) + +Sets the max size for a resizable window diff --git a/doc/files/setwindowminsize.html b/doc/files/setwindowminsize.html new file mode 100644 index 0000000..17fcb12 --- /dev/null +++ b/doc/files/setwindowminsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the min size for a resizable window +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowminsize.txt b/doc/files/setwindowminsize.txt new file mode 100644 index 0000000..06988b5 --- /dev/null +++ b/doc/files/setwindowminsize.txt @@ -0,0 +1,4 @@ +#title SetWindowMinSize [RCBasic Doc] +#header sub SetWindowMinSize( w, h) + +Sets the min size for a resizable window diff --git a/doc/files/setwindowposition.html b/doc/files/setwindowposition.html new file mode 100644 index 0000000..2590838 --- /dev/null +++ b/doc/files/setwindowposition.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the position of the window on the display +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowposition.txt b/doc/files/setwindowposition.txt new file mode 100644 index 0000000..a8ee5f2 --- /dev/null +++ b/doc/files/setwindowposition.txt @@ -0,0 +1,4 @@ +#title SetWindowPosition [RCBasic Doc] +#header sub SetWindowPosition( x, y ) + +Sets the position of the window on the display diff --git a/doc/files/setwindowresizable.html b/doc/files/setwindowresizable.html new file mode 100644 index 0000000..fc79bf9 --- /dev/null +++ b/doc/files/setwindowresizable.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets whether or not a window is resizable +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowresizable.txt b/doc/files/setwindowresizable.txt new file mode 100644 index 0000000..cf1f85c --- /dev/null +++ b/doc/files/setwindowresizable.txt @@ -0,0 +1,4 @@ +#title SetWindowResizable [RCBasic Doc] +#header sub SetWindowResizable( flag ) + +Sets whether or not a window is resizable diff --git a/doc/files/setwindowsize.html b/doc/files/setwindowsize.html new file mode 100644 index 0000000..678bcc8 --- /dev/null +++ b/doc/files/setwindowsize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the size of a window +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowsize.txt b/doc/files/setwindowsize.txt new file mode 100644 index 0000000..aae9525 --- /dev/null +++ b/doc/files/setwindowsize.txt @@ -0,0 +1,4 @@ +#title SetWindowSize [RCBasic Doc] +#header sub SetWindowSize( w, h ) + +Sets the size of a window diff --git a/doc/files/setwindowtitle.html b/doc/files/setwindowtitle.html new file mode 100644 index 0000000..f4c8180 --- /dev/null +++ b/doc/files/setwindowtitle.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the title of the window +
++ + + \ No newline at end of file diff --git a/doc/files/setwindowtitle.txt b/doc/files/setwindowtitle.txt new file mode 100644 index 0000000..78e294c --- /dev/null +++ b/doc/files/setwindowtitle.txt @@ -0,0 +1,4 @@ +#title SetWindowTitle [RCBasic Doc] +#header sub SetWindowTitle( title$ ) + +Sets the title of the window diff --git a/doc/files/setwindowvsync.html b/doc/files/setwindowvsync.html new file mode 100644 index 0000000..2f311c1 --- /dev/null +++ b/doc/files/setwindowvsync.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setwindowvsync.txt b/doc/files/setwindowvsync.txt new file mode 100644 index 0000000..92ed922 --- /dev/null +++ b/doc/files/setwindowvsync.txt @@ -0,0 +1,4 @@ +#title SetWindowVSync [RCBasic Doc] +#header sub SetWindowVSync( flag ) + + diff --git a/doc/files/setworld2dautoclearforces.html b/doc/files/setworld2dautoclearforces.html new file mode 100644 index 0000000..8680f37 --- /dev/null +++ b/doc/files/setworld2dautoclearforces.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the auto clear forces flag for the active canvas +
+Related: + GetWorld2DAutoClearForces +
++ + + \ No newline at end of file diff --git a/doc/files/setworld2dautoclearforces.txt b/doc/files/setworld2dautoclearforces.txt new file mode 100644 index 0000000..f48ac1b --- /dev/null +++ b/doc/files/setworld2dautoclearforces.txt @@ -0,0 +1,6 @@ +#title SetWorld2DAutoClearForces [RCBasic Doc] +#header sub SetWorld2DAutoClearForces( flag ) + +Sets the auto clear forces flag for the active canvas + +#ref GetWorld2DAutoClearForces diff --git a/doc/files/setworld2dpositioniterations.html b/doc/files/setworld2dpositioniterations.html new file mode 100644 index 0000000..6da7829 --- /dev/null +++ b/doc/files/setworld2dpositioniterations.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of position iterations for the position constraint solver +
+Related: + GetWorld2DPositionIterations +
++ + + \ No newline at end of file diff --git a/doc/files/setworld2dpositioniterations.txt b/doc/files/setworld2dpositioniterations.txt new file mode 100644 index 0000000..abec6f0 --- /dev/null +++ b/doc/files/setworld2dpositioniterations.txt @@ -0,0 +1,6 @@ +#title SetWorld2DPositionIterations [RCBasic Doc] +#header sub SetWorld2DPositionIterations( p ) + +Sets the number of position iterations for the position constraint solver + +#ref GetWorld2DPositionIterations diff --git a/doc/files/setworld2dtimestep.html b/doc/files/setworld2dtimestep.html new file mode 100644 index 0000000..b26b8af --- /dev/null +++ b/doc/files/setworld2dtimestep.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the timestep for the active canvas +
+Related: + GetWorld2DTimeStep +
++ + + \ No newline at end of file diff --git a/doc/files/setworld2dtimestep.txt b/doc/files/setworld2dtimestep.txt new file mode 100644 index 0000000..dce5140 --- /dev/null +++ b/doc/files/setworld2dtimestep.txt @@ -0,0 +1,6 @@ +#title SetWorld2DTimeStep [RCBasic Doc] +#header sub SetWorld2DTimeStep( ts ) + +Sets the timestep for the active canvas + +#ref GetWorld2DTimeStep diff --git a/doc/files/setworld2dvelocityiterations.html b/doc/files/setworld2dvelocityiterations.html new file mode 100644 index 0000000..7ff62a1 --- /dev/null +++ b/doc/files/setworld2dvelocityiterations.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets the number of velocity iterations for the velocity constraint solver +
+Related: + GetWorld2DVelocityIterations +
++ + + \ No newline at end of file diff --git a/doc/files/setworld2dvelocityiterations.txt b/doc/files/setworld2dvelocityiterations.txt new file mode 100644 index 0000000..4a43ebd --- /dev/null +++ b/doc/files/setworld2dvelocityiterations.txt @@ -0,0 +1,6 @@ +#title SetWorld2DVelocityIterations [RCBasic Doc] +#header sub SetWorld2DVelocityIterations( v ) + +Sets the number of velocity iterations for the velocity constraint solver + +#ref GetWorld2DVelocityIterations diff --git a/doc/files/setworld3ddeltatime.html b/doc/files/setworld3ddeltatime.html new file mode 100644 index 0000000..907b8c0 --- /dev/null +++ b/doc/files/setworld3ddeltatime.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/setworld3dmaxsubsteps.html b/doc/files/setworld3dmaxsubsteps.html new file mode 100644 index 0000000..dab9c54 --- /dev/null +++ b/doc/files/setworld3dmaxsubsteps.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetWorld3DMaxTimeStep +
++ + + \ No newline at end of file diff --git a/doc/files/setworld3dmaxsubsteps.txt b/doc/files/setworld3dmaxsubsteps.txt new file mode 100644 index 0000000..4b6d41e --- /dev/null +++ b/doc/files/setworld3dmaxsubsteps.txt @@ -0,0 +1,8 @@ +#title SetWorld3DMaxSubSteps [RCBasic Doc] +#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.html b/doc/files/setworld3dtimestep.html new file mode 100644 index 0000000..ac1a233 --- /dev/null +++ b/doc/files/setworld3dtimestep.html @@ -0,0 +1,23 @@ + + +
+ + ++ 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. +
+Related: + SetWorld3DMaxSubSteps +
++ + + \ No newline at end of file diff --git a/doc/files/setworld3dtimestep.txt b/doc/files/setworld3dtimestep.txt new file mode 100644 index 0000000..6169c85 --- /dev/null +++ b/doc/files/setworld3dtimestep.txt @@ -0,0 +1,8 @@ +#title SetWorld3DTimeStep [RCBasic Doc] +#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.html b/doc/files/showmouse.html new file mode 100644 index 0000000..8e4974b --- /dev/null +++ b/doc/files/showmouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the mouse cursor visible +
++ + + \ No newline at end of file diff --git a/doc/files/showmouse.txt b/doc/files/showmouse.txt new file mode 100644 index 0000000..fc6c9f2 --- /dev/null +++ b/doc/files/showmouse.txt @@ -0,0 +1,4 @@ +#title ShowMouse [RCBasic Doc] +#header sub ShowMouse() + +Sets the mouse cursor visible diff --git a/doc/files/showwindow.html b/doc/files/showwindow.html new file mode 100644 index 0000000..080d503 --- /dev/null +++ b/doc/files/showwindow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sets the window visible +
++ + + \ No newline at end of file diff --git a/doc/files/showwindow.txt b/doc/files/showwindow.txt new file mode 100644 index 0000000..2e15a70 --- /dev/null +++ b/doc/files/showwindow.txt @@ -0,0 +1,4 @@ +#title ShowWindow [RCBasic Doc] +#header sub ShowWindow( ) + +Sets the window visible diff --git a/doc/files/sign.html b/doc/files/sign.html new file mode 100644 index 0000000..272b35d --- /dev/null +++ b/doc/files/sign.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns the sign of a number +
++ n < 0 returns -1 n = 0 returns 0 n > 0 returns 1 +
++ + + \ No newline at end of file diff --git a/doc/files/sign.txt b/doc/files/sign.txt new file mode 100644 index 0000000..4d9b649 --- /dev/null +++ b/doc/files/sign.txt @@ -0,0 +1,8 @@ +#title Sign [RCBasic Doc] +#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.html b/doc/files/sin.html new file mode 100644 index 0000000..62e7947 --- /dev/null +++ b/doc/files/sin.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the sine of angle n +
++ + + \ No newline at end of file diff --git a/doc/files/sin.txt b/doc/files/sin.txt new file mode 100644 index 0000000..99fcd02 --- /dev/null +++ b/doc/files/sin.txt @@ -0,0 +1,4 @@ +#title Sin [RCBasic Doc] +#header function Sin(n) + +Returns the sine of angle n diff --git a/doc/files/size.html b/doc/files/size.html new file mode 100644 index 0000000..3fd05dc --- /dev/null +++ b/doc/files/size.html @@ -0,0 +1,24 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/size.txt b/doc/files/size.txt new file mode 100644 index 0000000..b4c4518 --- /dev/null +++ b/doc/files/size.txt @@ -0,0 +1,8 @@ +#title Size [RCBasic Doc] +#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.html b/doc/files/solvematrix.html new file mode 100644 index 0000000..597d09e --- /dev/null +++ b/doc/files/solvematrix.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/solvematrix.txt b/doc/files/solvematrix.txt new file mode 100644 index 0000000..9b8bd93 --- /dev/null +++ b/doc/files/solvematrix.txt @@ -0,0 +1,6 @@ +#title SolveMatrix [RCBasic Doc] +#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/sound.html b/doc/files/sound.html new file mode 100644 index 0000000..8c1aeb4 --- /dev/null +++ b/doc/files/sound.html @@ -0,0 +1,37 @@ + + +
+ + ++ Loading sound and music is fairly straight forward. The big difference between sounds and music is that your program can only have one music track but you could have several sound tracks at once. +
++ Lets first go over loading and playing sounds. +
+
+ snd = LoadSound("MySound.wav") 'Load a sound file
+ PlaySound(snd, 1, 3) 'Play the sound loaded in snd on channel 1 for 3 loops
+
+ There is a lot you can do with sounds when playing them including simulating 3D positional audio. I highly encourage you to play around with the audio to find the right mix for your project. +
++ There is only 1 music track that can be loaded at one time. Loading and playing music is pretty straight forward. +
+
+ LoadMusic ( "MYMUSIC.MP3" )
+ PlayMusic ( -1 ) 'Setting the music loop to -1 will have it loop infinitely
+
+ 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/files/sound.txt b/doc/files/sound.txt new file mode 100644 index 0000000..8fb64bc --- /dev/null +++ b/doc/files/sound.txt @@ -0,0 +1,22 @@ +#title RCBasic Sound [RCBasic Doc] +#header SOUND + +Loading sound and music is fairly straight forward. The big difference between sounds and music is that your program can only have one music track but you could have several sound tracks at once. + +Lets first go over loading and playing sounds. +#code +snd = LoadSound("MySound.wav") 'Load a sound file +PlaySound(snd, 1, 3) 'Play the sound loaded in snd on channel 1 for 3 loops +#/code + +There is a lot you can do with sounds when playing them including simulating 3D positional audio. I highly encourage you to play around with the audio to find the right mix for your project. + + +There is only 1 music track that can be loaded at one time. Loading and playing music is pretty straight forward. + +#code +LoadMusic ( "MYMUSIC.MP3" ) +PlayMusic ( -1 ) 'Setting the music loop to -1 will have it loop infinitely +#/code + +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. diff --git a/doc/files/soundexists.html b/doc/files/soundexists.html new file mode 100644 index 0000000..263c791 --- /dev/null +++ b/doc/files/soundexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/soundexists.txt b/doc/files/soundexists.txt new file mode 100644 index 0000000..43304d5 --- /dev/null +++ b/doc/files/soundexists.txt @@ -0,0 +1,4 @@ +#title SoundExists [RCBasic Doc] +#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.html b/doc/files/soundisenabled.html new file mode 100644 index 0000000..b74f6b6 --- /dev/null +++ b/doc/files/soundisenabled.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the audio subsystem has been initialized. +
++ + + \ No newline at end of file diff --git a/doc/files/soundisenabled.txt b/doc/files/soundisenabled.txt new file mode 100644 index 0000000..d9716eb --- /dev/null +++ b/doc/files/soundisenabled.txt @@ -0,0 +1,4 @@ +#title SoundIsEnabled [RCBasic Doc] +#header function SoundIsEnabled() + +Returns true if the audio subsystem has been initialized. diff --git a/doc/files/spriteanimationisplaying.html b/doc/files/spriteanimationisplaying.html new file mode 100644 index 0000000..6c7540b --- /dev/null +++ b/doc/files/spriteanimationisplaying.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/spriteanimationisplaying.txt b/doc/files/spriteanimationisplaying.txt new file mode 100644 index 0000000..6cf944c --- /dev/null +++ b/doc/files/spriteanimationisplaying.txt @@ -0,0 +1,4 @@ +#title SpriteAnimationIsPlaying [RCBasic Doc] +#header Function SpriteAnimationIsPlaying(sprite) + + diff --git a/doc/files/spriteheight.html b/doc/files/spriteheight.html new file mode 100644 index 0000000..8127675 --- /dev/null +++ b/doc/files/spriteheight.html @@ -0,0 +1,64 @@ + + +
+ + ++ Returns the frame height of a sprite +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SpriteHeight", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eSpriteHeight
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ eSpriteHeight = SpriteHeight(eyeSprite)
+
+ While Not Key(K_ESCAPE)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("EyeSprite Height " + STR$(eSpriteHeight), 10, 50)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + SpriteWidth + GetSpriteSize +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/spriteheight.txt b/doc/files/spriteheight.txt
new file mode 100644
index 0000000..92dbbe3
--- /dev/null
+++ b/doc/files/spriteheight.txt
@@ -0,0 +1,53 @@
+#title SpriteHeight [RCBasic Doc]
+#header Function SpriteHeight(sprite)
+
+Returns the frame height of a sprite
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("SpriteHeight", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eSpriteHeight
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, 100, 100)
+
+eSpriteHeight = SpriteHeight(eyeSprite)
+
+While Not Key(K_ESCAPE)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("EyeSprite Height " + STR$(eSpriteHeight), 10, 50)
+
+ Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref SpriteWidth GetSpriteSize
+
diff --git a/doc/files/spriteisawake.html b/doc/files/spriteisawake.html
new file mode 100644
index 0000000..33ed561
--- /dev/null
+++ b/doc/files/spriteisawake.html
@@ -0,0 +1,22 @@
+
+
+
+ Wakes a sleeping sprite +
+Related: + SetSpriteAwake + SpriteIsSleepAllowed + SetSpriteSleepAllowed +
++ + + \ No newline at end of file diff --git a/doc/files/spriteisawake.txt b/doc/files/spriteisawake.txt new file mode 100644 index 0000000..d67101f --- /dev/null +++ b/doc/files/spriteisawake.txt @@ -0,0 +1,6 @@ +#title spriteIsAwake [RCBasic Doc] +#header function spriteIsAwake( spr_id) + +Wakes a sleeping sprite + +#ref SetSpriteAwake SpriteIsSleepAllowed SetSpriteSleepAllowed diff --git a/doc/files/spriteisbullet.html b/doc/files/spriteisbullet.html new file mode 100644 index 0000000..7fd5e31 --- /dev/null +++ b/doc/files/spriteisbullet.html @@ -0,0 +1,23 @@ + + +
+ + ++ Returns whether body has continuous collision detection +
++ Note: Useful for fast moving objects +
+Related: + SetSpriteBullet +
++ + + \ No newline at end of file diff --git a/doc/files/spriteisbullet.txt b/doc/files/spriteisbullet.txt new file mode 100644 index 0000000..992041c --- /dev/null +++ b/doc/files/spriteisbullet.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/spriteisfixedrotation.html new file mode 100644 index 0000000..4fb0098 --- /dev/null +++ b/doc/files/spriteisfixedrotation.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns whether fixed rotation is set on the sprite +
+Related: + SetSpriteFixedRotation +
++ + + \ No newline at end of file diff --git a/doc/files/spriteisfixedrotation.txt b/doc/files/spriteisfixedrotation.txt new file mode 100644 index 0000000..82a8830 --- /dev/null +++ b/doc/files/spriteisfixedrotation.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/spriteissolid.html new file mode 100644 index 0000000..cfc65d9 --- /dev/null +++ b/doc/files/spriteissolid.html @@ -0,0 +1,65 @@ + + +
+ + ++ Returns true if a sprite is has physics and collision response enabled +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SpriteIsSolid", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM trigger : trigger = 0
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ eyeSprite2X = 400
+ eyeSprite2Y = 125
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ SetSpriteSolid(eyeSprite, 1) 'Setting the sprites as solid means they can collide with one another.
+
+ eyeSprite2 = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y)
+ SetSpriteSolid(eyeSprite2, 1)
+
+ While Not Key(K_ESCAPE)
+
+ SetSpriteLinearVelocity(eyeSprite, 30, 0)
+ eyeSpriteX = eyeSpriteX + 0.5
+
+ If SpriteIsSolid(eyeSprite2) And trigger = 0 Then
+ Print "Yup I'm solid!"
+ trigger = 1
+ End If
+ Update()
+ Wend
+
Related: + SetSpriteSolid +
++ + + \ No newline at end of file diff --git a/doc/files/spriteissolid.txt b/doc/files/spriteissolid.txt new file mode 100644 index 0000000..f11e968 --- /dev/null +++ b/doc/files/spriteissolid.txt @@ -0,0 +1,53 @@ +#title SpriteIsSolid [RCBasic Doc] +#header Function SpriteIsSolid(sprite) + +Returns true if a sprite is has physics and collision response enabled + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SpriteIsSolid", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +DIM trigger : trigger = 0 +eyeSpriteX = 100 +eyeSpriteY = 100 +eyeSprite2X = 400 +eyeSprite2Y = 125 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY) +SetSpriteSolid(eyeSprite, 1) 'Setting the sprites as solid means they can collide with one another. + +eyeSprite2 = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite2, eyeSprite2X, eyeSprite2Y) +SetSpriteSolid(eyeSprite2, 1) + +While Not Key(K_ESCAPE) + + SetSpriteLinearVelocity(eyeSprite, 30, 0) + eyeSpriteX = eyeSpriteX + 0.5 + + If SpriteIsSolid(eyeSprite2) And trigger = 0 Then + Print "Yup I'm solid!" + trigger = 1 + End If + Update() +Wend +#/code + +#image "images/theEye.png" + +#ref SetSpriteSolid diff --git a/doc/files/spriteisvisible.html b/doc/files/spriteisvisible.html new file mode 100644 index 0000000..c10a10b --- /dev/null +++ b/doc/files/spriteisvisible.html @@ -0,0 +1,61 @@ + + +
+ + ++ Returns whether the sprite is visible +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SetSpriteVisible", winWidth, winHeight, isFullScreen, vSync)
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM spriteTimer : spriteTimer = Timer()
+ DIM spriteTimerDiff : spriteTimerDiff = 2000
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+ SetSpriteVisible(eyeSprite, 0) 'Set the flag to 0 for not visible
+
+
+ While Not Key(K_ESCAPE)
+ If Timer() - spriteTimer > spriteTimerDiff Then
+ SetSpriteVisible(eyeSprite, 1)
+ Print ("Function Called")
+ End If
+
+ If SpriteIsVisible(eyeSprite) Then
+ Print ("Sprite is Visible")
+ else
+ Print ("Sprite is not visible")
+ End If
+ Update()
+ Wend
+
Related: + SetSpriteVisible +
++ + + \ No newline at end of file diff --git a/doc/files/spriteisvisible.txt b/doc/files/spriteisvisible.txt new file mode 100644 index 0000000..ea784c1 --- /dev/null +++ b/doc/files/spriteisvisible.txt @@ -0,0 +1,49 @@ +#title SpriteIsVisible [RCBasic Doc] +#header Function SpriteIsVisible(sprite) + +Returns whether the sprite is visible + +#code +isFullScreen = false +vSync = true +winWidth = 640 +winHeight = 480 +canViewPortX = 0 +canViewPortY = 0 + +OpenWindow("SetSpriteVisible", winWidth, winHeight, isFullScreen, vSync) +sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight) +Canvas(sCanvas) + +DIM eye +DIM eyeW +DIM eyeH +DIM spriteTimer : spriteTimer = Timer() +DIM spriteTimerDiff : spriteTimerDiff = 2000 + +eye = LoadImage("theEye.png") +GetImageSize(eye, eyeW, eyeH) + +eyeSprite = CreateSprite(eye, eyeW, eyeH) +SetSpritePosition(eyeSprite, 100, 100) +SetSpriteVisible(eyeSprite, 0) 'Set the flag to 0 for not visible + + +While Not Key(K_ESCAPE) + If Timer() - spriteTimer > spriteTimerDiff Then + SetSpriteVisible(eyeSprite, 1) + Print ("Function Called") + End If + + If SpriteIsVisible(eyeSprite) Then + Print ("Sprite is Visible") + else + Print ("Sprite is not visible") + End If + Update() +Wend +#/code + +#image "images/theEye.png" + +#ref SetSpriteVisible diff --git a/doc/files/spritesleepallowed.html b/doc/files/spritesleepallowed.html new file mode 100644 index 0000000..8b11273 --- /dev/null +++ b/doc/files/spritesleepallowed.html @@ -0,0 +1,22 @@ + + +
+ + ++ Whether the body is allowed to go to sleep when it's at rest +
+Related: + SetSpriteSleepAllowed + SpriteIsAwake + SetSpriteAwake +
++ + + \ No newline at end of file diff --git a/doc/files/spritesleepallowed.txt b/doc/files/spritesleepallowed.txt new file mode 100644 index 0000000..4e2bcb3 --- /dev/null +++ b/doc/files/spritesleepallowed.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/spritewidth.html new file mode 100644 index 0000000..cc0361c --- /dev/null +++ b/doc/files/spritewidth.html @@ -0,0 +1,64 @@ + + +
+ + ++ Returns the frame width of a sprite +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SpriteWidth", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eSpriteWidth
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+
+ eSpriteWidth = SpriteWidth(eyeSprite)
+
+ While Not Key(K_ESCAPE)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("EyeSprite Width " + STR$(eSpriteWidth), 10, 30)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + SpriteHeight + GetSpriteSize +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/spritewidth.txt b/doc/files/spritewidth.txt
new file mode 100644
index 0000000..0de5f6a
--- /dev/null
+++ b/doc/files/spritewidth.txt
@@ -0,0 +1,52 @@
+#title SpriteWidth [RCBasic Doc]
+#header Function SpriteWidth(sprite)
+
+Returns the frame width of a sprite
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("SpriteWidth", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eSpriteWidth
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, 100, 100)
+
+eSpriteWidth = SpriteWidth(eyeSprite)
+
+While Not Key(K_ESCAPE)
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("EyeSprite Width " + STR$(eSpriteWidth), 10, 30)
+
+ Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref SpriteHeight GetSpriteSize
diff --git a/doc/files/spritex.html b/doc/files/spritex.html
new file mode 100644
index 0000000..a95094a
--- /dev/null
+++ b/doc/files/spritex.html
@@ -0,0 +1,82 @@
+
+
+
+ Returns the X position of a sprite on a canvas +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SpriteX", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeX 'Variables to pass into the function for holding the x value
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ destX = 0
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+
+ While Not Key(K_ESCAPE)
+ clearcanvas()
+ Canvas(sCanvas) 'change to the sprite canvas for drawing sprites
+ If SpriteX(eyeSprite) < 450 And destX = 0 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX + 0.5
+ ElseIf SpriteX(eyeSprite) >= 440 And destX = 0 Then
+ destX = 1
+ 'eyeSpriteX = SpriteX(eyeSprite)
+ End If
+
+ If destX = 1 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX - 0.5
+ End If
+
+ Canvas(pCanvas)
+ eyeX = SpriteX(eyeSprite) 'change to the standard drawing canvas for drawing text
+ DrawText("Sprite X: " + STR$(eyeX), 10, 30)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + SpriteY + SetSpritePosition + GetSpritePosition +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/spritex.txt b/doc/files/spritex.txt
new file mode 100644
index 0000000..da1d886
--- /dev/null
+++ b/doc/files/spritex.txt
@@ -0,0 +1,70 @@
+#title SpriteX [RCBasic Doc]
+#header Function SpriteX(sprite)
+
+Returns the X position of a sprite on a canvas
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("SpriteX", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eyeX 'Variables to pass into the function for holding the x value
+eyeSpriteX = 100
+eyeSpriteY = 100
+destX = 0
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+
+While Not Key(K_ESCAPE)
+clearcanvas()
+Canvas(sCanvas) 'change to the sprite canvas for drawing sprites
+If SpriteX(eyeSprite) < 450 And destX = 0 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX + 0.5
+ElseIf SpriteX(eyeSprite) >= 440 And destX = 0 Then
+ destX = 1
+ 'eyeSpriteX = SpriteX(eyeSprite)
+End If
+
+If destX = 1 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteX = eyeSpriteX - 0.5
+End If
+
+Canvas(pCanvas)
+eyeX = SpriteX(eyeSprite) 'change to the standard drawing canvas for drawing text
+DrawText("Sprite X: " + STR$(eyeX), 10, 30)
+
+Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref SpriteY SetSpritePosition GetSpritePosition
+
diff --git a/doc/files/spritey.html b/doc/files/spritey.html
new file mode 100644
index 0000000..40512fa
--- /dev/null
+++ b/doc/files/spritey.html
@@ -0,0 +1,82 @@
+
+
+
+ Returns the Y position of a sprite on a canvas +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("SpriteY", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeY 'Variables to pass into the function for holding the y value
+ eyeSpriteX = 100
+ eyeSpriteY = 100
+ destY = 0
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+
+ While Not Key(K_ESCAPE)
+ clearcanvas()
+ Canvas(sCanvas) 'change to the sprite canvas for drawing sprites
+ If SpriteY(eyeSprite) < 450 And destY = 0 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteY = eyeSpriteY + 0.5
+ ElseIf SpriteY(eyeSprite) >= 440 And destY = 0 Then
+ destY = 1
+ End If
+
+ If destY = 1 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteY = eyeSpriteY - 0.5
+ End If
+
+ Canvas(pCanvas)
+ eyeY = SpriteY(eyeSprite) 'change to the standard drawing canvas for drawing text
+ DrawText("Sprite Y: " + STR$(eyeY), 10, 30)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + SpriteX + SetSpritePosition + GetSpritePosition + SpriteX +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/spritey.txt b/doc/files/spritey.txt
new file mode 100644
index 0000000..1e4de30
--- /dev/null
+++ b/doc/files/spritey.txt
@@ -0,0 +1,68 @@
+#title SpriteY [RCBasic Doc]
+#header Function SpriteY(sprite)
+
+Returns the Y position of a sprite on a canvas
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("SpriteY", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eyeY 'Variables to pass into the function for holding the y value
+eyeSpriteX = 100
+eyeSpriteY = 100
+destY = 0
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+
+While Not Key(K_ESCAPE)
+clearcanvas()
+Canvas(sCanvas) 'change to the sprite canvas for drawing sprites
+If SpriteY(eyeSprite) < 450 And destY = 0 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteY = eyeSpriteY + 0.5
+ElseIf SpriteY(eyeSprite) >= 440 And destY = 0 Then
+ destY = 1
+End If
+
+If destY = 1 Then
+ SetSpritePosition(eyeSprite, eyeSpriteX, eyeSpriteY)
+ eyeSpriteY = eyeSpriteY - 0.5
+End If
+
+Canvas(pCanvas)
+eyeY = SpriteY(eyeSprite) 'change to the standard drawing canvas for drawing text
+DrawText("Sprite Y: " + STR$(eyeY), 10, 30)
+
+Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref SpriteX SetSpritePosition GetSpritePosition SpriteX
diff --git a/doc/files/spritez.html b/doc/files/spritez.html
new file mode 100644
index 0000000..09bac66
--- /dev/null
+++ b/doc/files/spritez.html
@@ -0,0 +1,83 @@
+
+
+
+ Returns the drawing priority for sprites. +
++ Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top +
+
+ isFullScreen = false
+ vSync = true
+ winWidth = 640
+ winHeight = 480
+ canViewPortX = 0
+ canViewPortY = 0
+
+ OpenWindow("ScaleSprite", winWidth, winHeight, isFullScreen, vSync)
+ pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+ sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+ Canvas(sCanvas)
+
+ DIM eye
+ DIM eyeW
+ DIM eyeH
+ DIM eyeZ
+ DIM sword
+ DIM swordW
+ DIM swordH
+ DIM swordZ
+ ReleaseKey = 0
+
+ DIM font1
+
+ Font1 = LoadFont("DripOctober.ttf", 16)
+ SetFont(Font1)
+ SetColor(RGB(100, 200, 200))
+
+ eye = LoadImage("theEye.png")
+ GetImageSize(eye, eyeW, eyeH)
+
+ sword = LoadImage("sword.png")
+ GetImageSize(sword, swordW, swordH)
+
+ eyeSprite = CreateSprite(eye, eyeW, eyeH)
+ SetSpritePosition(eyeSprite, 100, 100)
+ SetSpriteZ(eyeSprite, 1)
+
+ swordSprite = CreateSprite(sword, swordW, swordH)
+ SetSpritePosition(swordSprite, 89, 75)
+ SetSpriteZ(swordSprite, 5)
+
+ While Not Key(K_ESCAPE)
+
+ swordZ = SpriteZ(swordSprite)
+ eyeZ = SpriteZ(eyeSprite)
+
+ Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+ DrawText("Eye Sprite Z: " + STR$(eyeZ), 10, 30)
+ DrawText("Sword Sprite Z: " + STR$(swordZ), 10, 50)
+
+ Update()
+ Wend
+
+
Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
Related: + SetSpriteZ +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/spritez.txt b/doc/files/spritez.txt
new file mode 100644
index 0000000..a771676
--- /dev/null
+++ b/doc/files/spritez.txt
@@ -0,0 +1,72 @@
+#title SpriteZ [RCBasic Doc]
+#header Function SpriteZ(sprite)
+
+Returns the drawing priority for sprites.
+
+Note: Sprites with a higher Z order are drawn first and those with lower values will be drawn on top
+
+#code
+isFullScreen = false
+vSync = true
+winWidth = 640
+winHeight = 480
+canViewPortX = 0
+canViewPortY = 0
+
+OpenWindow("ScaleSprite", winWidth, winHeight, isFullScreen, vSync)
+pCanvas = OpenCanvas(200, 80, 0, 0, 200, 80, 1) 'Need to open a canvas for drawing the text
+sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
+Canvas(sCanvas)
+
+DIM eye
+DIM eyeW
+DIM eyeH
+DIM eyeZ
+DIM sword
+DIM swordW
+DIM swordH
+DIM swordZ
+ReleaseKey = 0
+
+DIM font1
+
+Font1 = LoadFont("DripOctober.ttf", 16)
+SetFont(Font1)
+SetColor(RGB(100, 200, 200))
+
+eye = LoadImage("theEye.png")
+GetImageSize(eye, eyeW, eyeH)
+
+sword = LoadImage("sword.png")
+GetImageSize(sword, swordW, swordH)
+
+eyeSprite = CreateSprite(eye, eyeW, eyeH)
+SetSpritePosition(eyeSprite, 100, 100)
+SetSpriteZ(eyeSprite, 1)
+
+swordSprite = CreateSprite(sword, swordW, swordH)
+SetSpritePosition(swordSprite, 89, 75)
+SetSpriteZ(swordSprite, 5)
+
+While Not Key(K_ESCAPE)
+
+swordZ = SpriteZ(swordSprite)
+eyeZ = SpriteZ(eyeSprite)
+
+Canvas(pCanvas) 'change to the standard drawing canvas for drawing text
+DrawText("Eye Sprite Z: " + STR$(eyeZ), 10, 30)
+DrawText("Sword Sprite Z: " + STR$(swordZ), 10, 50)
+
+Update()
+Wend
+#/code
+
+#image "images/theEye.png"
+
+#image "images/sword.png"
+
+
+Link to Font (It's locally on your computer, your not downloading anything from the internet)
+
+
+#ref SetSpriteZ
diff --git a/doc/files/sqrt.html b/doc/files/sqrt.html
new file mode 100644
index 0000000..58e9a70
--- /dev/null
+++ b/doc/files/sqrt.html
@@ -0,0 +1,17 @@
+
+
+
+ Returns the square root of n +
++ + + \ No newline at end of file diff --git a/doc/files/sqrt.txt b/doc/files/sqrt.txt new file mode 100644 index 0000000..2665f91 --- /dev/null +++ b/doc/files/sqrt.txt @@ -0,0 +1,4 @@ +#title Sqrt [RCBasic Doc] +#header function Sqrt(n) + +Returns the square root of n diff --git a/doc/files/squarematrix.html b/doc/files/squarematrix.html new file mode 100644 index 0000000..8a30349 --- /dev/null +++ b/doc/files/squarematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores the square of matrix mA in the matrix mB +
++ + + \ No newline at end of file diff --git a/doc/files/squarematrix.txt b/doc/files/squarematrix.txt new file mode 100644 index 0000000..7f92595 --- /dev/null +++ b/doc/files/squarematrix.txt @@ -0,0 +1,4 @@ +#title SquareMatrix [RCBasic Doc] +#header function SquareMatrix(mA, mB) + +Stores the square of matrix mA in the matrix mB diff --git a/doc/files/stack_size_n.html b/doc/files/stack_size_n.html new file mode 100644 index 0000000..d2eb11d --- /dev/null +++ b/doc/files/stack_size_n.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of elements on a number stack +
++ + + \ No newline at end of file diff --git a/doc/files/stack_size_n.txt b/doc/files/stack_size_n.txt new file mode 100644 index 0000000..834e08b --- /dev/null +++ b/doc/files/stack_size_n.txt @@ -0,0 +1,4 @@ +#title Stack_Size_N [RCBasic Doc] +#header function Stack_Size_N( num_stack ) + +Returns the number of elements on a number stack diff --git a/doc/files/stack_size_s.html b/doc/files/stack_size_s.html new file mode 100644 index 0000000..2aba495 --- /dev/null +++ b/doc/files/stack_size_s.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of elements on a string stack +
++ + + \ No newline at end of file diff --git a/doc/files/stack_size_s.txt b/doc/files/stack_size_s.txt new file mode 100644 index 0000000..2f4651e --- /dev/null +++ b/doc/files/stack_size_s.txt @@ -0,0 +1,4 @@ +#title Stack_Size_S [RCBasic Doc] +#header function Stack_Size_S( str_stack ) + +Returns the number of elements on a string stack diff --git a/doc/files/startactortransition.html b/doc/files/startactortransition.html new file mode 100644 index 0000000..e71ec89 --- /dev/null +++ b/doc/files/startactortransition.html @@ -0,0 +1,37 @@ + + +
+ + ++ Starts an actor transition from its current frame in an animation to a specified frame +
+Related: + StopActorTransition + ActorIsInTransition +
++ + + \ No newline at end of file diff --git a/doc/files/startactortransition.txt b/doc/files/startactortransition.txt new file mode 100644 index 0000000..821ffb9 --- /dev/null +++ b/doc/files/startactortransition.txt @@ -0,0 +1,15 @@ +#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.html b/doc/files/startparticleemitter.html new file mode 100644 index 0000000..27a678a --- /dev/null +++ b/doc/files/startparticleemitter.html @@ -0,0 +1,20 @@ + + +
+ + ++ Starts particle emission for a particle actor +
+Related: + StopParticleEmitter +
++ + + \ No newline at end of file diff --git a/doc/files/startparticleemitter.txt b/doc/files/startparticleemitter.txt new file mode 100644 index 0000000..4153fab --- /dev/null +++ b/doc/files/startparticleemitter.txt @@ -0,0 +1,6 @@ +#title startParticleEmitter [RCBasic Doc] +#header sub startParticleEmitter( actor) + +Starts particle emission for a particle actor + +#ref StopParticleEmitter diff --git a/doc/files/stopactortransition.html b/doc/files/stopactortransition.html new file mode 100644 index 0000000..3213d7a --- /dev/null +++ b/doc/files/stopactortransition.html @@ -0,0 +1,21 @@ + + +
+ + ++ Stops a transition that was started with StartActorTransition +
+Related: + StartActorTransition + ActorIsInTransition +
++ + + \ No newline at end of file diff --git a/doc/files/stopactortransition.txt b/doc/files/stopactortransition.txt new file mode 100644 index 0000000..f277c23 --- /dev/null +++ b/doc/files/stopactortransition.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/stopmusic.html new file mode 100644 index 0000000..dbf89ea --- /dev/null +++ b/doc/files/stopmusic.html @@ -0,0 +1,21 @@ + + +
+ + ++ Stops playing the loaded music track and resets the music position to 0 +
+Related: + PlayMusic + PauseMusic +
++ + + \ No newline at end of file diff --git a/doc/files/stopmusic.txt b/doc/files/stopmusic.txt new file mode 100644 index 0000000..2154dfb --- /dev/null +++ b/doc/files/stopmusic.txt @@ -0,0 +1,6 @@ +#title StopMusic [RCBasic Doc] +#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.html b/doc/files/stopparticleemitter.html new file mode 100644 index 0000000..e6a603b --- /dev/null +++ b/doc/files/stopparticleemitter.html @@ -0,0 +1,20 @@ + + +
+ + ++ Stops particle emission for a particle actor +
+Related: + StartParticleEmitter +
++ + + \ No newline at end of file diff --git a/doc/files/stopparticleemitter.txt b/doc/files/stopparticleemitter.txt new file mode 100644 index 0000000..eb23fce --- /dev/null +++ b/doc/files/stopparticleemitter.txt @@ -0,0 +1,6 @@ +#title stopParticleEmitter [RCBasic Doc] +#header sub stopParticleEmitter( actor) + +Stops particle emission for a particle actor + +#ref StartParticleEmitter diff --git a/doc/files/stopsound.html b/doc/files/stopsound.html new file mode 100644 index 0000000..967ed26 --- /dev/null +++ b/doc/files/stopsound.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stops playing sound on the specified channel +
++ + + \ No newline at end of file diff --git a/doc/files/stopsound.txt b/doc/files/stopsound.txt new file mode 100644 index 0000000..0a12cd1 --- /dev/null +++ b/doc/files/stopsound.txt @@ -0,0 +1,4 @@ +#title StopSound [RCBasic Doc] +#header sub StopSound(channel) + +Stops playing sound on the specified channel diff --git a/doc/files/stopvideo.html b/doc/files/stopvideo.html new file mode 100644 index 0000000..77bfba6 --- /dev/null +++ b/doc/files/stopvideo.html @@ -0,0 +1,21 @@ + + +
+ + ++ Stops playing the loaded video track and resets the video position to 0 +
+Related: + PlayVideo + PauseVideo +
++ + + \ No newline at end of file diff --git a/doc/files/stopvideo.txt b/doc/files/stopvideo.txt new file mode 100644 index 0000000..d641926 --- /dev/null +++ b/doc/files/stopvideo.txt @@ -0,0 +1,6 @@ +#title StopVideo [RCBasic Doc] +#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.html b/doc/files/str.html new file mode 100644 index 0000000..bfb27a0 --- /dev/null +++ b/doc/files/str.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a number converted to a string +
++ + + \ No newline at end of file diff --git a/doc/files/str.txt b/doc/files/str.txt new file mode 100644 index 0000000..340112a --- /dev/null +++ b/doc/files/str.txt @@ -0,0 +1,4 @@ +#title Str$ [RCBasic Doc] +#header function Str$(n) + +Returns a number converted to a string diff --git a/doc/files/str_f.html b/doc/files/str_f.html new file mode 100644 index 0000000..8404c2f --- /dev/null +++ b/doc/files/str_f.html @@ -0,0 +1,24 @@ + + +
+ + ++ Returns a number converted to a string in fixed notation +
++ The number will be returned with 6 decimal places of precision. +
++ + + \ No newline at end of file diff --git a/doc/files/str_f.txt b/doc/files/str_f.txt new file mode 100644 index 0000000..2ed2984 --- /dev/null +++ b/doc/files/str_f.txt @@ -0,0 +1,8 @@ +#title Str_F$ [RCBasic Doc] +#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.html b/doc/files/str_s.html new file mode 100644 index 0000000..fc93794 --- /dev/null +++ b/doc/files/str_s.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns a number converted to a string in scientific notation +
++ + + \ No newline at end of file diff --git a/doc/files/str_s.txt b/doc/files/str_s.txt new file mode 100644 index 0000000..a33ce20 --- /dev/null +++ b/doc/files/str_s.txt @@ -0,0 +1,7 @@ +#title Str_S$ [RCBasic Doc] +#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.html b/doc/files/stringarraycopy.html new file mode 100644 index 0000000..7e76381 --- /dev/null +++ b/doc/files/stringarraycopy.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayCopy() +
+Related: + ArrayCopy +
++ + + \ No newline at end of file diff --git a/doc/files/stringarraycopy.txt b/doc/files/stringarraycopy.txt new file mode 100644 index 0000000..ffb1c87 --- /dev/null +++ b/doc/files/stringarraycopy.txt @@ -0,0 +1,9 @@ +#title StringArrayCopy [RCBasic Doc] +#header sub StringArrayCopy(ByRef src$, ByRef dst$) + +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/stringarraydim.html b/doc/files/stringarraydim.html new file mode 100644 index 0000000..8d1ce4f --- /dev/null +++ b/doc/files/stringarraydim.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayDim() +
+Related: + ArrayDim +
++ + + \ No newline at end of file diff --git a/doc/files/stringarraydim.txt b/doc/files/stringarraydim.txt new file mode 100644 index 0000000..fba6904 --- /dev/null +++ b/doc/files/stringarraydim.txt @@ -0,0 +1,9 @@ +#title StringArrayDim [RCBasic Doc] +#header function StringArrayDim(Byref id$) + +This function is exists to be internally called by the runtime but should not be called directly. + +Use ArrayDim() + +#ref ArrayDim + diff --git a/doc/files/stringarrayfill.html b/doc/files/stringarrayfill.html new file mode 100644 index 0000000..cfa606c --- /dev/null +++ b/doc/files/stringarrayfill.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayFill() +
+Related: + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/files/stringarrayfill.txt b/doc/files/stringarrayfill.txt new file mode 100644 index 0000000..09bd05c --- /dev/null +++ b/doc/files/stringarrayfill.txt @@ -0,0 +1,9 @@ +#title StringArrayFill [RCBasic Doc] +#header sub StringArrayFill(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/stringarraysize.html b/doc/files/stringarraysize.html new file mode 100644 index 0000000..a761347 --- /dev/null +++ b/doc/files/stringarraysize.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArraySize() +
+Related: + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/files/stringarraysize.txt b/doc/files/stringarraysize.txt new file mode 100644 index 0000000..6df1733 --- /dev/null +++ b/doc/files/stringarraysize.txt @@ -0,0 +1,9 @@ +#title StringArraySize [RCBasic Doc] +#header function StringArraySize(Byref id$, array_dim) + +This function is exists to be internally called by the runtime but should not be called directly. + +Use ArraySize() + +#ref ArraySize + diff --git a/doc/files/stringfill.html b/doc/files/stringfill.html new file mode 100644 index 0000000..fb98e68 --- /dev/null +++ b/doc/files/stringfill.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a string filled with src$ repeated n times +
++ + + \ No newline at end of file diff --git a/doc/files/stringfill.txt b/doc/files/stringfill.txt new file mode 100644 index 0000000..5fc2972 --- /dev/null +++ b/doc/files/stringfill.txt @@ -0,0 +1,4 @@ +#title StringFill$ [RCBasic Doc] +#header function StringFill$(src$, n) + +Returns a string filled with src$ repeated n times diff --git a/doc/files/stringfrombuffer.html b/doc/files/stringfrombuffer.html new file mode 100644 index 0000000..0bc5554 --- /dev/null +++ b/doc/files/stringfrombuffer.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns a string generated from the character values stored in the buffer +
++ + + \ No newline at end of file diff --git a/doc/files/stringfrombuffer.txt b/doc/files/stringfrombuffer.txt new file mode 100644 index 0000000..4092010 --- /dev/null +++ b/doc/files/stringfrombuffer.txt @@ -0,0 +1,4 @@ +#title StringFromBuffer$ [RCBasic Doc] +#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.html b/doc/files/subtractmatrix.html new file mode 100644 index 0000000..efce740 --- /dev/null +++ b/doc/files/subtractmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores matrix mA minus matrix mB in matrix mC +
++ + + \ No newline at end of file diff --git a/doc/files/subtractmatrix.txt b/doc/files/subtractmatrix.txt new file mode 100644 index 0000000..ece702d --- /dev/null +++ b/doc/files/subtractmatrix.txt @@ -0,0 +1,4 @@ +#title SubtractMatrix [RCBasic Doc] +#header function SubtractMatrix(mA, mB, mC) + +Stores matrix mA minus matrix mB in matrix mC diff --git a/doc/files/swapmatrix.html b/doc/files/swapmatrix.html new file mode 100644 index 0000000..9aeb654 --- /dev/null +++ b/doc/files/swapmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Swaps the contents of 2 matrices +
++ + + \ No newline at end of file diff --git a/doc/files/swapmatrix.txt b/doc/files/swapmatrix.txt new file mode 100644 index 0000000..1a51c51 --- /dev/null +++ b/doc/files/swapmatrix.txt @@ -0,0 +1,4 @@ +#title SwapMatrix [RCBasic Doc] +#header sub SwapMatrix(mA, mB) + +Swaps the contents of 2 matrices diff --git a/doc/files/swapmatrixcolumn.html b/doc/files/swapmatrixcolumn.html new file mode 100644 index 0000000..d1930ff --- /dev/null +++ b/doc/files/swapmatrixcolumn.html @@ -0,0 +1,17 @@ + + +
+ + ++ Swaps the contents of 2 columns in a matrix +
++ + + \ No newline at end of file diff --git a/doc/files/swapmatrixcolumn.txt b/doc/files/swapmatrixcolumn.txt new file mode 100644 index 0000000..4292fdc --- /dev/null +++ b/doc/files/swapmatrixcolumn.txt @@ -0,0 +1,4 @@ +#title SwapMatrixColumn [RCBasic Doc] +#header function SwapMatrixColumn(mA, C1, C2) + +Swaps the contents of 2 columns in a matrix diff --git a/doc/files/swapmatrixrow.html b/doc/files/swapmatrixrow.html new file mode 100644 index 0000000..cafced5 --- /dev/null +++ b/doc/files/swapmatrixrow.html @@ -0,0 +1,17 @@ + + +
+ + ++ Swaps the contents of 2 rows in a matrix +
++ + + \ No newline at end of file diff --git a/doc/files/swapmatrixrow.txt b/doc/files/swapmatrixrow.txt new file mode 100644 index 0000000..f039a6a --- /dev/null +++ b/doc/files/swapmatrixrow.txt @@ -0,0 +1,4 @@ +#title SwapMatrixRow [RCBasic Doc] +#header function SwapMatrixRow(mA, R1, R2) + +Swaps the contents of 2 rows in a matrix diff --git a/doc/files/system.html b/doc/files/system.html new file mode 100644 index 0000000..ec28956 --- /dev/null +++ b/doc/files/system.html @@ -0,0 +1,17 @@ + + +
+ + ++ Runs an operating system command +
++ + + \ No newline at end of file diff --git a/doc/files/system.txt b/doc/files/system.txt new file mode 100644 index 0000000..40d03b5 --- /dev/null +++ b/doc/files/system.txt @@ -0,0 +1,4 @@ +#title System [RCBasic Doc] +#header function System(cmd$) + +Runs an operating system command diff --git a/doc/files/systemram.html b/doc/files/systemram.html new file mode 100644 index 0000000..c4ed040 --- /dev/null +++ b/doc/files/systemram.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the amount of RAM available +
++ + + \ No newline at end of file diff --git a/doc/files/systemram.txt b/doc/files/systemram.txt new file mode 100644 index 0000000..d3dbd87 --- /dev/null +++ b/doc/files/systemram.txt @@ -0,0 +1,4 @@ +#title SystemRam [RCBasic Doc] +#header function SystemRam() + +Returns the amount of RAM available diff --git a/doc/files/systemreturnstdout.html b/doc/files/systemreturnstdout.html new file mode 100644 index 0000000..7aa7ca9 --- /dev/null +++ b/doc/files/systemreturnstdout.html @@ -0,0 +1,20 @@ + + +
+ + ++ Runs an operating system command and returns the output +
+Related: + System +
++ + + \ No newline at end of file diff --git a/doc/files/systemreturnstdout.txt b/doc/files/systemreturnstdout.txt new file mode 100644 index 0000000..6c907da --- /dev/null +++ b/doc/files/systemreturnstdout.txt @@ -0,0 +1,6 @@ +#title SystemReturnStdOut$ [RCBasic Doc] +#header function SystemReturnStdOut$(cmd$) + +Runs an operating system command and returns the output + +#ref System diff --git a/doc/files/tally.html b/doc/files/tally.html new file mode 100644 index 0000000..1c4819c --- /dev/null +++ b/doc/files/tally.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of instances of substr$ in the src$ string +
++ + + \ No newline at end of file diff --git a/doc/files/tally.txt b/doc/files/tally.txt new file mode 100644 index 0000000..0a4f2b4 --- /dev/null +++ b/doc/files/tally.txt @@ -0,0 +1,4 @@ +#title Tally [RCBasic Doc] +#header function Tally(src$, substr$) + +Returns the number of instances of substr$ in the src$ string diff --git a/doc/files/tan.html b/doc/files/tan.html new file mode 100644 index 0000000..0a3e829 --- /dev/null +++ b/doc/files/tan.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the tangent of n +
++ + + \ No newline at end of file diff --git a/doc/files/tan.txt b/doc/files/tan.txt new file mode 100644 index 0000000..8228f51 --- /dev/null +++ b/doc/files/tan.txt @@ -0,0 +1,4 @@ +#title Tan [RCBasic Doc] +#header function Tan(n) + +Returns the tangent of n diff --git a/doc/files/tcp_acceptsocket.html b/doc/files/tcp_acceptsocket.html new file mode 100644 index 0000000..57af5b0 --- /dev/null +++ b/doc/files/tcp_acceptsocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/tcp_acceptsocket.txt b/doc/files/tcp_acceptsocket.txt new file mode 100644 index 0000000..250726b --- /dev/null +++ b/doc/files/tcp_acceptsocket.txt @@ -0,0 +1,4 @@ +#title TCP_AcceptSocket [RCBasic Doc] +#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.html b/doc/files/tcp_closesocket.html new file mode 100644 index 0000000..d4080c1 --- /dev/null +++ b/doc/files/tcp_closesocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ Closes a socket +
++ + + \ No newline at end of file diff --git a/doc/files/tcp_closesocket.txt b/doc/files/tcp_closesocket.txt new file mode 100644 index 0000000..7a04842 --- /dev/null +++ b/doc/files/tcp_closesocket.txt @@ -0,0 +1,4 @@ +#title TCP_CloseSocket [RCBasic Doc] +#header sub TCP_CloseSocket(socket) + +Closes a socket diff --git a/doc/files/tcp_getdata.html b/doc/files/tcp_getdata.html new file mode 100644 index 0000000..3d19ae9 --- /dev/null +++ b/doc/files/tcp_getdata.html @@ -0,0 +1,17 @@ + + +
+ + ++ Reads a given number of bytes from a socket +
++ + + \ No newline at end of file diff --git a/doc/files/tcp_getdata.txt b/doc/files/tcp_getdata.txt new file mode 100644 index 0000000..2f165e7 --- /dev/null +++ b/doc/files/tcp_getdata.txt @@ -0,0 +1,4 @@ +#title TCP_GetData [RCBasic Doc] +#header function TCP_GetData(socket, numBytes, ByRef sData$) + +Reads a given number of bytes from a socket diff --git a/doc/files/tcp_opensocket.html b/doc/files/tcp_opensocket.html new file mode 100644 index 0000000..1545bdf --- /dev/null +++ b/doc/files/tcp_opensocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ Opens a socket to talk to host$ on the given port +
++ + + \ No newline at end of file diff --git a/doc/files/tcp_opensocket.txt b/doc/files/tcp_opensocket.txt new file mode 100644 index 0000000..1d170bf --- /dev/null +++ b/doc/files/tcp_opensocket.txt @@ -0,0 +1,4 @@ +#title TCP_OpenSocket [RCBasic Doc] +#header function TCP_OpenSocket(host$, port) + +Opens a socket to talk to host$ on the given port diff --git a/doc/files/tcp_remotehost.html b/doc/files/tcp_remotehost.html new file mode 100644 index 0000000..aeeb9a7 --- /dev/null +++ b/doc/files/tcp_remotehost.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the destination host address +
++ + + \ No newline at end of file diff --git a/doc/files/tcp_remotehost.txt b/doc/files/tcp_remotehost.txt new file mode 100644 index 0000000..bc1dcdc --- /dev/null +++ b/doc/files/tcp_remotehost.txt @@ -0,0 +1,4 @@ +#title TCP_RemoteHost [RCBasic Doc] +#header function TCP_RemoteHost(socket) + +Returns the destination host address diff --git a/doc/files/tcp_remoteport.html b/doc/files/tcp_remoteport.html new file mode 100644 index 0000000..d17b60a --- /dev/null +++ b/doc/files/tcp_remoteport.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the port the socket is connecting on +
++ + + \ No newline at end of file diff --git a/doc/files/tcp_remoteport.txt b/doc/files/tcp_remoteport.txt new file mode 100644 index 0000000..ed804cc --- /dev/null +++ b/doc/files/tcp_remoteport.txt @@ -0,0 +1,4 @@ +#title TCP_RemotePort [RCBasic Doc] +#header function TCP_RemotePort(socket) + +Returns the port the socket is connecting on diff --git a/doc/files/tcp_senddata.html b/doc/files/tcp_senddata.html new file mode 100644 index 0000000..342f683 --- /dev/null +++ b/doc/files/tcp_senddata.html @@ -0,0 +1,17 @@ + + +
+ + ++ Send data through the given socket. +
++ + + \ No newline at end of file diff --git a/doc/files/tcp_senddata.txt b/doc/files/tcp_senddata.txt new file mode 100644 index 0000000..63b506d --- /dev/null +++ b/doc/files/tcp_senddata.txt @@ -0,0 +1,4 @@ +#title TCP_SendData [RCBasic Doc] +#header sub TCP_SendData(socket, sData$) + +Send data through the given socket. diff --git a/doc/files/tcp_socketready.html b/doc/files/tcp_socketready.html new file mode 100644 index 0000000..408fa0b --- /dev/null +++ b/doc/files/tcp_socketready.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/tcp_socketready.txt b/doc/files/tcp_socketready.txt new file mode 100644 index 0000000..2aaef60 --- /dev/null +++ b/doc/files/tcp_socketready.txt @@ -0,0 +1,4 @@ +#title TCP_SocketReady [RCBasic Doc] +#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.html b/doc/files/tell.html new file mode 100644 index 0000000..f583808 --- /dev/null +++ b/doc/files/tell.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current position within the file stream +
++ + + \ No newline at end of file diff --git a/doc/files/tell.txt b/doc/files/tell.txt new file mode 100644 index 0000000..4184850 --- /dev/null +++ b/doc/files/tell.txt @@ -0,0 +1,4 @@ +#title Tell [RCBasic Doc] +#header function Tell(stream) + +Returns the current position within the file stream diff --git a/doc/files/textheight.html b/doc/files/textheight.html new file mode 100644 index 0000000..b0f3f2d --- /dev/null +++ b/doc/files/textheight.html @@ -0,0 +1,21 @@ + + +
+ + ++ The height of text rendered with the active font +
+Related: + TextWidth + GetTextSize +
++ + + \ No newline at end of file diff --git a/doc/files/textheight.txt b/doc/files/textheight.txt new file mode 100644 index 0000000..1741a1f --- /dev/null +++ b/doc/files/textheight.txt @@ -0,0 +1,7 @@ +#title TextHeight [RCBasic Doc] +#header function TextHeight(txt$) + +The height of text rendered with the active font + +#ref TextWidth GetTextSize + diff --git a/doc/files/textwidth.html b/doc/files/textwidth.html new file mode 100644 index 0000000..8852b65 --- /dev/null +++ b/doc/files/textwidth.html @@ -0,0 +1,21 @@ + + +
+ + ++ The width of text rendered with the active font +
+Related: + TextHeight + GetTextSize +
++ + + \ No newline at end of file diff --git a/doc/files/textwidth.txt b/doc/files/textwidth.txt new file mode 100644 index 0000000..9865276 --- /dev/null +++ b/doc/files/textwidth.txt @@ -0,0 +1,6 @@ +#title TextWidth [RCBasic Doc] +#header function TextWidth(txt$) + +The width of text rendered with the active font + +#ref TextHeight GetTextSize diff --git a/doc/files/ticks.html b/doc/files/ticks.html new file mode 100644 index 0000000..cec9e29 --- /dev/null +++ b/doc/files/ticks.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of CPU ticks since the start of a program +
++ + + \ No newline at end of file diff --git a/doc/files/ticks.txt b/doc/files/ticks.txt new file mode 100644 index 0000000..14825a1 --- /dev/null +++ b/doc/files/ticks.txt @@ -0,0 +1,4 @@ +#title Ticks [RCBasic Doc] +#header function Ticks() + +Returns the number of CPU ticks since the start of a program diff --git a/doc/files/time.html b/doc/files/time.html new file mode 100644 index 0000000..2e0bc47 --- /dev/null +++ b/doc/files/time.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the current time in "HH:MM:SS" format +
++ + + \ No newline at end of file diff --git a/doc/files/time.txt b/doc/files/time.txt new file mode 100644 index 0000000..574c68b --- /dev/null +++ b/doc/files/time.txt @@ -0,0 +1,4 @@ +#title Time$ [RCBasic Doc] +#header function Time$() + +Returns the current time in "HH:MM:SS" format diff --git a/doc/files/timer.html b/doc/files/timer.html new file mode 100644 index 0000000..813b266 --- /dev/null +++ b/doc/files/timer.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of milliseconds since the start of the program. +
++ + + \ No newline at end of file diff --git a/doc/files/timer.txt b/doc/files/timer.txt new file mode 100644 index 0000000..0f6a398 --- /dev/null +++ b/doc/files/timer.txt @@ -0,0 +1,4 @@ +#title Timer [RCBasic Doc] +#header function Timer() + +Returns the number of milliseconds since the start of the program. diff --git a/doc/files/touchpressure.html b/doc/files/touchpressure.html new file mode 100644 index 0000000..76e0774 --- /dev/null +++ b/doc/files/touchpressure.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the touch pressure of a touch event. +
++ + + \ No newline at end of file diff --git a/doc/files/touchpressure.txt b/doc/files/touchpressure.txt new file mode 100644 index 0000000..b9c8de0 --- /dev/null +++ b/doc/files/touchpressure.txt @@ -0,0 +1,4 @@ +#title TouchPressure [RCBasic Doc] +#header function TouchPressure() + +Returns the touch pressure of a touch event. diff --git a/doc/files/translateactor.html b/doc/files/translateactor.html new file mode 100644 index 0000000..645b627 --- /dev/null +++ b/doc/files/translateactor.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/translateactorlocal.html b/doc/files/translateactorlocal.html new file mode 100644 index 0000000..e6c2f7c --- /dev/null +++ b/doc/files/translateactorlocal.html @@ -0,0 +1,17 @@ + + +
+ + ++ Moves an actor relative to its current position +
++ + + \ No newline at end of file diff --git a/doc/files/translateactorlocal.txt b/doc/files/translateactorlocal.txt new file mode 100644 index 0000000..b54a5d8 --- /dev/null +++ b/doc/files/translateactorlocal.txt @@ -0,0 +1,4 @@ +#title TranslateActorLocal [RCBasic Doc] +#header sub TranslateActorLocal( actor, x, y, z ) + +Moves an actor relative to its current position diff --git a/doc/files/translateactorworld.html b/doc/files/translateactorworld.html new file mode 100644 index 0000000..7147fce --- /dev/null +++ b/doc/files/translateactorworld.html @@ -0,0 +1,17 @@ + + +
+ + ++ Moves an actor relative to its current position +
++ + + \ No newline at end of file diff --git a/doc/files/translateactorworld.txt b/doc/files/translateactorworld.txt new file mode 100644 index 0000000..8ef62ce --- /dev/null +++ b/doc/files/translateactorworld.txt @@ -0,0 +1,4 @@ +#title TranslateActorWorld [RCBasic Doc] +#header sub TranslateActorWorld( actor, x, y, z ) + +Moves an actor relative to its current position diff --git a/doc/files/translatecamera.html b/doc/files/translatecamera.html new file mode 100644 index 0000000..5c7c46b --- /dev/null +++ b/doc/files/translatecamera.html @@ -0,0 +1,17 @@ + + +
+ + ++ Moves the camera relative to its current position +
++ + + \ No newline at end of file diff --git a/doc/files/translatecamera.txt b/doc/files/translatecamera.txt new file mode 100644 index 0000000..4c1e0fa --- /dev/null +++ b/doc/files/translatecamera.txt @@ -0,0 +1,4 @@ +#title TranslateCamera [RCBasic Doc] +#header sub TranslateCamera( x, y, z) + +Moves the camera relative to its current position diff --git a/doc/files/translatesprite.html b/doc/files/translatesprite.html new file mode 100644 index 0000000..11f67fb --- /dev/null +++ b/doc/files/translatesprite.html @@ -0,0 +1,24 @@ + + +
+ + ++ 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. +
+Related: + SetSpritePosition + GetSpritePosition +
++ + + \ No newline at end of file diff --git a/doc/files/translatesprite.txt b/doc/files/translatesprite.txt new file mode 100644 index 0000000..21b05b6 --- /dev/null +++ b/doc/files/translatesprite.txt @@ -0,0 +1,8 @@ +#title TranslateSprite [RCBasic Doc] +#header Sub TranslateSprite(sprite, x, y) + +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.html b/doc/files/transposematrix.html new file mode 100644 index 0000000..eebd419 --- /dev/null +++ b/doc/files/transposematrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Stores the transpose of matrix mA in matrix mB +
++ + + \ No newline at end of file diff --git a/doc/files/transposematrix.txt b/doc/files/transposematrix.txt new file mode 100644 index 0000000..eae9039 --- /dev/null +++ b/doc/files/transposematrix.txt @@ -0,0 +1,4 @@ +#title TransposeMatrix [RCBasic Doc] +#header function TransposeMatrix(mA, mB) + +Stores the transpose of matrix mA in matrix mB diff --git a/doc/files/triangle.html b/doc/files/triangle.html new file mode 100644 index 0000000..ab9dc03 --- /dev/null +++ b/doc/files/triangle.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a filled Triangle +
++ + + \ No newline at end of file diff --git a/doc/files/triangle.txt b/doc/files/triangle.txt new file mode 100644 index 0000000..baf8414 --- /dev/null +++ b/doc/files/triangle.txt @@ -0,0 +1,5 @@ +#title Triangle [RCBasic Doc] +#header sub Triangle(x1, y1, x2, y2, x3, y3) + +Draws a filled Triangle + diff --git a/doc/files/triangle3d.html b/doc/files/triangle3d.html new file mode 100644 index 0000000..95dd959 --- /dev/null +++ b/doc/files/triangle3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a triangle in 3D space +
++ + + \ No newline at end of file diff --git a/doc/files/triangle3d.txt b/doc/files/triangle3d.txt new file mode 100644 index 0000000..8a070f8 --- /dev/null +++ b/doc/files/triangle3d.txt @@ -0,0 +1,4 @@ +#title Triangle3D [RCBasic Doc] +#header sub Triangle3D(x1, y1, z1, x2, y2, z2, x3, y3, z3) + +Draws a triangle in 3D space diff --git a/doc/files/trim.html b/doc/files/trim.html new file mode 100644 index 0000000..888f6a2 --- /dev/null +++ b/doc/files/trim.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with all leading and trailing spaces removed +
++ + + \ No newline at end of file diff --git a/doc/files/trim.txt b/doc/files/trim.txt new file mode 100644 index 0000000..d2e64a2 --- /dev/null +++ b/doc/files/trim.txt @@ -0,0 +1,4 @@ +#title Trim$ [RCBasic Doc] +#header function Trim$(src$) + +Returns src$ with all leading and trailing spaces removed diff --git a/doc/files/tst.html b/doc/files/tst.html new file mode 100644 index 0000000..27be6f1 --- /dev/null +++ b/doc/files/tst.html @@ -0,0 +1,14 @@ + + +
+ + ++ + + \ No newline at end of file diff --git a/doc/files/typearraycopy.html b/doc/files/typearraycopy.html new file mode 100644 index 0000000..31eb52e --- /dev/null +++ b/doc/files/typearraycopy.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayCopy() +
+Related: + ArrayCopy +
++ + + \ No newline at end of file diff --git a/doc/files/typearraycopy.txt b/doc/files/typearraycopy.txt new file mode 100644 index 0000000..652df26 --- /dev/null +++ b/doc/files/typearraycopy.txt @@ -0,0 +1,8 @@ +#title TypeArrayCopy [RCBasic Doc] +#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.html b/doc/files/typearraydim.html new file mode 100644 index 0000000..c1b7213 --- /dev/null +++ b/doc/files/typearraydim.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayDim() +
+Related: + ArrayDim +
++ + + \ No newline at end of file diff --git a/doc/files/typearraydim.txt b/doc/files/typearraydim.txt new file mode 100644 index 0000000..31da7e5 --- /dev/null +++ b/doc/files/typearraydim.txt @@ -0,0 +1,9 @@ +#title TypeArrayDim [RCBasic Doc] +#header function TypeArrayDim(Byref id as empty) + +This function is exists to be internally called by the runtime but should not be called directly. + +Use ArrayDim() + +#ref ArrayDim + diff --git a/doc/files/typearrayfill.html b/doc/files/typearrayfill.html new file mode 100644 index 0000000..a93ae77 --- /dev/null +++ b/doc/files/typearrayfill.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArrayFill() +
+Related: + ArrayFill +
++ + + \ No newline at end of file diff --git a/doc/files/typearrayfill.txt b/doc/files/typearrayfill.txt new file mode 100644 index 0000000..007c111 --- /dev/null +++ b/doc/files/typearrayfill.txt @@ -0,0 +1,9 @@ +#title TypeArrayFill [RCBasic Doc] +#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. + +Use ArrayFill() + +#ref ArrayFill + diff --git a/doc/files/typearraysize.html b/doc/files/typearraysize.html new file mode 100644 index 0000000..67be110 --- /dev/null +++ b/doc/files/typearraysize.html @@ -0,0 +1,23 @@ + + +
+ + ++ This function is exists to be internally called by the runtime but should not be called directly. +
++ Use ArraySize() +
+Related: + ArraySize +
++ + + \ No newline at end of file diff --git a/doc/files/typearraysize.txt b/doc/files/typearraysize.txt new file mode 100644 index 0000000..62c8cea --- /dev/null +++ b/doc/files/typearraysize.txt @@ -0,0 +1,9 @@ +#title TypeArraySize [RCBasic Doc] +#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. + +Use ArraySize() + +#ref ArraySize + diff --git a/doc/files/ucase.html b/doc/files/ucase.html new file mode 100644 index 0000000..23d0d2e --- /dev/null +++ b/doc/files/ucase.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns src$ with all characters uppercase +
++ + + \ No newline at end of file diff --git a/doc/files/ucase.txt b/doc/files/ucase.txt new file mode 100644 index 0000000..081a29c --- /dev/null +++ b/doc/files/ucase.txt @@ -0,0 +1,4 @@ +#title Ucase$ [RCBasic Doc] +#header function Ucase$(src$) + +Returns src$ with all characters uppercase diff --git a/doc/files/udp_closesocket.html b/doc/files/udp_closesocket.html new file mode 100644 index 0000000..77c1f24 --- /dev/null +++ b/doc/files/udp_closesocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ Closes a UDP Socket +
++ + + \ No newline at end of file diff --git a/doc/files/udp_closesocket.txt b/doc/files/udp_closesocket.txt new file mode 100644 index 0000000..c8e2d57 --- /dev/null +++ b/doc/files/udp_closesocket.txt @@ -0,0 +1,4 @@ +#title UDP_CloseSocket [RCBasic Doc] +#header sub UDP_CloseSocket(socket) + +Closes a UDP Socket diff --git a/doc/files/udp_getdata.html b/doc/files/udp_getdata.html new file mode 100644 index 0000000..4d195aa --- /dev/null +++ b/doc/files/udp_getdata.html @@ -0,0 +1,17 @@ + + +
+ + ++ Reads data from a udp socket. +
++ + + \ No newline at end of file diff --git a/doc/files/udp_getdata.txt b/doc/files/udp_getdata.txt new file mode 100644 index 0000000..ba4114f --- /dev/null +++ b/doc/files/udp_getdata.txt @@ -0,0 +1,4 @@ +#title UDP_GetData [RCBasic Doc] +#header function UDP_GetData(socket, byref host$, byref port, byref sData$) + +Reads data from a udp socket. diff --git a/doc/files/udp_length.html b/doc/files/udp_length.html new file mode 100644 index 0000000..061a3e0 --- /dev/null +++ b/doc/files/udp_length.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the number of bytes read from a udp socket +
++ + + \ No newline at end of file diff --git a/doc/files/udp_length.txt b/doc/files/udp_length.txt new file mode 100644 index 0000000..a70ef35 --- /dev/null +++ b/doc/files/udp_length.txt @@ -0,0 +1,4 @@ +#title UDP_Length [RCBasic Doc] +#header function UDP_Length() + +Returns the number of bytes read from a udp socket diff --git a/doc/files/udp_maxlength.html b/doc/files/udp_maxlength.html new file mode 100644 index 0000000..6323217 --- /dev/null +++ b/doc/files/udp_maxlength.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the maximum number of bytes from a udp socket +
++ + + \ No newline at end of file diff --git a/doc/files/udp_maxlength.txt b/doc/files/udp_maxlength.txt new file mode 100644 index 0000000..a9ce7cc --- /dev/null +++ b/doc/files/udp_maxlength.txt @@ -0,0 +1,4 @@ +#title UDP_MaxLength [RCBasic Doc] +#header function UDP_MaxLength() + +Returns the maximum number of bytes from a udp socket diff --git a/doc/files/udp_opensocket.html b/doc/files/udp_opensocket.html new file mode 100644 index 0000000..cc77368 --- /dev/null +++ b/doc/files/udp_opensocket.html @@ -0,0 +1,17 @@ + + +
+ + ++ Opens a UDP socket +
++ + + \ No newline at end of file diff --git a/doc/files/udp_opensocket.txt b/doc/files/udp_opensocket.txt new file mode 100644 index 0000000..65ff894 --- /dev/null +++ b/doc/files/udp_opensocket.txt @@ -0,0 +1,4 @@ +#title UDP_OpenSocket [RCBasic Doc] +#header function UDP_OpenSocket(port) + +Opens a UDP socket diff --git a/doc/files/udp_remotehost.html b/doc/files/udp_remotehost.html new file mode 100644 index 0000000..c7b5ba2 --- /dev/null +++ b/doc/files/udp_remotehost.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the connected host in a udp connection +
++ + + \ No newline at end of file diff --git a/doc/files/udp_remotehost.txt b/doc/files/udp_remotehost.txt new file mode 100644 index 0000000..a9a0d4e --- /dev/null +++ b/doc/files/udp_remotehost.txt @@ -0,0 +1,4 @@ +#title UDP_RemoteHost$ [RCBasic Doc] +#header function UDP_RemoteHost$(socket) + +Returns the connected host in a udp connection diff --git a/doc/files/udp_remoteport.html b/doc/files/udp_remoteport.html new file mode 100644 index 0000000..f3ab41b --- /dev/null +++ b/doc/files/udp_remoteport.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the port the socket is connected on. +
++ + + \ No newline at end of file diff --git a/doc/files/udp_remoteport.txt b/doc/files/udp_remoteport.txt new file mode 100644 index 0000000..fb75eb4 --- /dev/null +++ b/doc/files/udp_remoteport.txt @@ -0,0 +1,4 @@ +#title UDP_RemotePort [RCBasic Doc] +#header function UDP_RemotePort(socket) + +Returns the port the socket is connected on. diff --git a/doc/files/udp_senddata.html b/doc/files/udp_senddata.html new file mode 100644 index 0000000..5784dda --- /dev/null +++ b/doc/files/udp_senddata.html @@ -0,0 +1,17 @@ + + +
+ + ++ Sends data to a host using UDP +
++ + + \ No newline at end of file diff --git a/doc/files/udp_senddata.txt b/doc/files/udp_senddata.txt new file mode 100644 index 0000000..3db16d7 --- /dev/null +++ b/doc/files/udp_senddata.txt @@ -0,0 +1,4 @@ +#title UDP_SendData [RCBasic Doc] +#header sub UDP_SendData(socket, host$, port, sData$) + +Sends data to a host using UDP diff --git a/doc/files/udp_socketready.html b/doc/files/udp_socketready.html new file mode 100644 index 0000000..0d58e74 --- /dev/null +++ b/doc/files/udp_socketready.html @@ -0,0 +1,25 @@ + + +
+ + ++ 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. +
+
+ If UDP_SocketReady ( 0 ) > 0 Then
+ 'Socket has activity so we can do something here
+ End If
+
Related: + CheckSockets +
++ + + \ No newline at end of file diff --git a/doc/files/udp_socketready.txt b/doc/files/udp_socketready.txt new file mode 100644 index 0000000..b3b9f2c --- /dev/null +++ b/doc/files/udp_socketready.txt @@ -0,0 +1,13 @@ +#title UDP_SocketReady [RCBasic Doc] +#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. + +#code +If UDP_SocketReady ( 0 ) > 0 Then + 'Socket has activity so we can do something here +End If +#/code + +#ref CheckSockets diff --git a/doc/files/udt.html b/doc/files/udt.html new file mode 100644 index 0000000..5f26144 --- /dev/null +++ b/doc/files/udt.html @@ -0,0 +1,73 @@ + + +
+ + ++ RCBasic v4 and up introduces the ability to create user defined types. These are basically structures that allow you to store and manage related data. To create a user defined type you need to use the TYPE keyword. Look at the following: +
+
+ Type player
+ Dim x, y
+ End Type
+
+ In the above code, a type called player is created. The DIM keyword must be used to add attributes to our type. Now we can create a variable with the data type player as follows: +
+
+ Dim hero As player
+
+ Notice that in the above code, we are using the DIM keyword we have used in previous sections to create variables and arrays. We now have a variable called hero whose data type is player. +
++ Since our hero variable is of type player, it has all the attributes of that type. So we can access the attribute's with a "." like so: +
+
+ hero.x = 23
+ Print "Hero x is "; hero.x
+
+ The attributes of a UDT variable are accessed the same way a normal variable is. You can also create an array of UDT's the same way you would create a normal array. Look at the following: +
+
+ Dim enemy[20] As player
+
+ If you read through the section on arrays then this should make sense. We are using the DIM keyword to make an array called enemy and then we use the AS keyword to set the type of enemy to player. +
++ UDTs can also be used for attributes inside other UDTs. Lets say we wanted each player to have stats like health and power. We could create a UDT for player stats and have an attribute of that stat type inside our player UDT. Here is that example demonstrated: +
+
+ Type Player_Stats
+ Dim health
+ Dim power
+ End Type
+
+ Type Player
+ Dim x, y
+ Dim stats As Player_Stats
+ End Type
+
+ Dim hero As Player
+
+ In the above example, hero now has an attribute called stats that is of type Player_Stats. So now we can access the stats attributes like so: +
+
+ hero.stats.health = 100
+ Print "Hero Health = "; hero.stats.health
+
+ 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/files/udt.txt b/doc/files/udt.txt new file mode 100644 index 0000000..6f9ff5f --- /dev/null +++ b/doc/files/udt.txt @@ -0,0 +1,52 @@ +#title RCBasic UDTs [RCBasic Doc] +#header USER DEFINED TYPES (UDTs) + +RCBasic v4 and up introduces the ability to create user defined types. These are basically structures that allow you to store and manage related data. To create a user defined type you need to use the TYPE keyword. Look at the following: +#code +Type player + Dim x, y +End Type +#/code + +In the above code, a type called player is created. The DIM keyword must be used to add attributes to our type. Now we can create a variable with the data type player as follows: +#code +Dim hero As player +#/code + +Notice that in the above code, we are using the DIM keyword we have used in previous sections to create variables and arrays. We now have a variable called hero whose data type is player. + +Since our hero variable is of type player, it has all the attributes of that type. So we can access the attribute's with a "." like so: +#code +hero.x = 23 +Print "Hero x is "; hero.x +#/code + +The attributes of a UDT variable are accessed the same way a normal variable is. You can also create an array of UDT's the same way you would create a normal array. Look at the following: +#code +Dim enemy[20] As player +#/code + +If you read through the section on arrays then this should make sense. We are using the DIM keyword to make an array called enemy and then we use the AS keyword to set the type of enemy to player. + +UDTs can also be used for attributes inside other UDTs. Lets say we wanted each player to have stats like health and power. We could create a UDT for player stats and have an attribute of that stat type inside our player UDT. Here is that example demonstrated: +#code +Type Player_Stats + Dim health + Dim power +End Type + +Type Player + Dim x, y + Dim stats As Player_Stats +End Type + +Dim hero As Player +#/code + +In the above example, hero now has an attribute called stats that is of type Player_Stats. So now we can access the stats attributes like so: +#code +hero.stats.health = 100 +Print "Hero Health = "; hero.stats.health +#/code + +If used effectively, you can drastically increase the readability and maintainability of your code. Especially in large projects. diff --git a/doc/files/unaugmentmatrix.html b/doc/files/unaugmentmatrix.html new file mode 100644 index 0000000..42c82cc --- /dev/null +++ b/doc/files/unaugmentmatrix.html @@ -0,0 +1,17 @@ + + +
+ + ++ Splits matrix mA into coefficient mB and augment mC +
++ + + \ No newline at end of file diff --git a/doc/files/unaugmentmatrix.txt b/doc/files/unaugmentmatrix.txt new file mode 100644 index 0000000..d236202 --- /dev/null +++ b/doc/files/unaugmentmatrix.txt @@ -0,0 +1,4 @@ +#title UnAugmentMatrix [RCBasic Doc] +#header function UnAugmentMatrix(mA, mB, mC) + +Splits matrix mA into coefficient mB and augment mC diff --git a/doc/files/update.html b/doc/files/update.html new file mode 100644 index 0000000..724af65 --- /dev/null +++ b/doc/files/update.html @@ -0,0 +1,48 @@ + + +
+ + ++ This is the most important function in a graphics window. It must be called every frame. +
++ It performs a few different operations +
++ 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/files/update.txt b/doc/files/update.txt new file mode 100644 index 0000000..d3d18cd --- /dev/null +++ b/doc/files/update.txt @@ -0,0 +1,19 @@ +#title Update [RCBasic Doc] +#header sub Update() + +This is the most important function in a graphics window. It must be called every frame. + +It performs a few different operations +#list ol +#li Renders all graphics +#li Checks for every event on the window + #list ul + #li Keyboard and Mouse Events + #li Joystick Events + #li Window Control Events (minimize, maximize, close, etc.) + #/list +#li Updates the physics simulation for 2D and 3D objects if enabled +#li Makes breakfast if you are hungry +#/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.html b/doc/files/updateactorinertiatensor.html new file mode 100644 index 0000000..ae77614 --- /dev/null +++ b/doc/files/updateactorinertiatensor.html @@ -0,0 +1,17 @@ + + +
+ + ++ 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/files/updateactorinertiatensor.txt b/doc/files/updateactorinertiatensor.txt new file mode 100644 index 0000000..611f0b5 --- /dev/null +++ b/doc/files/updateactorinertiatensor.txt @@ -0,0 +1,4 @@ +#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/useconstraintframeoffset.html b/doc/files/useconstraintframeoffset.html new file mode 100644 index 0000000..1746c40 --- /dev/null +++ b/doc/files/useconstraintframeoffset.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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 +
++ + + \ No newline at end of file diff --git a/doc/files/useconstraintframeoffset.txt b/doc/files/useconstraintframeoffset.txt new file mode 100644 index 0000000..34bca05 --- /dev/null +++ b/doc/files/useconstraintframeoffset.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/usehingereferenceframea.html new file mode 100644 index 0000000..c8cb9b2 --- /dev/null +++ b/doc/files/usehingereferenceframea.html @@ -0,0 +1,20 @@ + + +
+ + ++ 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. +
++ + + \ No newline at end of file diff --git a/doc/files/usehingereferenceframea.txt b/doc/files/usehingereferenceframea.txt new file mode 100644 index 0000000..ecfdedb --- /dev/null +++ b/doc/files/usehingereferenceframea.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/useparticleeverymeshvertex.html new file mode 100644 index 0000000..6065280 --- /dev/null +++ b/doc/files/useparticleeverymeshvertex.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether to emit min<->max particles for every vertex or to pick min<->max vertices. +
+Related: + particleIsUsingEveryMeshVertex +
++ + + \ No newline at end of file diff --git a/doc/files/useparticleeverymeshvertex.txt b/doc/files/useparticleeverymeshvertex.txt new file mode 100644 index 0000000..57f4984 --- /dev/null +++ b/doc/files/useparticleeverymeshvertex.txt @@ -0,0 +1,6 @@ +#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.html b/doc/files/useparticlenormaldirection.html new file mode 100644 index 0000000..9f30d4b --- /dev/null +++ b/doc/files/useparticlenormaldirection.html @@ -0,0 +1,20 @@ + + +
+ + ++ Sets whether particle emitter is using vertex normal for direction, or direction specified. +
+Related: + particleIsUsingNormalDirection +
++ + + \ No newline at end of file diff --git a/doc/files/useparticlenormaldirection.txt b/doc/files/useparticlenormaldirection.txt new file mode 100644 index 0000000..62fc20c --- /dev/null +++ b/doc/files/useparticlenormaldirection.txt @@ -0,0 +1,7 @@ +#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.html b/doc/files/useparticleoutlineonly.html new file mode 100644 index 0000000..0524db2 --- /dev/null +++ b/doc/files/useparticleoutlineonly.html @@ -0,0 +1,23 @@ + + +
+ + ++ Set whether or not to draw points inside the cylinder. +
++ Note: Only applies to cylinder emitter +
+Related: + particleIsUsingOutlineOnly +
++ + + \ No newline at end of file diff --git a/doc/files/useparticleoutlineonly.txt b/doc/files/useparticleoutlineonly.txt new file mode 100644 index 0000000..f87374c --- /dev/null +++ b/doc/files/useparticleoutlineonly.txt @@ -0,0 +1,8 @@ +#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.html b/doc/files/val.html new file mode 100644 index 0000000..bb16765 --- /dev/null +++ b/doc/files/val.html @@ -0,0 +1,20 @@ + + +
+ + ++ Converts a string to a number and returns the value. +
++ Returns 0 if the string was not a valid number. +
++ + + \ No newline at end of file diff --git a/doc/files/val.txt b/doc/files/val.txt new file mode 100644 index 0000000..60150a2 --- /dev/null +++ b/doc/files/val.txt @@ -0,0 +1,6 @@ +#title Val [RCBasic Doc] +#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/var_data.html b/doc/files/var_data.html new file mode 100644 index 0000000..e1a4e4e --- /dev/null +++ b/doc/files/var_data.html @@ -0,0 +1,59 @@ + + +
+ + ++ RC Basic supports two basic types of data: Numbers and Strings. These data types can be used to represent any type of data used in a program. +
++ Numbers can be either integers or floating point. To designate an integer value you simply write out the number where you need to use it. Floating point numbers are similiar except that you would write a decimal point to denote the start of the floating point value. Look at the following: +
+
+ 5 'Integer Number
+
+ 5.5 'Floating Point Number
+
+ Strings are used to store and manipulate data other than numbers. They can be used to refer to single characters, words, sentences, paragraphs, etc. Look at the Following: +
+
+ "HELLO WORLD" 'String
+
+ Notice that the string "HELLO WORLD" is surrounded by quotation marks. When setting a strings value manually you must use quotation marks. +
++ In order to be able to use string or number data to do anything useful we have to be able to store and retrieve the data. This is what variables are used for. Look at the following: +
+
+ A = 5
+
+ B$ = "HELLO WORLD"
+
+ The above example creates two variables. The variable A stores the number 5 and the variable B$ stores the string HELLO WORLD. Note that the variable B ends with a $. The $ has to be used when creating a string variable to let RC BASIC know its a string and to not treat it as a number. You only have to use the $ when you first create the variable. +
++ If you don't want to set the value of a variable when you create it you can create the variable with the DIM keyword like this: +
+
+ Dim A
+
+ Dim B$
+
+ You can also declare multiple variables with DIM. +
++ Dim A, B$, C +
++ + + \ No newline at end of file diff --git a/doc/files/var_data.txt b/doc/files/var_data.txt new file mode 100644 index 0000000..ffd06db --- /dev/null +++ b/doc/files/var_data.txt @@ -0,0 +1,39 @@ +#title RCBasic Variables [RCBasic Doc] +#header VARIABLES AND DATA TYPES + +RC Basic supports two basic types of data: Numbers and Strings. These data types can be used to represent any type of data used in a program. + +Numbers can be either integers or floating point. To designate an integer value you simply write out the number where you need to use it. Floating point numbers are similiar except that you would write a decimal point to denote the start of the floating point value. Look at the following: + +#code +5 'Integer Number + +5.5 'Floating Point Number +#/code + + +Strings are used to store and manipulate data other than numbers. They can be used to refer to single characters, words, sentences, paragraphs, etc. Look at the Following: + +#code +"HELLO WORLD" 'String +#/code + +Notice that the string "HELLO WORLD" is surrounded by quotation marks. When setting a strings value manually you must use quotation marks. + +In order to be able to use string or number data to do anything useful we have to be able to store and retrieve the data. This is what variables are used for. Look at the following: +#code +A = 5 + +B$ = "HELLO WORLD" +#/code +The above example creates two variables. The variable A stores the number 5 and the variable B$ stores the string HELLO WORLD. Note that the variable B ends with a $. The $ has to be used when creating a string variable to let RC BASIC know its a string and to not treat it as a number. You only have to use the $ when you first create the variable. + +If you don't want to set the value of a variable when you create it you can create the variable with the DIM keyword like this: +#code +Dim A + +Dim B$ +#/code +You can also declare multiple variables with DIM. + +Dim A, B$, C diff --git a/doc/files/videoend.html b/doc/files/videoend.html new file mode 100644 index 0000000..0c54bb4 --- /dev/null +++ b/doc/files/videoend.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true when the currently playing video reaches the end +
++ + + \ No newline at end of file diff --git a/doc/files/videoend.txt b/doc/files/videoend.txt new file mode 100644 index 0000000..420a409 --- /dev/null +++ b/doc/files/videoend.txt @@ -0,0 +1,4 @@ +#title VideoEnd [RCBasic Doc] +#header function VideoEnd() + +Returns true when the currently playing video reaches the end diff --git a/doc/files/videoexists.html b/doc/files/videoexists.html new file mode 100644 index 0000000..be0496c --- /dev/null +++ b/doc/files/videoexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if there is a video loaded +
++ + + \ No newline at end of file diff --git a/doc/files/videoexists.txt b/doc/files/videoexists.txt new file mode 100644 index 0000000..fbb2228 --- /dev/null +++ b/doc/files/videoexists.txt @@ -0,0 +1,4 @@ +#title VideoExists [RCBasic Doc] +#header function VideoExists() + +Returns true if there is a video loaded diff --git a/doc/files/videoisplaying.html b/doc/files/videoisplaying.html new file mode 100644 index 0000000..117f66d --- /dev/null +++ b/doc/files/videoisplaying.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if a video is playing +
++ + + \ No newline at end of file diff --git a/doc/files/videoisplaying.txt b/doc/files/videoisplaying.txt new file mode 100644 index 0000000..d026de5 --- /dev/null +++ b/doc/files/videoisplaying.txt @@ -0,0 +1,4 @@ +#title VideoIsPlaying [RCBasic Doc] +#header function VideoIsPlaying() + +Returns true if a video is playing diff --git a/doc/files/wait.html b/doc/files/wait.html new file mode 100644 index 0000000..ec887cb --- /dev/null +++ b/doc/files/wait.html @@ -0,0 +1,17 @@ + + +
+ + ++ Halts execution of a program for a given number of milliseconds. +
++ + + \ No newline at end of file diff --git a/doc/files/wait.txt b/doc/files/wait.txt new file mode 100644 index 0000000..532cb58 --- /dev/null +++ b/doc/files/wait.txt @@ -0,0 +1,4 @@ +#title Wait [RCBasic Doc] +#header sub Wait(m_sec) + +Halts execution of a program for a given number of milliseconds. diff --git a/doc/files/waitkey.html b/doc/files/waitkey.html new file mode 100644 index 0000000..4597cdc --- /dev/null +++ b/doc/files/waitkey.html @@ -0,0 +1,17 @@ + + +
+ + ++ Halts execution of a program until a key is pressed. +
++ + + \ No newline at end of file diff --git a/doc/files/waitkey.txt b/doc/files/waitkey.txt new file mode 100644 index 0000000..b15b2b0 --- /dev/null +++ b/doc/files/waitkey.txt @@ -0,0 +1,4 @@ +#title WaitKey [RCBasic Doc] +#header function WaitKey() + +Halts execution of a program until a key is pressed. diff --git a/doc/files/warpmouse.html b/doc/files/warpmouse.html new file mode 100644 index 0000000..ce8f44a --- /dev/null +++ b/doc/files/warpmouse.html @@ -0,0 +1,17 @@ + + +
+ + ++ Move the mouse cursor to xy position in the window +
++ + + \ No newline at end of file diff --git a/doc/files/warpmouse.txt b/doc/files/warpmouse.txt new file mode 100644 index 0000000..519730d --- /dev/null +++ b/doc/files/warpmouse.txt @@ -0,0 +1,4 @@ +#title WarpMouse [RCBasic Doc] +#header sub WarpMouse(x, y) + +Move the mouse cursor to xy position in the window diff --git a/doc/files/warpmouseglobal.html b/doc/files/warpmouseglobal.html new file mode 100644 index 0000000..184a6d9 --- /dev/null +++ b/doc/files/warpmouseglobal.html @@ -0,0 +1,17 @@ + + +
+ + ++ Move the mouse cursor to xy position in the display +
++ + + \ No newline at end of file diff --git a/doc/files/warpmouseglobal.txt b/doc/files/warpmouseglobal.txt new file mode 100644 index 0000000..bda6283 --- /dev/null +++ b/doc/files/warpmouseglobal.txt @@ -0,0 +1,4 @@ +#title WarpMouseGlobal [RCBasic Doc] +#header sub WarpMouseGlobal(x, y) + +Move the mouse cursor to xy position in the display diff --git a/doc/files/windowclip.html b/doc/files/windowclip.html new file mode 100644 index 0000000..9b39ea0 --- /dev/null +++ b/doc/files/windowclip.html @@ -0,0 +1,20 @@ + + +
+ + ++ Returns an image with a portion of the window stored +
+Related: + CanvasClip +
++ + + \ No newline at end of file diff --git a/doc/files/windowclip.txt b/doc/files/windowclip.txt new file mode 100644 index 0000000..f79c076 --- /dev/null +++ b/doc/files/windowclip.txt @@ -0,0 +1,6 @@ +#title WindowClip [RCBasic Doc] +#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.html b/doc/files/windowevent_close.html new file mode 100644 index 0000000..cfd4652 --- /dev/null +++ b/doc/files/windowevent_close.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window close event is called. +
++ + + \ No newline at end of file diff --git a/doc/files/windowevent_close.txt b/doc/files/windowevent_close.txt new file mode 100644 index 0000000..88ff136 --- /dev/null +++ b/doc/files/windowevent_close.txt @@ -0,0 +1,4 @@ +#title WindowEvent_Close [RCBasic Doc] +#header function WindowEvent_Close() + +Returns true if the window close event is called. diff --git a/doc/files/windowevent_maximize.html b/doc/files/windowevent_maximize.html new file mode 100644 index 0000000..0771210 --- /dev/null +++ b/doc/files/windowevent_maximize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window maximize event is called. +
++ + + \ No newline at end of file diff --git a/doc/files/windowevent_maximize.txt b/doc/files/windowevent_maximize.txt new file mode 100644 index 0000000..b2e32d8 --- /dev/null +++ b/doc/files/windowevent_maximize.txt @@ -0,0 +1,4 @@ +#title WindowEvent_Maximize [RCBasic Doc] +#header function WindowEvent_Maximize() + +Returns true if the window maximize event is called. diff --git a/doc/files/windowevent_minimize.html b/doc/files/windowevent_minimize.html new file mode 100644 index 0000000..7300635 --- /dev/null +++ b/doc/files/windowevent_minimize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window minimize event is called. +
++ + + \ No newline at end of file diff --git a/doc/files/windowevent_minimize.txt b/doc/files/windowevent_minimize.txt new file mode 100644 index 0000000..5f0b87d --- /dev/null +++ b/doc/files/windowevent_minimize.txt @@ -0,0 +1,4 @@ +#title WindowEvent_Minimize [RCBasic Doc] +#header function WindowEvent_Minimize() + +Returns true if the window minimize event is called. diff --git a/doc/files/windowevent_resize.html b/doc/files/windowevent_resize.html new file mode 100644 index 0000000..d8e6529 --- /dev/null +++ b/doc/files/windowevent_resize.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window resize event is called. +
++ + + \ No newline at end of file diff --git a/doc/files/windowevent_resize.txt b/doc/files/windowevent_resize.txt new file mode 100644 index 0000000..60b7d8e --- /dev/null +++ b/doc/files/windowevent_resize.txt @@ -0,0 +1,4 @@ +#title WindowEvent_Resize [RCBasic Doc] +#header function WindowEvent_Resize() + +Returns true if the window resize event is called. diff --git a/doc/files/windowexists.html b/doc/files/windowexists.html new file mode 100644 index 0000000..3611124 --- /dev/null +++ b/doc/files/windowexists.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window is open +
++ + + \ No newline at end of file diff --git a/doc/files/windowexists.txt b/doc/files/windowexists.txt new file mode 100644 index 0000000..a08fac4 --- /dev/null +++ b/doc/files/windowexists.txt @@ -0,0 +1,4 @@ +#title WindowExists [RCBasic Doc] +#header function WindowExists() + +Returns true if the window is open diff --git a/doc/files/windowhasinputfocus.html b/doc/files/windowhasinputfocus.html new file mode 100644 index 0000000..45662a4 --- /dev/null +++ b/doc/files/windowhasinputfocus.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window has input focus, otherwise it returns false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowhasinputfocus.txt b/doc/files/windowhasinputfocus.txt new file mode 100644 index 0000000..e4c2c8e --- /dev/null +++ b/doc/files/windowhasinputfocus.txt @@ -0,0 +1,4 @@ +#title WindowHasInputFocus [RCBasic Doc] +#header function WindowHasInputFocus() + +Returns true if the window has input focus, otherwise it returns false. diff --git a/doc/files/windowhasmousefocus.html b/doc/files/windowhasmousefocus.html new file mode 100644 index 0000000..3da56fd --- /dev/null +++ b/doc/files/windowhasmousefocus.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window has mouse focus, otherwise it returns false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowhasmousefocus.txt b/doc/files/windowhasmousefocus.txt new file mode 100644 index 0000000..36c9c87 --- /dev/null +++ b/doc/files/windowhasmousefocus.txt @@ -0,0 +1,4 @@ +#title WindowHasMouseFocus [RCBasic Doc] +#header function WindowHasMouseFocus() + +Returns true if the window has mouse focus, otherwise it returns false. diff --git a/doc/files/windowisbordered.html b/doc/files/windowisbordered.html new file mode 100644 index 0000000..97a56b1 --- /dev/null +++ b/doc/files/windowisbordered.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window has a border, otherwise it will return false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowisbordered.txt b/doc/files/windowisbordered.txt new file mode 100644 index 0000000..f22c130 --- /dev/null +++ b/doc/files/windowisbordered.txt @@ -0,0 +1,4 @@ +#title WindowIsBordered [RCBasic Doc] +#header function WindowIsBordered() + +Returns true if the window has a border, otherwise it will return false. diff --git a/doc/files/windowisfullscreen.html b/doc/files/windowisfullscreen.html new file mode 100644 index 0000000..9a493e0 --- /dev/null +++ b/doc/files/windowisfullscreen.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window is fullscreen, otherwise it will return false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowisfullscreen.txt b/doc/files/windowisfullscreen.txt new file mode 100644 index 0000000..84a5aa2 --- /dev/null +++ b/doc/files/windowisfullscreen.txt @@ -0,0 +1,4 @@ +#title WindowIsFullscreen [RCBasic Doc] +#header function WindowIsFullscreen() + +Returns true if the window is fullscreen, otherwise it will return false. diff --git a/doc/files/windowisgrabbed.html b/doc/files/windowisgrabbed.html new file mode 100644 index 0000000..0ad0977 --- /dev/null +++ b/doc/files/windowisgrabbed.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns the window that is currently grabbing input. It returns -1 on failure. +
++ + + \ No newline at end of file diff --git a/doc/files/windowisgrabbed.txt b/doc/files/windowisgrabbed.txt new file mode 100644 index 0000000..0aee396 --- /dev/null +++ b/doc/files/windowisgrabbed.txt @@ -0,0 +1,4 @@ +#title WindowIsGrabbed [RCBasic Doc] +#header function WindowIsGrabbed( ) + +Returns the window that is currently grabbing input. It returns -1 on failure. diff --git a/doc/files/windowismaximized.html b/doc/files/windowismaximized.html new file mode 100644 index 0000000..1e41434 --- /dev/null +++ b/doc/files/windowismaximized.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window is maximized, otherwise it will return false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowismaximized.txt b/doc/files/windowismaximized.txt new file mode 100644 index 0000000..a7a9900 --- /dev/null +++ b/doc/files/windowismaximized.txt @@ -0,0 +1,4 @@ +#title WindowIsMaximized [RCBasic Doc] +#header function WindowIsMaximized() + +Returns true if the window is maximized, otherwise it will return false. diff --git a/doc/files/windowisminimized.html b/doc/files/windowisminimized.html new file mode 100644 index 0000000..bebd6a4 --- /dev/null +++ b/doc/files/windowisminimized.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window is minimized, otherwise it will return false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowisminimized.txt b/doc/files/windowisminimized.txt new file mode 100644 index 0000000..96e20a4 --- /dev/null +++ b/doc/files/windowisminimized.txt @@ -0,0 +1,4 @@ +#title WindowIsMinimized [RCBasic Doc] +#header function WindowIsMinimized() + +Returns true if the window is minimized, otherwise it will return false. diff --git a/doc/files/windowisresizable.html b/doc/files/windowisresizable.html new file mode 100644 index 0000000..4adbfa3 --- /dev/null +++ b/doc/files/windowisresizable.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window is resizable, otherwise it will return false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowisresizable.txt b/doc/files/windowisresizable.txt new file mode 100644 index 0000000..14e51a7 --- /dev/null +++ b/doc/files/windowisresizable.txt @@ -0,0 +1,4 @@ +#title WindowIsResizable [RCBasic Doc] +#header function WindowIsResizable() + +Returns true if the window is resizable, otherwise it will return false. diff --git a/doc/files/windowisvisible.html b/doc/files/windowisvisible.html new file mode 100644 index 0000000..62ad21a --- /dev/null +++ b/doc/files/windowisvisible.html @@ -0,0 +1,17 @@ + + +
+ + ++ Returns true if the window is visible, otherwise it returns false. +
++ + + \ No newline at end of file diff --git a/doc/files/windowisvisible.txt b/doc/files/windowisvisible.txt new file mode 100644 index 0000000..d8c2b9c --- /dev/null +++ b/doc/files/windowisvisible.txt @@ -0,0 +1,4 @@ +#title WindowIsVisible [RCBasic Doc] +#header function WindowIsVisible() + +Returns true if the window is visible, otherwise it returns false. diff --git a/doc/files/windowmode.html b/doc/files/windowmode.html new file mode 100644 index 0000000..3013cdd --- /dev/null +++ b/doc/files/windowmode.html @@ -0,0 +1,39 @@ + + +
+ + ++ Returns a bitmask of the combined window flags that can be used in OpenWindow() to set the mode for the window. +
++ Each flag is a boolean that determines whether or not to set that flag in the mask. +
++ Note: For most use cases, one of the following will work +
++ Window +
+
+ mode = WindowMode(1, 0, 0, 0, 0)
+
+
Fullscreen
+
+ mode = WindowMode(1, 1, 0, 0, 0)
+
Related: + OpenWindow + GetWindowMode +
+
+
+
+
\ No newline at end of file
diff --git a/doc/files/windowmode.txt b/doc/files/windowmode.txt
new file mode 100644
index 0000000..d9593d6
--- /dev/null
+++ b/doc/files/windowmode.txt
@@ -0,0 +1,20 @@
+#title WindowMode [RCBasic Doc]
+#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.
+
+Each flag is a boolean that determines whether or not to set that flag in the mask.
+
+Note: For most use cases, one of the following will work
+
+Window
+#code
+mode = WindowMode(1, 0, 0, 0, 0)
+#/code
+
+Fullscreen
+#code
+mode = WindowMode(1, 1, 0, 0, 0)
+#/code
+
+#ref OpenWindow GetWindowMode
diff --git a/doc/files/windowtitle.html b/doc/files/windowtitle.html
new file mode 100644
index 0000000..f833cd0
--- /dev/null
+++ b/doc/files/windowtitle.html
@@ -0,0 +1,20 @@
+
+
+
+ Returns the window title +
+Related: + SetWindowTitle +
++ + + \ No newline at end of file diff --git a/doc/files/windowtitle.txt b/doc/files/windowtitle.txt new file mode 100644 index 0000000..f3627af --- /dev/null +++ b/doc/files/windowtitle.txt @@ -0,0 +1,6 @@ +#title WindowTitle$ [RCBasic Doc] +#header function WindowTitle$( ) + +Returns the window title + +#ref SetWindowTitle diff --git a/doc/files/write.html b/doc/files/write.html new file mode 100644 index 0000000..859d72c --- /dev/null +++ b/doc/files/write.html @@ -0,0 +1,20 @@ + + +
+ + ++ Writes a string to a file. +
+Related: + WriteLine +
++ + + \ No newline at end of file diff --git a/doc/files/write.txt b/doc/files/write.txt new file mode 100644 index 0000000..7b5cee5 --- /dev/null +++ b/doc/files/write.txt @@ -0,0 +1,6 @@ +#title Write [RCBasic Doc] +#header sub Write(stream, txt$) + +Writes a string to a file. + +#ref WriteLine diff --git a/doc/files/writebyte.html b/doc/files/writebyte.html new file mode 100644 index 0000000..d760352 --- /dev/null +++ b/doc/files/writebyte.html @@ -0,0 +1,20 @@ + + +
+ + ++ Writes a byte to the file. +
+Related: + WriteByteBuffer +
++ + + \ No newline at end of file diff --git a/doc/files/writebyte.txt b/doc/files/writebyte.txt new file mode 100644 index 0000000..493d948 --- /dev/null +++ b/doc/files/writebyte.txt @@ -0,0 +1,6 @@ +#title WriteByte [RCBasic Doc] +#header sub WriteByte(stream, byte) + +Writes a byte to the file. + +#ref WriteByteBuffer diff --git a/doc/files/writebytebuffer.html b/doc/files/writebytebuffer.html new file mode 100644 index 0000000..5534572 --- /dev/null +++ b/doc/files/writebytebuffer.html @@ -0,0 +1,17 @@ + + +
+ + ++ Writes a number of bytes from a buffer to the file stream. +
++ + + \ No newline at end of file diff --git a/doc/files/writebytebuffer.txt b/doc/files/writebytebuffer.txt new file mode 100644 index 0000000..add1317 --- /dev/null +++ b/doc/files/writebytebuffer.txt @@ -0,0 +1,4 @@ +#title WriteByteBuffer [RCBasic Doc] +#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.html b/doc/files/writeline.html new file mode 100644 index 0000000..126cd6f --- /dev/null +++ b/doc/files/writeline.html @@ -0,0 +1,21 @@ + + +
+ + ++ Writes a string to a text file with a new-line appended at the end +
+Related: + Write + ReadLine$ +
++ + + \ No newline at end of file diff --git a/doc/files/writeline.txt b/doc/files/writeline.txt new file mode 100644 index 0000000..0a6c172 --- /dev/null +++ b/doc/files/writeline.txt @@ -0,0 +1,6 @@ +#title WriteLine [RCBasic Doc] +#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.html b/doc/files/xorbit.html new file mode 100644 index 0000000..81d1fe0 --- /dev/null +++ b/doc/files/xorbit.html @@ -0,0 +1,21 @@ + + +
+ + ++ Returns the value of the bitwise XOR operation on the operands A and B +
++ + + \ No newline at end of file diff --git a/doc/files/xorbit.txt b/doc/files/xorbit.txt new file mode 100644 index 0000000..798ec1c --- /dev/null +++ b/doc/files/xorbit.txt @@ -0,0 +1,6 @@ +#title XOrBit [RCBasic Doc] +#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.html b/doc/files/zeromatrix.html new file mode 100644 index 0000000..2700775 --- /dev/null +++ b/doc/files/zeromatrix.html @@ -0,0 +1,23 @@ + + +
+ + ++ Clears a matrix +
++ Note: Literally does the exact same thing as ClearMatrix. Its here as a legacy call convention. +
+Related: + ClearMatrix +
++ + + \ No newline at end of file diff --git a/doc/files/zeromatrix.txt b/doc/files/zeromatrix.txt new file mode 100644 index 0000000..e89b1c2 --- /dev/null +++ b/doc/files/zeromatrix.txt @@ -0,0 +1,8 @@ +#title ZeroMatrix [RCBasic Doc] +#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/rcbasic_manual.html b/doc/rcbasic_manual.html new file mode 100644 index 0000000..3edbefc --- /dev/null +++ b/doc/rcbasic_manual.html @@ -0,0 +1,18 @@ + + +
+ +| abc | def | ghi | |
|---|---|---|---|
| dfdf | kljlj | lwllwe | lwlel |
+Print "Hello World"
+
+
+
+
+
+
diff --git a/rcbasic_build/embedded_functions.bas b/rcbasic_build/embedded_functions.bas
index 40b7519..44c17aa 100644
--- a/rcbasic_build/embedded_functions.bas
+++ b/rcbasic_build/embedded_functions.bas
@@ -1,527 +1,46 @@
-'StringFill
-'Stack_Size_N
-'Stack_Size_S
-'Text I/O
-sub FPrint(txt$)
-function Input$(prompt$)
-'Arrays
-function ArrayDim(Byref id)
-function StringArrayDim(Byref id$)
-function NumberArrayDim(Byref id)
-function ArraySize(Byref id, array_dim)
-function StringArraySize(Byref id$, array_dim)
-function NumberArraySize(Byref id, array_dim)
-'Math
-function Abs(n)
-function ACos(n)
-function AndBit(a,b)
-function ASin(n)
-function ATan(n)
-function Bin$(n)
-function CInt32(i)
-function CInt64(i)
-function Cos(n)
-function Degrees(r)
-function Exp(n)
-function Frac(n)
-function Hex$(n)
-function HexVal(n$)
-function Int(n)
-function Log(n)
-function Max(a, b)
-function Min(a, b)
-function OrBit(a, b)
-function Radians(d)
-function Randomize(n)
-function Rand(n)
-function Round(n)
-function Sign(n)
-function Sin(n)
-function Sqrt(n)
-function Tan(n)
-function XOrBit(a, b)
-'Strings
-function Asc(c$)
-function Chr$(n)
-function Insert$(src$, tgt$, pos)
-function InStr(src$, substr$)
-function LCase$(src$)
-function Left$(src$, n)
-function Length(src$)
-function Len(src$)
-function LTrim$(src$)
-function Mid$(src$, start, n)
-function ReplaceSubstr$(src$, rpc$, pos)
-function Replace$(src$, tgt$, rpc$)
-function Reverse$(src$)
-function Right$(src$, n)
-function RTrim$(src$)
-function StringFill$(src$, n)
-function Str$(n)
-function Str_F$(n)
-function Str_S$(n)
-function Tally(src$, substr$)
-function Trim$(src$)
-function UCase$(src$)
-function Val(n$)
-'Stacks
-sub Stack_N(n)
-sub Stack_S(n)
-sub Push_N(n)
-function Pop_N()
-sub Push_S(s$)
-function Pop_S$()
-function Stack_Size_N()
-function Stack_Size_S()
-'File I/O
-function FileOpen(stream, fileName$, mode)
-sub FileClose(stream)
-function ReadByte(stream)
-sub WriteByte(stream, byte)
-function ReadLine$(stream)
-sub Write(stream, txt$)
-sub WriteLine(stream, txt$)
-sub CopyFile(src$, dst$)
-function RemoveFile(fileName$)
-function FileExists(fileName$)
-function MoveFile(src$, dst$)
-function RenameFile(src$, dst$)
-function FileLength(fileName$)
-function Tell(stream)
-function Seek(stream, pos)
-function EOF(stream)
-function FreeFile()
-'Directories
-sub ChangeDir(p$)
-function DirExists(p$)
-function DirFirst$()
-function Dir$()
-function DirNext$()
-function MakeDir(p$)
-function RemoveDir(p$)
-'Date and Time
-function Date$()
-function Easter$(year)
-function Ticks()
-function Time$()
-function Timer()
-sub Wait(m_sec)
-'Window Management
-sub WindowOpen(win, title$, x, y, w, h, flag, vsync)
-sub WindowClose(win)
-sub RaiseWindow(win)
-sub Window(win)
-sub Update()
-sub Cls()
-sub SetClearColor(c)
-sub ShowWindow(win)
-sub HideWindow(win)
-sub SetWindowTitle(win, title$)
-function WindowTitle$(win)
-sub SetWindowPosition(win, x, y)
-sub GetWindowPosition(win, byref x, byref y)
-sub SetWindowSize(win, w, h)
-sub GetWindowSize(win, byref w, byref h)
-sub SetWindowMinSize(win, w, h)
-sub GetWindowMinSize(win, byref w, byref h)
-sub SetWindowMaxSize(win, w, h)
-sub GetWindowMaxSize(win, byref w, byref h)
-function WindowIsFullscreen(win)
-function WindowIsVisible(win)
-function WindowIsBordered(win)
-function WindowIsResizable(win)
-function WindowIsMinimized(win)
-function WindowIsMaximized(win)
-function WindowHasInputFocus(win)
-function WindowHasMouseFocus(win)
-sub SetWindowFullscreen(win, flag)
-sub MaximizeWindow(win)
-sub MinimizeWindow(win)
-sub SetWindowBorder(win, flag)
-sub WindowClip(slot, x, y, w, h)
-function WindowExists(win)
-function NumWindows()
-function WindowEvent_Close(win)
-function WindowEvent_Maximize(win)
-function WindowEvent_Minimize(win)
-function ActiveWindow()
-function FPS()
-sub SetWindowIcon(win, slot)
-'Canvases
-sub CanvasOpen(c_num, w, h, viewport_x, viewport_y, viewport_w, viewport_h, mode)
-sub CanvasClose(c_num)
-sub SetCanvasVisible(c_num, flag)
-function CanvasIsVisible(c_num)
-sub SetCanvasViewport(cnum, x, y, w, h)
-sub GetCanvasViewport(c_num, byref x, byref y, byref w, byref h)
-sub Canvas(c_num)
-sub SetCanvasOffset(c_num, x, y)
-sub GetCanvasOffset(c_num, byref x, byref y)
-sub GetCanvasSize(c_num, byref w, byref h)
-sub ClearCanvas()
-sub SetCanvasAlpha(c_num, a)
-function CanvasAlpha(c_num)
-function SetCanvasBlendMode(c_num, blend_mode)
-function CanvasBlendMode(c_num)
-function SetCanvasColorMod(c_num, c)
-function CanvasColorMod(c_num)
-sub CopyCanvas(src, x, y, w, h, dst, dx, dy)
-sub CloneCanvas(src, dst)
-sub SetCanvasZ(c_num, z)
-function CanvasZ(c_num)
-sub CanvasClip(slot, x, y, w, h, flag)
-function ActiveCanvas()
-'Graphics Primitives
-sub Box(x1, y1, x2, y2)
-sub BoxFill(x1, y1, x2, y2)
-sub Circle(x,y,radius)
-sub CircleFill(x,y,radius)
-sub Ellipse(x,y,rx,ry)
-sub EllipseFill(x,y,rx,ry)
-sub FloodFill(x,y)
-function GetPixel(x,y)
-sub SetColor(c)
-sub Line(x1, y1, x2, y2)
-sub Poly(n, byref x, byref y)
-sub PolyFill(n, byref x, byref y)
-sub Rect(x, y, w, h)
-sub RectFill(x, y, w, h)
-sub RoundRect(x, y, w, h, r)
-sub RoundRectFill(x, y, w, h, r)
-function RGB(r,g,b)
-function RGBA(r,g,b,a)
-sub PSet(x,y)
-'Images
-sub LoadImage(slot, img$)
-sub LoadImage_Ex(slot, img$, colkey)
-sub ImageFromBuffer(slot, w, h, byref buffer)
-sub ImageFromBuffer_Ex(slot, w, h, byref buffer, colkey)
-sub BufferFromImage(slot, byref buffer)
-function ImageExists(slot)
-sub ColorKey(slot, c)
-sub CopyImage(src, dst)
-sub DeleteImage(slot)
-sub SetImageAlpha(slot, a)
-function ImageAlpha(slot)
-sub GetImageSize(slot, byref w, byref h)
-function SetImageBlendMode(slot, blend_mode)
-function ImageBlendMode(slot)
-function SetImageColorMod(slot, c)
-function ImageColorMod(slot)
-sub DrawImage(slot, x, y)
-sub DrawImage_Blit(slot, x, y, src_x, src_y, src_w, src_h)
-sub DrawImage_Blit_Ex(slot, x, y, w, h, src_x, src_y, src_w, src_h)
-sub DrawImage_Rotate(slot, x, y, angle)
-sub DrawImage_Rotate_Ex(slot, x, y, src_x, src_y, src_w, src_h, angle)
-sub DrawImage_Zoom(slot, x, y, zx, zy)
-sub DrawImage_Zoom_Ex(slot, x, y, src_x, src_y, src_w, src_h, zx, zy)
-sub DrawImage_Rotozoom(slot, x, y, angle, zx, zy)
-sub DrawImage_Rotozoom_Ex(slot, x, y, src_x, src_y, src_w, src_h, angle, zx, zy)
-sub DrawImage_Flip(slot, x, y, h, v)
-sub DrawImage_Flip_Ex(slot, x, y, src_x, src_y, src_w, src_h, h, v)
-'Keyboard and Mouse
-function InKey()
-function Key(key_code)
-function WaitKey()
-sub HideMouse()
-sub ShowMouse()
-function MouseIsVisible()
-sub GetMouse(byref x, byref y, byref mb1, byref mb2, byref mb3)
-function MouseX()
-function MouseY()
-function MouseButton(mb)
-sub GetMouseWheel(byref x_axis, byref y_axis)
-function MouseWheelX()
-function MouseWheelY()
-'Sound and Music
-sub SoundFromBuffer(slot, byref buffer, buffer_size, vol)
-sub LoadSound(slot, snd_file$)
-sub LoadMusic(music_file$)
-sub PlaySound(slot, channel, loops)
-sub PlaySoundTimed(slot, channel, loops, ms)
-sub PlayMusic(mLoops)
-sub PauseSound(channel)
-sub ResumeSound(channel)
-sub PauseMusic()
-sub ResumeMusic()
-sub DeleteSound(slot)
-sub DeleteMusic()
-sub FadeMusicIn(fade_time, loops)
-sub FadeMusicOut(fade_time)
-function MusicExists()
-sub SetMusicVolume(vol)
-function MusicVolume()
-sub SetMusicPosition(pos)
-function MusicPosition()
-sub RewindMusic()
-sub SetSoundChannels(max_channels)
-function NumSoundChannels()
-function SoundIsEnabled()
-function SoundExists(slot)
-sub SetChannelVolume(channel, vol)
-function ChannelVolume(channel)
-sub SetSoundVolume(slot, vol)
-function SoundVolume(slot)
-sub StopMusic()
-sub StopSound(channel)
-function SetChannelPanning(channel, left_value, right_value)
-function SetChannelDistance(channel, dist_value)
-function ChannelIsPlaying(channel)
-function ChannelIsPaused(channel)
-'Joysticks
-function NumJoysticks()
-function NumJoyAxes(joy_num)
-function NumJoyButtons(joy_num)
-function NumJoyHats(joy_num)
-function NumJoyTrackBalls(joy_num)
-function JoyAxis(joy_num, joy_axis)
-function JoyButton(joy_num, joy_button)
-function JoyHat(joy_num, joy_hat)
-sub GetJoyTrackBall(joy_num, ball, byref dx, byref dy)
-function JoyName$(joy_num)
-function JoystickIsConnected(joy_num)
-'Screen Console
-sub GetCursor(byref x, byref y)
-sub PrintS(txt$)
-function InputS$(prompt$)
-function ZoneInputS$(x, y, w, h)
-sub Locate(x, y)
-'Text Editing
-sub ReadInput_Start()
-sub ReadInput_Stop()
-function ReadInput_Text$()
-sub ReadInput_SetText(txt$)
-sub ReadInput_ToggleBackspace(flag)
-'Text Drawing
-sub LoadFont(slot, fnt_file$, size)
-sub DeleteFont(slot)
-function FontIsLoaded(slot)
-sub Font(slot)
-sub SetFontStyle(slot, style)
-sub DrawText(txt$, x, y)
-sub DrawText_Shaded(txt$, x, y, fg_color, bg_color)
-sub DrawText_Blended(txt$, x, y)
-sub RenderText(slot, txt$)
-sub GetTextSize(slot, txt$, byref w, byref h)
-'Touch Events
-function TouchPressure()
-sub GetTouch(byref status, byref x, byref y, byref dx, byref dy)
-sub GetMultiTouch(byref status, byref x, byref y, byref fingers, byref dist, byref theta)
-sub GetTouchFinger(finger, byref x, byref y, byref pressure)
-function NumFingers()
-'Networking
-function CheckSockets(timeout_ms)
-function TCP_SocketReady(socket)
-function UDP_SocketReady(socket)
-function TCP_SocketOpen(socket, host$, port)
-sub TCP_SocketClose(socket)
-function TCP_RemoteHost(socket)
-function TCP_RemotePort(socket)
-function TCP_GetData(socket, ByRef sData$, numBytes)
-sub TCP_SendData(socket, sData$)
-function TCP_AcceptSocket(server, client)
-function UDP_SocketOpen(socket, port)
-function UDP_SocketClose(socket)
-function UDP_GetData(socket, byref sData$, byref host$, byref port)
-function UDP_Length()
-function UDP_MaxLength()
-function UDP_RemoteHost$(socket)
-function UDP_RemotePort(socket)
-sub UDP_SendData(socket, sData$, host$, port)
-'Video Playback
-sub LoadVideo(vid$)
-sub PlayVideo(vLoops)
-sub PauseVideo()
-sub StopVideo()
-sub SetVideoPosition(pos)
-sub ResumeVideo()
-function VideoPosition()
-sub DeleteVideo()
-function VideoIsPlaying()
-function VideoEnd()
-sub GetVideoStats(vFile$, byref vLen, byref vfps, byref frame_w, byref frame_h)
-sub SetVideoDrawRect(x, y, w, h)
-sub GetVideoDrawRect(byref x, byref y, byref w, byref h)
-sub GetVideoSize(byref w, byref h)
-function VideoExists()
-sub SetVideoAlpha(a)
-'Operating System
-function System(cmd$)
-function OS$()
-function Command$(arg)
-function NumCommands()
-function Env$(v$)
-sub SetEnv(var$, value$, overwrite)
-function PrefPath$(org_name$, app_name$)
-function Android_GetExternalStoragePath$()
-function Android_GetExternalStorageState()
-function Android_GetInternalStoragePath$()
-function Android_JNI_Message$(arg$)
-function Runtime_Utility_Message$(arg$)
-'Clipboard
-function ClipboardText$()
-sub SetClipboardText(txt$)
-function HasClipboardText()
-
-'v3.12
-Sub GetDesktopDisplayMode(index, ByRef w, ByRef h, ByRef freq)
-Sub DrawImage_Transform(slot, x, y, w, h, src_x, src_y, src_w, src_h, angle, center_x, center_y, flip_h, flip_v)
-Sub GetPowerInfo(ByRef status, ByRef secs, ByRef pct)
-Function SystemRam()
-Function SetRenderScaleQuality(n)
-Function EvalJS$(js_code$) 'Only useable in Emscripten
-Function GetRenderScaleQuality()
-
-'v3.14
-sub GetGlobalMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3)
-function GlobalMouseX()
-function GlobalMouseY()
-sub GetAccel(accel_num, ByRef x, ByRef y, ByRef z)
-function AccelName$(accel_num)
-function NumAccels()
-sub GetGyro(gyro_num, ByRef x, ByRef y, ByRef z)
-function GyroName$(gyro_num)
-function NumGyros()
-sub JoyRumblePlay(joy_num, strength, duration)
-sub JoyRumbleStop(joy_num)
-function JoystickIsHaptic(joy_num)
-function WriteByteBuffer(stream, ByRef buf, buf_size)
-function ReadByteBuffer(stream, ByRef buf, buf_size)
-function WindowEvent_Resize(win)
-sub SetWindowAutoClose( win, exit_on_close )
-sub SetWindowResizable(win, flag) 'new
-function SystemReturnStdOut$(cmd$) 'new
-function WindowMode(visible, fullscreen, resizable, borderless, highDPI)
-function WindowFlags(win)
-sub RestoreWindow(win)
-sub UpdateAllWindows() 'new
-function QueryAudioSpec(ByRef freq, ByRef format, ByRef channels) 'new
-
-'v3.15
-function MusicIsPlaying()
-
-'v3.19
-function DrawGeometry(slot, num_vertices, ByRef vertices, num_indices, ByRef Indices)
-
-'v3.20
-function Size(s$)
-function BufferFromString(s$, ByRef buffer)
-function StringFromBuffer$(ByRef buffer, buffer_size)
-sub GrabInput(flag)
-function GrabbedWindow()
-sub WarpMouse(x, y)
-sub WarpMouseGlobal(x, y)
-sub SetMouseZone(x, y, w, h)
-sub ClearMouseZone()
-sub SetWindowAlwaysOnTop(win, flag)
-sub SetMouseRelative(flag)
-sub SetWindowVSync(win, flag)
-function OpenURL(url$)
-function APIVersion$()
-function FlashWindow(win)
-function MessageBox(title$, msg$)
-sub NumberArrayCopy(ByRef src, ByRef dst)
-sub StringArrayCopy(ByRef src$, ByRef dst$)
-sub ArrayCopy(ByRef src, ByRef dst)
-sub NumberArrayFill(ByRef src, fdata)
-sub StringArrayFill(ByRef src$, fdata$)
-sub ArrayFill(ByRef src, fdata)
-function Runtime$()
-
-'More v3.20 (Matrices and Parrallism)
-sub DimMatrix(m, m_rows, m_cols, preserve_flag)
-function AddMatrix(mA, mB, mC)
-function AugmentMatrix (mA, mB, mC)
-sub CopyMatrix(mA, mB)
-function InsertMatrixColumns(mA, c, num_cols)
-function InsertMatrixRows(mA, r, num_rows)
-function MultiplyMatrix (mA, mB, mC)
-function CubeMatrix(mA, mB)
-function DeleteMatrixColumns(mA, c, num_cols)
-function DeleteMatrixRows(mA, r, num_rows)
-sub ClearMatrix(mA)
-function ClearMatrixColumns (mA, c, num_cols)
-function ClearMatrixRows(mA, r, num_rows)
-sub FillMatrix(mA, v)
-function FillMatrixColumns(mA, c, num_cols, v)
-function FillMatrixRows(mA, r, num_rows, v)
-function CopyMatrixColumns(mA, mB, c, num_cols)
-function CopyMatrixRows (mA, mB, r, num_rows)
-sub IdentityMatrix(mA, n)
-function SolveMatrix(mA, mB, mC)
-function IsEqualMatrix(mA, mB, tolerance)
-function Determinant(mA)
-function AdjointMatrix(mA, mB)
-function InvertMatrix(mA, mB)
-sub MatrixFromBuffer(mA, r, c, ByRef buffer)
-sub GetMatrix(ByRef buffer, mA)
-sub RandomizeMatrix(mA, vmin, vmax)
-function MatrixValue(mA, r, c)
-sub SetMatrixValue(mA, r, c, v)
-sub ScalarMatrix (mA, mB, s_value)
-function ScalarMatrixColumns(mA, mB, c, num_cols, s_value)
-function ScalarMatrixRows(mA, mB, r, num_rows, s_value)
-function SquareMatrix(mA, mB)
-sub SubMatrix(mA, r, c)
-function SubtractMatrix (mA, mB, mC)
-sub SwapMatrix(mA, mB)
-function SwapMatrixColumn(mA, C1, C2)
-function SwapMatrixRow(mA, R1, R2)
-function TransposeMatrix(mA, mB)
-function UnAugmentMatrix(mA, mB, mC)
-sub ZeroMatrix(mA)
-
-sub GetMatrixSize(mA, ByRef r, ByRef c)
-function SetMatrixProcess(p_num) 'Set to -1 for main thread
-
-
-'ERROR_FLAG - MATRIX_ON_ERROR_STOP, MATRIX_ON_ERROR_WAIT, MATRIX_ON_ERROR_CONTINUE
-function ProcessOpen(p_num) 'stops and locks mutex, and clears queue before changing mode
-sub SetProcessErrorMode(p_num, error_mode)
-function ProcessError(p_num)
-sub ProcessWait(p_num) 'waits for all calculations to complete and lock matrix mutex
-sub ProcessWaitAll() 'waits for all process to finish
-sub ProcessContinue(p_num) 'unlock mutex
-sub ProcessStop(p_num) 'stops after current calculation its working on and lock mutex
-sub ProcessClear(p_num) 'locks mutex and clears matrix queue
-function ProcessClose(p_num)
-function ProcessErrorMode(p_num)
-sub ProcessSleep(p_num, msec)
-function ProcessExists(p_num)
-sub ProcessStopAll()
-sub ProcessContinueAll()
-function ProcessQueueSize(p_num)
-
-function NumCPUs()
-
-'v3.21
-sub GetProjectionGeometry(cam_dist, mA, f_vertex_count, ByRef columns, ByRef uv, graph_offset_x, graph_offset_y, v_color, ByRef vertex_count, ByRef vertex2D, ByRef index_count, ByRef index, ByRef clip_dist, ByRef min_x, ByRef min_y, ByRef max_x, ByRef max_y)
-function CalculateFaceZ(cam_dist, graph_offset_x, graph_offset_y, view_w, view_h, view_depth, mA, f_vertex_count, ByRef columns, ByRef face_min_z, ByRef face_max_z, ByRef z_avg)
-function SetChannelSpacePosition(channel, angle, distance)
-function SaveBMP(img, file$)
-function SavePNG(img, file$)
-function SaveJPG(img, file$)
-Function GetLineIntersection(p0_x, p0_y, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, ByRef i_x, ByRef i_y)
-Function Interpolate(min_a, max_a, mid_a, min_b, max_b)
-Function ATan2(y, x)
-function PointInQuad(x, y, x1, y1, x2, y2, x3, y3, x4, y4)
-function PointInTri(x, y, x1, y1, x2, y2, x3, y3)
-Function Distance2D(x1, y1, x2, y2)
-Function Distance3D(x1, y1, z1, x2, y2, z2)
-function GetCircleLineIntersection(circle_x, circle_y, radius, x1, y1, x2, y2, ByRef ix1, ByRef iy1, ByRef ix2, ByRef iy2)
-function GetLinePlaneIntersection(ByRef line_point, ByRef line_direction, ByRef plane_point_1, ByRef plane_point_2, ByRef plane_point_3, ByRef intersection)
-sub IncrementMatrixRows(mA, mB, r, num_rows, value)
-sub IncrementMatrixColumns(mA, mB, c, num_cols, value)
-sub JoinMatrixRows(mA, mB, mC)
-sub JoinMatrixColumns(mA, mB, mC)
-
-'v4.0
-
'Empty Type is used mainly for built-in functions that need to have a user type specified to be able to compile properly
type empty
end type
-function TypeArrayDim(Byref id as empty)
-function TypeArraySize(Byref id as empty, array_dim)
-sub TypeArrayCopy(ByRef src as empty, ByRef dst as empty)
-sub TypeArrayFill(ByRef src as empty, fdata as empty)
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/conio.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/arrays.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/math.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/strings.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/stacks.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/files.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/directories.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/datetime.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/window.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/canvas.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/prim2d.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/images.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/keyboard.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/audio.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/joystick.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/gfxconsole.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/text.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/touch.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/network.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/video.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/system.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/matrix.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/process.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/clipboard.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/textedit.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/sprites.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/sprite_animation.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/sprite_physics.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/joint2D.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/tilemaps.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/mesh.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/actor.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/actor_animation.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/actor_physics.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/constraint3D.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/camera.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/scene.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/particles.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/lights.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/terrain.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/water.bas"
+Include "/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_lib/materials.bas"
diff --git a/rcbasic_build/env_resolve.h b/rcbasic_build/env_resolve.h
old mode 100644
new mode 100755
diff --git a/rcbasic_build/file_directory.h b/rcbasic_build/file_directory.h
old mode 100644
new mode 100755
diff --git a/rcbasic_build/identifier.h b/rcbasic_build/identifier.h
old mode 100644
new mode 100755
index f4bd83f..c23c0df
--- a/rcbasic_build/identifier.h
+++ b/rcbasic_build/identifier.h
@@ -302,16 +302,17 @@ void output_vars()
int getUType(string utype_name)
{
+ string param = utype_name;
utype_name = StringToLower(utype_name);
for(int i = 0; i < utype.size(); i++)
{
//cout << "TYPE[" << i << "] = " << utype[i].name << endl;
- if(utype_name.compare(utype[i].name)==0)
+ if(utype_name.compare(StringToLower(utype[i].name))==0)
{
return i;
}
}
- rc_setError(utype_name + " does not name a type");
+ rc_setError(param + " does not name a type");
return -1;
}
@@ -339,9 +340,10 @@ bool create_type(string utype_name)
bool memberExists(string member_name)
{
+ member_name = StringToLower(member_name);
for(int i = 0; i < utype[current_type_index].num_members; i++)
{
- if(utype[current_type_index].member_name[i].compare(member_name)==0)
+ if(StringToLower(utype[current_type_index].member_name[i]).compare(member_name)==0)
return true;
}
return false;
@@ -531,7 +533,8 @@ int getIDInScope_ByIndex_TypeMatch(string id_name, string check_scope="")
for(int i = 0; i < id.size(); i++)
{
- if(id[i].scope.compare(check_scope)==0)
+ string id_cmp_scope = StringToLower(id[i].scope);
+ if(id_cmp_scope.compare(check_scope)==0)
{
if(id[i].name.substr(id[i].name.length()-1,1).compare("$")==0) //id in type is string
{
@@ -541,7 +544,7 @@ int getIDInScope_ByIndex_TypeMatch(string id_name, string check_scope="")
}
else
{
- //cout << id_name << " ~ " << id[i].name << endl;
+ //cout << id_name << " ~ " << id[i].name << " scope: " << check_scope << endl;
if(id_name.compare(StringToLower(id[i].name))==0)
return i;
}
diff --git a/rcbasic_build/intern_inc/exceptions/.h b/rcbasic_build/intern_inc/exceptions/.h
new file mode 100644
index 0000000..a10d449
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/.h
@@ -0,0 +1,4 @@
+if(STACK_S_N >= 0 && STACK_S_N <= (MAX_USER_STACKS-1))
+ rc_user_active_s_stack = STACK_S_N;
+Else
+ Cout << "Stack_S Error: Exceeds available stacks" << endl;
diff --git a/rcbasic_build/intern_inc/exceptions/rc_arrayCopy.h b/rcbasic_build/intern_inc/exceptions/rc_arrayCopy.h
new file mode 100644
index 0000000..f7b7a28
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_arrayCopy.h
@@ -0,0 +1 @@
+//DUMMY CASE
diff --git a/rcbasic_build/intern_inc/exceptions/rc_arrayDim.h b/rcbasic_build/intern_inc/exceptions/rc_arrayDim.h
new file mode 100644
index 0000000..f7b7a28
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_arrayDim.h
@@ -0,0 +1 @@
+//DUMMY CASE
diff --git a/rcbasic_build/intern_inc/exceptions/rc_arrayFill.h b/rcbasic_build/intern_inc/exceptions/rc_arrayFill.h
new file mode 100644
index 0000000..f7b7a28
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_arrayFill.h
@@ -0,0 +1 @@
+//DUMMY CASE
diff --git a/rcbasic_build/intern_inc/exceptions/rc_arraySize.h b/rcbasic_build/intern_inc/exceptions/rc_arraySize.h
new file mode 100644
index 0000000..f7b7a28
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_arraySize.h
@@ -0,0 +1 @@
+//DUMMY CASE
diff --git a/rcbasic_build/intern_inc/exceptions/rc_numberArrayCopy.h b/rcbasic_build/intern_inc/exceptions/rc_numberArrayCopy.h
new file mode 100644
index 0000000..c1f36c7
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_numberArrayCopy.h
@@ -0,0 +1,2 @@
+rc_number_array_copy( &num_var[0], &num_var[1]);
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_numberArrayDim.h b/rcbasic_build/intern_inc/exceptions/rc_numberArrayDim.h
new file mode 100644
index 0000000..1cdf766
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_numberArrayDim.h
@@ -0,0 +1,2 @@
+rc_push_num( rc_number_array_dim( (rc_numId*)num_var[0].nid_value.ref_parent ) );
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_numberArrayFill.h b/rcbasic_build/intern_inc/exceptions/rc_numberArrayFill.h
new file mode 100644
index 0000000..44d75b5
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_numberArrayFill.h
@@ -0,0 +1,2 @@
+rc_number_array_fill( &num_var[0], NUMBERARRAYFILL_FDATA);
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_numberArraySize.h b/rcbasic_build/intern_inc/exceptions/rc_numberArraySize.h
new file mode 100644
index 0000000..9c4469a
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_numberArraySize.h
@@ -0,0 +1,2 @@
+rc_push_num( rc_number_array_size( (rc_numId*)num_var[0].nid_value.ref_parent, NUMBERARRAYSIZE_ARRAY_DIM));
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_runtime.h b/rcbasic_build/intern_inc/exceptions/rc_runtime.h
new file mode 100644
index 0000000..9e825d3
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_runtime.h
@@ -0,0 +1 @@
+rc_push_str( rcbasic_runtime_path );
diff --git a/rcbasic_build/intern_inc/exceptions/rc_stack_N.h b/rcbasic_build/intern_inc/exceptions/rc_stack_N.h
new file mode 100644
index 0000000..802b89e
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_stack_N.h
@@ -0,0 +1,4 @@
+if(STACK_N_N >= 0 && STACK_N_N <= (MAX_USER_STACKS-1))
+ rc_user_active_n_stack = STACK_N_N;
+Else
+ cout << "Stack_N Error: Exceeds available stacks" << endl;
diff --git a/rcbasic_build/intern_inc/exceptions/rc_stack_S.h b/rcbasic_build/intern_inc/exceptions/rc_stack_S.h
new file mode 100644
index 0000000..a10d449
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_stack_S.h
@@ -0,0 +1,4 @@
+if(STACK_S_N >= 0 && STACK_S_N <= (MAX_USER_STACKS-1))
+ rc_user_active_s_stack = STACK_S_N;
+Else
+ Cout << "Stack_S Error: Exceeds available stacks" << endl;
diff --git a/rcbasic_build/intern_inc/exceptions/rc_stringArrayCopy.h b/rcbasic_build/intern_inc/exceptions/rc_stringArrayCopy.h
new file mode 100644
index 0000000..a2a252c
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_stringArrayCopy.h
@@ -0,0 +1,2 @@
+rc_string_array_copy( &str_var[0], &str_var[1]);
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_stringArrayDim.h b/rcbasic_build/intern_inc/exceptions/rc_stringArrayDim.h
new file mode 100644
index 0000000..1e82f6f
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_stringArrayDim.h
@@ -0,0 +1,2 @@
+rc_push_num( rc_string_array_dim( (rc_strId*) str_var[0].sid_value.ref_parent ) );
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_stringArrayFill.h b/rcbasic_build/intern_inc/exceptions/rc_stringArrayFill.h
new file mode 100644
index 0000000..44b4a58
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_stringArrayFill.h
@@ -0,0 +1,2 @@
+rc_string_array_fill( &str_var[0], STRINGARRAYFILL_FDATA$);
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_stringArraySize.h b/rcbasic_build/intern_inc/exceptions/rc_stringArraySize.h
new file mode 100644
index 0000000..32c7d64
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_stringArraySize.h
@@ -0,0 +1,2 @@
+rc_push_num( rc_string_array_size( (rc_strId*) str_var[0].sid_value.ref_parent, STRINGARRAYSIZE_ARRAY_DIM));
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_typeArrayCopy.h b/rcbasic_build/intern_inc/exceptions/rc_typeArrayCopy.h
new file mode 100644
index 0000000..b02ad38
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_typeArrayCopy.h
@@ -0,0 +1,2 @@
+rc_free_type(TYPEARRAYCOPY_DST);
+rc_type_array_copy( TYPEARRAYCOPY_SRC, TYPEARRAYCOPY_DST );
diff --git a/rcbasic_build/intern_inc/exceptions/rc_typeArrayDim.h b/rcbasic_build/intern_inc/exceptions/rc_typeArrayDim.h
new file mode 100644
index 0000000..40eb4cc
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_typeArrayDim.h
@@ -0,0 +1,2 @@
+rc_push_num( rc_type_array_dim( TYPEARRAYDIM_ID ) );
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_typeArrayFill.h b/rcbasic_build/intern_inc/exceptions/rc_typeArrayFill.h
new file mode 100644
index 0000000..c78bb75
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_typeArrayFill.h
@@ -0,0 +1 @@
+rc_type_array_fill( TYPEARRAYFILL_SRC, &TYPEARRAYFILL_FDATA );
diff --git a/rcbasic_build/intern_inc/exceptions/rc_typeArraySize.h b/rcbasic_build/intern_inc/exceptions/rc_typeArraySize.h
new file mode 100644
index 0000000..ef121ee
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_typeArraySize.h
@@ -0,0 +1,2 @@
+rc_push_num( rc_type_array_size( TYPEARRAYSIZE_ID, TYPEARRAYSIZE_ARRAY_DIM ) );
+arr_ref_id.clear();
diff --git a/rcbasic_build/intern_inc/exceptions/rc_update.h b/rcbasic_build/intern_inc/exceptions/rc_update.h
new file mode 100644
index 0000000..fc0e15f
--- /dev/null
+++ b/rcbasic_build/intern_inc/exceptions/rc_update.h
@@ -0,0 +1,7 @@
+rc_events();
+rc_media_updateWindow_hw();
+#ifdef RC_WEB
+ emscripten_sleep(0);
+#else
+ SDL_Delay(0);
+#endif // RC_WEB
diff --git a/rcbasic_build/intern_inc/rc_builtin_template.h b/rcbasic_build/intern_inc/rc_builtin_template.h
new file mode 100755
index 0000000..744d915
--- /dev/null
+++ b/rcbasic_build/intern_inc/rc_builtin_template.h
@@ -0,0 +1,19 @@
+#ifndef RC_BUILTIN_H_INCLUDED
+#define RC_BUILTIN_H_INCLUDED
+#include "identifier.h"
+
+void init_embedded_functions()
+{
+}
+
+
+void init_embedded_types()
+{
+ create_type("empty");
+}
+
+void init_embedded_variables()
+{
+}
+
+#endif // RC_BUILTIN_H_INCLUDED
diff --git a/rcbasic_build/intern_inc/switch_cases.h b/rcbasic_build/intern_inc/switch_cases.h
new file mode 100644
index 0000000..898569e
--- /dev/null
+++ b/rcbasic_build/intern_inc/switch_cases.h
@@ -0,0 +1,1014 @@
+rc_fprint( FPRINT_TXT$ )
+rc_input( INPUT$_PROMPT$ )
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_arrayDim.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_stringArrayDim.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_numberArrayDim.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_arraySize.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_stringArraySize.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_numberArraySize.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_numberArrayCopy.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_stringArrayCopy.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_arrayCopy.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_numberArrayFill.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_stringArrayFill.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_arrayFill.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_typeArrayDim.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_typeArraySize.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_typeArrayCopy.h
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_typeArrayFill.h
+rc_intern_abs( ABS_N )
+rc_intern_aCos( ACOS_N )
+rc_intern_andBit( ANDBIT_A, ANDBIT_B )
+rc_intern_aSin( ASIN_N )
+rc_intern_aTan( ATAN_N )
+rc_intern_bin( BIN$_N )
+rc_intern_cint32( CINT32_I )
+rc_intern_cint64( CINT64_I )
+rc_intern_cos( COS_N )
+rc_intern_degrees( DEGREES_R )
+rc_intern_exp( EXP_N )
+rc_intern_frac( FRAC_N )
+rc_intern_hex( HEX$_N )
+rc_intern_hexInt( HEXVAL_N$ )
+rc_intern_int( INT_N )
+rc_intern_log( LOG_N )
+rc_intern_max( MAX_A, MAX_B )
+rc_intern_min( MIN_A, MIN_B )
+rc_intern_orBit( ORBIT_A, ORBIT_B )
+rc_intern_radians( RADIANS_D )
+rc_intern_randomize( RANDOMIZE_N )
+rc_intern_rand( RAND_N )
+rc_intern_round( ROUND_N )
+rc_intern_sign( SIGN_N )
+rc_intern_sin( SIN_N )
+rc_intern_sqrt( SQRT_N )
+rc_intern_tan( TAN_N )
+rc_intern_xorbit( XORBIT_A, XORBIT_B )
+GetLineIntersect( GETLINEINTERSECTION_P0_X, GETLINEINTERSECTION_P0_Y, GETLINEINTERSECTION_P1_X, GETLINEINTERSECTION_P1_Y, GETLINEINTERSECTION_P2_X, GETLINEINTERSECTION_P2_Y, GETLINEINTERSECTION_P3_X, GETLINEINTERSECTION_P3_Y, &GETLINEINTERSECTION_I_X, &GETLINEINTERSECTION_I_Y )
+Interpolate( INTERPOLATE_MIN_A, INTERPOLATE_MAX_A, INTERPOLATE_MID_A, INTERPOLATE_MIN_B, INTERPOLATE_MAX_B )
+atan2( ATAN2_Y, ATAN2_X )
+PointInQuad( POINTINQUAD_X, POINTINQUAD_Y, POINTINQUAD_X1, POINTINQUAD_Y1, POINTINQUAD_X2, POINTINQUAD_Y2, POINTINQUAD_X3, POINTINQUAD_Y3, POINTINQUAD_X4, POINTINQUAD_Y4 )
+PointInTri( POINTINTRI_X, POINTINTRI_Y, POINTINTRI_X1, POINTINTRI_Y1, POINTINTRI_X2, POINTINTRI_Y2, POINTINTRI_X3, POINTINTRI_Y3 )
+Distance2D( DISTANCE2D_X1, DISTANCE2D_Y1, DISTANCE2D_X2, DISTANCE2D_Y2 )
+Distance3D( DISTANCE3D_X1, DISTANCE3D_Y1, DISTANCE3D_Z1, DISTANCE3D_X2, DISTANCE3D_Y2, DISTANCE3D_Z2 )
+GetCircleLineIntersection( GETCIRCLELINEINTERSECTION_CIRCLE_X, GETCIRCLELINEINTERSECTION_CIRCLE_Y, GETCIRCLELINEINTERSECTION_RADIUS, GETCIRCLELINEINTERSECTION_X1, GETCIRCLELINEINTERSECTION_Y1, GETCIRCLELINEINTERSECTION_X2, GETCIRCLELINEINTERSECTION_Y2, &GETCIRCLELINEINTERSECTION_IX1, &GETCIRCLELINEINTERSECTION_IY1, &GETCIRCLELINEINTERSECTION_IX2, &GETCIRCLELINEINTERSECTION_IY2 )
+GetLinePlaneIntersection( &GETLINEPLANEINTERSECTION_LINE_POINT, &GETLINEPLANEINTERSECTION_LINE_DIRECTION, &GETLINEPLANEINTERSECTION_PLANE_POINT_1, &GETLINEPLANEINTERSECTION_PLANE_POINT_2, &GETLINEPLANEINTERSECTION_PLANE_POINT_3, &GETLINEPLANEINTERSECTION_INTERSECTION )
+rc_intern_asc( ASC_C$ )
+rc_intern_chr( CHR$_N )
+rc_intern_insert( INSERT$_SRC$, INSERT$_TGT$, INSERT$_POS )
+rc_intern_instr( INSTR_SRC$, INSTR_SUBSTR$ )
+rc_intern_lcase( LCASE$_SRC$ )
+rc_intern_left( LEFT$_SRC$, LEFT$_N )
+rc_intern_length( LENGTH_SRC$ )
+rc_intern_length( LEN_SRC$ )
+rc_intern_ltrim( LTRIM$_SRC$ )
+rc_intern_mid( MID$_SRC$, MID$_START, MID$_N )
+rc_intern_replaceSubstr( REPLACESUBSTR$_SRC$, REPLACESUBSTR$_RPC$, REPLACESUBSTR$_POS )
+rc_intern_replace( REPLACE$_SRC$, REPLACE$_TGT$, REPLACE$_RPC$ )
+rc_intern_reverse( REVERSE$_SRC$ )
+rc_intern_right( RIGHT$_SRC$, RIGHT$_N )
+rc_intern_rtrim( RTRIM$_SRC$ )
+rc_intern_stringfill( STRINGFILL$_SRC$, STRINGFILL$_N )
+rc_intern_str( STR$_N )
+rc_intern_str_f( STR_F$_N )
+rc_intern_str_s( STR_S$_N )
+rc_intern_tally( TALLY_SRC$, TALLY_SUBSTR$ )
+rc_intern_trim( TRIM$_SRC$ )
+rc_intern_ucase( UCASE$_SRC$ )
+rc_intern_val( VAL_N$ )
+rc_intern_size( SIZE_S$ )
+rc_intern_bufferFromString( BUFFERFROMSTRING_S$, &BUFFERFROMSTRING_BUFFER )
+rc_intern_stringFromBuffer( &STRINGFROMBUFFER$_BUFFER, STRINGFROMBUFFER$_BUFFER_SIZE )
+rc_intern_createStack_N( )
+rc_intern_createStack_S( )
+rc_intern_clearStack_N( CLEARSTACK_N_NUM_STACK )
+rc_intern_clearStack_S( CLEARSTACK_S_STR_STACK )
+rc_intern_deleteStack_N( DELETESTACK_N_NUM_STACK )
+rc_intern_deleteStack_S( DELETESTACK_S_STR_STACK )
+rc_intern_push_n( PUSH_N_NUM_STACK, PUSH_N_N )
+rc_intern_pop_n( POP_N_NUM_STACK )
+rc_intern_push_s( PUSH_S_STR_STACK, PUSH_S_S$ )
+rc_intern_pop_s( POP_S$_STR_STACK )
+rc_intern_n_stack_size( STACK_SIZE_N_NUM_STACK )
+rc_intern_s_stack_size( STACK_SIZE_S_STR_STACK )
+rc_intern_fileOpen( OPENFILE_FILENAME$, OPENFILE_MODE )
+rc_intern_fileClose( CLOSEFILE_STREAM )
+rc_intern_fileReadByte( READBYTE_STREAM )
+rc_intern_fileWriteByte( WRITEBYTE_STREAM, WRITEBYTE_BYTE )
+rc_intern_fileReadLine( READLINE$_STREAM )
+rc_intern_fileWrite( WRITE_STREAM, WRITE_TXT$ )
+rc_intern_fileWriteLine( WRITELINE_STREAM, WRITELINE_TXT$ )
+rc_intern_fileCopy( COPYFILE_SRC$, COPYFILE_DST$ )
+rc_intern_fileDelete( REMOVEFILE_FILENAME$ )
+rc_intern_fileExist( FILEEXISTS_FILENAME$ )
+rc_intern_fileMove( MOVEFILE_SRC$, MOVEFILE_DST$ )
+rc_intern_fileRename( RENAMEFILE_SRC$, RENAMEFILE_DST$ )
+rc_intern_fileLength( FILELENGTH_FILENAME$ )
+rc_intern_fileTell( TELL_STREAM )
+rc_intern_fileSeek( SEEK_STREAM, SEEK_POS )
+rc_intern_eof( EOF_STREAM )
+rc_intern_fileWriteByteBuffer( WRITEBYTEBUFFER_STREAM, &WRITEBYTEBUFFER_BUF, WRITEBYTEBUFFER_BUF_SIZE )
+rc_intern_fileReadByteBuffer( READBYTEBUFFER_STREAM, &READBYTEBUFFER_BUF, READBYTEBUFFER_BUF_SIZE )
+rc_intern_dirChange( CHANGEDIR_P$ )
+rc_intern_dirExist( DIREXISTS_P$ )
+rc_intern_dirFirst( )
+rc_intern_dir( )
+rc_intern_dirNext( )
+rc_intern_dirCreate( MAKEDIR_P$ )
+rc_intern_dirDelete( REMOVEDIR_P$ )
+rc_intern_date( )
+rc_intern_easter( EASTER$_YEAR )
+rc_intern_ticks( )
+rc_intern_time( )
+rc_intern_timer( )
+rc_intern_wait( WAIT_M_SEC )
+rc_windowOpen( OPENWINDOW_TITLE$, OPENWINDOW_W, OPENWINDOW_H, OPENWINDOW_FULLSCREEN, OPENWINDOW_VSYNC )
+rc_windowOpenEx( OPENWINDOWEX_TITLE$, OPENWINDOWEX_X, OPENWINDOWEX_Y, OPENWINDOWEX_W, OPENWINDOWEX_H, OPENWINDOWEX_MODE, OPENWINDOWEX_AA, OPENWINDOWEX_STENCIL_BUFFER, OPENWINDOWEX_VSYNC )
+rc_closeWindow_hw( )
+rc_raiseWindow( )
+rc_update( )
+rc_cls( )
+rc_setClearColor( SETCLEARCOLOR_C )
+rc_showWindow( )
+rc_hideWindow( )
+rc_setWindowTitle( SETWINDOWTITLE_TITLE$ )
+rc_getWindowTitle( )
+rc_setWindowPosition( SETWINDOWPOSITION_X, SETWINDOWPOSITION_Y )
+rc_getWindowPosition( &GETWINDOWPOSITION_X, &GETWINDOWPOSITION_Y )
+rc_setWindowSize( SETWINDOWSIZE_W, SETWINDOWSIZE_H )
+rc_getWindowSize( &GETWINDOWSIZE_W, &GETWINDOWSIZE_H )
+rc_setWindowMinSize( SETWINDOWMINSIZE_W, SETWINDOWMINSIZE_H )
+rc_getWindowMinSize( &GETWINDOWMINSIZE_W, &GETWINDOWMINSIZE_H )
+rc_setWindowMaxSize( SETWINDOWMAXSIZE_W, SETWINDOWMAXSIZE_H )
+rc_getWindowMaxSize( &GETWINDOWMAXSIZE_W, &GETWINDOWMAXSIZE_H )
+rc_windowIsFullscreen( )
+rc_windowIsVisible( )
+rc_windowIsBordered( )
+rc_windowIsResizable( )
+rc_windowIsMinimized( )
+rc_windowIsMaximized( )
+rc_windowHasInputFocus( )
+rc_windowHasMouseFocus( )
+rc_setWindowFullscreen( SETWINDOWFULLSCREEN_FLAG )
+rc_maximizeWindow( )
+rc_minimizeWindow( )
+rc_setWindowBordered( SETWINDOWBORDERED_FLAG )
+rc_windowClip( WINDOWCLIP_X, WINDOWCLIP_Y, WINDOWCLIP_W, WINDOWCLIP_H )
+rc_windowExists( )
+rc_windowEvent_Close( )
+rc_windowEvent_Maximize( )
+rc_windowEvent_Minimize( )
+rc_FPS( )
+rc_setWindowIcon( SETWINDOWICON_SLOT )
+rc_windowEvent_Resize( )
+rc_setWindowAutoClose( SETWINDOWAUTOCLOSE_EXIT_ON_CLOSE )
+rc_setWindowResizable( SETWINDOWRESIZABLE_FLAG )
+rc_windowMode( WINDOWMODE_VISIBLE, WINDOWMODE_FULLSCREEN, WINDOWMODE_RESIZABLE, WINDOWMODE_BORDERLESS, WINDOWMODE_HIGHDPI )
+rc_getWindowMode( )
+rc_restoreWindow( )
+rc_grabInput( GRABINPUT_FLAG )
+rc_setWindowAlwaysOnTop( SETWINDOWALWAYSONTOP_FLAG )
+rc_setMouseRelative( SETMOUSERELATIVE_FLAG )
+rc_flashWindow( FLASHWINDOW_FLAG )
+rc_windowIsGrabbed( )
+rc_preUpdate( )
+rc_canvasOpen( OPENCANVAS_W, OPENCANVAS_H, OPENCANVAS_VIEWPORT_X, OPENCANVAS_VIEWPORT_Y, OPENCANVAS_VIEWPORT_W, OPENCANVAS_VIEWPORT_H, OPENCANVAS_MODE )
+rc_canvasClose( CLOSECANVAS_C_NUM )
+rc_canvasOpen3D( OPENCANVAS3D_VIEWPORT_X, OPENCANVAS3D_VIEWPORT_Y, OPENCANVAS3D_VIEWPORT_W, OPENCANVAS3D_VIEWPORT_H, OPENCANVAS3D_MODE )
+rc_setCanvasVisible( SETCANVASVISIBLE_C_NUM, SETCANVASVISIBLE_FLAG )
+rc_canvasIsVisible( CANVASISVISIBLE_C_NUM )
+rc_setCanvasViewport( SETCANVASVIEWPORT_CNUM, SETCANVASVIEWPORT_X, SETCANVASVIEWPORT_Y, SETCANVASVIEWPORT_W, SETCANVASVIEWPORT_H )
+rc_getCanvasViewport( GETCANVASVIEWPORT_C_NUM, &GETCANVASVIEWPORT_X, &GETCANVASVIEWPORT_Y, &GETCANVASVIEWPORT_W, &GETCANVASVIEWPORT_H )
+rc_setActiveCanvas( CANVAS_C_NUM )
+rc_setCanvasOffset( SETCANVASOFFSET_C_NUM, SETCANVASOFFSET_X, SETCANVASOFFSET_Y )
+rc_getCanvasOffset( GETCANVASOFFSET_C_NUM, &GETCANVASOFFSET_X, &GETCANVASOFFSET_Y )
+rc_getCanvasSize( GETCANVASSIZE_C_NUM, &GETCANVASSIZE_W, &GETCANVASSIZE_H )
+rc_clearCanvas( )
+rc_setCanvasAlpha( SETCANVASALPHA_C_NUM, SETCANVASALPHA_A )
+rc_canvasAlpha( GETCANVASALPHA_C_NUM )
+rc_setCanvasColorMod( SETCANVASCOLORMOD_C_NUM, SETCANVASCOLORMOD_C )
+rc_getCanvasColorMod( GETCANVASCOLORMOD_C_NUM )
+rc_cloneCanvas( CLONECANVAS_C_NUM, CLONECANVAS_MODE )
+rc_setCanvasZ( SETCANVASZ_C_NUM, SETCANVASZ_Z )
+rc_getCanvasZ( CANVASZ_C_NUM )
+rc_canvasClip( CANVASCLIP_X, CANVASCLIP_Y, CANVASCLIP_W, CANVASCLIP_H )
+rc_activeCanvas( )
+rc_setCanvasPhysics2D( SETCANVASPHYSICS2D_C_NUM, SETCANVASPHYSICS2D_STATE )
+rc_canvasOpenSpriteLayer( OPENCANVASSPRITELAYER_VIEWPORT_X, OPENCANVASSPRITELAYER_VIEWPORT_Y, OPENCANVASSPRITELAYER_VIEWPORT_W, OPENCANVASSPRITELAYER_VIEWPORT_H )
+rc_drawCircle( CIRCLE_X, CIRCLE_Y, CIRCLE_RADIUS )
+rc_drawCircleFill( CIRCLEFILL_X, CIRCLEFILL_Y, CIRCLEFILL_RADIUS )
+rc_drawEllipse( ELLIPSE_X, ELLIPSE_Y, ELLIPSE_RX, ELLIPSE_RY )
+rc_drawEllipseFill( ELLIPSEFILL_X, ELLIPSEFILL_Y, ELLIPSEFILL_RX, ELLIPSEFILL_RY )
+rc_floodFill( FLOODFILL_X, FLOODFILL_Y )
+rc_getPixel( GETPIXEL_X, GETPIXEL_Y )
+rc_setColor( SETCOLOR_C )
+rc_drawLine( LINE_X1, LINE_Y1, LINE_X2, LINE_Y2 )
+rc_poly( POLY_N, &POLY_X, &POLY_Y )
+rc_drawRect( RECT_X, RECT_Y, RECT_W, RECT_H )
+rc_drawRectFill( RECTFILL_X, RECTFILL_Y, RECTFILL_W, RECTFILL_H )
+rc_rgb( RGB_R, RGB_G, RGB_B )
+rc_rgba( RGBA_R, RGBA_G, RGBA_B, RGBA_A )
+rc_drawPixel( PSET_X, PSET_Y )
+rc_drawTriangle( TRIANGLE_X1, TRIANGLE_Y1, TRIANGLE_X2, TRIANGLE_Y2, TRIANGLE_X3, TRIANGLE_Y3 )
+rc_drawLine3D( LINE3D_X1, LINE3D_Y1, LINE3D_Z1, LINE3D_X2, LINE3D_Y2, LINE3D_Z2 )
+rc_drawBox3D( BOX3D_MIN_X, BOX3D_MIN_Y, BOX3D_MIN_Z, BOX3D_MAX_X, BOX3D_MAX_Y, BOX3D_MAX_Z )
+rc_drawTriangle3D( TRIANGLE3D_X1, TRIANGLE3D_Y1, TRIANGLE3D_Z1, TRIANGLE3D_X2, TRIANGLE3D_Y2, TRIANGLE3D_Z2, TRIANGLE3D_X3, TRIANGLE3D_Y3, TRIANGLE3D_Z3 )
+rc_loadImage( LOADIMAGE_IMG$ )
+rc_loadImageEx( LOADIMAGEEX_IMG$, LOADIMAGEEX_COLKEY )
+rc_createImage( CREATEIMAGE_W, CREATEIMAGE_H, &CREATEIMAGE_BUFFER )
+rc_createImageEx( CREATEIMAGEEX_W, CREATEIMAGEEX_H, &CREATEIMAGEEX_BUFFER, CREATEIMAGEEX_COLOR )
+rc_getImageBuffer( BUFFERFROMIMAGE_SLOT, &BUFFERFROMIMAGE_BUFFER )
+rc_imageExists( IMAGEEXISTS_SLOT )
+rc_setColorKey( COLORKEY_SLOT, COLORKEY_C )
+rc_setBilinearFilter( SETBILINEARFILTER_FLAG )
+rc_getBilinearFilter( )
+rc_copyImage( COPYIMAGE_IMG_ID )
+rc_deleteImage( DELETEIMAGE_SLOT )
+rc_setImageAlpha( SETIMAGEALPHA_SLOT, SETIMAGEALPHA_A )
+rc_getImageAlpha( GETIMAGEALPHA_IMG_ID )
+rc_getImageSize( GETIMAGESIZE_SLOT, &GETIMAGESIZE_W, &GETIMAGESIZE_H )
+rc_setBlendMode( SETBLENDMODE_BLEND_MODE )
+rc_getBlendMode( )
+rc_setImageColorMod( SETIMAGECOLORMOD_SLOT, SETIMAGECOLORMOD_C )
+rc_getImageColorMod( GETIMAGECOLORMOD_SLOT )
+rc_drawImage( DRAWIMAGE_SLOT, DRAWIMAGE_X, DRAWIMAGE_Y )
+rc_drawImage_Blit( DRAWIMAGE_BLIT_SLOT, DRAWIMAGE_BLIT_X, DRAWIMAGE_BLIT_Y, DRAWIMAGE_BLIT_SRC_X, DRAWIMAGE_BLIT_SRC_Y, DRAWIMAGE_BLIT_SRC_W, DRAWIMAGE_BLIT_SRC_H )
+rc_drawImage_BlitEx( DRAWIMAGE_BLITEX_SLOT, DRAWIMAGE_BLITEX_X, DRAWIMAGE_BLITEX_Y, DRAWIMAGE_BLITEX_W, DRAWIMAGE_BLITEX_H, DRAWIMAGE_BLITEX_SRC_X, DRAWIMAGE_BLITEX_SRC_Y, DRAWIMAGE_BLITEX_SRC_W, DRAWIMAGE_BLITEX_SRC_H )
+rc_drawImage_Rotate( DRAWIMAGE_ROTATE_SLOT, DRAWIMAGE_ROTATE_X, DRAWIMAGE_ROTATE_Y, DRAWIMAGE_ROTATE_ANGLE )
+rc_drawImage_RotateEx( DRAWIMAGE_ROTATEEX_SLOT, DRAWIMAGE_ROTATEEX_X, DRAWIMAGE_ROTATEEX_Y, DRAWIMAGE_ROTATEEX_SRC_X, DRAWIMAGE_ROTATEEX_SRC_Y, DRAWIMAGE_ROTATEEX_SRC_W, DRAWIMAGE_ROTATEEX_SRC_H, DRAWIMAGE_ROTATEEX_ANGLE )
+rc_drawImage_Zoom( DRAWIMAGE_ZOOM_SLOT, DRAWIMAGE_ZOOM_X, DRAWIMAGE_ZOOM_Y, DRAWIMAGE_ZOOM_ZX, DRAWIMAGE_ZOOM_ZY )
+rc_drawImage_ZoomEx( DRAWIMAGE_ZOOMEX_SLOT, DRAWIMAGE_ZOOMEX_X, DRAWIMAGE_ZOOMEX_Y, DRAWIMAGE_ZOOMEX_SRC_X, DRAWIMAGE_ZOOMEX_SRC_Y, DRAWIMAGE_ZOOMEX_SRC_W, DRAWIMAGE_ZOOMEX_SRC_H, DRAWIMAGE_ZOOMEX_ZX, DRAWIMAGE_ZOOMEX_ZY )
+rc_drawImage_Rotozoom( DRAWIMAGE_ROTOZOOM_SLOT, DRAWIMAGE_ROTOZOOM_X, DRAWIMAGE_ROTOZOOM_Y, DRAWIMAGE_ROTOZOOM_ANGLE, DRAWIMAGE_ROTOZOOM_ZX, DRAWIMAGE_ROTOZOOM_ZY )
+rc_drawImage_RotozoomEx( DRAWIMAGE_ROTOZOOMEX_SLOT, DRAWIMAGE_ROTOZOOMEX_X, DRAWIMAGE_ROTOZOOMEX_Y, DRAWIMAGE_ROTOZOOMEX_SRC_X, DRAWIMAGE_ROTOZOOMEX_SRC_Y, DRAWIMAGE_ROTOZOOMEX_SRC_W, DRAWIMAGE_ROTOZOOMEX_SRC_H, DRAWIMAGE_ROTOZOOMEX_ANGLE, DRAWIMAGE_ROTOZOOMEX_ZX, DRAWIMAGE_ROTOZOOMEX_ZY )
+rc_drawImage_Flip( DRAWIMAGE_FLIP_SLOT, DRAWIMAGE_FLIP_X, DRAWIMAGE_FLIP_Y, DRAWIMAGE_FLIP_H, DRAWIMAGE_FLIP_V )
+rc_drawImage_FlipEx( DRAWIMAGE_FLIPEX_SLOT, DRAWIMAGE_FLIPEX_X, DRAWIMAGE_FLIPEX_Y, DRAWIMAGE_FLIPEX_SRC_X, DRAWIMAGE_FLIPEX_SRC_Y, DRAWIMAGE_FLIPEX_SRC_W, DRAWIMAGE_FLIPEX_SRC_H, DRAWIMAGE_FLIPEX_H, DRAWIMAGE_FLIPEX_V )
+rc_inKey( )
+rc_key( KEY_KEY_CODE )
+rc_waitKey( )
+rc_hideMouse( )
+rc_showMouse( )
+rc_mouseIsVisible( )
+rc_getMouse( &GETMOUSE_X, &GETMOUSE_Y, &GETMOUSE_MB1, &GETMOUSE_MB2, &GETMOUSE_MB3 )
+rc_mouseX( )
+rc_mouseY( )
+rc_mouseButton( MOUSEBUTTON_MB )
+rc_getMouseWheel( &GETMOUSEWHEEL_X_AXIS, &GETMOUSEWHEEL_Y_AXIS )
+rc_mouseWheelX( )
+rc_mouseWheelY( )
+rc_getGlobalMouse( &GETGLOBALMOUSE_X, &GETGLOBALMOUSE_Y, &GETGLOBALMOUSE_MB1, &GETGLOBALMOUSE_MB2, &GETGLOBALMOUSE_MB3 )
+rc_globalMouseX( )
+rc_globalMouseY( )
+rc_warpMouse( WARPMOUSE_X, WARPMOUSE_Y )
+rc_warpMouseGlobal( WARPMOUSEGLOBAL_X, WARPMOUSEGLOBAL_Y )
+rc_setMouseZone( SETMOUSEZONE_X, SETMOUSEZONE_Y, SETMOUSEZONE_W, SETMOUSEZONE_H )
+rc_clearMouseZone( )
+rc_createSound( &CREATESOUND_BUFFER, CREATESOUND_BUFFER_SIZE, CREATESOUND_VOL )
+rc_loadSound( LOADSOUND_SND_FILE$ )
+rc_loadMusic( LOADMUSIC_MUSIC_FILE$ )
+rc_playSound( PLAYSOUND_SLOT, PLAYSOUND_CHANNEL, PLAYSOUND_LOOPS )
+rc_playSoundTimed( PLAYSOUNDTIMED_SLOT, PLAYSOUNDTIMED_CHANNEL, PLAYSOUNDTIMED_LOOPS, PLAYSOUNDTIMED_MS )
+rc_playMusic( PLAYMUSIC_MLOOPS )
+rc_pauseSound( PAUSESOUND_CHANNEL )
+rc_resumeSound( RESUMESOUND_CHANNEL )
+rc_pauseMusic( )
+rc_resumeMusic( )
+rc_deleteSound( DELETESOUND_SLOT )
+rc_deleteMusic( )
+rc_fadeMusicIn( FADEMUSICIN_FADE_TIME, FADEMUSICIN_LOOPS )
+rc_fadeMusicOut( FADEMUSICOUT_FADE_TIME )
+rc_musicExists( )
+rc_setMusicVolume( SETMUSICVOLUME_VOL )
+rc_getMusicVolume( )
+rc_setMusicPosition( SETMUSICPOSITION_POS )
+rc_getMusicPosition( )
+rc_rewindMusic( )
+rc_setSoundChannels( SETSOUNDCHANNELS_MAX_CHANNELS )
+rc_getSoundChannels( )
+rc_soundIsEnabled( )
+rc_soundExists( SOUNDEXISTS_SLOT )
+rc_setChannelVolume( SETCHANNELVOLUME_CHANNEL, SETCHANNELVOLUME_VOL )
+rc_getChannelVolume( GETCHANNELVOLUME_CHANNEL )
+rc_setSoundVolume( SETSOUNDVOLUME_SLOT, SETSOUNDVOLUME_VOL )
+rc_getSoundVolume( GETSOUNDVOLUME_SLOT )
+rc_stopMusic( )
+rc_stopSound( STOPSOUND_CHANNEL )
+rc_setChannelPanning( SETCHANNELPANNING_CHANNEL, SETCHANNELPANNING_LEFT_VALUE, SETCHANNELPANNING_RIGHT_VALUE )
+rc_setChannelDistance( SETCHANNELDISTANCE_CHANNEL, SETCHANNELDISTANCE_DIST_VALUE )
+rc_channelIsPlaying( CHANNELISPLAYING_CHANNEL )
+rc_channelIsPaused( CHANNELISPAUSED_CHANNEL )
+rc_queryAudioSpec( &QUERYAUDIOSPEC_FREQ, &QUERYAUDIOSPEC_FORMAT, &QUERYAUDIOSPEC_CHANNELS )
+rc_musicIsPlaying( )
+rc_setChannelSpacePosition( SETCHANNELSPACEPOSITION_CHANNEL, SETCHANNELSPACEPOSITION_ANGLE, SETCHANNELSPACEPOSITION_DISTANCE )
+rc_getNumJoysticks( )
+rc_numJoyAxes( NUMJOYAXES_JOY_NUM )
+rc_numJoyButtons( NUMJOYBUTTONS_JOY_NUM )
+rc_numJoyHats( NUMJOYHATS_JOY_NUM )
+rc_numJoyTrackBalls( NUMJOYTRACKBALLS_JOY_NUM )
+rc_joyAxis( JOYAXIS_JOY_NUM, JOYAXIS_JOY_AXIS )
+rc_joyButton( JOYBUTTON_JOY_NUM, JOYBUTTON_JOY_BUTTON )
+rc_joyHat( JOYHAT_JOY_NUM, JOYHAT_JOY_HAT )
+rc_getJoyTrackBall( GETJOYTRACKBALL_JOY_NUM, GETJOYTRACKBALL_BALL, &GETJOYTRACKBALL_DX, &GETJOYTRACKBALL_DY )
+rc_joyName( JOYNAME$_JOY_NUM )
+rc_joystickIsConnected( JOYSTICKISCONNECTED_JOY_NUM )
+rc_joyRumblePlay( JOYRUMBLEPLAY_JOY_NUM, JOYRUMBLEPLAY_STRENGTH, JOYRUMBLEPLAY_DURATION )
+rc_joyRumbleStop( JOYRUMBLESTOP_JOY_NUM )
+rc_joystickIsHaptic( JOYSTICKISHAPTIC_JOY_NUM )
+rc_loadFont( LOADFONT_FNT_FILE$, LOADFONT_FONT_SIZE )
+rc_deleteFont( DELETEFONT_SLOT )
+rc_fontExists( FONTEXISTS_SLOT )
+rc_setFont( SETFONT_SLOT )
+rc_drawText( DRAWTEXT_TXT$, DRAWTEXT_X, DRAWTEXT_Y )
+rc_getTextSize( GETTEXTSIZE_TXT$, &GETTEXTSIZE_W, &GETTEXTSIZE_H )
+rc_getTextWidth( TEXTWIDTH_TXT$ )
+rc_getTextHeight( TEXTHEIGHT_TXT$ )
+rc_touchPressure( )
+rc_getTouch( &GETTOUCH_STATUS, &GETTOUCH_X, &GETTOUCH_Y, &GETTOUCH_DX, &GETTOUCH_DY )
+rc_getMultiTouch( &GETMULTITOUCH_STATUS, &GETMULTITOUCH_X, &GETMULTITOUCH_Y, &GETMULTITOUCH_FINGERS, &GETMULTITOUCH_DIST, &GETMULTITOUCH_THETA )
+rc_getTouchFinger( GETTOUCHFINGER_FINGER, &GETTOUCHFINGER_X, &GETTOUCHFINGER_Y, &GETTOUCHFINGER_PRESSURE )
+rc_numFingers( )
+rc_getAccel( GETACCEL_ACCEL_NUM, &GETACCEL_X, &GETACCEL_Y, &GETACCEL_Z )
+rc_accelName( ACCELNAME$_ACCEL_NUM )
+rc_numAccels( )
+rc_getGyro( GETGYRO_GYRO_NUM, &GETGYRO_X, &GETGYRO_Y, &GETGYRO_Z )
+rc_gyroName( GYRONAME$_GYRO_NUM )
+rc_numGyros( )
+rc_net_checkSockets( CHECKSOCKETS_TIMEOUT_MS )
+rc_net_tcp_socketReady( TCP_SOCKETREADY_SOCKET )
+rc_net_udp_socketReady( UDP_SOCKETREADY_SOCKET )
+rc_net_tcp_openSocket( TCP_OPENSOCKET_HOST$, TCP_OPENSOCKET_PORT )
+rc_net_tcp_closeSocket( TCP_CLOSESOCKET_SOCKET )
+rc_net_tcp_remoteHost( TCP_REMOTEHOST_SOCKET )
+rc_net_tcp_remotePort( TCP_REMOTEPORT_SOCKET )
+rc_net_tcp_getData_str( TCP_GETDATA_SOCKET, TCP_GETDATA_NUMBYTES, &TCP_GETDATA_SDATA$ )
+rc_net_tcp_sendData( TCP_SENDDATA_SOCKET, TCP_SENDDATA_SDATA$ )
+rc_net_tcp_acceptSocket( TCP_ACCEPTSOCKET_SERVER )
+rc_net_udp_openSocket( UDP_OPENSOCKET_PORT )
+rc_net_udp_closeSocket( UDP_CLOSESOCKET_SOCKET )
+rc_net_udp_readStream( UDP_GETDATA_SOCKET, &UDP_GETDATA_HOST$, &UDP_GETDATA_PORT, &UDP_GETDATA_SDATA$ )
+rc_net_udp_len( )
+rc_net_udp_maxlen( )
+rc_net_udp_getRemoteHost( UDP_REMOTEHOST$_SOCKET )
+rc_net_udp_getRemotePort( UDP_REMOTEPORT_SOCKET )
+rc_net_udp_sendData( UDP_SENDDATA_SOCKET, UDP_SENDDATA_HOST$, UDP_SENDDATA_PORT, UDP_SENDDATA_SDATA$ )
+rc_loadVideo( LOADVIDEO_VID$ )
+rc_playVideo( PLAYVIDEO_VLOOPS )
+rc_pauseVideo( )
+rc_stopVideo( )
+rc_setVideoPosition( SETVIDEOPOSITION_POS )
+rc_resumeVideo( )
+rc_getVideoPosition( )
+rc_deleteVideo( )
+rc_videoIsPlaying( )
+rc_videoEnd( )
+rc_getVideoStats( GETVIDEOSTATS_VFILE$, &GETVIDEOSTATS_VLEN, &GETVIDEOSTATS_VFPS, &GETVIDEOSTATS_FRAME_W, &GETVIDEOSTATS_FRAME_H )
+rc_setVideoDrawRect( SETVIDEODRAWRECT_X, SETVIDEODRAWRECT_Y, SETVIDEODRAWRECT_W, SETVIDEODRAWRECT_H )
+rc_getVideoDrawRect( &GETVIDEODRAWRECT_X, &GETVIDEODRAWRECT_Y, &GETVIDEODRAWRECT_W, &GETVIDEODRAWRECT_H )
+rc_getVideoSize( &GETVIDEOSIZE_W, &GETVIDEOSIZE_H )
+rc_videoExists( )
+rc_setVideoVolume( SETVIDEOVOLUME_VOL )
+rc_getVideoVolume( )
+rc_intern_system( SYSTEM_CMD$ )
+rc_intern_OS( )
+rc_intern_command( COMMAND$_ARG )
+rc_intern_numCommands( )
+rc_intern_env( ENV$_V$ )
+rc_intern_setEnv( SETENV_VAR$, SETENV_VALUE$ )
+rc_intern_prefPath( PREFPATH$_ORG_NAME$, PREFPATH$_APP_NAME$ )
+rc_intern_android_getExternalStoragePath( )
+rc_intern_android_getExternalStorageState( )
+rc_intern_android_getInternalStoragePath( )
+rc_intern_android_jni_message( ANDROID_JNI_MESSAGE$_ARG$ )
+rc_intern_runtime_utility( RUNTIME_UTILITY_MESSAGE$_ARG$ )
+rc_getDesktopDisplayMode( GETDESKTOPDISPLAYMODE_INDEX, &GETDESKTOPDISPLAYMODE_W, &GETDESKTOPDISPLAYMODE_H, &GETDESKTOPDISPLAYMODE_FREQ )
+rc_intern_getPowerInfo( &GETPOWERINFO_STATUS, &GETPOWERINFO_SECS, &GETPOWERINFO_PCT )
+rc_intern_evalJS( EVALJS$_JS_CODE$ )
+rc_intern_sysReturnOutput( SYSTEMRETURNSTDOUT$_CMD$ )
+rc_openURL( OPENURL_URL$ )
+rc_messageBox( MESSAGEBOX_TITLE$, MESSAGEBOX_MSG$ )
+#/home/n00b/Projects/RCBASIC4/rcbasic_build/intern_inc/exceptions/rc_runtime.h
+rc_numCPUs( )
+rc_intern_systemRam( )
+rc_dimMatrix( DIMMATRIX_M_ROWS, DIMMATRIX_M_COLS )
+rc_deleteMatrix( DELETEMATRIX_MA )
+rc_addMatrix( ADDMATRIX_MA, ADDMATRIX_MB, ADDMATRIX_MC )
+rc_augmentMatrix( AUGMENTMATRIX_MA, AUGMENTMATRIX_MB, AUGMENTMATRIX_MC )
+rc_copyMatrix( COPYMATRIX_MA, COPYMATRIX_MB )
+rc_insertMatrixColumns( INSERTMATRIXCOLUMNS_MA, INSERTMATRIXCOLUMNS_C, INSERTMATRIXCOLUMNS_NUM_COLS )
+rc_insertMatrixRows( INSERTMATRIXROWS_MA, INSERTMATRIXROWS_R, INSERTMATRIXROWS_NUM_ROWS )
+rc_multiplyMatrix( MULTIPLYMATRIX_MA, MULTIPLYMATRIX_MB, MULTIPLYMATRIX_MC )
+rc_cubeMatrix( CUBEMATRIX_MA, CUBEMATRIX_MB )
+rc_deleteMatrixColumns( DELETEMATRIXCOLUMNS_MA, DELETEMATRIXCOLUMNS_C, DELETEMATRIXCOLUMNS_NUM_COLS )
+rc_deleteMatrixRows( DELETEMATRIXROWS_MA, DELETEMATRIXROWS_R, DELETEMATRIXROWS_NUM_ROWS )
+rc_clearMatrix( CLEARMATRIX_MA )
+rc_clearMatrixColumns( CLEARMATRIXCOLUMNS_MA, CLEARMATRIXCOLUMNS_C, CLEARMATRIXCOLUMNS_NUM_COLS )
+rc_clearMatrixRows( CLEARMATRIXROWS_MA, CLEARMATRIXROWS_R, CLEARMATRIXROWS_NUM_ROWS )
+rc_fillMatrix( FILLMATRIX_MA, FILLMATRIX_V )
+rc_fillMatrixColumns( FILLMATRIXCOLUMNS_MA, FILLMATRIXCOLUMNS_C, FILLMATRIXCOLUMNS_NUM_COLS, FILLMATRIXCOLUMNS_V )
+rc_fillMatrixRows( FILLMATRIXROWS_MA, FILLMATRIXROWS_R, FILLMATRIXROWS_NUM_ROWS, FILLMATRIXROWS_V )
+rc_copyMatrixColumns( COPYMATRIXCOLUMNS_MA, COPYMATRIXCOLUMNS_MB, COPYMATRIXCOLUMNS_C, COPYMATRIXCOLUMNS_NUM_COLS )
+rc_copyMatrixRows( COPYMATRIXROWS_MA, COPYMATRIXROWS_MB, COPYMATRIXROWS_R, COPYMATRIXROWS_NUM_ROWS )
+rc_setIdentityMatrix( SETIDENTITYMATRIX_MA, SETIDENTITYMATRIX_N )
+rc_solveMatrix( SOLVEMATRIX_MA, SOLVEMATRIX_MB, SOLVEMATRIX_MC )
+rc_isEqualMatrix( ISEQUALMATRIX_MA, ISEQUALMATRIX_MB, ISEQUALMATRIX_TOLERANCE )
+rc_determinant( DETERMINANT_MA )
+rc_adjointMatrix( ADJOINTMATRIX_MA, ADJOINTMATRIX_MB )
+rc_invertMatrix( INVERTMATRIX_MA, INVERTMATRIX_MB )
+rc_matrixFromBuffer( MATRIXFROMBUFFER_MA, MATRIXFROMBUFFER_R, MATRIXFROMBUFFER_C, &MATRIXFROMBUFFER_BUFFER )
+rc_bufferFromMatrix( &BUFFERFROMMATRIX_BUFFER, BUFFERFROMMATRIX_MA )
+rc_randomizeMatrix( RANDOMIZEMATRIX_MA, RANDOMIZEMATRIX_VMIN, RANDOMIZEMATRIX_VMAX )
+rc_matrixValue( MATRIXVALUE_MA, MATRIXVALUE_R, MATRIXVALUE_C )
+rc_setMatrixValue( SETMATRIXVALUE_MA, SETMATRIXVALUE_R, SETMATRIXVALUE_C, SETMATRIXVALUE_V )
+rc_scalarMatrix( SCALARMATRIX_MA, SCALARMATRIX_MB, SCALARMATRIX_S_VALUE )
+rc_scalarMatrixColumns( SCALARMATRIXCOLUMNS_MA, SCALARMATRIXCOLUMNS_MB, SCALARMATRIXCOLUMNS_C, SCALARMATRIXCOLUMNS_NUM_COLS, SCALARMATRIXCOLUMNS_S_VALUE )
+rc_scalarMatrixRows( SCALARMATRIXROWS_MA, SCALARMATRIXROWS_MB, SCALARMATRIXROWS_R, SCALARMATRIXROWS_NUM_ROWS, SCALARMATRIXROWS_S_VALUE )
+rc_squareMatrix( SQUAREMATRIX_MA, SQUAREMATRIX_MB )
+rc_subMatrix( COFACTORMATRIX_MA, COFACTORMATRIX_R, COFACTORMATRIX_C )
+rc_subtractMatrix( SUBTRACTMATRIX_MA, SUBTRACTMATRIX_MB, SUBTRACTMATRIX_MC )
+rc_swapMatrix( SWAPMATRIX_MA, SWAPMATRIX_MB )
+rc_swapMatrixColumn( SWAPMATRIXCOLUMN_MA, SWAPMATRIXCOLUMN_C1, SWAPMATRIXCOLUMN_C2 )
+rc_swapMatrixRow( SWAPMATRIXROW_MA, SWAPMATRIXROW_R1, SWAPMATRIXROW_R2 )
+rc_transposeMatrix( TRANSPOSEMATRIX_MA, TRANSPOSEMATRIX_MB )
+rc_unAugmentMatrix( UNAUGMENTMATRIX_MA, UNAUGMENTMATRIX_MB, UNAUGMENTMATRIX_MC )
+rc_zeroMatrix( ZEROMATRIX_MA )
+rc_getMatrixSize( GETMATRIXSIZE_MA, &GETMATRIXSIZE_R, &GETMATRIXSIZE_C )
+rc_incrementMatrixRows( INCREMENTMATRIXROWS_MA, INCREMENTMATRIXROWS_MB, INCREMENTMATRIXROWS_R, INCREMENTMATRIXROWS_NUM_ROWS, INCREMENTMATRIXROWS_VALUE )
+rc_incrementMatrixColumns( INCREMENTMATRIXCOLUMNS_MA, INCREMENTMATRIXCOLUMNS_MB, INCREMENTMATRIXCOLUMNS_C, INCREMENTMATRIXCOLUMNS_NUM_COLS, INCREMENTMATRIXCOLUMNS_VALUE )
+rc_joinMatrixRows( JOINMATRIXROWS_MA, JOINMATRIXROWS_MB, JOINMATRIXROWS_MC )
+rc_joinMatrixColumns( JOINMATRIXCOLUMNS_MA, JOINMATRIXCOLUMNS_MB, JOINMATRIXCOLUMNS_MC )
+rc_clipMatrix( CLIPMATRIX_MA, CLIPMATRIX_R, CLIPMATRIX_C, CLIPMATRIX_NUM_ROWS, CLIPMATRIX_NUM_COLS, CLIPMATRIX_MB )
+rc_setMatrixTranslation( SETMATRIXTRANSLATION_MA, SETMATRIXTRANSLATION_X, SETMATRIXTRANSLATION_Y, SETMATRIXTRANSLATION_Z )
+rc_setMatrixRotation( SETMATRIXROTATION_MA, SETMATRIXROTATION_X, SETMATRIXROTATION_Y, SETMATRIXROTATION_Z )
+rc_setMatrixScale( SETMATRIXSCALE_MA, SETMATRIXSCALE_X, SETMATRIXSCALE_Y, SETMATRIXSCALE_Z )
+rc_getMatrixTranslation( GETMATRIXTRANSLATION_MA, &GETMATRIXTRANSLATION_X, &GETMATRIXTRANSLATION_Y, &GETMATRIXTRANSLATION_Z )
+rc_getMatrixRotation( GETMATRIXROTATION_MA, &GETMATRIXROTATION_X, &GETMATRIXROTATION_Y, &GETMATRIXROTATION_Z )
+rc_getMatrixScale( GETMATRIXSCALE_MA, &GETMATRIXSCALE_X, &GETMATRIXSCALE_Y, &GETMATRIXSCALE_Z )
+rc_getClipboardText( )
+rc_setClipboardText( SETCLIPBOARDTEXT_TXT$ )
+rc_hasClipboardText( )
+rc_readInput_Start( )
+rc_readInput_Stop( )
+rc_readInput_GetText( )
+rc_readInput_SetText( READINPUT_SETTEXT_TXT$ )
+rc_readInput_ToggleBackspace( READINPUT_TOGGLEBACKSPACE_FLAG )
+rc_createSprite( CREATESPRITE_IMG, CREATESPRITE_FRAME_W, CREATESPRITE_FRAME_H )
+rc_deleteSprite( DELETESPRITE_SPRITE )
+rc_setSpritePosition( SETSPRITEPOSITION_SPRITE, SETSPRITEPOSITION_X, SETSPRITEPOSITION_Y )
+rc_translateSprite( TRANSLATESPRITE_SPRITE, TRANSLATESPRITE_X, TRANSLATESPRITE_Y )
+rc_getSpritePosition( GETSPRITEPOSITION_SPRITE, &GETSPRITEPOSITION_X, &GETSPRITEPOSITION_Y )
+rc_spriteX( SPRITEX_SPRITE )
+rc_spriteY( SPRITEY_SPRITE )
+rc_setSpriteRotation( SETSPRITEROTATION_SPRITE, SETSPRITEROTATION_ANGLE )
+rc_rotateSprite( ROTATESPRITE_SPRITE, ROTATESPRITE_ANGLE )
+rc_getSpriteRotation( GETSPRITEROTATION_SPRITE )
+rc_setSpriteScale( SETSPRITESCALE_SPRITE, SETSPRITESCALE_X, SETSPRITESCALE_Y )
+rc_scaleSprite( SCALESPRITE_SPRITE, SCALESPRITE_X, SCALESPRITE_Y )
+rc_getSpriteScale( GETSPRITESCALE_SPRITE, &GETSPRITESCALE_X, &GETSPRITESCALE_Y )
+rc_setSpriteZ( SETSPRITEZ_SPRITE, SETSPRITEZ_Z )
+rc_spriteZ( SPRITEZ_SPRITE )
+rc_getSpriteSize( GETSPRITESIZE_SPRITE, &GETSPRITESIZE_W, &GETSPRITESIZE_H )
+rc_spriteWidth( SPRITEWIDTH_SPRITE )
+rc_spriteHeight( SPRITEHEIGHT_SPRITE )
+rc_setSpriteVisible( SETSPRITEVISIBLE_SPRITE, SETSPRITEVISIBLE_FLAG )
+rc_spriteIsVisible( SPRITEISVISIBLE_SPRITE )
+rc_setSpriteSolid( SETSPRITESOLID_SPRITE, SETSPRITESOLID_FLAG )
+rc_spriteIsSolid( SPRITEISSOLID_SPRITE )
+rc_setSpriteType( SETSPRITETYPE_SPRITE, SETSPRITETYPE_SPRITE_TYPE )
+rc_getSpriteType( GETSPRITETYPE_SPRITE )
+rc_setSpriteSource( SETSPRITESOURCE_SPRITE, SETSPRITESOURCE_IMG )
+rc_getSpriteSource( GETSPRITESOURCE_SPRITE )
+rc_createSpriteAnimation( CREATESPRITEANIMATION_SPRITE, CREATESPRITEANIMATION_ANIM_LENGTH, CREATESPRITEANIMATION_SPEED )
+rc_setSpriteFrame( SETSPRITEFRAME_SPRITE, SETSPRITEFRAME_FRAME )
+rc_getSpriteFrame( GETSPRITEFRAME_SPRITE )
+rc_setSpriteAnimationFrame( SETSPRITEANIMATIONFRAME_SPRITE, SETSPRITEANIMATIONFRAME_ANIMATION, SETSPRITEANIMATIONFRAME_ANIM_FRAME, SETSPRITEANIMATIONFRAME_FRAME )
+rc_getSpriteAnimationFrame( GETSPRITEANIMATIONFRAME_SPRITE, GETSPRITEANIMATIONFRAME_ANIMATION, GETSPRITEANIMATIONFRAME_ANIM_FRAME )
+rc_setSpriteAnimationLength( SETSPRITEANIMATIONLENGTH_SPRITE, SETSPRITEANIMATIONLENGTH_ANIMATION, SETSPRITEANIMATIONLENGTH_ANIM_LENGTH )
+rc_getSpriteAnimationLength( GETSPRITEANIMATIONLENGTH_SPRITE, GETSPRITEANIMATIONLENGTH_ANIMATION )
+rc_setSpriteAnimationSpeed( SETSPRITEANIMATIONSPEED_SPRITE, SETSPRITEANIMATIONSPEED_ANIMATION, SETSPRITEANIMATIONSPEED_SPEED )
+rc_getSpriteAnimationSpeed( GETSPRITEANIMATIONSPEED_SPRITE, GETSPRITEANIMATIONSPEED_ANIMATION )
+rc_setSpriteAnimation( SETSPRITEANIMATION_SPRITE, SETSPRITEANIMATION_ANIMATION, SETSPRITEANIMATION_NUM_LOOPS )
+rc_getSpriteAnimation( GETSPRITEANIMATION_SPRITE )
+rc_getSpriteCurrentAnimationFrame( GETSPRITECURRENTANIMATIONFRAME_SPRITE )
+rc_numSpriteAnimationLoops( NUMSPRITEANIMATIONLOOPS_SPRITE )
+rc_spriteAnimationIsPlaying( SPRITEANIMATIONISPLAYING_SPRITE )
+rc_deleteSpriteAnimation( DELETESPRITEANIMATION_SPRITE, DELETESPRITEANIMATION_ANIMATION )
+rc_getSpriteCenter( GETSPRITECENTER_SPR_ID, &GETSPRITECENTER_X, &GETSPRITECENTER_Y )
+rc_setSpriteLinearVelocity( SETSPRITELINEARVELOCITY_SPR_ID, SETSPRITELINEARVELOCITY_X, SETSPRITELINEARVELOCITY_Y )
+rc_getSpriteLinearVelocity( GETSPRITELINEARVELOCITY_SPR_ID, &GETSPRITELINEARVELOCITY_X, &GETSPRITELINEARVELOCITY_Y )
+rc_setSpriteAngularVelocity( SETSPRITEANGULARVELOCITY_SPR_ID, SETSPRITEANGULARVELOCITY_AV )
+rc_getSpriteAngularVelocity( GETSPRITEANGULARVELOCITY_SPR_ID )
+rc_applySpriteForce( APPLYSPRITEFORCE_SPR_ID, APPLYSPRITEFORCE_FX, APPLYSPRITEFORCE_FY, APPLYSPRITEFORCE_PX, APPLYSPRITEFORCE_PY )
+rc_applySpriteCentralForce( APPLYSPRITECENTRALFORCE_SPR_ID, APPLYSPRITECENTRALFORCE_X, APPLYSPRITECENTRALFORCE_Y )
+rc_applySpriteTorque( APPLYSPRITETORQUE_SPR_ID, APPLYSPRITETORQUE_TORQUE )
+rc_applySpriteLinearImpulse( APPLYSPRITELINEARIMPULSE_SPR_ID, APPLYSPRITELINEARIMPULSE_IX, APPLYSPRITELINEARIMPULSE_IY, APPLYSPRITELINEARIMPULSE_PX, APPLYSPRITELINEARIMPULSE_PY )
+rc_applySpriteAngularImpulse( APPLYSPRITEANGULARIMPULSE_SPR_ID, APPLYSPRITEANGULARIMPULSE_IMPULSE )
+rc_getSpriteMass( GETSPRITEMASS_SPR_ID )
+rc_getSpriteInertia( GETSPRITEINERTIA_SPR_ID )
+rc_getSpriteWorldPoint( GETSPRITEWORLDPOINT_SPR_ID, GETSPRITEWORLDPOINT_LX, GETSPRITEWORLDPOINT_LY, &GETSPRITEWORLDPOINT_X, &GETSPRITEWORLDPOINT_Y )
+rc_getSpriteWorldVector( GETSPRITEWORLDVECTOR_SPR_ID, GETSPRITEWORLDVECTOR_LX, GETSPRITEWORLDVECTOR_LY, &GETSPRITEWORLDVECTOR_X, &GETSPRITEWORLDVECTOR_Y )
+rc_getSpriteLocalPoint( GETSPRITELOCALPOINT_SPR_ID, GETSPRITELOCALPOINT_WX, GETSPRITELOCALPOINT_WY, &GETSPRITELOCALPOINT_X, &GETSPRITELOCALPOINT_Y )
+rc_getSpriteLocalVector( GETSPRITELOCALVECTOR_SPR_ID, GETSPRITELOCALVECTOR_WX, GETSPRITELOCALVECTOR_WY, &GETSPRITELOCALVECTOR_X, &GETSPRITELOCALVECTOR_Y )
+rc_getSpriteLinearVelocityFromLocalPoint( GETSPRITELINEARVELOCITYFROMLOCALPOINT_SPR_ID, GETSPRITELINEARVELOCITYFROMLOCALPOINT_PX, GETSPRITELINEARVELOCITYFROMLOCALPOINT_PY, &GETSPRITELINEARVELOCITYFROMLOCALPOINT_X, &GETSPRITELINEARVELOCITYFROMLOCALPOINT_Y )
+rc_getSpriteLinearVelocityFromWorldPoint( GETSPRITELINEARVELOCITYFROMWORLDPOINT_SPR_ID, GETSPRITELINEARVELOCITYFROMWORLDPOINT_WX, GETSPRITELINEARVELOCITYFROMWORLDPOINT_WY, &GETSPRITELINEARVELOCITYFROMWORLDPOINT_X, &GETSPRITELINEARVELOCITYFROMWORLDPOINT_Y )
+rc_getSpriteLinearDamping( GETSPRITELINEARDAMPING_SPR_ID )
+rc_setSpriteLinearDamping( SETSPRITELINEARDAMPING_SPR_ID, SETSPRITELINEARDAMPING_LINEARDAMPING )
+rc_getSpriteAngularDamping( GETSPRITEANGULARDAMPING_SPR_ID )
+rc_setSpriteAngularDamping( SETSPRITEANGULARDAMPING_SPR_ID, SETSPRITEANGULARDAMPING_ANGULARDAMPING )
+rc_getSpriteGravityScale( GETSPRITEGRAVITYSCALE_SPR_ID )
+rc_setSpriteGravityScale( SETSPRITEGRAVITYSCALE_SPR_ID, SETSPRITEGRAVITYSCALE_G_SCALE )
+rc_setSpriteBullet( SETSPRITEBULLET_SPR_ID, SETSPRITEBULLET_FLAG )
+rc_spriteIsBullet( SPRITEISBULLET_SPR_ID )
+rc_setSpriteSleepAllowed( SETSPRITESLEEPALLOWED_SPR_ID, SETSPRITESLEEPALLOWED_FLAG )
+rc_spriteSleepAllowed( SPRITESLEEPALLOWED_SPR_ID )
+rc_setSpriteAwake( SETSPRITEAWAKE_SPR_ID, SETSPRITEAWAKE_FLAG )
+rc_spriteIsAwake( SPRITEISAWAKE_SPR_ID )
+rc_setSpriteFixedRotation( SETSPRITEFIXEDROTATION_SPR_ID, SETSPRITEFIXEDROTATION_FLAG )
+rc_spriteIsFixedRotation( SPRITEISFIXEDROTATION_SPR_ID )
+rc_setSpriteDensity( SETSPRITEDENSITY_SPR_ID, SETSPRITEDENSITY_DENSITY )
+rc_getSpriteDensity( GETSPRITEDENSITY_SPR_ID )
+rc_setSpriteFriction( SETSPRITEFRICTION_SPR_ID, SETSPRITEFRICTION_FRICTION )
+rc_getSpriteFriction( GETSPRITEFRICTION_SPR_ID )
+rc_setSpriteRestitution( SETSPRITERESTITUTION_SPR_ID, SETSPRITERESTITUTION_RESTITUTION )
+rc_getSpriteRestitution( GETSPRITERESTITUTION_SPR_ID )
+rc_setSpriteRestitutionThreshold( SETSPRITERESTITUTIONTHRESHOLD_SPR_ID, SETSPRITERESTITUTIONTHRESHOLD_THRESHOLD )
+rc_getSpriteRestitutionThreshold( GETSPRITERESTITUTIONTHRESHOLD_SPR_ID )
+rc_getSpriteAABB( GETSPRITEAABB_SPR_ID, &GETSPRITEAABB_X1, &GETSPRITEAABB_Y1, &GETSPRITEAABB_X2, &GETSPRITEAABB_Y2 )
+rc_setGravity2D( SETGRAVITY2D_X, SETGRAVITY2D_Y )
+rc_getGravity2D( &GETGRAVITY2D_X, &GETGRAVITY2D_Y )
+rc_setWorld2DTimeStep( SETWORLD2DTIMESTEP_TS )
+rc_setWorld2DVelocityIterations( SETWORLD2DVELOCITYITERATIONS_V )
+rc_setWorld2DPositionIterations( SETWORLD2DPOSITIONITERATIONS_P )
+rc_getWorld2DTimeStep( )
+rc_getWorld2DVelocityIterations( )
+rc_getWorld2DPositionIterations( )
+rc_setWorld2DAutoClearForces( SETWORLD2DAUTOCLEARFORCES_FLAG )
+rc_getWorld2DAutoClearForces( )
+rc_castRay2D( CASTRAY2D_FROM_X, CASTRAY2D_FROM_Y, CASTRAY2D_TO_X, CASTRAY2D_TO_Y )
+rc_castRay2D_All( CASTRAY2D_ALL_FROM_X, CASTRAY2D_ALL_FROM_Y, CASTRAY2D_ALL_TO_X, CASTRAY2D_ALL_TO_Y )
+rc_getRayHit2D( GETRAYHIT2D_INDEX, &GETRAYHIT2D_SPR_ID, &GETRAYHIT2D_X, &GETRAYHIT2D_Y, &GETRAYHIT2D_NORMAL_X, &GETRAYHIT2D_NORMAL_Y )
+rc_createDistanceJoint( CREATEDISTANCEJOINT_SPRITEA, CREATEDISTANCEJOINT_SPRITEB, CREATEDISTANCEJOINT_AX, CREATEDISTANCEJOINT_AY, CREATEDISTANCEJOINT_BX, CREATEDISTANCEJOINT_BY, CREATEDISTANCEJOINT_COLLIDE_CONNECT )
+rc_createFrictionJoint( CREATEFRICTIONJOINT_SPRITEA, CREATEFRICTIONJOINT_SPRITEB, CREATEFRICTIONJOINT_X, CREATEFRICTIONJOINT_Y, CREATEFRICTIONJOINT_COLLIDE_CONNECT )
+rc_createGearJoint( CREATEGEARJOINT_JOINTA, CREATEGEARJOINT_JOINTB, CREATEGEARJOINT_G_RATIO, CREATEGEARJOINT_COLLIDE_CONNECT )
+rc_createMotorJoint( CREATEMOTORJOINT_SPRITEA, CREATEMOTORJOINT_SPRITEB, CREATEMOTORJOINT_COLLIDE_CONNECT )
+rc_createPrismaticJoint( CREATEPRISMATICJOINT_SPRITEA, CREATEPRISMATICJOINT_SPRITEB, CREATEPRISMATICJOINT_AX, CREATEPRISMATICJOINT_AY, CREATEPRISMATICJOINT_AXISX, CREATEPRISMATICJOINT_AXISY, CREATEPRISMATICJOINT_COLLIDE_CONNECT )
+rc_createPulleyJoint( CREATEPULLEYJOINT_SPRITEA, CREATEPULLEYJOINT_SPRITEB, CREATEPULLEYJOINT_GAX, CREATEPULLEYJOINT_GAY, CREATEPULLEYJOINT_GBX, CREATEPULLEYJOINT_GBY, CREATEPULLEYJOINT_AX, CREATEPULLEYJOINT_AY, CREATEPULLEYJOINT_BX, CREATEPULLEYJOINT_BY, CREATEPULLEYJOINT_J_RATIO, CREATEPULLEYJOINT_COLLIDE_CONNECT )
+rc_createRevoluteJoint( CREATEREVOLUTEJOINT_SPRITEA, CREATEREVOLUTEJOINT_SPRITEB, CREATEREVOLUTEJOINT_X, CREATEREVOLUTEJOINT_Y, CREATEREVOLUTEJOINT_COLLIDE_CONNECT )
+rc_createWeldJoint( CREATEWELDJOINT_SPRITEA, CREATEWELDJOINT_SPRITEB, CREATEWELDJOINT_X, CREATEWELDJOINT_Y, CREATEWELDJOINT_COLLIDE_CONNECT )
+rc_createWheelJoint( CREATEWHEELJOINT_SPRITEA, CREATEWHEELJOINT_SPRITEB, CREATEWHEELJOINT_AX, CREATEWHEELJOINT_AY, CREATEWHEELJOINT_AXISX, CREATEWHEELJOINT_AXISY, CREATEWHEELJOINT_COLLIDE_CONNECT )
+rc_getJointWorldAnchorA( GETJOINTWORLDANCHORA_JOINT_ID, &GETJOINTWORLDANCHORA_X, &GETJOINTWORLDANCHORA_Y )
+rc_getJointWorldAnchorB( GETJOINTWORLDANCHORB_JOINT_ID, &GETJOINTWORLDANCHORB_X, &GETJOINTWORLDANCHORB_Y )
+rc_getJointReactionForce( GETJOINTREACTIONFORCE_JOINT_ID, GETJOINTREACTIONFORCE_INV_DT, &GETJOINTREACTIONFORCE_X, &GETJOINTREACTIONFORCE_Y )
+rc_getJointReactionTorque( GETJOINTREACTIONTORQUE_JOINT_ID, GETJOINTREACTIONTORQUE_INV_DT )
+rc_getJointLocalAnchorA( GETJOINTLOCALANCHORA_JOINT_ID, &GETJOINTLOCALANCHORA_X, &GETJOINTLOCALANCHORA_Y )
+rc_getJointLocalAnchorB( GETJOINTLOCALANCHORB_JOINT_ID, &GETJOINTLOCALANCHORB_X, &GETJOINTLOCALANCHORB_Y )
+rc_setJointLength( SETJOINTLENGTH_JOINT_ID, SETJOINTLENGTH_JLEN )
+rc_getJointLength( GETJOINTLENGTH_JOINT_ID )
+rc_setJointMinLength( SETJOINTMINLENGTH_JOINT_ID, SETJOINTMINLENGTH_JLEN )
+rc_getJointMinLength( GETJOINTMINLENGTH_JOINT_ID )
+rc_setJointMaxLength( SETJOINTMAXLENGTH_JOINT_ID, SETJOINTMAXLENGTH_JLEN )
+rc_getJointMaxLength( GETJOINTMAXLENGTH_JOINT_ID )
+rc_getJointCurrentLength( GETJOINTCURRENTLENGTH_JOINT_ID )
+rc_setJointStiffness( SETJOINTSTIFFNESS_JOINT_ID, SETJOINTSTIFFNESS_STIFFNESS )
+rc_getJointStiffness( GETJOINTSTIFFNESS_JOINT_ID )
+rc_setJointDamping( SETJOINTDAMPING_JOINT_ID, SETJOINTDAMPING_DAMPING )
+rc_getJointDamping( GETJOINTDAMPING_JOINT_ID )
+rc_setJointMaxForce( SETJOINTMAXFORCE_JOINT_ID, SETJOINTMAXFORCE_FORCE )
+rc_getJointMaxForce( GETJOINTMAXFORCE_JOINT_ID )
+rc_setJointMaxTorque( SETJOINTMAXTORQUE_JOINT_ID, SETJOINTMAXTORQUE_TORQUE )
+rc_getJointMaxTorque( GETJOINTMAXTORQUE_JOINT_ID )
+rc_setJointCorrectionFactor( SETJOINTCORRECTIONFACTOR_JOINT_ID, SETJOINTCORRECTIONFACTOR_FACTOR )
+rc_getJointCorrectionFactor( GETJOINTCORRECTIONFACTOR_JOINT_ID )
+rc_setJointRatio( SETJOINTRATIO_JOINT_ID, SETJOINTRATIO_J_RATIO )
+rc_getJointRatio( GETJOINTRATIO_JOINT_ID )
+rc_setJointLinearOffset( SETJOINTLINEAROFFSET_JOINT_ID, SETJOINTLINEAROFFSET_X, SETJOINTLINEAROFFSET_Y )
+rc_getJointLinearOffset( GETJOINTLINEAROFFSET_JOINT_ID, &GETJOINTLINEAROFFSET_X, &GETJOINTLINEAROFFSET_Y )
+rc_setJointAngularOffset( SETJOINTANGULAROFFSET_JOINT_ID, SETJOINTANGULAROFFSET_ANGLEOFFSET )
+rc_getJointAngularOffset( GETJOINTANGULAROFFSET_JOINT_ID )
+rc_getJointLocalAxisA( GETJOINTLOCALAXISA_JOINT_ID, &GETJOINTLOCALAXISA_X, &GETJOINTLOCALAXISA_Y )
+rc_getJointReferenceAngle( GETJOINTREFERENCEANGLE_JOINT_ID )
+rc_getJointTranslation( GETJOINTTRANSLATION_JOINT_ID )
+rc_getJointSpeed( GETJOINTSPEED_JOINT_ID )
+rc_jointIsLimitEnabled( JOINTISLIMITENABLED_JOINT_ID )
+rc_enableJointLimit( ENABLEJOINTLIMIT_JOINT_ID, ENABLEJOINTLIMIT_FLAG )
+rc_getJointLowerLimit( GETJOINTLOWERLIMIT_JOINT_ID )
+rc_getJointUpperLimit( GETJOINTUPPERLIMIT_JOINT_ID )
+rc_setJointLimits( SETJOINTLIMITS_JOINT_ID, SETJOINTLIMITS_LOWER_LIMIT, SETJOINTLIMITS_UPPER_LIMIT )
+rc_jointMotorIsEnabled( JOINTMOTORISENABLED_JOINT_ID )
+rc_enableJointMotor( ENABLEJOINTMOTOR_JOINT_ID, ENABLEJOINTMOTOR_FLAG )
+rc_setJointMotorSpeed( SETJOINTMOTORSPEED_JOINT_ID, SETJOINTMOTORSPEED_SPEED )
+rc_getJointMotorSpeed( GETJOINTMOTORSPEED_JOINT_ID )
+rc_setJointMaxMotorForce( SETJOINTMAXMOTORFORCE_JOINT_ID, SETJOINTMAXMOTORFORCE_FORCE )
+rc_getJointMaxMotorForce( GETJOINTMAXMOTORFORCE_JOINT_ID )
+rc_getJointMotorForce( GETJOINTMOTORFORCE_JOINT_ID, GETJOINTMOTORFORCE_INV_DT )
+rc_setJointMaxMotorTorque( SETJOINTMAXMOTORTORQUE_JOINT_ID, SETJOINTMAXMOTORTORQUE_TORQUE )
+rc_getJointMaxMotorTorque( GETJOINTMAXMOTORTORQUE_JOINT_ID )
+rc_getJointMotorTorque( GETJOINTMOTORTORQUE_JOINT_ID, GETJOINTMOTORTORQUE_INV_DT )
+rc_getJointGroundAnchorA( GETJOINTGROUNDANCHORA_JOINT_ID, &GETJOINTGROUNDANCHORA_X, &GETJOINTGROUNDANCHORA_Y )
+rc_getJointGroundAnchorB( GETJOINTGROUNDANCHORB_JOINT_ID, &GETJOINTGROUNDANCHORB_X, &GETJOINTGROUNDANCHORB_Y )
+rc_getJointLengthA( GETJOINTLENGTHA_JOINT_ID )
+rc_getJointLengthB( GETJOINTLENGTHB_JOINT_ID )
+rc_getJointCurrentLengthA( GETJOINTCURRENTLENGTHA_JOINT_ID )
+rc_getJointCurrentLengthB( GETJOINTCURRENTLENGTHB_JOINT_ID )
+rc_setJointOrigin( SETJOINTORIGIN_JOINT_ID, SETJOINTORIGIN_X, SETJOINTORIGIN_Y )
+rc_getJointAngle( GETJOINTANGLE_JOINT_ID )
+rc_getJointLinearSpeed( GETJOINTLINEARSPEED_JOINT_ID )
+rc_getJointAngularSpeed( GETJOINTANGULARSPEED_JOINT_ID )
+rc_deleteJoint( DELETEJOINT_JOINT_ID )
+rc_createTileSet( CREATETILESET_IMG_ID, CREATETILESET_TILE_W, CREATETILESET_TILE_H )
+rc_setTileAnimationLength( SETTILEANIMATIONLENGTH_TILESET, SETTILEANIMATIONLENGTH_BASE_TILE, SETTILEANIMATIONLENGTH_NUM_FRAMES )
+rc_getTileAnimationLength( GETTILEANIMATIONLENGTH_TILESET, GETTILEANIMATIONLENGTH_BASE_TILE )
+rc_setTileAnimationFrame( SETTILEANIMATIONFRAME_TILESET, SETTILEANIMATIONFRAME_BASE_TILE, SETTILEANIMATIONFRAME_ANIM_FRAME, SETTILEANIMATIONFRAME_TILE_FRAME )
+rc_getTileAnimationFrame( GETTILEANIMATIONFRAME_TILESET, GETTILEANIMATIONFRAME_BASE_TILE, GETTILEANIMATIONFRAME_ANIM_FRAME )
+rc_setTileAnimationSpeed( SETTILEANIMATIONSPEED_TILESET, SETTILEANIMATIONSPEED_BASE_TILE, SETTILEANIMATIONSPEED_SPEED )
+rc_getTileAnimationSpeed( GETTILEANIMATIONSPEED_TILESET, GETTILEANIMATIONSPEED_BASE_TILE )
+rc_createTileMap( CREATETILEMAP_TILESET, CREATETILEMAP_WIDTHINTILES, CREATETILEMAP_HEIGHTINTILES )
+rc_setTileMapSize( SETTILEMAPSIZE_TILEMAP, SETTILEMAPSIZE_WIDTHINTILES, SETTILEMAPSIZE_HEIGHTINTILES )
+rc_getTileMapSize( GETTILEMAPSIZE_TILEMAP, &GETTILEMAPSIZE_WIDTHINTILES, &GETTILEMAPSIZE_HEIGHTINTILES )
+rc_setTile( SETTILE_TILEMAP, SETTILE_TILE, SETTILE_X, SETTILE_Y )
+rc_getTile( GETTILE_TILEMAP, GETTILE_X, GETTILE_Y )
+rc_fillTile( FILLTILE_TILEMAP, FILLTILE_TILE, FILLTILE_X, FILLTILE_Y, FILLTILE_WIDTHINTILES, FILLTILE_HEIGHTINTILES )
+rc_drawTileMap( DRAWTILEMAP_TILEMAP, DRAWTILEMAP_X, DRAWTILEMAP_Y, DRAWTILEMAP_W, DRAWTILEMAP_H, DRAWTILEMAP_OFFSET_X, DRAWTILEMAP_OFFSET_Y )
+rc_deleteTileSet( DELETETILESET_TILESET )
+rc_deleteTileMap( DELETETILEMAP_TILEMAP )
+rc_loadMesh( LOADMESH_MESH_FILE$ )
+rc_deleteMesh( DELETEMESH_MESH )
+rc_createMesh( )
+rc_addMeshBuffer( ADDMESHBUFFER_MESH, ADDMESHBUFFER_VERTEX_COUNT, &ADDMESHBUFFER_VERTEX_DATA, &ADDMESHBUFFER_NORMAL_DATA, &ADDMESHBUFFER_UV_DATA, ADDMESHBUFFER_INDEX_COUNT, &ADDMESHBUFFER_INDEX_DATA )
+rc_loadMeshFromArchive( LOADMESHFROMARCHIVE_ARCHIVE$, LOADMESHFROMARCHIVE_MESH_FILE$ )
+rc_createPlaneMesh( CREATEPLANEMESH_W, CREATEPLANEMESH_H, CREATEPLANEMESH_TILECOUNT_W, CREATEPLANEMESH_TILECOUNT_H )
+rc_loadAN8( LOADAN8_AN8_FILE$ )
+rc_loadMeshFromAN8( LOADMESHFROMAN8_AN8_PROJECT, LOADMESHFROMAN8_AN8_SCENE$ )
+rc_getNumAN8Scenes( GETNUMAN8SCENES_AN8_PROJECT )
+rc_getAN8SceneName( GETAN8SCENENAME$_AN8_PROJECT, GETAN8SCENENAME$_SCENE_NUM )
+rc_createAnimatedActor( CREATEANIMATEDACTOR_MESH )
+rc_createOctreeActor( CREATEOCTREEACTOR_MESH )
+rc_createCubeActor( CREATECUBEACTOR_CUBE_SIZE )
+rc_createSphereActor( CREATESPHEREACTOR_RADIUS )
+rc_createWaterActor( CREATEWATERACTOR_MESH, CREATEWATERACTOR_WAVEHEIGHT, CREATEWATERACTOR_WAVESPEED, CREATEWATERACTOR_WAVELENGTH )
+rc_createLightActor( )
+rc_createBillboardActor( )
+rc_createTerrainActor( CREATETERRAINACTOR_HMAP_FILE$ )
+rc_createParticleActor( CREATEPARTICLEACTOR_PARTICLE_TYPE )
+rc_deleteActor( DELETEACTOR_ACTOR )
+rc_getActorTransform( GETACTORTRANSFORM_ACTOR, GETACTORTRANSFORM_MATRIX )
+rc_setActorPosition( SETACTORPOSITION_ACTOR, SETACTORPOSITION_X, SETACTORPOSITION_Y, SETACTORPOSITION_Z )
+rc_translateActorLocal( TRANSLATEACTORLOCAL_ACTOR, TRANSLATEACTORLOCAL_X, TRANSLATEACTORLOCAL_Y, TRANSLATEACTORLOCAL_Z )
+rc_translateActorWorld( TRANSLATEACTORWORLD_ACTOR, TRANSLATEACTORWORLD_X, TRANSLATEACTORWORLD_Y, TRANSLATEACTORWORLD_Z )
+rc_getActorPosition( GETACTORPOSITION_ACTOR, &GETACTORPOSITION_X, &GETACTORPOSITION_Y, &GETACTORPOSITION_Z )
+rc_setActorScale( SETACTORSCALE_ACTOR, SETACTORSCALE_X, SETACTORSCALE_Y, SETACTORSCALE_Z )
+rc_scaleActor( SCALEACTOR_ACTOR, SCALEACTOR_X, SCALEACTOR_Y, SCALEACTOR_Z )
+rc_getActorScale( GETACTORSCALE_ACTOR, &GETACTORSCALE_X, &GETACTORSCALE_Y, &GETACTORSCALE_Z )
+rc_setActorRotation( SETACTORROTATION_ACTOR, SETACTORROTATION_X, SETACTORROTATION_Y, SETACTORROTATION_Z )
+rc_rotateActor( ROTATEACTOR_ACTOR, ROTATEACTOR_X, ROTATEACTOR_Y, ROTATEACTOR_Z )
+rc_getActorRotation( GETACTORROTATION_ACTOR, &GETACTORROTATION_X, &GETACTORROTATION_Y, &GETACTORROTATION_Z )
+rc_setActorVisible( SETACTORVISIBLE_ACTOR, SETACTORVISIBLE_FLAG )
+rc_actorIsVisible( ACTORISVISIBLE_ACTOR )
+rc_setActorAutoCulling( SETACTORAUTOCULLING_ACTOR, SETACTORAUTOCULLING_CULL_TYPE )
+rc_getActorAutoCulling( GETACTORAUTOCULLING_ACTOR )
+rc_addActorShadow( ADDACTORSHADOW_ACTOR )
+rc_removeActorShadow( REMOVEACTORSHADOW_ACTOR )
+rc_actorExists( ACTOREXISTS_ACTOR )
+rc_createActorAnimation( CREATEACTORANIMATION_ACTOR, CREATEACTORANIMATION_START_FRAME, CREATEACTORANIMATION_END_FRAME, CREATEACTORANIMATION_SPEED )
+rc_setActorAnimation( SETACTORANIMATION_ACTOR, SETACTORANIMATION_ANIMATION, SETACTORANIMATION_NUM_LOOPS )
+rc_setActorAnimationSpeed( SETACTORANIMATIONSPEED_ACTOR, SETACTORANIMATIONSPEED_ANIMATION, SETACTORANIMATIONSPEED_SPEED )
+rc_setActorAnimationFrames( SETACTORANIMATIONFRAMES_ACTOR, SETACTORANIMATIONFRAMES_ANIMATION, SETACTORANIMATIONFRAMES_START_FRAME, SETACTORANIMATIONFRAMES_END_FRAME )
+rc_getActorCurrentAnimation( GETACTORCURRENTANIMATION_ACTOR )
+rc_getActorAnimationSpeed( GETACTORANIMATIONSPEED_ACTOR, GETACTORANIMATIONSPEED_ANIMATION )
+rc_getActorAnimationStartFrame( GETACTORANIMATIONSTARTFRAME_ACTOR, GETACTORANIMATIONSTARTFRAME_ANIMATION )
+rc_getActorAnimationEndFrame( GETACTORANIMATIONENDFRAME_ACTOR, GETACTORANIMATIONENDFRAME_ANIMATION )
+rc_setActorFrame( SETACTORFRAME_ACTOR, SETACTORFRAME_FRAME )
+rc_getActorFrame( GETACTORFRAME_ACTOR )
+rc_actorAnimationIsPlaying( ACTORANIMATIONISPLAYING_ACTOR )
+rc_numActorAnimationLoops( NUMACTORANIMATIONLOOPS_ACTOR )
+rc_setActorMD2Animation( SETACTORMD2ANIMATION_ACTOR, SETACTORMD2ANIMATION_ANIM, SETACTORMD2ANIMATION_NUM_LOOPS )
+rc_setActorMD2AnimationByName( SETACTORMD2ANIMATIONBYNAME_ACTOR, SETACTORMD2ANIMATIONBYNAME_ANIM_NAME$, SETACTORMD2ANIMATIONBYNAME_NUM_LOOPS )
+rc_deleteActorAnimation( DELETEACTORANIMATION_ACTOR, DELETEACTORANIMATION_ANIMATION )
+rc_setGravity3D( SETGRAVITY3D_X, SETGRAVITY3D_Y, SETGRAVITY3D_Z )
+rc_getGravity3D( &GETGRAVITY3D_X, &GETGRAVITY3D_Y, &GETGRAVITY3D_Z )
+rc_setActorCollisionShape( SETACTORCOLLISIONSHAPE_ACTOR, SETACTORCOLLISIONSHAPE_SHAPE_TYPE, SETACTORCOLLISIONSHAPE_MASS )
+rc_getActorCollisionShape( GETACTORCOLLISIONSHAPE_ACTOR )
+rc_setActorSolid( SETACTORSOLID_ACTOR, SETACTORSOLID_FLAG )
+rc_actorIsSolid( ACTORISSOLID_ACTOR )
+rc_getActorCollision( GETACTORCOLLISION_ACTOR1, GETACTORCOLLISION_ACTOR2 )
+rc_setActorGravity( SETACTORGRAVITY_ACTOR, SETACTORGRAVITY_X, SETACTORGRAVITY_Y, SETACTORGRAVITY_Z )
+rc_getActorGravity( GETACTORGRAVITY_ACTOR, &GETACTORGRAVITY_X, &GETACTORGRAVITY_Y, &GETACTORGRAVITY_Z )
+rc_setActorDamping( SETACTORDAMPING_ACTOR, SETACTORDAMPING_LIN_DAMPING, SETACTORDAMPING_ANG_DAMPING )
+rc_getActorLinearDamping( GETACTORLINEARDAMPING_ACTOR )
+rc_getActorAngularDamping( GETACTORANGULARDAMPING_ACTOR )
+rc_getActorLinearSleepThreshold( GETACTORLINEARSLEEPTHRESHOLD_ACTOR )
+rc_getActorAngularSleepThreshold( GETACTORANGULARSLEEPTHRESHOLD_ACTOR )
+rc_applyActorDamping( APPLYACTORDAMPING_ACTOR, APPLYACTORDAMPING_TIMESTEP )
+rc_setActorMassProperties( SETACTORMASSPROPERTIES_ACTOR, SETACTORMASSPROPERTIES_MASS, SETACTORMASSPROPERTIES_INERTIA_X, SETACTORMASSPROPERTIES_INERTIA_Y, SETACTORMASSPROPERTIES_INERTIA_Z )
+rc_getActorLinearFactor( GETACTORLINEARFACTOR_ACTOR, &GETACTORLINEARFACTOR_X, &GETACTORLINEARFACTOR_Y, &GETACTORLINEARFACTOR_Z )
+rc_setActorLinearFactor( SETACTORLINEARFACTOR_ACTOR, SETACTORLINEARFACTOR_X, SETACTORLINEARFACTOR_Y, SETACTORLINEARFACTOR_Z )
+rc_getActorInverseMass( GETACTORINVERSEMASS_ACTOR )
+rc_integrateActorVelocities( INTEGRATEACTORVELOCITIES_ACTOR, INTEGRATEACTORVELOCITIES_V_STEP )
+rc_applyActorCentralForceLocal( APPLYACTORCENTRALFORCELOCAL_ACTOR, APPLYACTORCENTRALFORCELOCAL_X, APPLYACTORCENTRALFORCELOCAL_Y, APPLYACTORCENTRALFORCELOCAL_Z )
+rc_applyActorCentralForceWorld( APPLYACTORCENTRALFORCEWORLD_ACTOR, APPLYACTORCENTRALFORCEWORLD_X, APPLYACTORCENTRALFORCEWORLD_Y, APPLYACTORCENTRALFORCEWORLD_Z )
+rc_getActorTotalForce( GETACTORTOTALFORCE_ACTOR, &GETACTORTOTALFORCE_X, &GETACTORTOTALFORCE_Y, &GETACTORTOTALFORCE_Z )
+rc_getActorTotalTorque( GETACTORTOTALTORQUE_ACTOR, &GETACTORTOTALTORQUE_X, &GETACTORTOTALTORQUE_Y, &GETACTORTOTALTORQUE_Z )
+rc_getActorInverseInertiaDiagLocal( GETACTORINVERSEINERTIADIAGLOCAL_ACTOR, &GETACTORINVERSEINERTIADIAGLOCAL_X, &GETACTORINVERSEINERTIADIAGLOCAL_Y, &GETACTORINVERSEINERTIADIAGLOCAL_Z )
+rc_setActorInverseInertiaDiagLocal( SETACTORINVERSEINERTIADIAGLOCAL_ACTOR, SETACTORINVERSEINERTIADIAGLOCAL_X, SETACTORINVERSEINERTIADIAGLOCAL_Y, SETACTORINVERSEINERTIADIAGLOCAL_Z )
+rc_setActorSleepThresholds( SETACTORSLEEPTHRESHOLDS_ACTOR, SETACTORSLEEPTHRESHOLDS_LINEAR, SETACTORSLEEPTHRESHOLDS_ANGULAR )
+rc_applyActorTorqueLocal( APPLYACTORTORQUELOCAL_ACTOR, APPLYACTORTORQUELOCAL_X, APPLYACTORTORQUELOCAL_Y, APPLYACTORTORQUELOCAL_Z )
+rc_applyActorTorqueWorld( APPLYACTORTORQUEWORLD_ACTOR, APPLYACTORTORQUEWORLD_X, APPLYACTORTORQUEWORLD_Y, APPLYACTORTORQUEWORLD_Z )
+rc_applyActorForceLocal( APPLYACTORFORCELOCAL_ACTOR, APPLYACTORFORCELOCAL_X, APPLYACTORFORCELOCAL_Y, APPLYACTORFORCELOCAL_Z, APPLYACTORFORCELOCAL_REL_X, APPLYACTORFORCELOCAL_REL_Y, APPLYACTORFORCELOCAL_REL_Z )
+rc_applyActorForceWorld( APPLYACTORFORCEWORLD_ACTOR, APPLYACTORFORCEWORLD_X, APPLYACTORFORCEWORLD_Y, APPLYACTORFORCEWORLD_Z, APPLYACTORFORCEWORLD_REL_X, APPLYACTORFORCEWORLD_REL_Y, APPLYACTORFORCEWORLD_REL_Z )
+rc_applyActorCentralImpulseLocal( APPLYACTORCENTRALIMPULSELOCAL_ACTOR, APPLYACTORCENTRALIMPULSELOCAL_X, APPLYACTORCENTRALIMPULSELOCAL_Y, APPLYACTORCENTRALIMPULSELOCAL_Z )
+rc_applyActorCentralImpulseWorld( APPLYACTORCENTRALIMPULSEWORLD_ACTOR, APPLYACTORCENTRALIMPULSEWORLD_X, APPLYACTORCENTRALIMPULSEWORLD_Y, APPLYACTORCENTRALIMPULSEWORLD_Z )
+rc_applyActorTorqueImpulseLocal( APPLYACTORTORQUEIMPULSELOCAL_ACTOR, APPLYACTORTORQUEIMPULSELOCAL_X, APPLYACTORTORQUEIMPULSELOCAL_Y, APPLYACTORTORQUEIMPULSELOCAL_Z )
+rc_applyActorTorqueImpulseWorld( APPLYACTORTORQUEIMPULSEWORLD_ACTOR, APPLYACTORTORQUEIMPULSEWORLD_X, APPLYACTORTORQUEIMPULSEWORLD_Y, APPLYACTORTORQUEIMPULSEWORLD_Z )
+rc_applyActorImpulseLocal( APPLYACTORIMPULSELOCAL_ACTOR, APPLYACTORIMPULSELOCAL_X, APPLYACTORIMPULSELOCAL_Y, APPLYACTORIMPULSELOCAL_Z, APPLYACTORIMPULSELOCAL_REL_X, APPLYACTORIMPULSELOCAL_REL_Y, APPLYACTORIMPULSELOCAL_REL_Z )
+rc_applyActorImpulseWorld( APPLYACTORIMPULSEWORLD_ACTOR, APPLYACTORIMPULSEWORLD_X, APPLYACTORIMPULSEWORLD_Y, APPLYACTORIMPULSEWORLD_Z, APPLYACTORIMPULSEWORLD_REL_X, APPLYACTORIMPULSEWORLD_REL_Y, APPLYACTORIMPULSEWORLD_REL_Z )
+rc_clearActorForces( CLEARACTORFORCES_ACTOR )
+rc_updateActorInertiaTensor( UPDATEACTORINERTIATENSOR_ACTOR )
+rc_getActorCenter( GETACTORCENTER_ACTOR, &GETACTORCENTER_X, &GETACTORCENTER_Y, &GETACTORCENTER_Z )
+rc_getActorRotationQ( GETACTORROTATIONQ_ACTOR, &GETACTORROTATIONQ_X, &GETACTORROTATIONQ_Y, &GETACTORROTATIONQ_Z, &GETACTORROTATIONQ_W )
+rc_getActorLinearVelocityWorld( GETACTORLINEARVELOCITYWORLD_ACTOR, &GETACTORLINEARVELOCITYWORLD_X, &GETACTORLINEARVELOCITYWORLD_Y, &GETACTORLINEARVELOCITYWORLD_Z )
+rc_getActorAngularVelocityWorld( GETACTORANGULARVELOCITYWORLD_ACTOR, &GETACTORANGULARVELOCITYWORLD_X, &GETACTORANGULARVELOCITYWORLD_Y, &GETACTORANGULARVELOCITYWORLD_Z )
+rc_setActorLinearVelocityLocal( SETACTORLINEARVELOCITYLOCAL_ACTOR, SETACTORLINEARVELOCITYLOCAL_X, SETACTORLINEARVELOCITYLOCAL_Y, SETACTORLINEARVELOCITYLOCAL_Z )
+rc_setActorLinearVelocityWorld( SETACTORLINEARVELOCITYWORLD_ACTOR, SETACTORLINEARVELOCITYWORLD_X, SETACTORLINEARVELOCITYWORLD_Y, SETACTORLINEARVELOCITYWORLD_Z )
+rc_setActorAngularVelocityLocal( SETACTORANGULARVELOCITYLOCAL_ACTOR, SETACTORANGULARVELOCITYLOCAL_X, SETACTORANGULARVELOCITYLOCAL_Y, SETACTORANGULARVELOCITYLOCAL_Z )
+rc_setActorAngularVelocityWorld( SETACTORANGULARVELOCITYWORLD_ACTOR, SETACTORANGULARVELOCITYWORLD_X, SETACTORANGULARVELOCITYWORLD_Y, SETACTORANGULARVELOCITYWORLD_Z )
+rc_getActorVelocityInLocalPoint( GETACTORVELOCITYINLOCALPOINT_ACTOR, GETACTORVELOCITYINLOCALPOINT_REL_X, GETACTORVELOCITYINLOCALPOINT_REL_Y, GETACTORVELOCITYINLOCALPOINT_REL_Z, &GETACTORVELOCITYINLOCALPOINT_X, &GETACTORVELOCITYINLOCALPOINT_Y, &GETACTORVELOCITYINLOCALPOINT_Z )
+rc_getActorLinearVelocityLocal( GETACTORLINEARVELOCITYLOCAL_ACTOR, &GETACTORLINEARVELOCITYLOCAL_X, &GETACTORLINEARVELOCITYLOCAL_Y, &GETACTORLINEARVELOCITYLOCAL_Z )
+rc_getActorAngularVelocityLocal( GETACTORANGULARVELOCITYLOCAL_ACTOR, &GETACTORANGULARVELOCITYLOCAL_X, &GETACTORANGULARVELOCITYLOCAL_Y, &GETACTORANGULARVELOCITYLOCAL_Z )
+rc_getActorAABB( GETACTORAABB_ACTOR, &GETACTORAABB_MIN_X, &GETACTORAABB_MIN_Y, &GETACTORAABB_MIN_Z, &GETACTORAABB_MAX_X, &GETACTORAABB_MAX_Y, &GETACTORAABB_MAX_Z )
+rc_computeActorImpulseDenominator( COMPUTEACTORIMPULSEDENOMINATOR_ACTOR, COMPUTEACTORIMPULSEDENOMINATOR_POS_X, COMPUTEACTORIMPULSEDENOMINATOR_POS_Y, COMPUTEACTORIMPULSEDENOMINATOR_POS_Z, COMPUTEACTORIMPULSEDENOMINATOR_NORMAL_X, COMPUTEACTORIMPULSEDENOMINATOR_NORMAL_Y, COMPUTEACTORIMPULSEDENOMINATOR_NORMAL_Z )
+rc_computeActorAngularImpulseDenominator( COMPUTEACTORANGULARIMPULSEDENOMINATOR_ACTOR, COMPUTEACTORANGULARIMPULSEDENOMINATOR_X, COMPUTEACTORANGULARIMPULSEDENOMINATOR_Y, COMPUTEACTORANGULARIMPULSEDENOMINATOR_Z )
+rc_setActorAngularFactor( SETACTORANGULARFACTOR_ACTOR, SETACTORANGULARFACTOR_X, SETACTORANGULARFACTOR_Y, SETACTORANGULARFACTOR_Z )
+rc_getActorAngularFactor( GETACTORANGULARFACTOR_ACTOR, &GETACTORANGULARFACTOR_X, &GETACTORANGULARFACTOR_Y, &GETACTORANGULARFACTOR_Z )
+rc_computeActorGyroImpulseLocal( COMPUTEACTORGYROIMPULSELOCAL_ACTOR, COMPUTEACTORGYROIMPULSELOCAL_DT, &COMPUTEACTORGYROIMPULSELOCAL_X, &COMPUTEACTORGYROIMPULSELOCAL_Y, &COMPUTEACTORGYROIMPULSELOCAL_Z )
+rc_computeActorGyroImpulseWorld( COMPUTEACTORGYROIMPULSEWORLD_ACTOR, COMPUTEACTORGYROIMPULSEWORLD_DT, &COMPUTEACTORGYROIMPULSEWORLD_X, &COMPUTEACTORGYROIMPULSEWORLD_Y, &COMPUTEACTORGYROIMPULSEWORLD_Z )
+rc_getActorLocalInertia( GETACTORLOCALINERTIA_ACTOR, &GETACTORLOCALINERTIA_X, &GETACTORLOCALINERTIA_Y, &GETACTORLOCALINERTIA_Z )
+rc_setActorSleepState( SETACTORSLEEPSTATE_ACTOR, SETACTORSLEEPSTATE_STATE )
+rc_castRay3D( CASTRAY3D_FROM_X, CASTRAY3D_FROM_Y, CASTRAY3D_FROM_Z, CASTRAY3D_TO_X, CASTRAY3D_TO_Y, CASTRAY3D_TO_Z )
+rc_castRay3D_All( CASTRAY3D_ALL_FROM_X, CASTRAY3D_ALL_FROM_Y, CASTRAY3D_ALL_FROM_Z, CASTRAY3D_ALL_TO_X, CASTRAY3D_ALL_TO_Y, CASTRAY3D_ALL_TO_Z )
+rc_getRayHit3D( GETRAYHIT3D_INDEX, &GETRAYHIT3D_ACTOR_ID, &GETRAYHIT3D_X, &GETRAYHIT3D_Y, &GETRAYHIT3D_Z, &GETRAYHIT3D_NORMAL_X, &GETRAYHIT3D_NORMAL_Y, &GETRAYHIT3D_NORMAL_Z )
+rc_createPointConstraint( CREATEPOINTCONSTRAINT_ACTORA, CREATEPOINTCONSTRAINT_PXA, CREATEPOINTCONSTRAINT_PYA, CREATEPOINTCONSTRAINT_PZA )
+rc_createPointConstraintEx( CREATEPOINTCONSTRAINTEX_ACTORA, CREATEPOINTCONSTRAINTEX_ACTORB, CREATEPOINTCONSTRAINTEX_PXA, CREATEPOINTCONSTRAINTEX_PYA, CREATEPOINTCONSTRAINTEX_PZA, CREATEPOINTCONSTRAINTEX_PXB, CREATEPOINTCONSTRAINTEX_PYB, CREATEPOINTCONSTRAINTEX_PZB )
+rc_setPointPivotA( SETPOINTPIVOTA_CONSTRAINT_ID, SETPOINTPIVOTA_X, SETPOINTPIVOTA_Y, SETPOINTPIVOTA_Z )
+rc_setPointPivotB( SETPOINTPIVOTB_CONSTRAINT_ID, SETPOINTPIVOTB_X, SETPOINTPIVOTB_Y, SETPOINTPIVOTB_Z )
+rc_createHingeConstraint( CREATEHINGECONSTRAINT_ACTORA, CREATEHINGECONSTRAINT_FRAMEA, CREATEHINGECONSTRAINT_USEREFERENCEFRAMEA )
+rc_createHingeConstraintEx( CREATEHINGECONSTRAINTEX_ACTORA, CREATEHINGECONSTRAINTEX_ACTORB, CREATEHINGECONSTRAINTEX_FRAMEA, CREATEHINGECONSTRAINTEX_FRAMEB, CREATEHINGECONSTRAINTEX_USEREFERENCEFRAMEA )
+rc_createSlideConstraint( CREATESLIDECONSTRAINT_ACTORA, CREATESLIDECONSTRAINT_FRAMEINB_MATRIX, CREATESLIDECONSTRAINT_USELINEARREFERENCEFRAMEA )
+rc_createSlideConstraintEx( CREATESLIDECONSTRAINTEX_ACTORA, CREATESLIDECONSTRAINTEX_ACTORB, CREATESLIDECONSTRAINTEX_FRAMEINA_MATRIX, CREATESLIDECONSTRAINTEX_FRAMEINB_MATRIX, CREATESLIDECONSTRAINTEX_USELINEARREFERENCEFRAMEA )
+rc_createConeConstraint( CREATECONECONSTRAINT_ACTORA, CREATECONECONSTRAINT_RBAFRAME_MATRIX )
+rc_createConeConstraintEx( CREATECONECONSTRAINTEX_ACTORA, CREATECONECONSTRAINTEX_ACTORB, CREATECONECONSTRAINTEX_RBAFRAME_MATRIX, CREATECONECONSTRAINTEX_RBBFRAME_MATRIX )
+rc_deleteConstraint( DELETECONSTRAINT_CONSTRAINT_ID )
+rc_getConstraintFrameOffsetA( GETCONSTRAINTFRAMEOFFSETA_CONSTRAINT_ID, & GETCONSTRAINTFRAMEOFFSETA_X, & GETCONSTRAINTFRAMEOFFSETA_Y, & GETCONSTRAINTFRAMEOFFSETA_Z, & GETCONSTRAINTFRAMEOFFSETA_RX, & GETCONSTRAINTFRAMEOFFSETA_RY, & GETCONSTRAINTFRAMEOFFSETA_RZ )
+rc_getConstraintFrameOffsetB( GETCONSTRAINTFRAMEOFFSETB_CONSTRAINT_ID, & GETCONSTRAINTFRAMEOFFSETB_X, & GETCONSTRAINTFRAMEOFFSETB_Y, & GETCONSTRAINTFRAMEOFFSETB_Z, & GETCONSTRAINTFRAMEOFFSETB_RX, & GETCONSTRAINTFRAMEOFFSETB_RY, & GETCONSTRAINTFRAMEOFFSETB_RZ )
+rc_useConstraintFrameOffset( USECONSTRAINTFRAMEOFFSET_CONSTRAINT_ID, USECONSTRAINTFRAMEOFFSET_FLAG )
+rc_getHingeAngle( GETHINGEANGLE_CONSTRAINT_ID )
+rc_getHingeAngleEx( GETHINGEANGLEEX_CONSTRAINT_ID, GETHINGEANGLEEX_T_MATRIXA, GETHINGEANGLEEX_T_MATRIXB )
+rc_getConstraintBreakingImpulseThreshold( GETCONSTRAINTBREAKINGIMPULSETHRESHOLD_CONSTRAINT_ID )
+rc_getConstraintAFrame( GETCONSTRAINTAFRAME_CONSTRAINT_ID, GETCONSTRAINTAFRAME_MA )
+rc_getConstraintBFrame( GETCONSTRAINTBFRAME_CONSTRAINT_ID, GETCONSTRAINTBFRAME_MA )
+rc_setHingeAxis( SETHINGEAXIS_CONSTRAINT_ID, SETHINGEAXIS_X, SETHINGEAXIS_Y, SETHINGEAXIS_Z )
+rc_setConstraintBreakingImpulseThreshold( SETCONSTRAINTBREAKINGIMPULSETHRESHOLD_CONSTRAINT_ID, SETCONSTRAINTBREAKINGIMPULSETHRESHOLD_THRESHOLD )
+rc_setConstraintFrames( SETCONSTRAINTFRAMES_CONSTRAINT_ID, SETCONSTRAINTFRAMES_FRAMEA_MATRIX, SETCONSTRAINTFRAMES_FRAMEB_MATRIX )
+rc_setHingeLimit( SETHINGELIMIT_CONSTRAINT_ID, SETHINGELIMIT_LOW, SETHINGELIMIT_HIGH, SETHINGELIMIT_SOFTNESS, SETHINGELIMIT_BIAS_FACTOR, SETHINGELIMIT_RELAXATION_FACTOR )
+rc_setConeLimit( SETCONELIMIT_CONSTRAINT_ID, SETCONELIMIT_SWINGSPAN1, SETCONELIMIT_SWINGSPAN2, SETCONELIMIT_TWISTSPAN, SETCONELIMIT_SOFTNESS, SETCONELIMIT_BIAS_FACTOR, SETCONELIMIT_RELAXATION_FACTOR )
+rc_getHingeLimitBiasFactor( GETHINGELIMITBIASFACTOR_CONSTRAINT_ID )
+rc_getHingeLimitRelaxationFactor( GETHINGELIMITRELAXATIONFACTOR_CONSTRAINT_ID )
+rc_getHingeLimitSign( GETHINGELIMITSIGN_CONSTRAINT_ID )
+rc_getHingeSolveLimit( GETHINGESOLVELIMIT_CONSTRAINT_ID )
+rc_useHingeReferenceFrameA( USEHINGEREFERENCEFRAMEA_CONSTRAINT_ID, USEHINGEREFERENCEFRAMEA_FLAG )
+rc_getConstraintAppliedImpulse( GETCONSTRAINTAPPLIEDIMPULSE_CONSTRAINT_ID )
+rc_getConstraintFixedActor( GETCONSTRAINTFIXEDACTOR_CONSTRAINT_ID )
+rc_getPointPivotA( GETPOINTPIVOTA_CONSTRAINT_ID, & GETPOINTPIVOTA_X, & GETPOINTPIVOTA_Y, & GETPOINTPIVOTA_Z )
+rc_getPointPivotB( GETPOINTPIVOTB_CONSTRAINT_ID, & GETPOINTPIVOTB_X, & GETPOINTPIVOTB_Y, & GETPOINTPIVOTB_Z )
+rc_getConstraintActorA( GETCONSTRAINTACTORA_CONSTRAINT_ID )
+rc_getConstraintActorB( GETCONSTRAINTACTORB_CONSTRAINT_ID )
+rc_setConstraintSolverIterations( SETCONSTRAINTSOLVERITERATIONS_CONSTRAINT_ID, SETCONSTRAINTSOLVERITERATIONS_NUM )
+rc_getConeBiasFactor( GETCONEBIASFACTOR_CONSTRAINT_ID )
+rc_getConeDamping( GETCONEDAMPING_CONSTRAINT_ID )
+rc_getConeFixThresh( GETCONEFIXTHRESH_CONSTRAINT_ID )
+rc_getConeLimit( GETCONELIMIT_CONSTRAINT_ID, GETCONELIMIT_LIMIT_INDEX )
+rc_getConstraintLimitSoftness( GETCONSTRAINTLIMITSOFTNESS_CONSTRAINT_ID )
+rc_getConstraintSolverIterations( GETCONSTRAINTSOLVERITERATIONS_CONSTRAINT_ID )
+rc_getConeAnglePoint( GETCONEANGLEPOINT_CONSTRAINT_ID, GETCONEANGLEPOINT_ANGLE, GETCONEANGLEPOINT_C_LEN, & GETCONEANGLEPOINT_X, & GETCONEANGLEPOINT_Y, & GETCONEANGLEPOINT_Z )
+rc_getConstraintAngularOnly( GETCONSTRAINTANGULARONLY_CONSTRAINT_ID )
+rc_getConeSolveSwingLimit( GETCONESOLVESWINGLIMIT_CONSTRAINT_ID )
+rc_getConeSolveTwistLimit( GETCONESOLVETWISTLIMIT_CONSTRAINT_ID )
+rc_getConeSwingSpan1( GETCONESWINGSPAN1_CONSTRAINT_ID )
+rc_getConeSwingSpan2( GETCONESWINGSPAN2_CONSTRAINT_ID )
+rc_getConeTwistAngle( GETCONETWISTANGLE_CONSTRAINT_ID )
+rc_getConeTwistLimitSign( GETCONETWISTLIMITSIGN_CONSTRAINT_ID )
+rc_getConeTwistSpan( GETCONETWISTSPAN_CONSTRAINT_ID )
+rc_setConstraintAngularOnly( SETCONSTRAINTANGULARONLY_CONSTRAINT_ID, SETCONSTRAINTANGULARONLY_FLAG )
+rc_setConeDamping( SETCONEDAMPING_CONSTRAINT_ID, SETCONEDAMPING_DAMPING )
+rc_setConeFixThresh( SETCONEFIXTHRESH_CONSTRAINT_ID, SETCONEFIXTHRESH_FIXTHRESH )
+rc_getSlideAnchorA( GETSLIDEANCHORA_CONSTRAINT_ID, & GETSLIDEANCHORA_X, & GETSLIDEANCHORA_Y, & GETSLIDEANCHORA_Z )
+rc_getSlideAnchorB( GETSLIDEANCHORB_CONSTRAINT_ID, & GETSLIDEANCHORB_X, & GETSLIDEANCHORB_Y, & GETSLIDEANCHORB_Z )
+rc_getSlideAngDepth( GETSLIDEANGDEPTH_CONSTRAINT_ID )
+rc_getSlideAngularPos( GETSLIDEANGULARPOS_CONSTRAINT_ID )
+rc_getSlideDampingDirAng( GETSLIDEDAMPINGDIRANG_CONSTRAINT_ID )
+rc_getSlideDampingDirLin( GETSLIDEDAMPINGDIRLIN_CONSTRAINT_ID )
+rc_getSlideDampingLimAng( GETSLIDEDAMPINGLIMANG_CONSTRAINT_ID )
+rc_getSlideDampingLimLin( GETSLIDEDAMPINGLIMLIN_CONSTRAINT_ID )
+rc_getSlideDampingOrthoAng( GETSLIDEDAMPINGORTHOANG_CONSTRAINT_ID )
+rc_getSlideDampingOrthoLin( GETSLIDEDAMPINGORTHOLIN_CONSTRAINT_ID )
+rc_getSlideLinearPos( GETSLIDELINEARPOS_CONSTRAINT_ID )
+rc_getSlideLinDepth( GETSLIDELINDEPTH_CONSTRAINT_ID )
+rc_getSlideLowerAngLimit( GETSLIDELOWERANGLIMIT_CONSTRAINT_ID )
+rc_getSlideLowerLinLimit( GETSLIDELOWERLINLIMIT_CONSTRAINT_ID )
+rc_getSlideRestitutionDirAng( GETSLIDERESTITUTIONDIRANG_CONSTRAINT_ID )
+rc_getSlideRestitutionDirLin( GETSLIDERESTITUTIONDIRLIN_CONSTRAINT_ID )
+rc_getSlideRestitutionLimAng( GETSLIDERESTITUTIONLIMANG_CONSTRAINT_ID )
+rc_getSlideRestitutionLimLin( GETSLIDERESTITUTIONLIMLIN_CONSTRAINT_ID )
+rc_getSlideRestitutionOrthoAng( GETSLIDERESTITUTIONORTHOANG_CONSTRAINT_ID )
+rc_getSlideRestitutionOrthoLin( GETSLIDERESTITUTIONORTHOLIN_CONSTRAINT_ID )
+rc_getSlideSoftnessDirAng( GETSLIDESOFTNESSDIRANG_CONSTRAINT_ID )
+rc_getSlideSoftnessDirLin( GETSLIDESOFTNESSDIRLIN_CONSTRAINT_ID )
+rc_getSlideSoftnessLimAng( GETSLIDESOFTNESSLIMANG_CONSTRAINT_ID )
+rc_getSlideSoftnessLimLin( GETSLIDESOFTNESSLIMLIN_CONSTRAINT_ID )
+rc_getSlideSoftnessOrthoAng( GETSLIDESOFTNESSORTHOANG_CONSTRAINT_ID )
+rc_getSlideSoftnessOrthoLin( GETSLIDESOFTNESSORTHOLIN_CONSTRAINT_ID )
+rc_getSlideSolveAngLimit( GETSLIDESOLVEANGLIMIT_CONSTRAINT_ID )
+rc_getSlideSolveLinLimit( GETSLIDESOLVELINLIMIT_CONSTRAINT_ID )
+rc_getSlideUpperAngLimit( GETSLIDEUPPERANGLIMIT_CONSTRAINT_ID )
+rc_getSlideUpperLinLimit( GETSLIDEUPPERLINLIMIT_CONSTRAINT_ID )
+rc_getSlideUseFrameOffset( GETSLIDEUSEFRAMEOFFSET_CONSTRAINT_ID )
+rc_setSlideDampingDirAng( SETSLIDEDAMPINGDIRANG_CONSTRAINT_ID, SETSLIDEDAMPINGDIRANG_N )
+rc_setSlideDampingDirLin( SETSLIDEDAMPINGDIRLIN_CONSTRAINT_ID, SETSLIDEDAMPINGDIRLIN_N )
+rc_setSlideDampingLimAng( SETSLIDEDAMPINGLIMANG_CONSTRAINT_ID, SETSLIDEDAMPINGLIMANG_N )
+rc_setSlideDampingLimLin( SETSLIDEDAMPINGLIMLIN_CONSTRAINT_ID, SETSLIDEDAMPINGLIMLIN_N )
+rc_setSlideDampingOrthoAng( SETSLIDEDAMPINGORTHOANG_CONSTRAINT_ID, SETSLIDEDAMPINGORTHOANG_N )
+rc_setSlideDampingOrthoLin( SETSLIDEDAMPINGORTHOLIN_CONSTRAINT_ID, SETSLIDEDAMPINGORTHOLIN_N )
+rc_setSlideLowerAngLimit( SETSLIDELOWERANGLIMIT_CONSTRAINT_ID, SETSLIDELOWERANGLIMIT_N )
+rc_setSlideLowerLinLimit( SETSLIDELOWERLINLIMIT_CONSTRAINT_ID, SETSLIDELOWERLINLIMIT_N )
+rc_setSlideRestitutionDirAng( SETSLIDERESTITUTIONDIRANG_CONSTRAINT_ID, SETSLIDERESTITUTIONDIRANG_N )
+rc_setSlideRestitutionDirLin( SETSLIDERESTITUTIONDIRLIN_CONSTRAINT_ID, SETSLIDERESTITUTIONDIRLIN_N )
+rc_setSlideRestitutionLimAng( SETSLIDERESTITUTIONLIMANG_CONSTRAINT_ID, SETSLIDERESTITUTIONLIMANG_N )
+rc_setSlideRestitutionLimLin( SETSLIDERESTITUTIONLIMLIN_CONSTRAINT_ID, SETSLIDERESTITUTIONLIMLIN_N )
+rc_setSlideRestitutionOrthoAng( SETSLIDERESTITUTIONORTHOANG_CONSTRAINT_ID, SETSLIDERESTITUTIONORTHOANG_N )
+rc_setSlideRestitutionOrthoLin( SETSLIDERESTITUTIONORTHOLIN_CONSTRAINT_ID, SETSLIDERESTITUTIONORTHOLIN_N )
+rc_setSlideSoftnessDirAng( SETSLIDESOFTNESSDIRANG_CONSTRAINT_ID, SETSLIDESOFTNESSDIRANG_N )
+rc_setSlideSoftnessDirLin( SETSLIDESOFTNESSDIRLIN_CONSTRAINT_ID, SETSLIDESOFTNESSDIRLIN_N )
+rc_setSlideSoftnessLimAng( SETSLIDESOFTNESSLIMANG_CONSTRAINT_ID, SETSLIDESOFTNESSLIMANG_N )
+rc_setSlideSoftnessLimLin( SETSLIDESOFTNESSLIMLIN_CONSTRAINT_ID, SETSLIDESOFTNESSLIMLIN_N )
+rc_setSlideSoftnessOrthoAng( SETSLIDESOFTNESSORTHOANG_CONSTRAINT_ID, SETSLIDESOFTNESSORTHOANG_N )
+rc_setSlideSoftnessOrthoLin( SETSLIDESOFTNESSORTHOLIN_CONSTRAINT_ID, SETSLIDESOFTNESSORTHOLIN_N )
+rc_setSlideUpperAngLimit( SETSLIDEUPPERANGLIMIT_CONSTRAINT_ID, SETSLIDEUPPERANGLIMIT_N )
+rc_setSlideUpperLinLimit( SETSLIDEUPPERLINLIMIT_CONSTRAINT_ID, SETSLIDEUPPERLINLIMIT_N )
+rc_constraintExists( CONSTRAINTEXISTS_CONSTRAINT_ID )
+rc_setCameraPosition( SETCAMERAPOSITION_X, SETCAMERAPOSITION_Y, SETCAMERAPOSITION_Z )
+rc_getCameraPosition( &GETCAMERAPOSITION_X, &GETCAMERAPOSITION_Y, &GETCAMERAPOSITION_Z )
+rc_translateCamera( TRANSLATECAMERA_X, TRANSLATECAMERA_Y, TRANSLATECAMERA_Z )
+rc_setCameraRotation( SETCAMERAROTATION_X, SETCAMERAROTATION_Y, SETCAMERAROTATION_Z )
+rc_getCameraRotation( &GETCAMERAROTATION_X, &GETCAMERAROTATION_Y, &GETCAMERAROTATION_Z )
+rc_rotateCamera( ROTATECAMERA_X, ROTATECAMERA_Y, ROTATECAMERA_Z )
+rc_setCameraFOV( SETCAMERAFOV_FOV )
+rc_getCameraFOV( )
+rc_setCameraAspectRatio( SETCAMERAASPECTRATIO_ASPECT )
+rc_getCameraAspectRatio( )
+rc_setCameraFarValue( SETCAMERAFARVALUE_ZF )
+rc_getCameraFarValue( )
+rc_setCameraNearValue( SETCAMERANEARVALUE_ZN )
+rc_getCameraNearValue( )
+rc_setProjectionMatrix( SETPROJECTIONMATRIX_MATA, SETPROJECTIONMATRIX_PROJECTION_TYPE )
+rc_getProjectionMatrix( GETPROJECTIONMATRIX_MATA )
+rc_getWorldToViewportPosition( GETWORLDTOVIEWPORTPOSITION_X, GETWORLDTOVIEWPORTPOSITION_Y, GETWORLDTOVIEWPORTPOSITION_Z, &GETWORLDTOVIEWPORTPOSITION_VX, &GETWORLDTOVIEWPORTPOSITION_VY )
+rc_addSceneSkyBox( ADDSCENESKYBOX_IMG_TOP, ADDSCENESKYBOX_IMG_BOTTOM, ADDSCENESKYBOX_IMG_LEFT, ADDSCENESKYBOX_IMG_RIGHT, ADDSCENESKYBOX_IMG_FRONT, ADDSCENESKYBOX_IMG_BACK )
+rc_addSceneSkyDome( ADDSCENESKYDOME_IMG )
+rc_addSceneSkyDomeEx( ADDSCENESKYDOMEEX_IMG, ADDSCENESKYDOMEEX_HORIRES, ADDSCENESKYDOMEEX_VERTRES, ADDSCENESKYDOMEEX_TXPERCENTAGE, ADDSCENESKYDOMEEX_SPHEREPERCENTAGE, ADDSCENESKYDOMEEX_RADIUS )
+rc_removeSceneSky( )
+rc_setWorld3DMaxSubSteps( SETWORLD3DMAXSUBSTEPS_STEPS )
+rc_setWorld3DTimeStep( SETWORLD3DTIMESTEP_TS )
+rc_getWorld3DMaxSubSteps( )
+rc_getWorld3DTimeStep( )
+rc_setSceneFog( SETSCENEFOG_COLOR, SETSCENEFOG_FOG_TYPE, SETSCENEFOG_START_VAL, SETSCENEFOG_END_VAL, SETSCENEFOG_DENSITY, SETSCENEFOG_PIXELFOG, SETSCENEFOG_RANGEFOG )
+rc_getSceneFog( &GETSCENEFOG_COLOR, &GETSCENEFOG_FOG_TYPE, &GETSCENEFOG_START_VAL, &GETSCENEFOG_END_VAL, &GETSCENEFOG_DENSITY, &GETSCENEFOG_PIXELFOG, &GETSCENEFOG_RANGEFOG )
+rc_clearScene( )
+rc_startParticleEmitter( STARTPARTICLEEMITTER_ACTOR )
+rc_stopParticleEmitter( STOPPARTICLEEMITTER_ACTOR )
+rc_setParticleDirection( SETPARTICLEDIRECTION_ACTOR, SETPARTICLEDIRECTION_X, SETPARTICLEDIRECTION_Y, SETPARTICLEDIRECTION_Z )
+rc_getParticleDirection( GETPARTICLEDIRECTION_ACTOR, & GETPARTICLEDIRECTION_X, & GETPARTICLEDIRECTION_Y, & GETPARTICLEDIRECTION_Z )
+rc_useParticleEveryMeshVertex( USEPARTICLEEVERYMESHVERTEX_ACTOR, USEPARTICLEEVERYMESHVERTEX_FLAG )
+rc_particleIsUsingEveryMeshVertex( PARTICLEISUSINGEVERYMESHVERTEX_ACTOR )
+rc_setParticleNormalDirectionMod( SETPARTICLENORMALDIRECTIONMOD_ACTOR, SETPARTICLENORMALDIRECTIONMOD_ND_MOD )
+rc_getParticleNormalDirectionMod( GETPARTICLENORMALDIRECTIONMOD_ACTOR )
+rc_useParticleNormalDirection( USEPARTICLENORMALDIRECTION_ACTOR, USEPARTICLENORMALDIRECTION_FLAG )
+rc_particleIsUsingNormalDirection( PARTICLEISUSINGNORMALDIRECTION_ACTOR )
+rc_setParticleMesh( SETPARTICLEMESH_ACTOR, SETPARTICLEMESH_MESH )
+rc_setMinParticlesPerSecond( SETMINPARTICLESPERSECOND_ACTOR, SETMINPARTICLESPERSECOND_MINPARTICLESPERSECOND )
+rc_getMinParticlesPerSecond( GETMINPARTICLESPERSECOND_ACTOR )
+rc_setMaxParticlesPerSecond( SETMAXPARTICLESPERSECOND_ACTOR, SETMAXPARTICLESPERSECOND_MAXPARTICLESPERSECOND )
+rc_getMaxParticlesPerSecond( GETMAXPARTICLESPERSECOND_ACTOR )
+rc_setParticleMinStartColor( SETPARTICLEMINSTARTCOLOR_ACTOR, SETPARTICLEMINSTARTCOLOR_COLOR )
+rc_getParticleMinStartColor( GETPARTICLEMINSTARTCOLOR_ACTOR )
+rc_setParticleMaxStartColor( SETPARTICLEMAXSTARTCOLOR_ACTOR, SETPARTICLEMAXSTARTCOLOR_COLOR )
+rc_getParticleMaxStartColor( GETPARTICLEMAXSTARTCOLOR_ACTOR )
+rc_setParticleMinLife( SETPARTICLEMINLIFE_ACTOR, SETPARTICLEMINLIFE_MINLIFE )
+rc_getParticleMinLife( GETPARTICLEMINLIFE_ACTOR )
+rc_setParticleMaxLife( SETPARTICLEMAXLIFE_ACTOR, SETPARTICLEMAXLIFE_MAXLIFE )
+rc_getParticleMaxLife( GETPARTICLEMAXLIFE_ACTOR )
+rc_setParticleMaxAngle( SETPARTICLEMAXANGLE_ACTOR, SETPARTICLEMAXANGLE_MAXANGLE )
+rc_getParticleMaxAngle( GETPARTICLEMAXANGLE_ACTOR )
+rc_setParticleMinStartSize( SETPARTICLEMINSTARTSIZE_ACTOR, SETPARTICLEMINSTARTSIZE_W, SETPARTICLEMINSTARTSIZE_H )
+rc_getParticleMinStartSize( GETPARTICLEMINSTARTSIZE_ACTOR, & GETPARTICLEMINSTARTSIZE_W, & GETPARTICLEMINSTARTSIZE_H )
+rc_setParticleMaxStartSize( SETPARTICLEMAXSTARTSIZE_ACTOR, SETPARTICLEMAXSTARTSIZE_W, SETPARTICLEMAXSTARTSIZE_H )
+rc_getParticleMaxStartSize( GETPARTICLEMAXSTARTSIZE_ACTOR, & GETPARTICLEMAXSTARTSIZE_W, & GETPARTICLEMAXSTARTSIZE_H )
+rc_setParticleCenter( SETPARTICLECENTER_ACTOR, SETPARTICLECENTER_X, SETPARTICLECENTER_Y, SETPARTICLECENTER_Z )
+rc_getParticleCenter( GETPARTICLECENTER_ACTOR, & GETPARTICLECENTER_X, & GETPARTICLECENTER_Y, & GETPARTICLECENTER_Z )
+rc_setParticleRadius( SETPARTICLERADIUS_ACTOR, SETPARTICLERADIUS_RADIUS )
+rc_getParticleRadius( GETPARTICLERADIUS_ACTOR )
+rc_setParticleRingThickness( SETPARTICLERINGTHICKNESS_ACTOR, SETPARTICLERINGTHICKNESS_RINGTHICKNESS )
+rc_getParticleRingThickness( GETPARTICLERINGTHICKNESS_ACTOR )
+rc_setParticleBox( SETPARTICLEBOX_ACTOR, SETPARTICLEBOX_MIN_X, SETPARTICLEBOX_MIN_Y, SETPARTICLEBOX_MIN_Z, SETPARTICLEBOX_MAX_X, SETPARTICLEBOX_MAX_Y, SETPARTICLEBOX_MAX_Z )
+rc_getParticleBox( GETPARTICLEBOX_ACTOR, & GETPARTICLEBOX_MIN_X, & GETPARTICLEBOX_MIN_Y, & GETPARTICLEBOX_MIN_Z, & GETPARTICLEBOX_MAX_X, & GETPARTICLEBOX_MAX_Y, & GETPARTICLEBOX_MAX_Z )
+rc_setParticleNormal( SETPARTICLENORMAL_ACTOR, SETPARTICLENORMAL_X, SETPARTICLENORMAL_Y, SETPARTICLENORMAL_Z )
+rc_getParticleNormal( GETPARTICLENORMAL_ACTOR, & GETPARTICLENORMAL_X, & GETPARTICLENORMAL_Y, & GETPARTICLENORMAL_Z )
+rc_setParticleLength( SETPARTICLELENGTH_ACTOR, SETPARTICLELENGTH_P_LEN )
+rc_getParticleLength( GETPARTICLELENGTH_ACTOR )
+rc_useParticleOutlineOnly( USEPARTICLEOUTLINEONLY_ACTOR, USEPARTICLEOUTLINEONLY_FLAG )
+rc_particleIsUsingOutlineOnly( PARTICLEISUSINGOUTLINEONLY_ACTOR )
+rc_getParticleType( GETPARTICLETYPE_ACTOR )
+rc_lightIsCastingShadow( LIGHTISCASTINGSHADOW_ACTOR )
+rc_getLightType( GETLIGHTTYPE_ACTOR )
+rc_getLightRadius( GETLIGHTRADIUS_ACTOR )
+rc_setLightType( SETLIGHTTYPE_ACTOR, SETLIGHTTYPE_LIGHT_TYPE )
+rc_setLightRadius( SETLIGHTRADIUS_ACTOR, SETLIGHTRADIUS_RADIUS )
+rc_setLightShadowCast( SETLIGHTSHADOWCAST_ACTOR, SETLIGHTSHADOWCAST_FLAG )
+rc_setLightAmbientColor( SETLIGHTAMBIENTCOLOR_ACTOR, SETLIGHTAMBIENTCOLOR_COLOR )
+rc_getLightAmbientColor( GETLIGHTAMBIENTCOLOR_ACTOR )
+rc_setLightAttenuation( SETLIGHTATTENUATION_ACTOR, SETLIGHTATTENUATION_L_CONSTANT, SETLIGHTATTENUATION_L_LINEAR, SETLIGHTATTENUATION_L_QUADRATIC )
+rc_getLightAttenuation( GETLIGHTATTENUATION_ACTOR, &GETLIGHTATTENUATION_CONSTANT, &GETLIGHTATTENUATION_LINEAR, &GETLIGHTATTENUATION_QUADRATIC )
+rc_setLightDiffuseColor( SETLIGHTDIFFUSECOLOR_ACTOR, SETLIGHTDIFFUSECOLOR_COLOR )
+rc_getLightDiffuseColor( GETLIGHTDIFFUSECOLOR_ACTOR )
+rc_setLightFalloff( SETLIGHTFALLOFF_ACTOR, SETLIGHTFALLOFF_FALLOFF )
+rc_getLightFalloff( GETLIGHTFALLOFF_ACTOR )
+rc_setLightInnerCone( SETLIGHTINNERCONE_ACTOR, SETLIGHTINNERCONE_ANGLE )
+rc_getLightInnerCone( GETLIGHTINNERCONE_ACTOR )
+rc_setLightOuterCone( SETLIGHTOUTERCONE_ACTOR, SETLIGHTOUTERCONE_ANGLE )
+rc_getLightOuterCone( GETLIGHTOUTERCONE_ACTOR )
+rc_setLightSpecularColor( SETLIGHTSPECULARCOLOR_ACTOR, SETLIGHTSPECULARCOLOR_COLOR )
+rc_getLightSpecularColor( GETLIGHTSPECULARCOLOR_ACTOR )
+rc_getTerrainPatchAABB( GETTERRAINPATCHAABB_ACTOR, GETTERRAINPATCHAABB_PATCHX, GETTERRAINPATCHAABB_PATCHZ, &GETTERRAINPATCHAABB_MINX, &GETTERRAINPATCHAABB_MINY, &GETTERRAINPATCHAABB_MINZ, &GETTERRAINPATCHAABB_MAXX, &GETTERRAINPATCHAABB_MAXY, &GETTERRAINPATCHAABB_MAXZ )
+rc_getTerrainPatchLOD( GETTERRAINPATCHLOD_ACTOR, GETTERRAINPATCHLOD_PATCHX, GETTERRAINPATCHLOD_PATCHZ )
+rc_getTerrainHeight( GETTERRAINHEIGHT_ACTOR, GETTERRAINHEIGHT_PATCHX, GETTERRAINHEIGHT_PATCHZ )
+rc_getTerrainCenter( GETTERRAINCENTER_ACTOR, &GETTERRAINCENTER_X, &GETTERRAINCENTER_Y, &GETTERRAINCENTER_Z )
+rc_setTerrainLODDistance( SETTERRAINLODDISTANCE_ACTOR, SETTERRAINLODDISTANCE_LOD, SETTERRAINLODDISTANCE_DISTANCE )
+rc_scaleTerrainTexture( SCALETERRAINTEXTURE_ACTOR, SCALETERRAINTEXTURE_SCALE, SCALETERRAINTEXTURE_SCALE2 )
+rc_setTerrainCameraMovementDelta( SETTERRAINCAMERAMOVEMENTDELTA_ACTOR, SETTERRAINCAMERAMOVEMENTDELTA_DELTA )
+rc_setTerrainCameraRotationDelta( SETTERRAINCAMERAROTATIONDELTA_ACTOR, SETTERRAINCAMERAROTATIONDELTA_DELTA )
+rc_setTerrainPatchLOD( SETTERRAINPATCHLOD_ACTOR, SETTERRAINPATCHLOD_PATCHX, SETTERRAINPATCHLOD_PATCHZ, SETTERRAINPATCHLOD_LOD )
+rc_createMaterial( )
+rc_deleteMaterial( DELETEMATERIAL_MATERIAL_ID )
+rc_setActorMaterial( SETACTORMATERIAL_ACTOR, SETACTORMATERIAL_MATERIAL_NUM, SETACTORMATERIAL_MATERIAL_ID )
+rc_getActorMaterial( GETACTORMATERIAL_ACTOR, GETACTORMATERIAL_MATERIAL_NUM )
+rc_copyActorMaterial( COPYACTORMATERIAL_ACTOR, COPYACTORMATERIAL_MATERIAL_NUM )
+rc_copyMaterial( COPYMATERIAL_SMATERIAL_ID )
+rc_setMaterialTextureCanvas( SETMATERIALTEXTURECANVAS_MATERIAL_ID, SETMATERIALTEXTURECANVAS_LEVEL, SETMATERIALTEXTURECANVAS_CANVAS_ID )
+rc_setMaterialAmbientColor( SETMATERIALAMBIENTCOLOR_MATERIAL_ID, SETMATERIALAMBIENTCOLOR_COLOR )
+rc_getMaterialAmbientColor( GETMATERIALAMBIENTCOLOR_MATERIAL_ID )
+rc_setMaterialAntiAliasing( SETMATERIALANTIALIASING_MATERIAL_ID, SETMATERIALANTIALIASING_AA )
+rc_getMaterialAntiAliasing( GETMATERIALANTIALIASING_MATERIAL_ID )
+rc_setMaterialBackfaceCulling( SETMATERIALBACKFACECULLING_MATERIAL_ID, SETMATERIALBACKFACECULLING_FLAG )
+rc_getMaterialBackfaceCulling( GETMATERIALBACKFACECULLING_MATERIAL_ID )
+rc_setMaterialBlendFactor( SETMATERIALBLENDFACTOR_MATERIAL_ID, SETMATERIALBLENDFACTOR_BF )
+rc_getMaterialBlendFactor( GETMATERIALBLENDFACTOR_MATERIAL_ID )
+rc_setMaterialBlendMode( SETMATERIALBLENDMODE_MATERIAL_ID, SETMATERIALBLENDMODE_BLEND_MODE )
+rc_getMaterialBlendMode( GETMATERIALBLENDMODE_MATERIAL_ID )
+rc_setMaterialColorMask( SETMATERIALCOLORMASK_MATERIAL_ID, SETMATERIALCOLORMASK_COLOR_MASK )
+rc_getMaterialColorMask( GETMATERIALCOLORMASK_MATERIAL_ID )
+rc_setMaterialColorMode( SETMATERIALCOLORMODE_MATERIAL_ID, SETMATERIALCOLORMODE_COLOR_MODE )
+rc_getMaterialColorMode( GETMATERIALCOLORMODE_MATERIAL_ID )
+rc_setMaterialDiffuseColor( SETMATERIALDIFFUSECOLOR_MATERIAL_ID, SETMATERIALDIFFUSECOLOR_COLOR )
+rc_getMaterialDiffuseColor( GETMATERIALDIFFUSECOLOR_MATERIAL_ID )
+rc_setMaterialEmissiveColor( SETMATERIALEMISSIVECOLOR_MATERIAL_ID, SETMATERIALEMISSIVECOLOR_COLOR )
+rc_getMaterialEmissiveColor( GETMATERIALEMISSIVECOLOR_MATERIAL_ID )
+rc_setMaterialFog( SETMATERIALFOG_MATERIAL_ID, SETMATERIALFOG_FLAG )
+rc_getMaterialFog( GETMATERIALFOG_MATERIAL_ID )
+rc_setMaterialFrontfaceCulling( SETMATERIALFRONTFACECULLING_MATERIAL_ID, SETMATERIALFRONTFACECULLING_FLAG )
+rc_getMaterialFrontfaceCulling( GETMATERIALFRONTFACECULLING_MATERIAL_ID )
+rc_setMaterialGouraudShading( SETMATERIALGOURAUDSHADING_MATERIAL_ID, SETMATERIALGOURAUDSHADING_FLAG )
+rc_materialIsGouraudShaded( MATERIALISGOURAUDSHADED_MATERIAL_ID )
+rc_materialIsAplhaBlend( MATERIALISAPLHABLEND_MATERIAL_ID )
+rc_materialIsTransparent( MATERIALISTRANSPARENT_MATERIAL_ID )
+rc_setMaterialLighting( SETMATERIALLIGHTING_MATERIAL_ID, SETMATERIALLIGHTING_FLAG )
+rc_materialIsLit( MATERIALISLIT_MATERIAL_ID )
+rc_setMaterialType( SETMATERIALTYPE_MATERIAL_ID, SETMATERIALTYPE_MAT_TYPE )
+rc_getMaterialType( GETMATERIALTYPE_MATERIAL_ID )
+rc_setMaterialNormalize( SETMATERIALNORMALIZE_MATERIAL_ID, SETMATERIALNORMALIZE_FLAG )
+rc_materialIsNormalized( MATERIALISNORMALIZED_MATERIAL_ID )
+rc_setMaterialPointCloud( SETMATERIALPOINTCLOUD_MATERIAL_ID, SETMATERIALPOINTCLOUD_FLAG )
+rc_materialIsPointCloud( MATERIALISPOINTCLOUD_MATERIAL_ID )
+rc_setMaterialFlag( SETMATERIALFLAG_MATERIAL_ID, SETMATERIALFLAG_MATERIAL_FLAG, SETMATERIALFLAG_F_VALUE )
+rc_getMaterialFlag( GETMATERIALFLAG_MATERIAL_ID, GETMATERIALFLAG_MATERIAL_FLAG )
+rc_setMaterialTexture( SETMATERIALTEXTURE_MATERIAL_ID, SETMATERIALTEXTURE_LEVEL, SETMATERIALTEXTURE_IMG_ID )
+rc_setMaterialShininess( SETMATERIALSHININESS_MATERIAL_ID, SETMATERIALSHININESS_SHININESS )
+rc_getMaterialShininess( GETMATERIALSHININESS_MATERIAL_ID )
+rc_setMaterialSpecularColor( SETMATERIALSPECULARCOLOR_MATERIAL_ID, SETMATERIALSPECULARCOLOR_COLOR )
+rc_getMaterialSpecularColor( GETMATERIALSPECULARCOLOR_MATERIAL_ID )
+rc_setMaterialThickness( SETMATERIALTHICKNESS_MATERIAL_ID, SETMATERIALTHICKNESS_THICKNESS )
+rc_getMaterialThickness( GETMATERIALTHICKNESS_MATERIAL_ID )
+rc_setMaterialWireframe( SETMATERIALWIREFRAME_MATERIAL_ID, SETMATERIALWIREFRAME_FLAG )
+rc_materialIsWireframe( MATERIALISWIREFRAME_MATERIAL_ID )
+rc_setActorTexture( SETACTORTEXTURE_ACTOR, SETACTORTEXTURE_LAYER, SETACTORTEXTURE_IMAGE_ID )
+rc_getActorMaterialCount( GETACTORMATERIALCOUNT_ACTOR )
+rc_setActorMaterialFlag( SETACTORMATERIALFLAG_ACTOR, SETACTORMATERIALFLAG_FLAG, SETACTORMATERIALFLAG_FLAG_VALUE )
+rc_getActorMaterialFlag( GETACTORMATERIALFLAG_ACTOR, GETACTORMATERIALFLAG_MATERIAL, GETACTORMATERIALFLAG_FLAG )
+rc_setActorMaterialType( SETACTORMATERIALTYPE_ACTOR, SETACTORMATERIALTYPE_MATERIAL_TYPE )
+rc_getActorMaterialType( GETACTORMATERIALTYPE_ACTOR, GETACTORMATERIALTYPE_MATERIAL )
+rc_materialExists( MATERIALEXISTS_MATERIAL )
diff --git a/rcbasic_build/intern_lib/actor.bas b/rcbasic_build/intern_lib/actor.bas
new file mode 100644
index 0000000..c60185a
--- /dev/null
+++ b/rcbasic_build/intern_lib/actor.bas
@@ -0,0 +1,28 @@
+function CreateAnimatedActor( mesh )
+function CreateOctreeActor( mesh )
+function CreateCubeActor( cube_size )
+function CreateSphereActor( radius )
+function CreateWaterActor( mesh, waveHeight, waveSpeed, waveLength )
+function CreateLightActor( )
+function CreateBillboardActor( )
+function CreateTerrainActor( hmap_file$ )
+function CreateParticleActor( particle_type )
+sub DeleteActor( actor )
+sub GetActorTransform( actor, matrix )
+sub SetActorPosition( actor, x, y, z )
+sub TranslateActorLocal( actor, x, y, z )
+sub TranslateActorWorld( actor, x, y, z )
+sub GetActorPosition( actor, ByRef x, ByRef y, ByRef z )
+sub SetActorScale( actor, x, y, z )
+sub ScaleActor( actor, x, y, z )
+sub GetActorScale( actor, ByRef x, ByRef y, ByRef z )
+sub SetActorRotation( actor, x, y, z )
+sub RotateActor( actor, x, y, z )
+sub GetActorRotation( actor, ByRef x, ByRef y, ByRef z )
+sub SetActorVisible( actor, flag )
+function ActorIsVisible( actor )
+sub SetActorAutoCulling( actor, cull_type )
+function GetActorAutoCulling( actor )
+sub AddActorShadow( actor )
+sub RemoveActorShadow( actor )
+function ActorExists( actor )
diff --git a/rcbasic_build/intern_lib/actor_animation.bas b/rcbasic_build/intern_lib/actor_animation.bas
new file mode 100644
index 0000000..12d3aec
--- /dev/null
+++ b/rcbasic_build/intern_lib/actor_animation.bas
@@ -0,0 +1,15 @@
+Function CreateActorAnimation(actor, start_frame, end_frame, speed)
+sub SetActorAnimation( actor, animation, num_loops)
+sub SetActorAnimationSpeed( actor, animation, speed )
+sub SetActorAnimationFrames(actor, animation, start_frame, end_frame)
+Function GetActorCurrentAnimation(actor)
+function GetActorAnimationSpeed( actor, animation )
+Function GetActorAnimationStartFrame(actor, animation)
+Function GetActorAnimationEndFrame(actor, animation)
+sub SetActorFrame(actor, frame)
+function GetActorFrame(actor)
+function ActorAnimationIsPlaying(actor)
+function NumActorAnimationLoops(actor)
+sub SetActorMD2Animation( actor, anim, num_loops )
+sub SetActorMD2AnimationByName( actor, anim_name$, num_loops )
+sub DeleteActorAnimation(actor, animation)
diff --git a/rcbasic_build/intern_lib/actor_physics.bas b/rcbasic_build/intern_lib/actor_physics.bas
new file mode 100644
index 0000000..8da4efb
--- /dev/null
+++ b/rcbasic_build/intern_lib/actor_physics.bas
@@ -0,0 +1,62 @@
+sub SetGravity3D(x, y, z)
+sub GetGravity3D(ByRef x, ByRef y, ByRef z)
+sub SetActorCollisionShape( actor, shape_type, mass)
+function GetActorCollisionShape(actor)
+sub SetActorSolid(actor, flag)
+function ActorIsSolid(actor)
+function GetActorCollision(actor1, actor2)
+sub SetActorGravity( actor, x, y, z )
+sub GetActorGravity( actor, ByRef x, ByRef y, ByRef z )
+sub setActorDamping( actor, lin_damping, ang_damping)
+function getActorLinearDamping( actor)
+function getActorAngularDamping( actor)
+function getActorLinearSleepThreshold( actor)
+function getActorAngularSleepThreshold( actor)
+sub applyActorDamping( actor, timeStep)
+sub setActorMassProperties( actor, mass, inertia_x, inertia_y, inertia_z)
+sub getActorLinearFactor( actor, ByRef x, ByRef y, ByRef z)
+sub setActorLinearFactor( actor, x, y, z)
+function getActorInverseMass( actor)
+sub integrateActorVelocities( actor, v_step)
+sub applyActorCentralForceLocal( actor, x, y, z)
+sub applyActorCentralForceWorld( actor, x, y, z)
+sub getActorTotalForce( actor, ByRef x, ByRef y, ByRef z)
+sub getActorTotalTorque( actor, ByRef x, ByRef y, ByRef z)
+sub getActorInverseInertiaDiagLocal( actor, ByRef x, ByRef y, ByRef z)
+sub setActorInverseInertiaDiagLocal( actor, x, y, z)
+sub setActorSleepThresholds( actor, linear, angular)
+sub applyActorTorqueLocal( actor, x, y, z)
+sub applyActorTorqueWorld( actor, x, y, z)
+sub applyActorForceLocal( actor, x, y, z, rel_x, rel_y, rel_z)
+sub applyActorForceWorld( actor, x, y, z, rel_x, rel_y, rel_z)
+sub applyActorCentralImpulseLocal( actor, x, y, z)
+sub applyActorCentralImpulseWorld( actor, x, y, z)
+sub applyActorTorqueImpulseLocal( actor, x, y, z)
+sub applyActorTorqueImpulseWorld( actor, x, y, z)
+sub applyActorImpulseLocal( actor, x, y, z, rel_x, rel_y, rel_z)
+sub applyActorImpulseWorld( actor, x, y, z, rel_x, rel_y, rel_z)
+sub clearActorForces( actor)
+sub updateActorInertiaTensor( actor)
+sub getActorCenter( actor, ByRef x, ByRef y, ByRef z)
+sub getActorRotationQ( actor, ByRef x, ByRef y, ByRef z, ByRef w)
+sub getActorLinearVelocityWorld( actor, ByRef x, ByRef y, ByRef z)
+sub getActorAngularVelocityWorld( actor, ByRef x, ByRef y, ByRef z)
+sub setActorLinearVelocityLocal( actor, x, y, z)
+sub setActorLinearVelocityWorld( actor, x, y, z)
+sub setActorAngularVelocityLocal( actor, x, y, z)
+sub setActorAngularVelocityWorld( actor, x, y, z)
+sub getActorVelocityInLocalPoint( actor, rel_x, rel_y, rel_z, ByRef x, ByRef y, ByRef z)
+sub getActorLinearVelocityLocal( actor, ByRef x, ByRef y, ByRef z)
+sub getActorAngularVelocityLocal( actor, ByRef x, ByRef y, ByRef z)
+sub getActorAABB( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z)
+function computeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z)
+function computeActorAngularImpulseDenominator( actor, x, y, z)
+sub setActorAngularFactor( actor, x, y, z)
+sub getActorAngularFactor( actor, ByRef x, ByRef y, ByRef z)
+sub computeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z)
+sub computeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z)
+sub getActorLocalInertia( actor, ByRef x, ByRef y, ByRef z)
+sub SetActorSleepState(actor, state)
+function CastRay3D( 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 )
+sub GetRayHit3D( index, ByRef actor_id, ByRef x, ByRef y, ByRef z, ByRef normal_x, ByRef normal_y, ByRef normal_z )
diff --git a/rcbasic_build/intern_lib/animation.bas b/rcbasic_build/intern_lib/animation.bas
new file mode 100644
index 0000000..c704927
--- /dev/null
+++ b/rcbasic_build/intern_lib/animation.bas
@@ -0,0 +1,15 @@
+sub SetActorAnimation( actor, start_frame, end_frame)
+sub SetActorAnimationSpeed( actor, speed )
+sub SetActorFrame( actor, frame )
+sub SetActorMD2Animation( actor, anim )
+sub SetActorMD2AnimationByName( actor, anim_name$ )
+function GetActorAnimationSpeed( actor )
+function GetActorEndFrame( actor )
+function GetActorCurrentFrame( actor )
+function GetActorStartFrame( actor )
+sub StartActorTransition( actor, frame, transition_time )
+sub StopActorTransition( actor )
+function ActorIsInTransition( actor )
+function GetActorTransitionTime( actor )
+function actorAnimationIsLooped( actor )
+sub loopActorAnimation( actor, flag )
diff --git a/rcbasic_build/intern_lib/arrays.bas b/rcbasic_build/intern_lib/arrays.bas
new file mode 100644
index 0000000..876d7aa
--- /dev/null
+++ b/rcbasic_build/intern_lib/arrays.bas
@@ -0,0 +1,16 @@
+function ArrayDim(Byref id)
+function StringArrayDim(Byref id$)
+function NumberArrayDim(Byref id)
+function ArraySize(Byref id, array_dim)
+function StringArraySize(Byref id$, array_dim)
+function NumberArraySize(Byref id, array_dim)
+sub NumberArrayCopy(ByRef src, ByRef dst)
+sub StringArrayCopy(ByRef src$, ByRef dst$)
+sub ArrayCopy(ByRef src, ByRef dst)
+sub NumberArrayFill(ByRef src, fdata)
+sub StringArrayFill(ByRef src$, fdata$)
+sub ArrayFill(ByRef src, fdata)
+function TypeArrayDim(Byref id as empty)
+function TypeArraySize(Byref id as empty, array_dim)
+sub TypeArrayCopy(ByRef src as empty, ByRef dst as empty)
+sub TypeArrayFill(ByRef src as empty, fdata as empty)
diff --git a/rcbasic_build/intern_lib/audio.bas b/rcbasic_build/intern_lib/audio.bas
new file mode 100644
index 0000000..073b665
--- /dev/null
+++ b/rcbasic_build/intern_lib/audio.bas
@@ -0,0 +1,37 @@
+function CreateSound(byref buffer, buffer_size, vol)
+function LoadSound(snd_file$)
+sub LoadMusic(music_file$)
+sub PlaySound(slot, channel, loops)
+sub PlaySoundTimed(slot, channel, loops, ms)
+sub PlayMusic(mLoops)
+sub PauseSound(channel)
+sub ResumeSound(channel)
+sub PauseMusic()
+sub ResumeMusic()
+sub DeleteSound(slot)
+sub DeleteMusic()
+sub FadeMusicIn(fade_time, loops)
+sub FadeMusicOut(fade_time)
+function MusicExists()
+sub SetMusicVolume(vol)
+function GetMusicVolume()
+sub SetMusicPosition(pos)
+function GetMusicPosition()
+sub RewindMusic()
+sub SetSoundChannels(max_channels)
+function NumSoundChannels()
+function SoundIsEnabled()
+function SoundExists(slot)
+sub SetChannelVolume(channel, vol)
+function GetChannelVolume(channel)
+sub SetSoundVolume(slot, vol)
+function GetSoundVolume(slot)
+sub StopMusic()
+sub StopSound(channel)
+function SetChannelPanning(channel, left_value, right_value)
+function SetChannelDistance(channel, dist_value)
+function ChannelIsPlaying(channel)
+function ChannelIsPaused(channel)
+function QueryAudioSpec(ByRef freq, ByRef format, ByRef channels)
+function MusicIsPlaying()
+function SetChannelSpacePosition(channel, angle, distance)
diff --git a/rcbasic_build/intern_lib/camera.bas b/rcbasic_build/intern_lib/camera.bas
new file mode 100644
index 0000000..b47e930
--- /dev/null
+++ b/rcbasic_build/intern_lib/camera.bas
@@ -0,0 +1,17 @@
+sub SetCameraPosition( x, y, z)
+sub GetCameraPosition(ByRef x, ByRef y, ByRef z)
+sub TranslateCamera( x, y, z)
+sub SetCameraRotation( x, y, z)
+sub GetCameraRotation(ByRef x, ByRef y, ByRef z)
+sub RotateCamera( x, y, z)
+sub SetCameraFOV( fov )
+function GetCameraFOV( )
+sub SetCameraAspectRatio( aspect )
+function GetCameraAspectRatio( )
+sub SetCameraFarValue( zf )
+function GetCameraFarValue( )
+sub SetCameraNearValue( zn )
+function GetCameraNearValue( )
+Sub SetProjectionMatrix(matA, projection_type)
+Sub GetProjectionMatrix(matA )
+Sub GetWorldToViewportPosition(x, y, z, ByRef vx, ByRef vy)
diff --git a/rcbasic_build/intern_lib/canvas.bas b/rcbasic_build/intern_lib/canvas.bas
new file mode 100644
index 0000000..5ce8205
--- /dev/null
+++ b/rcbasic_build/intern_lib/canvas.bas
@@ -0,0 +1,23 @@
+function OpenCanvas( w, h, viewport_x, viewport_y, viewport_w, viewport_h, mode)
+Sub CloseCanvas(c_num)
+function OpenCanvas3D( viewport_x, viewport_y, viewport_w, viewport_h, mode)
+sub SetCanvasVisible(c_num, flag)
+function CanvasIsVisible(c_num)
+sub SetCanvasViewport(cnum, x, y, w, h)
+sub GetCanvasViewport(c_num, byref x, byref y, byref w, byref h)
+sub Canvas(c_num)
+sub SetCanvasOffset(c_num, x, y)
+sub GetCanvasOffset(c_num, byref x, byref y)
+sub GetCanvasSize(c_num, byref w, byref h)
+sub ClearCanvas()
+sub SetCanvasAlpha(c_num, a)
+function GetCanvasAlpha(c_num)
+sub SetCanvasColorMod(c_num, c)
+function GetCanvasColorMod(c_num)
+function CloneCanvas(c_num, mode)
+sub SetCanvasZ(c_num, z)
+function CanvasZ(c_num)
+function CanvasClip(x, y, w, h)
+function ActiveCanvas()
+sub SetCanvasPhysics2D(c_num, state)
+function OpenCanvasSpriteLayer(viewport_x, viewport_y, viewport_w, viewport_h)
diff --git a/rcbasic_build/intern_lib/clipboard.bas b/rcbasic_build/intern_lib/clipboard.bas
new file mode 100644
index 0000000..03cc20a
--- /dev/null
+++ b/rcbasic_build/intern_lib/clipboard.bas
@@ -0,0 +1,3 @@
+function GetClipboardText$( )
+sub SetClipboardText(txt$)
+function HasClipboardText()
diff --git a/rcbasic_build/intern_lib/conio.bas b/rcbasic_build/intern_lib/conio.bas
new file mode 100644
index 0000000..5812ad5
--- /dev/null
+++ b/rcbasic_build/intern_lib/conio.bas
@@ -0,0 +1,2 @@
+sub FPrint(txt$)
+function Input$(prompt$)
diff --git a/rcbasic_build/intern_lib/constraint3D.bas b/rcbasic_build/intern_lib/constraint3D.bas
new file mode 100644
index 0000000..5fd0e17
--- /dev/null
+++ b/rcbasic_build/intern_lib/constraint3D.bas
@@ -0,0 +1,108 @@
+function createPointConstraint( actorA, pxA, pyA, pzA)
+function createPointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB)
+sub setPointPivotA( constraint_id, x, y, z)
+sub setPointPivotB( constraint_id, x, y, z)
+function createHingeConstraint( actorA, frameA, useReferenceFrameA )
+function createHingeConstraintEx( actorA, actorB, frameA, frameB, useReferenceFrameA)
+function createSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA)
+function createSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA)
+function createConeConstraint( actorA, rbAFrame_matrix)
+function createConeConstraintEx( actorA, actorB, rbAFrame_matrix, rbBFrame_matrix)
+sub deleteConstraint( constraint_id)
+sub getConstraintFrameOffsetA( 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)
+sub useConstraintFrameOffset( constraint_id, flag)
+function getHingeAngle( constraint_id)
+function getHingeAngleEx( constraint_id, t_matrixA, t_matrixB)
+function getConstraintBreakingImpulseThreshold( constraint_id)
+function getConstraintAFrame( constraint_id, mA)
+function getConstraintBFrame( constraint_id, mA)
+sub setHingeAxis( constraint_id, x, y, z)
+sub setConstraintBreakingImpulseThreshold( constraint_id, threshold)
+sub setConstraintFrames( constraint_id, frameA_matrix, frameB_matrix)
+sub setHingeLimit( constraint_id, low, high, softness, bias_factor, relaxation_factor)
+sub setConeLimit( constraint_id, swingSpan1, swingSpan2, twistSpan, softness, bias_factor, relaxation_factor)
+function getHingeLimitBiasFactor( constraint_id)
+function getHingeLimitRelaxationFactor( constraint_id)
+function getHingeLimitSign( constraint_id)
+function getHingeSolveLimit( constraint_id)
+sub useHingeReferenceFrameA( constraint_id, flag)
+function getConstraintAppliedImpulse( constraint_id)
+function getConstraintFixedActor( constraint_id)
+sub getPointPivotA( constraint_id, ByRef x, ByRef y, ByRef z)
+sub getPointPivotB( constraint_id, ByRef x, ByRef y, ByRef z)
+function getConstraintActorA( constraint_id)
+function getConstraintActorB( constraint_id)
+sub setConstraintSolverIterations( constraint_id, num)
+function getConeBiasFactor( constraint_id)
+function getConeDamping( constraint_id)
+function getConeFixThresh( constraint_id)
+function getConeLimit( constraint_id, limit_index)
+function getConstraintLimitSoftness( constraint_id)
+function getConstraintSolverIterations( constraint_id)
+sub getConeAnglePoint( constraint_id, angle, c_len, ByRef x, ByRef y, ByRef z)
+function getConstraintAngularOnly( constraint_id)
+function getConeSolveSwingLimit( constraint_id)
+function getConeSolveTwistLimit( constraint_id)
+function getConeSwingSpan1( constraint_id)
+function getConeSwingSpan2( constraint_id)
+function getConeTwistAngle( constraint_id)
+function getConeTwistLimitSign( constraint_id)
+function getConeTwistSpan( constraint_id)
+sub setConstraintAngularOnly( constraint_id, flag)
+sub setConeDamping( constraint_id, damping)
+sub setConeFixThresh( constraint_id, fixThresh)
+sub getSlideAnchorA( constraint_id, ByRef x, ByRef y, ByRef z)
+sub getSlideAnchorB( constraint_id, ByRef x, ByRef y, ByRef z)
+function getSlideAngDepth( constraint_id)
+function getSlideAngularPos( constraint_id)
+function getSlideDampingDirAng( constraint_id)
+function getSlideDampingDirLin( constraint_id)
+function getSlideDampingLimAng( constraint_id)
+function getSlideDampingLimLin( constraint_id)
+function getSlideDampingOrthoAng( constraint_id)
+function getSlideDampingOrthoLin( constraint_id)
+function getSlideLinearPos( constraint_id)
+function getSlideLinDepth( constraint_id)
+function getSlideLowerAngLimit( constraint_id)
+function getSlideLowerLinLimit( constraint_id)
+function getSlideRestitutionDirAng( constraint_id)
+function getSlideRestitutionDirLin( constraint_id)
+function getSlideRestitutionLimAng( constraint_id)
+function getSlideRestitutionLimLin( constraint_id)
+function getSlideRestitutionOrthoAng( constraint_id)
+function getSlideRestitutionOrthoLin( constraint_id)
+function getSlideSoftnessDirAng( constraint_id)
+function getSlideSoftnessDirLin( constraint_id)
+function getSlideSoftnessLimAng( constraint_id)
+function getSlideSoftnessLimLin( constraint_id)
+function getSlideSoftnessOrthoAng( constraint_id)
+function getSlideSoftnessOrthoLin( constraint_id)
+function getSlideSolveAngLimit( constraint_id)
+function getSlideSolveLinLimit( constraint_id)
+function getSlideUpperAngLimit( constraint_id)
+function getSlideUpperLinLimit( constraint_id)
+function getSlideUseFrameOffset( constraint_id)
+sub setSlideDampingDirAng( constraint_id, n)
+sub setSlideDampingDirLin( constraint_id, n)
+sub setSlideDampingLimAng( constraint_id, n)
+sub setSlideDampingLimLin( constraint_id, n)
+sub setSlideDampingOrthoAng( constraint_id, n)
+sub setSlideDampingOrthoLin( constraint_id, n)
+sub setSlideLowerAngLimit( constraint_id, n)
+sub setSlideLowerLinLimit( constraint_id, n)
+sub setSlideRestitutionDirAng( constraint_id, n)
+sub setSlideRestitutionDirLin( constraint_id, n)
+sub setSlideRestitutionLimAng( constraint_id, n)
+sub setSlideRestitutionLimLin( constraint_id, n)
+sub setSlideRestitutionOrthoAng( constraint_id, n)
+sub setSlideRestitutionOrthoLin( constraint_id, n)
+sub setSlideSoftnessDirAng( constraint_id, n)
+sub setSlideSoftnessDirLin( constraint_id, n)
+sub setSlideSoftnessLimAng( constraint_id, n)
+sub setSlideSoftnessLimLin( constraint_id, n)
+sub setSlideSoftnessOrthoAng( constraint_id, n)
+sub setSlideSoftnessOrthoLin( constraint_id, n)
+sub setSlideUpperAngLimit( constraint_id, n)
+sub setSlideUpperLinLimit( constraint_id, n)
+function ConstraintExists( constraint_id )
diff --git a/rcbasic_build/intern_lib/datetime.bas b/rcbasic_build/intern_lib/datetime.bas
new file mode 100644
index 0000000..e514694
--- /dev/null
+++ b/rcbasic_build/intern_lib/datetime.bas
@@ -0,0 +1,6 @@
+function Date$()
+function Easter$(year)
+function Ticks()
+function Time$()
+function Timer()
+sub Wait(m_sec)
diff --git a/rcbasic_build/intern_lib/directories.bas b/rcbasic_build/intern_lib/directories.bas
new file mode 100644
index 0000000..c76d504
--- /dev/null
+++ b/rcbasic_build/intern_lib/directories.bas
@@ -0,0 +1,7 @@
+sub ChangeDir(p$)
+function DirExists(p$)
+function DirFirst$()
+function Dir$()
+function DirNext$()
+function MakeDir(p$)
+function RemoveDir(p$)
diff --git a/rcbasic_build/intern_lib/files.bas b/rcbasic_build/intern_lib/files.bas
new file mode 100644
index 0000000..3187e02
--- /dev/null
+++ b/rcbasic_build/intern_lib/files.bas
@@ -0,0 +1,18 @@
+function OpenFile(fileName$, mode)
+sub CloseFile( stream )
+function ReadByte(stream)
+sub WriteByte(stream, byte)
+function ReadLine$(stream)
+sub Write(stream, txt$)
+sub WriteLine(stream, txt$)
+sub CopyFile(src$, dst$)
+function RemoveFile(fileName$)
+function FileExists(fileName$)
+function MoveFile(src$, dst$)
+function RenameFile(src$, dst$)
+function FileLength(fileName$)
+function Tell(stream)
+function Seek(stream, pos)
+function EOF(stream)
+function WriteByteBuffer(stream, ByRef buf, buf_size)
+function ReadByteBuffer(stream, ByRef buf, buf_size)
diff --git a/rcbasic_build/intern_lib/gfxconsole.bas b/rcbasic_build/intern_lib/gfxconsole.bas
new file mode 100644
index 0000000..e69de29
diff --git a/rcbasic_build/intern_lib/images.bas b/rcbasic_build/intern_lib/images.bas
new file mode 100644
index 0000000..45331c7
--- /dev/null
+++ b/rcbasic_build/intern_lib/images.bas
@@ -0,0 +1,29 @@
+function LoadImage( img$ )
+function LoadImageEx(img$, colkey)
+function createImage(w, h, byref buffer)
+function createImageEx(w, h, byref buffer, color)
+sub BufferFromImage(slot, byref buffer)
+function ImageExists(slot)
+sub ColorKey(slot, c)
+sub setBilinearFilter( flag )
+function getBilinearFilter()
+function CopyImage( img_id )
+sub DeleteImage(slot)
+sub SetImageAlpha(slot, a)
+function GetImageAlpha( img_id )
+sub GetImageSize(slot, byref w, byref h)
+sub SetBlendMode( blend_mode )
+function GetBlendMode( )
+sub SetImageColorMod(slot, c)
+function GetImageColorMod(slot)
+sub DrawImage(slot, x, y)
+sub DrawImage_Blit(slot, x, y, src_x, src_y, src_w, src_h)
+sub DrawImage_BlitEx(slot, x, y, w, h, src_x, src_y, src_w, src_h)
+sub DrawImage_Rotate(slot, x, y, angle)
+sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle)
+sub DrawImage_Zoom(slot, x, y, zx, zy)
+sub DrawImage_ZoomEx(slot, x, y, src_x, src_y, src_w, src_h, zx, zy)
+sub DrawImage_Rotozoom(slot, x, y, angle, zx, zy)
+sub DrawImage_RotozoomEx(slot, x, y, src_x, src_y, src_w, src_h, angle, zx, zy)
+sub DrawImage_Flip(slot, x, y, h, v)
+sub DrawImage_FlipEx(slot, x, y, src_x, src_y, src_w, src_h, h, v)
diff --git a/rcbasic_build/intern_lib/joint2D.bas b/rcbasic_build/intern_lib/joint2D.bas
new file mode 100644
index 0000000..514118d
--- /dev/null
+++ b/rcbasic_build/intern_lib/joint2D.bas
@@ -0,0 +1,68 @@
+function createDistanceJoint( spriteA, spriteB, aX, aY, bX, bY, collide_connect)
+function createFrictionJoint( spriteA, spriteB, x, y, collide_connect)
+function createGearJoint( jointA, jointB, g_ratio, collide_connect)
+function createMotorJoint( spriteA, spriteB, collide_connect)
+function createPrismaticJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect)
+function createPulleyJoint( spriteA, spriteB, gaX, gaY, gbX, gbY, aX, aY, bX, bY, j_ratio, collide_connect)
+function createRevoluteJoint( spriteA, spriteB, x, y, collide_connect)
+function createWeldJoint( spriteA, spriteB, x, y, collide_connect)
+function createWheelJoint( spriteA, spriteB, aX, aY, axisX, axisY, collide_connect)
+sub getJointWorldAnchorA( joint_id, ByRef x, ByRef y)
+sub getJointWorldAnchorB( joint_id, ByRef x, ByRef y)
+sub getJointReactionForce( joint_id, inv_dt, ByRef x, ByRef y)
+function getJointReactionTorque( joint_id, inv_dt)
+sub getJointLocalAnchorA( joint_id, ByRef x, ByRef y)
+sub getJointLocalAnchorB( joint_id, ByRef x, ByRef y)
+sub setJointLength( joint_id, jlen)
+function getJointLength( joint_id)
+sub setJointMinLength( joint_id, jlen)
+function getJointMinLength( joint_id)
+sub setJointMaxLength( joint_id, jlen)
+function getJointMaxLength( joint_id)
+function getJointCurrentLength( joint_id)
+sub setJointStiffness( joint_id, stiffness)
+function getJointStiffness( joint_id)
+sub setJointDamping( joint_id, damping)
+function getJointDamping( joint_id)
+sub setJointMaxForce( joint_id, force)
+function getJointMaxForce( joint_id)
+sub setJointMaxTorque( joint_id, torque)
+function getJointMaxTorque( joint_id)
+sub setJointCorrectionFactor( joint_id, factor)
+function getJointCorrectionFactor( joint_id)
+sub setJointRatio( joint_id, j_ratio)
+function getJointRatio( joint_id)
+sub setJointLinearOffset( joint_id, x, y)
+sub getJointLinearOffset( joint_id, ByRef x, ByRef y)
+sub setJointAngularOffset( joint_id, angleOffset)
+function getJointAngularOffset( joint_id)
+sub getJointLocalAxisA( joint_id, ByRef x, ByRef y)
+function getJointReferenceAngle( joint_id)
+function getJointTranslation( joint_id)
+function getJointSpeed( joint_id)
+function jointIsLimitEnabled( joint_id)
+sub enableJointLimit( joint_id, flag)
+function getJointLowerLimit( joint_id)
+function getJointUpperLimit( joint_id)
+sub setJointLimits( joint_id, lower_limit, upper_limit)
+function jointMotorIsEnabled( joint_id)
+sub enableJointMotor( joint_id, flag)
+sub setJointMotorSpeed( joint_id, speed)
+function getJointMotorSpeed( joint_id)
+sub setJointMaxMotorForce( joint_id, force)
+function getJointMaxMotorForce( joint_id)
+function getJointMotorForce( joint_id, inv_dt)
+sub setJointMaxMotorTorque( joint_id, torque)
+function getJointMaxMotorTorque( joint_id)
+function getJointMotorTorque( joint_id, inv_dt)
+sub getJointGroundAnchorA( joint_id, ByRef x, ByRef y)
+sub getJointGroundAnchorB( joint_id, ByRef x, ByRef y)
+function getJointLengthA( joint_id)
+function getJointLengthB( joint_id)
+function getJointCurrentLengthA( joint_id)
+function getJointCurrentLengthB( joint_id)
+sub setJointOrigin( joint_id, x, y)
+function getJointAngle( joint_id)
+function getJointLinearSpeed( joint_id)
+function getJointAngularSpeed( joint_id)
+Sub DeleteJoint( joint_id )
diff --git a/rcbasic_build/intern_lib/joystick.bas b/rcbasic_build/intern_lib/joystick.bas
new file mode 100644
index 0000000..a9fb00b
--- /dev/null
+++ b/rcbasic_build/intern_lib/joystick.bas
@@ -0,0 +1,14 @@
+function NumJoysticks()
+function NumJoyAxes(joy_num)
+function NumJoyButtons(joy_num)
+function NumJoyHats(joy_num)
+function NumJoyTrackBalls(joy_num)
+function JoyAxis(joy_num, joy_axis)
+function JoyButton(joy_num, joy_button)
+function JoyHat(joy_num, joy_hat)
+sub GetJoyTrackBall(joy_num, ball, byref dx, byref dy)
+function JoyName$(joy_num)
+function JoystickIsConnected(joy_num)
+sub JoyRumblePlay(joy_num, strength, duration)
+sub JoyRumbleStop(joy_num)
+function JoystickIsHaptic(joy_num)
diff --git a/rcbasic_build/intern_lib/keyboard.bas b/rcbasic_build/intern_lib/keyboard.bas
new file mode 100644
index 0000000..4257ecc
--- /dev/null
+++ b/rcbasic_build/intern_lib/keyboard.bas
@@ -0,0 +1,20 @@
+function InKey()
+function Key(key_code)
+function WaitKey()
+sub HideMouse()
+sub ShowMouse()
+function MouseIsVisible()
+sub GetMouse(byref x, byref y, byref mb1, byref mb2, byref mb3)
+function MouseX()
+function MouseY()
+function MouseButton(mb)
+sub GetMouseWheel(byref x_axis, byref y_axis)
+function MouseWheelX()
+function MouseWheelY()
+sub GetGlobalMouse(ByRef x, ByRef y, ByRef mb1, ByRef mb2, ByRef mb3)
+function GlobalMouseX()
+function GlobalMouseY()
+sub WarpMouse(x, y)
+sub WarpMouseGlobal(x, y)
+sub SetMouseZone(x, y, w, h)
+sub ClearMouseZone()
diff --git a/rcbasic_build/intern_lib/lights.bas b/rcbasic_build/intern_lib/lights.bas
new file mode 100644
index 0000000..ceb652c
--- /dev/null
+++ b/rcbasic_build/intern_lib/lights.bas
@@ -0,0 +1,20 @@
+function lightIsCastingShadow( actor )
+function getLightType( actor )
+function getLightRadius( actor )
+sub setLightType( actor, light_type )
+sub setLightRadius( actor, radius )
+sub setLightShadowCast( actor, flag )
+sub SetLightAmbientColor( actor, color )
+function GetLightAmbientColor( actor )
+sub SetLightAttenuation( actor, l_constant, l_linear, l_quadratic )
+sub GetLightAttenuation( actor, ByRef constant, ByRef linear, ByRef quadratic)
+sub SetLightDiffuseColor( actor, color )
+function GetLightDiffuseColor( actor )
+sub SetLightFalloff( actor, falloff )
+function GetLightFalloff( actor )
+sub SetLightInnerCone( actor, angle )
+function GetLightInnerCone( actor )
+sub SetLightOuterCone( actor, angle)
+function GetLightOuterCone( actor )
+sub SetLightSpecularColor( actor, color )
+function GetLightSpecularColor( actor )
diff --git a/rcbasic_build/intern_lib/materials.bas b/rcbasic_build/intern_lib/materials.bas
new file mode 100644
index 0000000..20ef4b5
--- /dev/null
+++ b/rcbasic_build/intern_lib/materials.bas
@@ -0,0 +1,59 @@
+function createMaterial()
+sub deleteMaterial( material_id)
+sub setActorMaterial( actor, material_num, material_id)
+function getActorMaterial( actor, material_num)
+function copyActorMaterial( actor, material_num)
+function copyMaterial( smaterial_id)
+sub setMaterialTextureCanvas( material_id, level, canvas_id)
+sub setMaterialAmbientColor( material_id, color)
+function getMaterialAmbientColor( material_id)
+sub setMaterialAntiAliasing( material_id, aa)
+function getMaterialAntiAliasing( material_id)
+sub setMaterialBackfaceCulling( material_id, flag)
+function getMaterialBackfaceCulling( material_id)
+sub setMaterialBlendFactor( material_id, bf)
+function getMaterialBlendFactor( material_id)
+sub setMaterialBlendMode( material_id, blend_mode)
+function getMaterialBlendMode( material_id)
+sub setMaterialColorMask( material_id, color_mask)
+function getMaterialColorMask( material_id)
+sub setMaterialColorMode( material_id, color_mode)
+function getMaterialColorMode( material_id)
+sub setMaterialDiffuseColor( material_id, color)
+function getMaterialDiffuseColor( material_id)
+sub setMaterialEmissiveColor( material_id, color)
+function getMaterialEmissiveColor( material_id)
+sub setMaterialFog( material_id, flag)
+function getMaterialFog( material_id)
+sub setMaterialFrontfaceCulling( material_id, flag)
+function getMaterialFrontfaceCulling( material_id)
+sub setMaterialGouraudShading( material_id, flag)
+function materialIsGouraudShaded( material_id)
+function materialIsAplhaBlend( material_id)
+function materialIsTransparent( material_id)
+sub setMaterialLighting( material_id, flag)
+function materialIsLit( material_id)
+sub setMaterialType( material_id, mat_type)
+function getMaterialType( material_id)
+sub setMaterialNormalize( material_id, flag)
+function materialIsNormalized( material_id)
+sub setMaterialPointCloud( material_id, flag)
+function materialIsPointCloud( material_id)
+sub setMaterialFlag( material_id, material_flag, f_value)
+function getMaterialFlag( material_id, material_flag)
+sub setMaterialTexture( material_id, level, img_id)
+sub setMaterialShininess( material_id, shininess)
+function getMaterialShininess( material_id)
+sub setMaterialSpecularColor( material_id, color)
+function getMaterialSpecularColor( material_id)
+sub setMaterialThickness( material_id, thickness)
+function getMaterialThickness( material_id)
+sub setMaterialWireframe( material_id, flag)
+function materialIsWireframe( material_id)
+sub setActorTexture( actor, layer, image_id)
+function getActorMaterialCount( actor)
+sub setActorMaterialFlag( actor, flag, flag_value)
+function getActorMaterialFlag( actor, material, flag)
+sub setActorMaterialType( actor, material_type)
+function getActorMaterialType( actor, material)
+function MaterialExists( material )
diff --git a/rcbasic_build/intern_lib/math.bas b/rcbasic_build/intern_lib/math.bas
new file mode 100644
index 0000000..b8f7a02
--- /dev/null
+++ b/rcbasic_build/intern_lib/math.bas
@@ -0,0 +1,37 @@
+function Abs(n)
+function Acos(n)
+function AndBit(a,b)
+function Asin(n)
+function Atan(n)
+function Bin$(n)
+function CInt32(i)
+function CInt64(i)
+function Cos(n)
+function Degrees(r)
+function Exp(n)
+function Frac(n)
+function Hex$(n)
+function HexVal(n$)
+function Int(n)
+function Log(n)
+function Max(a, b)
+function Min(a, b)
+function OrBit(a, b)
+function Radians(d)
+function Randomize(n)
+function Rand(n)
+function Round(n)
+function Sign(n)
+function Sin(n)
+function Sqrt(n)
+function Tan(n)
+function XOrBit(a, b)
+Function GetLineIntersection(p0_x, p0_y, p1_x, p1_y, p2_x, p2_y, p3_x, p3_y, ByRef i_x, ByRef i_y)
+Function Interpolate(min_a, max_a, mid_a, min_b, max_b)
+Function ATan2(y, x)
+function PointInQuad(x, y, x1, y1, x2, y2, x3, y3, x4, y4)
+function PointInTri(x, y, x1, y1, x2, y2, x3, y3)
+Function Distance2D(x1, y1, x2, y2)
+Function Distance3D(x1, y1, z1, x2, y2, z2)
+function GetCircleLineIntersection(circle_x, circle_y, radius, x1, y1, x2, y2, ByRef ix1, ByRef iy1, ByRef ix2, ByRef iy2)
+function GetLinePlaneIntersection(ByRef line_point, ByRef line_direction, ByRef plane_point_1, ByRef plane_point_2, ByRef plane_point_3, ByRef intersection)
diff --git a/rcbasic_build/intern_lib/matrix.bas b/rcbasic_build/intern_lib/matrix.bas
new file mode 100644
index 0000000..073efda
--- /dev/null
+++ b/rcbasic_build/intern_lib/matrix.bas
@@ -0,0 +1,54 @@
+function DimMatrix(m_rows, m_cols)
+Sub DeleteMatrix(mA)
+function AddMatrix(mA, mB, mC)
+function AugmentMatrix(mA, mB, mC)
+sub CopyMatrix(mA, mB)
+function InsertMatrixColumns(mA, c, num_cols)
+function InsertMatrixRows(mA, r, num_rows)
+function MultiplyMatrix(mA, mB, mC)
+function CubeMatrix(mA, mB)
+function DeleteMatrixColumns(mA, c, num_cols)
+function DeleteMatrixRows(mA, r, num_rows)
+sub ClearMatrix(mA)
+function ClearMatrixColumns(mA, c, num_cols)
+function ClearMatrixRows(mA, r, num_rows)
+sub FillMatrix(mA, v)
+function FillMatrixColumns(mA, c, num_cols, v)
+function FillMatrixRows(mA, r, num_rows, v)
+function CopyMatrixColumns(mA, mB, c, num_cols)
+function CopyMatrixRows(mA, mB, r, num_rows)
+sub SetIdentityMatrix(mA, n)
+function SolveMatrix(mA, mB, mC)
+function IsEqualMatrix(mA, mB, tolerance)
+function Determinant(mA)
+function AdjointMatrix(mA, mB)
+function InvertMatrix(mA, mB)
+sub MatrixFromBuffer(mA, r, c, ByRef buffer)
+sub BufferFromMatrix(ByRef buffer, mA)
+sub RandomizeMatrix(mA, vmin, vmax)
+function MatrixValue(mA, r, c)
+sub SetMatrixValue(mA, r, c, v)
+sub ScalarMatrix(mA, mB, s_value)
+function ScalarMatrixColumns(mA, mB, c, num_cols, s_value)
+function ScalarMatrixRows(mA, mB, r, num_rows, s_value)
+function SquareMatrix(mA, mB)
+sub CofactorMatrix(mA, r, c)
+function SubtractMatrix(mA, mB, mC)
+sub SwapMatrix(mA, mB)
+function SwapMatrixColumn(mA, C1, C2)
+function SwapMatrixRow(mA, R1, R2)
+function TransposeMatrix(mA, mB)
+function UnAugmentMatrix(mA, mB, mC)
+sub ZeroMatrix(mA)
+sub GetMatrixSize(mA, ByRef r, ByRef c)
+sub IncrementMatrixRows(mA, mB, r, num_rows, value)
+sub IncrementMatrixColumns(mA, mB, c, num_cols, value)
+sub JoinMatrixRows(mA, mB, mC)
+sub JoinMatrixColumns(mA, mB, mC)
+sub ClipMatrix(mA, r, c, num_rows, num_cols, mB)
+sub SetMatrixTranslation( mA, x, y, z )
+sub SetMatrixRotation( mA, x, y, z )
+sub SetMatrixScale( mA, x, y, z )
+sub GetMatrixTranslation( mA, ByRef x, ByRef y, ByRef z)
+sub GetMatrixRotation( mA, ByRef x, ByRef y, ByRef z)
+sub GetMatrixScale( mA, ByRef x, ByRef y, ByRef z)
diff --git a/rcbasic_build/intern_lib/mesh.bas b/rcbasic_build/intern_lib/mesh.bas
new file mode 100644
index 0000000..2b650ab
--- /dev/null
+++ b/rcbasic_build/intern_lib/mesh.bas
@@ -0,0 +1,10 @@
+function LoadMesh( mesh_file$ )
+sub DeleteMesh( mesh )
+function CreateMesh( )
+sub AddMeshBuffer( mesh, vertex_count, ByRef vertex_data, ByRef normal_data, ByRef uv_data, index_count, ByRef index_data )
+function LoadMeshFromArchive( archive$, mesh_file$ )
+Function CreatePlaneMesh( w, h, tileCount_w, tileCount_h )
+Function LoadAN8( an8_file$ )
+Function LoadMeshFromAN8(an8_project, an8_scene$)
+Function GetNumAN8Scenes(an8_project)
+Function GetAN8SceneName$(an8_project, scene_num)
diff --git a/rcbasic_build/intern_lib/network.bas b/rcbasic_build/intern_lib/network.bas
new file mode 100644
index 0000000..bfdc910
--- /dev/null
+++ b/rcbasic_build/intern_lib/network.bas
@@ -0,0 +1,18 @@
+function CheckSockets(timeout_ms)
+function TCP_SocketReady(socket)
+function UDP_SocketReady(socket)
+function TCP_OpenSocket(host$, port)
+sub TCP_CloseSocket(socket)
+function TCP_RemoteHost(socket)
+function TCP_RemotePort(socket)
+function TCP_GetData(socket, numBytes, ByRef sData$)
+sub TCP_SendData(socket, sData$)
+function TCP_AcceptSocket(server)
+function UDP_OpenSocket(port)
+sub UDP_CloseSocket(socket)
+function UDP_GetData(socket, byref host$, byref port, byref sData$)
+function UDP_Length()
+function UDP_MaxLength()
+function UDP_RemoteHost$(socket)
+function UDP_RemotePort(socket)
+sub UDP_SendData(socket, host$, port, sData$)
diff --git a/rcbasic_build/intern_lib/particles.bas b/rcbasic_build/intern_lib/particles.bas
new file mode 100644
index 0000000..a51612d
--- /dev/null
+++ b/rcbasic_build/intern_lib/particles.bas
@@ -0,0 +1,44 @@
+sub startParticleEmitter( actor)
+sub stopParticleEmitter( actor)
+sub setParticleDirection( actor, x, y, z)
+sub getParticleDirection( actor, ByRef x, ByRef y, ByRef z)
+sub useParticleEveryMeshVertex( actor, flag)
+function particleIsUsingEveryMeshVertex( actor)
+sub setParticleNormalDirectionMod( actor, nd_mod)
+function getParticleNormalDirectionMod( actor)
+sub useParticleNormalDirection( actor, flag)
+function particleIsUsingNormalDirection( actor)
+sub setParticleMesh( actor, mesh)
+sub setMinParticlesPerSecond( actor, minParticlesPerSecond)
+function getMinParticlesPerSecond( actor)
+sub setMaxParticlesPerSecond( actor, maxParticlesPerSecond)
+function getMaxParticlesPerSecond( actor)
+sub setParticleMinStartColor( actor, color)
+function getParticleMinStartColor( actor)
+sub setParticleMaxStartColor( actor, color)
+function getParticleMaxStartColor( actor)
+sub setParticleMinLife( actor, minLife)
+function getParticleMinLife( actor)
+sub setParticleMaxLife( actor, maxLife)
+function getParticleMaxLife( actor)
+sub setParticleMaxAngle( actor, maxAngle)
+function getParticleMaxAngle( actor)
+sub setParticleMinStartSize( actor, w, h)
+sub getParticleMinStartSize( actor, ByRef w, ByRef h)
+sub setParticleMaxStartSize( actor, w, h)
+sub getParticleMaxStartSize( actor, ByRef w, ByRef h)
+sub setParticleCenter( actor, x, y, z)
+sub getParticleCenter( actor, ByRef x, ByRef y, ByRef z)
+sub setParticleRadius( actor, radius)
+function getParticleRadius( actor)
+sub setParticleRingThickness( actor, ringThickness)
+function getParticleRingThickness( actor)
+sub setParticleBox( actor, min_x, min_y, min_z, max_x, max_y, max_z)
+sub getParticleBox( actor, ByRef min_x, ByRef min_y, ByRef min_z, ByRef max_x, ByRef max_y, ByRef max_z)
+sub setParticleNormal( actor, x, y, z)
+sub getParticleNormal( actor, ByRef x, ByRef y, ByRef z)
+sub setParticleLength( actor, p_len)
+function getParticleLength( actor)
+sub useParticleOutlineOnly( actor, flag)
+function particleIsUsingOutlineOnly( actor)
+function getParticleType( actor )
diff --git a/rcbasic_build/intern_lib/prim2d.bas b/rcbasic_build/intern_lib/prim2d.bas
new file mode 100644
index 0000000..5299737
--- /dev/null
+++ b/rcbasic_build/intern_lib/prim2d.bas
@@ -0,0 +1,18 @@
+sub Circle(x,y,radius)
+sub CircleFill(x,y,radius)
+sub Ellipse(x,y,rx,ry)
+sub EllipseFill(x,y,rx,ry)
+sub FloodFill(x,y)
+function GetPixel(x,y)
+sub SetColor(c)
+sub Line(x1, y1, x2, y2)
+sub Poly(n, byref x, byref y)
+sub Rect(x, y, w, h)
+sub RectFill(x, y, w, h)
+function RGB(r,g,b)
+function RGBA(r,g,b,a)
+sub Pset(x,y)
+sub Triangle(x1, y1, x2, y2, x3, y3)
+sub Line3D(x1, y1, z1, x2, y2, z2)
+sub Box3D(min_x, min_y, min_z, max_x, max_y, max_z)
+sub Triangle3D(x1, y1, z1, x2, y2, z2, x3, y3, z3)
diff --git a/rcbasic_build/intern_lib/process.bas b/rcbasic_build/intern_lib/process.bas
new file mode 100644
index 0000000..e69de29
diff --git a/rcbasic_build/intern_lib/scene.bas b/rcbasic_build/intern_lib/scene.bas
new file mode 100644
index 0000000..60937b9
--- /dev/null
+++ b/rcbasic_build/intern_lib/scene.bas
@@ -0,0 +1,11 @@
+sub AddSceneSkyBox( img_top, img_bottom, img_left, img_right, img_front, img_back)
+sub AddSceneSkyDome( img )
+sub AddSceneSkyDomeEx( img, horiRes, vertRes, txPercentage, spherePercentage, radius)
+sub RemoveSceneSky( )
+sub SetWorld3DMaxSubSteps( steps )
+sub SetWorld3DTimeStep( ts )
+function GetWorld3DMaxSubSteps()
+function GetWorld3DTimeStep()
+Sub SetSceneFog(color, fog_type, start_val, end_val, density, pixelFog, rangeFog)
+Sub GetSceneFog(ByRef color, ByRef fog_type, ByRef start_val, ByRef end_val, ByRef density, ByRef pixelFog, ByRef rangeFog)
+Sub ClearScene()
diff --git a/rcbasic_build/intern_lib/sprite_animation.bas b/rcbasic_build/intern_lib/sprite_animation.bas
new file mode 100644
index 0000000..e91a106
--- /dev/null
+++ b/rcbasic_build/intern_lib/sprite_animation.bas
@@ -0,0 +1,15 @@
+Function CreateSpriteAnimation(sprite, anim_length, speed)
+Sub SetSpriteFrame(sprite, frame)
+Function GetSpriteFrame(sprite)
+Sub SetSpriteAnimationFrame(sprite, animation, anim_frame, frame)
+Function GetSpriteAnimationFrame(sprite, animation, anim_frame)
+Sub SetSpriteAnimationLength(sprite, animation, anim_length)
+Function GetSpriteAnimationLength(sprite, animation)
+Sub SetSpriteAnimationSpeed(sprite, animation, speed)
+Function GetSpriteAnimationSpeed(sprite, animation)
+Sub SetSpriteAnimation(sprite, animation, num_loops)
+Function GetSpriteAnimation(sprite)
+Function GetSpriteCurrentAnimationFrame(sprite)
+Function NumSpriteAnimationLoops(sprite)
+Function SpriteAnimationIsPlaying(sprite)
+Sub DeleteSpriteAnimation(sprite, animation)
diff --git a/rcbasic_build/intern_lib/sprite_physics.bas b/rcbasic_build/intern_lib/sprite_physics.bas
new file mode 100644
index 0000000..70a2445
--- /dev/null
+++ b/rcbasic_build/intern_lib/sprite_physics.bas
@@ -0,0 +1,54 @@
+sub getSpriteCenter( spr_id, ByRef x, ByRef y)
+sub setSpriteLinearVelocity( spr_id, x, y)
+sub getSpriteLinearVelocity( spr_id, ByRef x, ByRef y)
+sub setSpriteAngularVelocity( spr_id, av)
+function getSpriteAngularVelocity( spr_id)
+sub applySpriteForce( spr_id, fX, fY, pX, pY)
+sub applySpriteCentralForce( spr_id, x, y)
+sub applySpriteTorque( spr_id, torque)
+sub applySpriteLinearImpulse( spr_id, iX, iY, pX, pY)
+sub applySpriteAngularImpulse( spr_id, impulse)
+function getSpriteMass( spr_id)
+function getSpriteInertia( spr_id)
+sub getSpriteWorldPoint( spr_id, lX, lY, ByRef x, ByRef y)
+sub getSpriteWorldVector( spr_id, lX, lY, ByRef x, ByRef y)
+sub getSpriteLocalPoint( spr_id, wX, wY, ByRef x, ByRef y)
+sub getSpriteLocalVector( spr_id, wX, wY, ByRef x, ByRef y)
+sub getSpriteLinearVelocityFromLocalPoint( spr_id, pX, pY, ByRef x, ByRef y)
+sub getSpriteLinearVelocityFromWorldPoint( spr_id, wX, wY, ByRef x, ByRef y)
+function getSpriteLinearDamping( spr_id)
+sub setSpriteLinearDamping( spr_id, linearDamping)
+function getSpriteAngularDamping( spr_id)
+sub setSpriteAngularDamping( spr_id, angularDamping)
+function getSpriteGravityScale( spr_id)
+sub setSpriteGravityScale( spr_id, g_scale)
+sub setSpriteBullet( spr_id, flag)
+function spriteIsBullet( spr_id)
+sub setSpriteSleepAllowed( spr_id, flag)
+function spriteSleepAllowed( spr_id)
+sub setSpriteAwake( spr_id, flag)
+function spriteIsAwake( spr_id)
+sub setSpriteFixedRotation( spr_id, flag)
+function spriteIsFixedRotation( spr_id)
+sub SetSpriteDensity( spr_id, density )
+function GetSpriteDensity( spr_id )
+sub SetSpriteFriction( spr_id, friction )
+function GetSpriteFriction( spr_id )
+sub SetSpriteRestitution( spr_id, restitution )
+function GetSpriteRestitution( spr_id )
+sub SetSpriteRestitutionThreshold( spr_id, threshold )
+function GetSpriteRestitutionThreshold( spr_id )
+sub GetSpriteAABB( spr_id, ByRef x1, ByRef y1, ByRef x2, ByRef y2 )
+sub SetGravity2D( x, y )
+sub GetGravity2D( ByRef x, ByRef y )
+sub SetWorld2DTimeStep( ts )
+sub SetWorld2DVelocityIterations( v )
+sub SetWorld2DPositionIterations( p )
+function GetWorld2DTimeStep()
+function GetWorld2DVelocityIterations()
+function GetWorld2DPositionIterations()
+sub SetWorld2DAutoClearForces( flag )
+function GetWorld2DAutoClearForces()
+function CastRay2D( from_x, from_y, to_x, to_y )
+function CastRay2D_All( from_x, from_y, to_x, to_y )
+sub GetRayHit2D( index, ByRef spr_id, ByRef x, ByRef y, ByRef normal_x, ByRef normal_y )
diff --git a/rcbasic_build/intern_lib/sprites.bas b/rcbasic_build/intern_lib/sprites.bas
new file mode 100644
index 0000000..3ac0e87
--- /dev/null
+++ b/rcbasic_build/intern_lib/sprites.bas
@@ -0,0 +1,26 @@
+function CreateSprite( img, frame_w, frame_h )
+Sub DeleteSprite( sprite )
+Sub SetSpritePosition( sprite, x, y )
+Sub TranslateSprite(sprite, x, y)
+Sub GetSpritePosition(sprite, ByRef x, ByRef y)
+Function SpriteX(sprite)
+Function SpriteY(sprite)
+Sub SetSpriteRotation(sprite, angle)
+Sub RotateSprite(sprite, angle)
+Function GetSpriteRotation(sprite)
+Sub SetSpriteScale(sprite, x, y)
+Sub ScaleSprite(sprite, x, y)
+Sub GetSpriteScale(sprite, ByRef x, ByRef y)
+Sub SetSpriteZ(sprite, z)
+Function SpriteZ(sprite)
+Sub GetSpriteSize(sprite, ByRef w, ByRef h)
+Function SpriteWidth(sprite)
+Function SpriteHeight(sprite)
+Sub SetSpriteVisible(sprite, flag)
+Function SpriteIsVisible(sprite)
+Sub SetSpriteSolid(sprite, flag)
+Function SpriteIsSolid(sprite)
+Sub SetSpriteType(sprite, sprite_type)
+Function GetSpriteType(sprite)
+Sub SetSpriteSource(sprite, img)
+Function GetSpriteSource(sprite)
diff --git a/rcbasic_build/intern_lib/stacks.bas b/rcbasic_build/intern_lib/stacks.bas
new file mode 100644
index 0000000..43fee8b
--- /dev/null
+++ b/rcbasic_build/intern_lib/stacks.bas
@@ -0,0 +1,12 @@
+function CreateStack_N( )
+function CreateStack_S()
+sub ClearStack_N( num_stack )
+sub ClearStack_S( str_stack )
+sub DeleteStack_N( num_stack )
+sub DeleteStack_S( str_stack )
+sub Push_N( num_stack, n )
+function Pop_N( num_stack )
+sub Push_S( str_stack, s$ )
+function Pop_S$( str_stack )
+function Stack_Size_N( num_stack )
+function Stack_Size_S( str_stack )
diff --git a/rcbasic_build/intern_lib/strings.bas b/rcbasic_build/intern_lib/strings.bas
new file mode 100644
index 0000000..e4c448c
--- /dev/null
+++ b/rcbasic_build/intern_lib/strings.bas
@@ -0,0 +1,26 @@
+function Asc(c$)
+function Chr$(n)
+function Insert$(src$, tgt$, pos)
+function InStr(src$, substr$)
+function Lcase$(src$)
+function Left$(src$, n)
+function Length(src$)
+function Len(src$)
+function Ltrim$(src$)
+function Mid$(src$, start, n)
+function ReplaceSubstr$(src$, rpc$, pos)
+function Replace$(src$, tgt$, rpc$)
+function Reverse$(src$)
+function Right$(src$, n)
+function Rtrim$(src$)
+function StringFill$(src$, n)
+function Str$(n)
+function Str_F$(n)
+function Str_S$(n)
+function Tally(src$, substr$)
+function Trim$(src$)
+function Ucase$(src$)
+function Val(n$)
+function Size(s$)
+function BufferFromString(s$, ByRef buffer)
+function StringFromBuffer$(ByRef buffer, buffer_size)
diff --git a/rcbasic_build/intern_lib/system.bas b/rcbasic_build/intern_lib/system.bas
new file mode 100644
index 0000000..c3ad89d
--- /dev/null
+++ b/rcbasic_build/intern_lib/system.bas
@@ -0,0 +1,21 @@
+function System(cmd$)
+function OS$()
+function Command$(arg)
+function NumCommands()
+function Env$(v$)
+sub SetEnv(var$, value$)
+function PrefPath$(org_name$, app_name$)
+function Android_GetExternalStoragePath$()
+function Android_GetExternalStorageState()
+function Android_GetInternalStoragePath$()
+function Android_JNI_Message$(arg$)
+function Runtime_Utility_Message$(arg$)
+Sub GetDesktopDisplayMode(index, ByRef w, ByRef h, ByRef freq)
+Sub GetPowerInfo(ByRef status, ByRef secs, ByRef pct)
+Function EvalJS$(js_code$) 'Only useable in Emscripten
+function SystemReturnStdOut$(cmd$)
+function OpenURL(url$)
+function MessageBox(title$, msg$)
+function Runtime$()
+function NumCPUs()
+function SystemRam()
diff --git a/rcbasic_build/intern_lib/terrain.bas b/rcbasic_build/intern_lib/terrain.bas
new file mode 100644
index 0000000..8cce10f
--- /dev/null
+++ b/rcbasic_build/intern_lib/terrain.bas
@@ -0,0 +1,9 @@
+sub GetTerrainPatchAABB( actor, patchX, patchZ, ByRef minX, ByRef minY, ByRef minZ, ByRef maxX, ByRef maxY, ByRef maxZ )
+function GetTerrainPatchLOD( actor, patchX, patchZ )
+function GetTerrainHeight( actor, patchX, patchZ )
+sub GetTerrainCenter( actor, ByRef x, ByRef y, ByRef z )
+sub SetTerrainLODDistance( actor, LOD, distance )
+sub ScaleTerrainTexture( actor, scale, scale2 )
+sub SetTerrainCameraMovementDelta( actor, delta )
+sub SetTerrainCameraRotationDelta( actor, delta )
+sub SetTerrainPatchLOD( actor, patchX, patchZ, LOD )
diff --git a/rcbasic_build/intern_lib/text.bas b/rcbasic_build/intern_lib/text.bas
new file mode 100644
index 0000000..f9a19a7
--- /dev/null
+++ b/rcbasic_build/intern_lib/text.bas
@@ -0,0 +1,8 @@
+function LoadFont(fnt_file$, font_size)
+sub DeleteFont(slot)
+Function FontExists(slot)
+sub SetFont(slot)
+sub DrawText(txt$, x, y)
+sub GetTextSize(txt$, byref w, byref h)
+function TextWidth(txt$)
+function TextHeight(txt$)
diff --git a/rcbasic_build/intern_lib/textedit.bas b/rcbasic_build/intern_lib/textedit.bas
new file mode 100644
index 0000000..18bec8e
--- /dev/null
+++ b/rcbasic_build/intern_lib/textedit.bas
@@ -0,0 +1,5 @@
+sub ReadInput_Start()
+sub ReadInput_Stop()
+function ReadInput_GetText$()
+sub ReadInput_SetText(txt$)
+sub ReadInput_ToggleBackspace(flag)
diff --git a/rcbasic_build/intern_lib/tilemaps.bas b/rcbasic_build/intern_lib/tilemaps.bas
new file mode 100644
index 0000000..4ef783f
--- /dev/null
+++ b/rcbasic_build/intern_lib/tilemaps.bas
@@ -0,0 +1,16 @@
+Function CreateTileSet(img_id, tile_w, tile_h)
+Sub SetTileAnimationLength(tileset, base_tile, num_frames)
+Function GetTileAnimationLength(tileset, base_tile)
+Sub SetTileAnimationFrame(tileset, base_tile, anim_frame, tile_frame)
+Function GetTileAnimationFrame(tileset, base_tile, anim_frame)
+Sub SetTileAnimationSpeed(tileset, base_tile, speed)
+Function GetTileAnimationSpeed(tileset, base_tile)
+Function CreateTileMap(tileset, widthInTiles, heightInTiles)
+Sub SetTileMapSize(tilemap, widthInTiles, heightInTiles)
+Sub GetTileMapSize(tilemap, ByRef widthInTiles, ByRef heightInTiles)
+Sub SetTile(tilemap, tile, x, y)
+Function GetTile(tilemap, x, y)
+Sub FillTile(tilemap, tile, x, y, widthInTiles, heightInTiles)
+Sub DrawTileMap(tilemap, x, y, w, h, offset_x, offset_y)
+Sub DeleteTileSet(tileset)
+Sub DeleteTileMap(tilemap)
diff --git a/rcbasic_build/intern_lib/touch.bas b/rcbasic_build/intern_lib/touch.bas
new file mode 100644
index 0000000..5fe93d0
--- /dev/null
+++ b/rcbasic_build/intern_lib/touch.bas
@@ -0,0 +1,11 @@
+function TouchPressure()
+sub GetTouch(byref status, byref x, byref y, byref dx, byref dy)
+sub GetMultiTouch(byref status, byref x, byref y, byref fingers, byref dist, byref theta)
+sub GetTouchFinger(finger, byref x, byref y, byref pressure)
+function NumFingers()
+sub GetAccel(accel_num, ByRef x, ByRef y, ByRef z)
+function AccelName$(accel_num)
+function NumAccels()
+sub GetGyro(gyro_num, ByRef x, ByRef y, ByRef z)
+function GyroName$(gyro_num)
+function NumGyros()
diff --git a/rcbasic_build/intern_lib/video.bas b/rcbasic_build/intern_lib/video.bas
new file mode 100644
index 0000000..1fac1ee
--- /dev/null
+++ b/rcbasic_build/intern_lib/video.bas
@@ -0,0 +1,17 @@
+sub LoadVideo(vid$)
+sub PlayVideo(vLoops)
+sub PauseVideo()
+sub StopVideo()
+sub SetVideoPosition(pos)
+sub ResumeVideo()
+function GetVideoPosition()
+sub DeleteVideo()
+function VideoIsPlaying()
+function VideoEnd()
+sub GetVideoStats(vFile$, byref vLen, byref vfps, byref frame_w, byref frame_h)
+sub SetVideoDrawRect(x, y, w, h)
+sub GetVideoDrawRect(byref x, byref y, byref w, byref h)
+sub GetVideoSize(byref w, byref h)
+function VideoExists()
+sub SetVideoVolume( vol )
+function GetVideoVolume( )
diff --git a/rcbasic_build/intern_lib/water.bas b/rcbasic_build/intern_lib/water.bas
new file mode 100644
index 0000000..e69de29
diff --git a/rcbasic_build/intern_lib/window.bas b/rcbasic_build/intern_lib/window.bas
new file mode 100644
index 0000000..9f2fc12
--- /dev/null
+++ b/rcbasic_build/intern_lib/window.bas
@@ -0,0 +1,50 @@
+Function OpenWindow( title$, w, h, fullscreen, vsync )
+function OpenWindowEx(title$, x, y, w, h, mode, aa, stencil_buffer, vsync)
+sub CloseWindow( )
+sub RaiseWindow( )
+sub Update()
+sub Cls()
+sub SetClearColor(c)
+sub ShowWindow( )
+sub HideWindow( )
+sub SetWindowTitle( title$ )
+function WindowTitle$( )
+sub SetWindowPosition( x, y )
+sub GetWindowPosition( byref x, byref y )
+sub SetWindowSize( w, h )
+sub GetWindowSize( byref w, byref h )
+sub SetWindowMinSize( w, h)
+sub GetWindowMinSize( byref w, byref h)
+sub SetWindowMaxSize( w, h)
+sub GetWindowMaxSize( byref w, byref h)
+function WindowIsFullscreen()
+function WindowIsVisible()
+function WindowIsBordered()
+function WindowIsResizable()
+function WindowIsMinimized()
+function WindowIsMaximized()
+function WindowHasInputFocus()
+function WindowHasMouseFocus()
+sub SetWindowFullscreen( flag)
+sub MaximizeWindow()
+sub MinimizeWindow()
+sub SetWindowBordered( flag)
+function WindowClip(x, y, w, h)
+function WindowExists()
+function WindowEvent_Close()
+function WindowEvent_Maximize()
+function WindowEvent_Minimize()
+function FPS()
+sub SetWindowIcon( slot)
+function WindowEvent_Resize()
+sub SetWindowAutoClose( exit_on_close )
+sub SetWindowResizable( flag )
+function WindowMode(visible, fullscreen, resizable, borderless, highDPI)
+function getWindowMode( )
+sub RestoreWindow( )
+sub GrabInput(flag)
+sub SetWindowAlwaysOnTop( flag )
+sub SetMouseRelative(flag)
+function FlashWindow( flag )
+function WindowIsGrabbed( )
+Sub PreUpdate( )
diff --git a/rcbasic_build/keywords.h b/rcbasic_build/keywords.h
old mode 100644
new mode 100755
diff --git a/rcbasic_build/main.cpp b/rcbasic_build/main.cpp
old mode 100644
new mode 100755
index 7d2024c..2e67d53
--- a/rcbasic_build/main.cpp
+++ b/rcbasic_build/main.cpp
@@ -322,6 +322,11 @@ bool rc_eval_embedded(string line)
return false;
}
+ if(!rc_preprocessor())
+ {
+ return false;
+ }
+
if(tmp_token.size()==0)
return true;
//cout << "-------START TOKENS--------" << endl;
@@ -493,8 +498,73 @@ bool rcbasic_compile()
//debug_output_VMASM();
}
+struct rc_dev_case_functions
+{
+ std::string code;
+ bool case_exception = false;
+};
+
void rcbasic_export_dev()
{
+ std::vector