+ 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..654000b --- /dev/null +++ b/doc/doc_files/accelname.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b809913 --- /dev/null +++ b/doc/doc_files/acos.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0d7a7f1 --- /dev/null +++ b/doc/doc_files/activecanvas.html @@ -0,0 +1,101 @@ + + +
+ + ++ 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..685698a --- /dev/null +++ b/doc/doc_files/actoranimationislooped.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..b721962 --- /dev/null +++ b/doc/doc_files/actoranimationisplaying.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9865844 --- /dev/null +++ b/doc/doc_files/actorexists.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..ebead32 --- /dev/null +++ b/doc/doc_files/actorisintransition.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..3cbf088 --- /dev/null +++ b/doc/doc_files/actorissolid.html @@ -0,0 +1,96 @@ + + +
+ + ++ 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..652ed03
--- /dev/null
+++ b/doc/doc_files/actorisvisible.html
@@ -0,0 +1,94 @@
+
+
+
+
+
+ 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..04ef105 --- /dev/null +++ b/doc/doc_files/addactorshadow.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..8257d82 --- /dev/null +++ b/doc/doc_files/addmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..57ea744 --- /dev/null +++ b/doc/doc_files/addmeshbuffer.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..87875c7 --- /dev/null +++ b/doc/doc_files/addsceneskybox.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..7234e24 --- /dev/null +++ b/doc/doc_files/addsceneskydome.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..efb3e20 --- /dev/null +++ b/doc/doc_files/addsceneskydomeex.html @@ -0,0 +1,109 @@ + + +
+ + ++ 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..4b77e3c --- /dev/null +++ b/doc/doc_files/adjointmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b79d081 --- /dev/null +++ b/doc/doc_files/andbit.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..126b49f --- /dev/null +++ b/doc/doc_files/android_getexternalstoragepath.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..0e5a47d --- /dev/null +++ b/doc/doc_files/android_getexternalstoragestate.html @@ -0,0 +1,102 @@ + + +
+ + ++ 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..97b0a88 --- /dev/null +++ b/doc/doc_files/android_getinternalstoragepath.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..226103e --- /dev/null +++ b/doc/doc_files/android_jni_message.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2818bd3 --- /dev/null +++ b/doc/doc_files/applyactorcentralforcelocal.html @@ -0,0 +1,95 @@ + + +
+ + ++ 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..97c1f25 --- /dev/null +++ b/doc/doc_files/applyactorcentralforceworld.html @@ -0,0 +1,95 @@ + + +
+ + ++ 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..0ac8478 --- /dev/null +++ b/doc/doc_files/applyactorcentralimpulselocal.html @@ -0,0 +1,95 @@ + + +
+ + ++ 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..a8505cb --- /dev/null +++ b/doc/doc_files/applyactorcentralimpulseworld.html @@ -0,0 +1,95 @@ + + +
+ + ++ 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..3fcf6d0 --- /dev/null +++ b/doc/doc_files/applyactordamping.html @@ -0,0 +1,106 @@ + + +
+ + ++ 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..359b6d8 --- /dev/null +++ b/doc/doc_files/applyactorforcelocal.html @@ -0,0 +1,98 @@ + + +
+ + ++ 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..d1ee9a0 --- /dev/null +++ b/doc/doc_files/applyactorforceworld.html @@ -0,0 +1,98 @@ + + +
+ + ++ 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..454597a --- /dev/null +++ b/doc/doc_files/applyactorimpulselocal.html @@ -0,0 +1,98 @@ + + +
+ + ++ 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..d9698cb --- /dev/null +++ b/doc/doc_files/applyactorimpulseworld.html @@ -0,0 +1,98 @@ + + +
+ + ++ 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..03e2bea --- /dev/null +++ b/doc/doc_files/applyactortorqueimpulselocal.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..5b16e28 --- /dev/null +++ b/doc/doc_files/applyactortorqueimpulseworld.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..5d97177 --- /dev/null +++ b/doc/doc_files/applyactortorquelocal.html @@ -0,0 +1,95 @@ + + +
+ + ++ 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..385b3f9 --- /dev/null +++ b/doc/doc_files/applyactortorqueworld.html @@ -0,0 +1,95 @@ + + +
+ + ++ 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..6b4a56d --- /dev/null +++ b/doc/doc_files/arraycopy.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..0ab70fc --- /dev/null +++ b/doc/doc_files/arraydim.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..3b27f92 --- /dev/null +++ b/doc/doc_files/arrayfill.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..444621d --- /dev/null +++ b/doc/doc_files/arrays.html @@ -0,0 +1,129 @@ + + +
+ + ++ 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..17ed546 --- /dev/null +++ b/doc/doc_files/arraysize.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..f282ad1 --- /dev/null +++ b/doc/doc_files/asc.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..031c9db --- /dev/null +++ b/doc/doc_files/asin.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7758f87 --- /dev/null +++ b/doc/doc_files/atan.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..967f200 --- /dev/null +++ b/doc/doc_files/atan2.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c35e83f --- /dev/null +++ b/doc/doc_files/augmentmatrix.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9b9fccb --- /dev/null +++ b/doc/doc_files/bin.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..6b8e9a7 --- /dev/null +++ b/doc/doc_files/bufferfromimage.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..1f2c0c2 --- /dev/null +++ b/doc/doc_files/bufferfrommatrix.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..da4dcdf --- /dev/null +++ b/doc/doc_files/bufferfromstring.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f6741e6 --- /dev/null +++ b/doc/doc_files/canvas.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d1187e0 --- /dev/null +++ b/doc/doc_files/canvasclip.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..e5002c2 --- /dev/null +++ b/doc/doc_files/canvasisvisible.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..7c015f8 --- /dev/null +++ b/doc/doc_files/canvasz.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..d2ad726 --- /dev/null +++ b/doc/doc_files/changedir.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8d6cbdc --- /dev/null +++ b/doc/doc_files/channelispaused.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..28c826c --- /dev/null +++ b/doc/doc_files/channelisplaying.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..c90f3c2 --- /dev/null +++ b/doc/doc_files/checksockets.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..5894448 --- /dev/null +++ b/doc/doc_files/chr.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b0c8581 --- /dev/null +++ b/doc/doc_files/cint32.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ec75058 --- /dev/null +++ b/doc/doc_files/cint64.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cd28a1b --- /dev/null +++ b/doc/doc_files/circle.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..269e99c --- /dev/null +++ b/doc/doc_files/circlefill.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7b8ebbb --- /dev/null +++ b/doc/doc_files/clearactorforces.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..2cb0976 --- /dev/null +++ b/doc/doc_files/clearcanvas.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ab84cb9 --- /dev/null +++ b/doc/doc_files/clearmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cce933c --- /dev/null +++ b/doc/doc_files/clearmatrixcolumns.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..fd9179a --- /dev/null +++ b/doc/doc_files/clearmatrixrows.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..24ffb6c --- /dev/null +++ b/doc/doc_files/clearmousezone.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ecb7520 --- /dev/null +++ b/doc/doc_files/clearstack_n.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..dd0b7f1 --- /dev/null +++ b/doc/doc_files/clearstack_s.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a9390cb --- /dev/null +++ b/doc/doc_files/clipmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c4d9b0f --- /dev/null +++ b/doc/doc_files/clonecanvas.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..aabe560 --- /dev/null +++ b/doc/doc_files/closecanvas.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f304c22 --- /dev/null +++ b/doc/doc_files/closefile.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..de3d73f --- /dev/null +++ b/doc/doc_files/closewindow.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..30073e8 --- /dev/null +++ b/doc/doc_files/cls.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e9d41bc --- /dev/null +++ b/doc/doc_files/cofactormatrix.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..300181c --- /dev/null +++ b/doc/doc_files/colorkey.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..995f2fd --- /dev/null +++ b/doc/doc_files/command.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..35bdb9d --- /dev/null +++ b/doc/doc_files/comments.html @@ -0,0 +1,100 @@ + + +
+ + ++ 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..b1ccf5a --- /dev/null +++ b/doc/doc_files/computeactorangularimpulsedenominator.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..06b56a9 --- /dev/null +++ b/doc/doc_files/computeactorgyroimpulselocal.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..73b74de --- /dev/null +++ b/doc/doc_files/computeactorgyroimpulseworld.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f0608da --- /dev/null +++ b/doc/doc_files/computeactorimpulsedenominator.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..4fca846 --- /dev/null +++ b/doc/doc_files/conditions.html @@ -0,0 +1,103 @@ + + +
+ + ++ 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..264e541 --- /dev/null +++ b/doc/doc_files/constants.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..9e932d6 --- /dev/null +++ b/doc/doc_files/constraintexists.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..bee23bf --- /dev/null +++ b/doc/doc_files/copyactormaterial.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..24fbdcc --- /dev/null +++ b/doc/doc_files/copyfile.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..75f1cc7 --- /dev/null +++ b/doc/doc_files/copyimage.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7871374 --- /dev/null +++ b/doc/doc_files/copymaterial.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..99e95ad --- /dev/null +++ b/doc/doc_files/copymatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3a2a489 --- /dev/null +++ b/doc/doc_files/copymatrixcolumns.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..1e3f87c --- /dev/null +++ b/doc/doc_files/copymatrixrows.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..6b4a03c --- /dev/null +++ b/doc/doc_files/cos.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9cadaa8 --- /dev/null +++ b/doc/doc_files/createactoranimation.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..d1a0118 --- /dev/null +++ b/doc/doc_files/createanimatedactor.html @@ -0,0 +1,105 @@ + + +
+ + ++ 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..c44ea3b --- /dev/null +++ b/doc/doc_files/createbillboardactor.html @@ -0,0 +1,97 @@ + + +
+ + ++ 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..f6a8186 --- /dev/null +++ b/doc/doc_files/createconeconstraint.html @@ -0,0 +1,104 @@ + + +
+ + ++ 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..2a645da --- /dev/null +++ b/doc/doc_files/createconeconstraintex.html @@ -0,0 +1,107 @@ + + +
+ + ++ 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..64d4079 --- /dev/null +++ b/doc/doc_files/createcubeactor.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..b8a3b0a --- /dev/null +++ b/doc/doc_files/createhingeconstraint.html @@ -0,0 +1,101 @@ + + +
+ + ++ 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..22403ec --- /dev/null +++ b/doc/doc_files/createhingeconstraintex.html @@ -0,0 +1,107 @@ + + +
+ + ++ 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..752b401 --- /dev/null +++ b/doc/doc_files/createimage.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..b8fcd4f --- /dev/null +++ b/doc/doc_files/createimageex.html @@ -0,0 +1,92 @@ + + +
+ + ++ 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..c2d62cc --- /dev/null +++ b/doc/doc_files/createlightactor.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..3dcddd2 --- /dev/null +++ b/doc/doc_files/creatematerial.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..75352c0 --- /dev/null +++ b/doc/doc_files/createmesh.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2e5dd1c --- /dev/null +++ b/doc/doc_files/createmeshactor.html @@ -0,0 +1,105 @@ + + +
+ + ++ 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..039e00c --- /dev/null +++ b/doc/doc_files/createmeshoctreeactor.html @@ -0,0 +1,101 @@ + + +
+ + ++ 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..bd21103 --- /dev/null +++ b/doc/doc_files/createoctreeactor.html @@ -0,0 +1,101 @@ + + +
+ + ++ 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..749b9bc --- /dev/null +++ b/doc/doc_files/createparticleactor.html @@ -0,0 +1,117 @@ + + +
+ + ++ 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..1908591 --- /dev/null +++ b/doc/doc_files/createplanemesh.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..042ad50 --- /dev/null +++ b/doc/doc_files/createpointconstraint.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..ac12bc6 --- /dev/null +++ b/doc/doc_files/createpointconstraintex.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d7d6a1e --- /dev/null +++ b/doc/doc_files/createslideconstraint.html @@ -0,0 +1,102 @@ + + +
+ + ++ 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..c48ac52 --- /dev/null +++ b/doc/doc_files/createslideconstraintex.html @@ -0,0 +1,108 @@ + + +
+ + ++ 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..3d91bb5 --- /dev/null +++ b/doc/doc_files/createsound.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..13a5508 --- /dev/null +++ b/doc/doc_files/createsphereactor.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..7ad0646 --- /dev/null +++ b/doc/doc_files/createsprite.html @@ -0,0 +1,85 @@ + + +
+ + ++ Returns new sprite +
++ + + \ 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..d3f2703 --- /dev/null +++ b/doc/doc_files/createspriteanimation.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..7733e37 --- /dev/null +++ b/doc/doc_files/createstack_n.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2b31282 --- /dev/null +++ b/doc/doc_files/createstack_s.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9eb6bae --- /dev/null +++ b/doc/doc_files/createterrainactor.html @@ -0,0 +1,97 @@ + + +
+ + ++ 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..1005612 --- /dev/null +++ b/doc/doc_files/createtilemap.html @@ -0,0 +1,102 @@ + + +
+ + ++ 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..9bebe13 --- /dev/null +++ b/doc/doc_files/createtileset.html @@ -0,0 +1,102 @@ + + +
+ + ++ Return a new Tileset +
++ Parameters: +
+Related: + CreateTileMap +
++ + + \ 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..9d2febd --- /dev/null +++ b/doc/doc_files/createwateractor.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..a6141b1 --- /dev/null +++ b/doc/doc_files/createwaterplaneactor.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..30e13f6 --- /dev/null +++ b/doc/doc_files/cubematrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..050b077 --- /dev/null +++ b/doc/doc_files/date.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..eff9d28 --- /dev/null +++ b/doc/doc_files/degrees.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..667cc04 --- /dev/null +++ b/doc/doc_files/deleteactor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1dae07f --- /dev/null +++ b/doc/doc_files/deleteactoranimation.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5c15dcc --- /dev/null +++ b/doc/doc_files/deleteconstraint.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c9e1bac --- /dev/null +++ b/doc/doc_files/deletefont.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7b1769a --- /dev/null +++ b/doc/doc_files/deleteimage.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1c0474a --- /dev/null +++ b/doc/doc_files/deletematerial.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2fc40b2 --- /dev/null +++ b/doc/doc_files/deletematrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0d4db2c --- /dev/null +++ b/doc/doc_files/deletematrixcolumns.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..e418ad3 --- /dev/null +++ b/doc/doc_files/deletematrixrows.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..53ab5ad --- /dev/null +++ b/doc/doc_files/deletemesh.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cc7e2c1 --- /dev/null +++ b/doc/doc_files/deletemusic.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0bfb08e --- /dev/null +++ b/doc/doc_files/deletesound.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..6260ac7 --- /dev/null +++ b/doc/doc_files/deletesprite.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..922a1e6 --- /dev/null +++ b/doc/doc_files/deletespriteanimation.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d38b5c5 --- /dev/null +++ b/doc/doc_files/deletestack_n.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..02a9598 --- /dev/null +++ b/doc/doc_files/deletestack_s.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b5281df --- /dev/null +++ b/doc/doc_files/deletevideo.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fdf079a --- /dev/null +++ b/doc/doc_files/determinant.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5c27b67 --- /dev/null +++ b/doc/doc_files/dimmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1a0d7f2 --- /dev/null +++ b/doc/doc_files/dir.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..353364b --- /dev/null +++ b/doc/doc_files/direxists.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f73f027 --- /dev/null +++ b/doc/doc_files/dirfirst.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..29af91c --- /dev/null +++ b/doc/doc_files/dirnext.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d441e5f --- /dev/null +++ b/doc/doc_files/distance2d.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..78f8472 --- /dev/null +++ b/doc/doc_files/distance3d.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..87d44e5 --- /dev/null +++ b/doc/doc_files/drawimage.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..af501ce --- /dev/null +++ b/doc/doc_files/drawimage_blit.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f4261f6 --- /dev/null +++ b/doc/doc_files/drawimage_blitex.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..ee59cf4 --- /dev/null +++ b/doc/doc_files/drawimage_flip.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..f812d49 --- /dev/null +++ b/doc/doc_files/drawimage_flipex.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..1ef106c --- /dev/null +++ b/doc/doc_files/drawimage_rotate.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bd376f9 --- /dev/null +++ b/doc/doc_files/drawimage_rotateex.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0c6b256 --- /dev/null +++ b/doc/doc_files/drawimage_rotozoom.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d3f1a53 --- /dev/null +++ b/doc/doc_files/drawimage_rotozoomex.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..83f1880 --- /dev/null +++ b/doc/doc_files/drawimage_zoom.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..c9749c0 --- /dev/null +++ b/doc/doc_files/drawimage_zoomex.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..507e862 --- /dev/null +++ b/doc/doc_files/drawtext.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8453b98 --- /dev/null +++ b/doc/doc_files/drawtilemap.html @@ -0,0 +1,105 @@ + + +
+ + ++ 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..7f9c541 --- /dev/null +++ b/doc/doc_files/easter.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3141bad --- /dev/null +++ b/doc/doc_files/ellipse.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ccdaa69 --- /dev/null +++ b/doc/doc_files/ellipsefill.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7614cda --- /dev/null +++ b/doc/doc_files/env.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f3c58dd --- /dev/null +++ b/doc/doc_files/eof.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3da6af2 --- /dev/null +++ b/doc/doc_files/escape_char.html @@ -0,0 +1,125 @@ + + +
+ + +| 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..4c4562a --- /dev/null +++ b/doc/doc_files/exp.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0627e96 --- /dev/null +++ b/doc/doc_files/fademusicin.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b7bb9f6 --- /dev/null +++ b/doc/doc_files/fademusicout.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f4d3e7d --- /dev/null +++ b/doc/doc_files/fileexists.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..996647e --- /dev/null +++ b/doc/doc_files/filelength.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c1060de --- /dev/null +++ b/doc/doc_files/fillmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0ec59fd --- /dev/null +++ b/doc/doc_files/fillmatrixcolumns.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..24d7955 --- /dev/null +++ b/doc/doc_files/fillmatrixrows.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f4880e2 --- /dev/null +++ b/doc/doc_files/filltile.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fd01307 --- /dev/null +++ b/doc/doc_files/flashwindow.html @@ -0,0 +1,102 @@ + + +
+ + ++ 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..cc5ff5d --- /dev/null +++ b/doc/doc_files/floodfill.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..48fc77e --- /dev/null +++ b/doc/doc_files/fontexists.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5dd1339 --- /dev/null +++ b/doc/doc_files/fprint.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3bfd415 --- /dev/null +++ b/doc/doc_files/fps.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3e56486 --- /dev/null +++ b/doc/doc_files/frac.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ab373f6 --- /dev/null +++ b/doc/doc_files/func_sub.html @@ -0,0 +1,229 @@ + + +
+ + ++ 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..2e4a0a1 --- /dev/null +++ b/doc/doc_files/getaccel.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7619b54 --- /dev/null +++ b/doc/doc_files/getactoraabb.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cff2b90 --- /dev/null +++ b/doc/doc_files/getactorangulardamping.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..759e536 --- /dev/null +++ b/doc/doc_files/getactorangularfactor.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..a74f507 --- /dev/null +++ b/doc/doc_files/getactorangularsleepthreshold.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..8548ff6 --- /dev/null +++ b/doc/doc_files/getactorangularvelocitylocal.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..8c83eb7 --- /dev/null +++ b/doc/doc_files/getactorangularvelocityworld.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..523d974 --- /dev/null +++ b/doc/doc_files/getactoranimationendframe.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d3c61c9 --- /dev/null +++ b/doc/doc_files/getactoranimationspeed.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..0393dbc --- /dev/null +++ b/doc/doc_files/getactoranimationstartframe.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..bf55ae8 --- /dev/null +++ b/doc/doc_files/getactorautoculling.html @@ -0,0 +1,108 @@ + + +
+ + ++ 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..3680e99 --- /dev/null +++ b/doc/doc_files/getactorcollision.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..7e8d1c7 --- /dev/null +++ b/doc/doc_files/getactorcollisionshape.html @@ -0,0 +1,117 @@ + + +
+ + ++ 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..5246ed1 --- /dev/null +++ b/doc/doc_files/getactorcomposition.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a363d49 --- /dev/null +++ b/doc/doc_files/getactorcurrentanimation.html @@ -0,0 +1,92 @@ + + +
+ + ++ 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..7d013fb --- /dev/null +++ b/doc/doc_files/getactorcurrentframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4ca76fc --- /dev/null +++ b/doc/doc_files/getactorendframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f49fe24 --- /dev/null +++ b/doc/doc_files/getactorframe.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..dda91c1 --- /dev/null +++ b/doc/doc_files/getactorgravity.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..6c439df --- /dev/null +++ b/doc/doc_files/getactorinverseinertiadiaglocal.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..685858a --- /dev/null +++ b/doc/doc_files/getactorinversemass.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f381fa4 --- /dev/null +++ b/doc/doc_files/getactorlineardamping.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..e22f017 --- /dev/null +++ b/doc/doc_files/getactorlinearfactor.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..c9a0b9a --- /dev/null +++ b/doc/doc_files/getactorlinearsleepthreshold.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..ce7c4ac --- /dev/null +++ b/doc/doc_files/getactorlinearvelocitylocal.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..da022ec --- /dev/null +++ b/doc/doc_files/getactorlinearvelocityworld.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..37bee06 --- /dev/null +++ b/doc/doc_files/getactorlocalinertia.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..43a0daa --- /dev/null +++ b/doc/doc_files/getactorlocalpointvelocity.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..202a43e --- /dev/null +++ b/doc/doc_files/getactormaterial.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..6529583 --- /dev/null +++ b/doc/doc_files/getactormaterialcount.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0dff1c0 --- /dev/null +++ b/doc/doc_files/getactormaterialflag.html @@ -0,0 +1,153 @@ + + +
+ + ++ 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..fee54c7 --- /dev/null +++ b/doc/doc_files/getactormaterialtype.html @@ -0,0 +1,170 @@ + + +
+ + ++ 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..be333e5 --- /dev/null +++ b/doc/doc_files/getactorposition.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d24d0ff --- /dev/null +++ b/doc/doc_files/getactorrotation.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..e9b90b8 --- /dev/null +++ b/doc/doc_files/getactorrotationq.html @@ -0,0 +1,92 @@ + + +
+ + ++ 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..9c05d4b --- /dev/null +++ b/doc/doc_files/getactorscale.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a35a95a --- /dev/null +++ b/doc/doc_files/getactorstartframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bbe629e --- /dev/null +++ b/doc/doc_files/getactortotalforce.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..89ea69b --- /dev/null +++ b/doc/doc_files/getactortotaltorque.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..6dc39ab --- /dev/null +++ b/doc/doc_files/getactortransform.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..272ad0e --- /dev/null +++ b/doc/doc_files/getactortransitiontime.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..fb3fa8e --- /dev/null +++ b/doc/doc_files/getan8scenename.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b095dd7 --- /dev/null +++ b/doc/doc_files/getbilinearfilter.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..fe10c44 --- /dev/null +++ b/doc/doc_files/getblendmode.html @@ -0,0 +1,126 @@ + + +
+ + ++ 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..ae2199a --- /dev/null +++ b/doc/doc_files/getcameraaspectratio.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..379d998 --- /dev/null +++ b/doc/doc_files/getcamerafarvalue.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..5e67f6b --- /dev/null +++ b/doc/doc_files/getcamerafov.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..550a458 --- /dev/null +++ b/doc/doc_files/getcameranearvalue.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2c5761a --- /dev/null +++ b/doc/doc_files/getcameraposition.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..b58bc18 --- /dev/null +++ b/doc/doc_files/getcamerarotation.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..ef7574e --- /dev/null +++ b/doc/doc_files/getcanvasalpha.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..eb5673f --- /dev/null +++ b/doc/doc_files/getcanvascolormod.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..eef0a99 --- /dev/null +++ b/doc/doc_files/getcanvasoffset.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..bb40b37 --- /dev/null +++ b/doc/doc_files/getcanvassize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9401d99 --- /dev/null +++ b/doc/doc_files/getcanvasviewport.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..e3bc365 --- /dev/null +++ b/doc/doc_files/getcanvasz.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..05b318f --- /dev/null +++ b/doc/doc_files/getchannelvolume.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..04e8786 --- /dev/null +++ b/doc/doc_files/getcirclelineintersection.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a69006c --- /dev/null +++ b/doc/doc_files/getclipboardtext.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5abbfde --- /dev/null +++ b/doc/doc_files/getconeanglepoint.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bba4793 --- /dev/null +++ b/doc/doc_files/getconebiasfactor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3a738fe --- /dev/null +++ b/doc/doc_files/getconedamping.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7146d4b --- /dev/null +++ b/doc/doc_files/getconefixthresh.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..441d227 --- /dev/null +++ b/doc/doc_files/getconelimit.html @@ -0,0 +1,102 @@ + + +
+ + ++ 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..cd3d2a9 --- /dev/null +++ b/doc/doc_files/getconesolveswinglimit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3bb88f3 --- /dev/null +++ b/doc/doc_files/getconesolvetwistlimit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..fe7286c --- /dev/null +++ b/doc/doc_files/getconeswingspan1.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..10a96b5 --- /dev/null +++ b/doc/doc_files/getconeswingspan2.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..352fcb9 --- /dev/null +++ b/doc/doc_files/getconetwistangle.html @@ -0,0 +1,96 @@ + + +
+ + ++ 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..d02b7e8 --- /dev/null +++ b/doc/doc_files/getconetwistlimitsign.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..b1d2bfe --- /dev/null +++ b/doc/doc_files/getconetwistspan.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9d943bf --- /dev/null +++ b/doc/doc_files/getconstraintactora.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..332e227 --- /dev/null +++ b/doc/doc_files/getconstraintactorb.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c013528 --- /dev/null +++ b/doc/doc_files/getconstraintaframe.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..9148112 --- /dev/null +++ b/doc/doc_files/getconstraintangularonly.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7b91a4f --- /dev/null +++ b/doc/doc_files/getconstraintappliedimpulse.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b56d4cd --- /dev/null +++ b/doc/doc_files/getconstraintbframe.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..d4a3ae7 --- /dev/null +++ b/doc/doc_files/getconstraintbreakingimpulsethreshold.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f82d172 --- /dev/null +++ b/doc/doc_files/getconstraintfixedactor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1774bad --- /dev/null +++ b/doc/doc_files/getconstraintframeoffseta.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9ed2f90 --- /dev/null +++ b/doc/doc_files/getconstraintframeoffsetb.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9c3bcd9 --- /dev/null +++ b/doc/doc_files/getconstraintlimitsoftness.html @@ -0,0 +1,100 @@ + + +
+ + ++ 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..a3d2002 --- /dev/null +++ b/doc/doc_files/getconstraintsolveriterations.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d928762 --- /dev/null +++ b/doc/doc_files/getdesktopdisplaymode.html @@ -0,0 +1,96 @@ + + +
+ + ++ 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..8808160 --- /dev/null +++ b/doc/doc_files/getglobalmouse.html @@ -0,0 +1,85 @@ + + +
+ + ++ Gets the global mouse position and button state +
++ + + \ 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..12e3aea --- /dev/null +++ b/doc/doc_files/getgravity3d.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..c5655d9 --- /dev/null +++ b/doc/doc_files/getgyro.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..628bb40 --- /dev/null +++ b/doc/doc_files/gethingeangle.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1c1bbef --- /dev/null +++ b/doc/doc_files/gethingeangleex.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..973616b --- /dev/null +++ b/doc/doc_files/gethingelimitbiasfactor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..42a2e34 --- /dev/null +++ b/doc/doc_files/gethingelimitrelaxationfactor.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..5920522 --- /dev/null +++ b/doc/doc_files/gethingelimitsign.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..144cc6f --- /dev/null +++ b/doc/doc_files/gethingesolvelimit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..8a3efae --- /dev/null +++ b/doc/doc_files/getimagealpha.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cc2564c --- /dev/null +++ b/doc/doc_files/getimagecolormod.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..428c20e --- /dev/null +++ b/doc/doc_files/getimagesize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d43ce75 --- /dev/null +++ b/doc/doc_files/getjoytrackball.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5e0b317 --- /dev/null +++ b/doc/doc_files/getlightambientcolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..95072f4 --- /dev/null +++ b/doc/doc_files/getlightattenuation.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1a41825 --- /dev/null +++ b/doc/doc_files/getlightdiffusecolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4aaf256 --- /dev/null +++ b/doc/doc_files/getlightfalloff.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5221492 --- /dev/null +++ b/doc/doc_files/getlightinnercone.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ec4ac2b --- /dev/null +++ b/doc/doc_files/getlightoutercone.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0c7c339 --- /dev/null +++ b/doc/doc_files/getlightradius.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f8a8287 --- /dev/null +++ b/doc/doc_files/getlightspecularcolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c893fa5 --- /dev/null +++ b/doc/doc_files/getlighttype.html @@ -0,0 +1,102 @@ + + +
+ + ++ 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..cf1f675 --- /dev/null +++ b/doc/doc_files/getlineintersection.html @@ -0,0 +1,88 @@ + + + + + ++ 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..1a9442a --- /dev/null +++ b/doc/doc_files/getlineplaneintersection.html @@ -0,0 +1,108 @@ + + +
+ + ++ 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..9a8a9b9 --- /dev/null +++ b/doc/doc_files/getmaterialambientcolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a5f0b3a --- /dev/null +++ b/doc/doc_files/getmaterialantialiasing.html @@ -0,0 +1,114 @@ + + +
+ + ++ 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..ec74554 --- /dev/null +++ b/doc/doc_files/getmaterialbackfaceculling.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3ff7bab --- /dev/null +++ b/doc/doc_files/getmaterialblendfactor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b25beda --- /dev/null +++ b/doc/doc_files/getmaterialblendmode.html @@ -0,0 +1,123 @@ + + +
+ + ++ 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..57a55b3 --- /dev/null +++ b/doc/doc_files/getmaterialcolormask.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e4a0f28 --- /dev/null +++ b/doc/doc_files/getmaterialcolormode.html @@ -0,0 +1,111 @@ + + +
+ + ++ 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..1870d35 --- /dev/null +++ b/doc/doc_files/getmaterialdiffusecolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2fdb52d --- /dev/null +++ b/doc/doc_files/getmaterialemissivecolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..4e6b2f3 --- /dev/null +++ b/doc/doc_files/getmaterialflag.html @@ -0,0 +1,153 @@ + + +
+ + ++ 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..cb4e3ea --- /dev/null +++ b/doc/doc_files/getmaterialfog.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..67df316 --- /dev/null +++ b/doc/doc_files/getmaterialfrontfaceculling.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..fbd47e1 --- /dev/null +++ b/doc/doc_files/getmaterialshininess.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d40cbba --- /dev/null +++ b/doc/doc_files/getmaterialspecularcolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..8aec812 --- /dev/null +++ b/doc/doc_files/getmaterialthickness.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..6190f25 --- /dev/null +++ b/doc/doc_files/getmaterialtype.html @@ -0,0 +1,170 @@ + + +
+ + ++ 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..d6c94c3 --- /dev/null +++ b/doc/doc_files/getmatrixrotation.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a1da7d1 --- /dev/null +++ b/doc/doc_files/getmatrixscale.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..0eb1750 --- /dev/null +++ b/doc/doc_files/getmatrixsize.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..dafb31b --- /dev/null +++ b/doc/doc_files/getmatrixtranslation.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..879c4f7 --- /dev/null +++ b/doc/doc_files/getmaxparticlespersecond.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..c211581 --- /dev/null +++ b/doc/doc_files/getminparticlespersecond.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..4acf217 --- /dev/null +++ b/doc/doc_files/getmouse.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..72b44e4 --- /dev/null +++ b/doc/doc_files/getmousewheel.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..31198ef --- /dev/null +++ b/doc/doc_files/getmultitouch.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..351624e --- /dev/null +++ b/doc/doc_files/getmusicposition.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..80cd05c --- /dev/null +++ b/doc/doc_files/getmusicvolume.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..6dada92 --- /dev/null +++ b/doc/doc_files/getnuman8scenes.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..0228809 --- /dev/null +++ b/doc/doc_files/getparticlebox.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..608dd47 --- /dev/null +++ b/doc/doc_files/getparticlecenter.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..36f79e9 --- /dev/null +++ b/doc/doc_files/getparticledirection.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..62ecc41 --- /dev/null +++ b/doc/doc_files/getparticlelength.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7e7c55d --- /dev/null +++ b/doc/doc_files/getparticlemaxangle.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..ccb05c0 --- /dev/null +++ b/doc/doc_files/getparticlemaxlife.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..6623632 --- /dev/null +++ b/doc/doc_files/getparticlemaxstartcolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..27b203a --- /dev/null +++ b/doc/doc_files/getparticlemaxstartsize.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..11b1094 --- /dev/null +++ b/doc/doc_files/getparticleminlife.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..61ea1c8 --- /dev/null +++ b/doc/doc_files/getparticleminstartcolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..7f7eb59 --- /dev/null +++ b/doc/doc_files/getparticleminstartsize.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..42ab090 --- /dev/null +++ b/doc/doc_files/getparticlenormal.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..e148ee3 --- /dev/null +++ b/doc/doc_files/getparticlenormaldirectionmod.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..f060ab4 --- /dev/null +++ b/doc/doc_files/getparticleradius.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..d6d26af --- /dev/null +++ b/doc/doc_files/getparticleringthickness.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..4c1103c --- /dev/null +++ b/doc/doc_files/getparticletype.html @@ -0,0 +1,111 @@ + + +
+ + ++ 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..3d62367 --- /dev/null +++ b/doc/doc_files/getpixel.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0a77a31 --- /dev/null +++ b/doc/doc_files/getpointpivota.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..b06ea04 --- /dev/null +++ b/doc/doc_files/getpointpivotb.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..e2fd5b2 --- /dev/null +++ b/doc/doc_files/getpowerinfo.html @@ -0,0 +1,108 @@ + + +
+ + ++ 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..5f59fc7 --- /dev/null +++ b/doc/doc_files/getprojectionmatrix.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..8d0657a --- /dev/null +++ b/doc/doc_files/getslideanchora.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..966c2c8 --- /dev/null +++ b/doc/doc_files/getslideanchorb.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a930b46 --- /dev/null +++ b/doc/doc_files/getslideangdepth.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b120695 --- /dev/null +++ b/doc/doc_files/getslideangularpos.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..363de39 --- /dev/null +++ b/doc/doc_files/getslidedampingdirang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..441a14c --- /dev/null +++ b/doc/doc_files/getslidedampingdirlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7b85996 --- /dev/null +++ b/doc/doc_files/getslidedampinglimang.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..26d1fc3 --- /dev/null +++ b/doc/doc_files/getslidedampinglimlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..5431cdb --- /dev/null +++ b/doc/doc_files/getslidedampingorthoang.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d4d5cdb --- /dev/null +++ b/doc/doc_files/getslidedampingortholin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..b6d0719 --- /dev/null +++ b/doc/doc_files/getslidelindepth.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9cef0b3 --- /dev/null +++ b/doc/doc_files/getslidelinearpos.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..6c79e02 --- /dev/null +++ b/doc/doc_files/getslideloweranglimit.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..2007466 --- /dev/null +++ b/doc/doc_files/getslidelowerlinlimit.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..b0cc256 --- /dev/null +++ b/doc/doc_files/getsliderestitutiondirang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..8bdaedc --- /dev/null +++ b/doc/doc_files/getsliderestitutiondirlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..bdf71af --- /dev/null +++ b/doc/doc_files/getsliderestitutionlimang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..5714a45 --- /dev/null +++ b/doc/doc_files/getsliderestitutionlimlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7f37024 --- /dev/null +++ b/doc/doc_files/getsliderestitutionorthoang.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..75539d0 --- /dev/null +++ b/doc/doc_files/getsliderestitutionortholin.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..a341402 --- /dev/null +++ b/doc/doc_files/getslidesoftnessdirang.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..fd26d45 --- /dev/null +++ b/doc/doc_files/getslidesoftnessdirlin.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..661a1d7 --- /dev/null +++ b/doc/doc_files/getslidesoftnesslimang.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..da30efc --- /dev/null +++ b/doc/doc_files/getslidesoftnesslimlin.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..7445990 --- /dev/null +++ b/doc/doc_files/getslidesoftnessorthoang.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3c14838 --- /dev/null +++ b/doc/doc_files/getslidesoftnessortholin.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..097d105 --- /dev/null +++ b/doc/doc_files/getslidesolveanglimit.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1b433cd --- /dev/null +++ b/doc/doc_files/getslidesolvelinlimit.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..826d558 --- /dev/null +++ b/doc/doc_files/getslideupperanglimit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..ce909b3 --- /dev/null +++ b/doc/doc_files/getslideupperlinlimit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..1b5c5a6 --- /dev/null +++ b/doc/doc_files/getslideuseframeoffset.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..6f83f51 --- /dev/null +++ b/doc/doc_files/getsoundvolume.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7082734 --- /dev/null +++ b/doc/doc_files/getspriteanimation.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..402a3cd --- /dev/null +++ b/doc/doc_files/getspriteanimationframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..62df60c --- /dev/null +++ b/doc/doc_files/getspriteanimationlength.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f9e21cc --- /dev/null +++ b/doc/doc_files/getspriteanimationspeed.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..dc2d72c --- /dev/null +++ b/doc/doc_files/getspritecurrentanimationframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..40a0823 --- /dev/null +++ b/doc/doc_files/getspriteframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..efc39a8 --- /dev/null +++ b/doc/doc_files/getspriteposition.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..3552d4e --- /dev/null +++ b/doc/doc_files/getspriterotation.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..d92e3b6 --- /dev/null +++ b/doc/doc_files/getspritescale.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..6fa0511 --- /dev/null +++ b/doc/doc_files/getspritesize.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9b5bbdd --- /dev/null +++ b/doc/doc_files/getspritesource.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..6ee65a0 --- /dev/null +++ b/doc/doc_files/getspritetype.html @@ -0,0 +1,105 @@ + + +
+ + ++ 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..cf2468d --- /dev/null +++ b/doc/doc_files/getterraincenter.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a592d1c --- /dev/null +++ b/doc/doc_files/getterrainheight.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2e9d9b6 --- /dev/null +++ b/doc/doc_files/getterrainpatchaabb.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..60c2f87 --- /dev/null +++ b/doc/doc_files/getterrainpatchlod.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5128623 --- /dev/null +++ b/doc/doc_files/gettextheight.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..6b260fd --- /dev/null +++ b/doc/doc_files/gettextsize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..94d03ed --- /dev/null +++ b/doc/doc_files/gettextwidth.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cdf9874 --- /dev/null +++ b/doc/doc_files/gettile.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..22405ce --- /dev/null +++ b/doc/doc_files/gettileanimationframe.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..954fe92 --- /dev/null +++ b/doc/doc_files/gettileanimationlength.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a41b176 --- /dev/null +++ b/doc/doc_files/gettileanimationspeed.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..1dbbe1d --- /dev/null +++ b/doc/doc_files/gettilemapsize.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..7ae45f1 --- /dev/null +++ b/doc/doc_files/gettouch.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5430d89 --- /dev/null +++ b/doc/doc_files/gettouchfinger.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..96ced3b --- /dev/null +++ b/doc/doc_files/getvideodrawrect.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7c4d327 --- /dev/null +++ b/doc/doc_files/getvideoposition.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f30b581 --- /dev/null +++ b/doc/doc_files/getvideosize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..baa15bc --- /dev/null +++ b/doc/doc_files/getvideostats.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9bc4177 --- /dev/null +++ b/doc/doc_files/getvideovolume.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7f847bd --- /dev/null +++ b/doc/doc_files/getwatercolor.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..4f8ae97 --- /dev/null +++ b/doc/doc_files/getwatercolorblendfactor.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..9f7b999 --- /dev/null +++ b/doc/doc_files/getwaterwaveheight.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..8288c23 --- /dev/null +++ b/doc/doc_files/getwaterwinddirection.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..47ce5a1 --- /dev/null +++ b/doc/doc_files/getwaterwindforce.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..07365ec --- /dev/null +++ b/doc/doc_files/getwindowmaxsize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4aafc72 --- /dev/null +++ b/doc/doc_files/getwindowminsize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ba15357 --- /dev/null +++ b/doc/doc_files/getwindowmode.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a7ae7d4 --- /dev/null +++ b/doc/doc_files/getwindowposition.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7674587 --- /dev/null +++ b/doc/doc_files/getwindowsize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..32d6266 --- /dev/null +++ b/doc/doc_files/getworldtoviewportposition.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5a006af --- /dev/null +++ b/doc/doc_files/globalmousex.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..cfa154c --- /dev/null +++ b/doc/doc_files/globalmousey.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..4f65b9b --- /dev/null +++ b/doc/doc_files/grabinput.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..afe8b8e --- /dev/null +++ b/doc/doc_files/graphics.html @@ -0,0 +1,171 @@ + + +
+ + ++ 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..fa55118 --- /dev/null +++ b/doc/doc_files/gyroname.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cca6a1b --- /dev/null +++ b/doc/doc_files/hasclipboardtext.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3dccd10 --- /dev/null +++ b/doc/doc_files/hello_world.html @@ -0,0 +1,644 @@ + + +
+ + ++ 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..05d9825 --- /dev/null +++ b/doc/doc_files/hex.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..36a7eb4 --- /dev/null +++ b/doc/doc_files/hexval.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7e3ff0a --- /dev/null +++ b/doc/doc_files/hidemouse.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..eb03bc1 --- /dev/null +++ b/doc/doc_files/hidewindow.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..3b2429b --- /dev/null +++ b/doc/doc_files/imageexists.html @@ -0,0 +1,85 @@ + + +
+ + ++ Returns true if img is associated with an allocated image in memory +
++ + + \ No newline at end of file diff --git a/doc/doc_files/incrementmatrixcolumns.html b/doc/doc_files/incrementmatrixcolumns.html new file mode 100644 index 0000000..e3a80bc --- /dev/null +++ b/doc/doc_files/incrementmatrixcolumns.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2615f3f --- /dev/null +++ b/doc/doc_files/incrementmatrixrows.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d0daa8f --- /dev/null +++ b/doc/doc_files/inkey.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7089015 --- /dev/null +++ b/doc/doc_files/input.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..747a128 --- /dev/null +++ b/doc/doc_files/insert.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e241b06 --- /dev/null +++ b/doc/doc_files/insertmatrixcolumns.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d602d1c --- /dev/null +++ b/doc/doc_files/insertmatrixrows.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f5dc99c --- /dev/null +++ b/doc/doc_files/instr.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a40a0b4 --- /dev/null +++ b/doc/doc_files/int.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..023b488 --- /dev/null +++ b/doc/doc_files/integrateactorvelocities.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..54009d5 --- /dev/null +++ b/doc/doc_files/interpolate.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..089204f --- /dev/null +++ b/doc/doc_files/intro.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..4400930 --- /dev/null +++ b/doc/doc_files/invertmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e93194e --- /dev/null +++ b/doc/doc_files/io.html @@ -0,0 +1,109 @@ + + +
+ + ++ 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..242df07 --- /dev/null +++ b/doc/doc_files/isequalmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d674564 --- /dev/null +++ b/doc/doc_files/joinmatrixcolumns.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..dcdfdd7 --- /dev/null +++ b/doc/doc_files/joinmatrixrows.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..92d6fa8 --- /dev/null +++ b/doc/doc_files/joyaxis.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3d94624 --- /dev/null +++ b/doc/doc_files/joybutton.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..53ec6c2 --- /dev/null +++ b/doc/doc_files/joyhat.html @@ -0,0 +1,117 @@ + + +
+ + ++ 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..ed2a630 --- /dev/null +++ b/doc/doc_files/joyname.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c68a427 --- /dev/null +++ b/doc/doc_files/joyrumbleplay.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..901a4d7 --- /dev/null +++ b/doc/doc_files/joyrumblestop.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d5a9281 --- /dev/null +++ b/doc/doc_files/joystickisconnected.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..04fc365 --- /dev/null +++ b/doc/doc_files/joystickishaptic.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..87d84c5 --- /dev/null +++ b/doc/doc_files/key.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..84c2469 --- /dev/null +++ b/doc/doc_files/key_codes.html @@ -0,0 +1,1899 @@ + + +
+ + +|
+ 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..43119e7 --- /dev/null +++ b/doc/doc_files/left.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c478b47 --- /dev/null +++ b/doc/doc_files/len.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..3a0e7c4 --- /dev/null +++ b/doc/doc_files/length.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..52cbdb2 --- /dev/null +++ b/doc/doc_files/license.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..0babf47 --- /dev/null +++ b/doc/doc_files/lightiscastingshadow.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..448aac0 --- /dev/null +++ b/doc/doc_files/line.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d36f304 --- /dev/null +++ b/doc/doc_files/loadan8.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3e10868 --- /dev/null +++ b/doc/doc_files/loadfont.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ad094a1 --- /dev/null +++ b/doc/doc_files/loadimage.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8dc01c0 --- /dev/null +++ b/doc/doc_files/loadimageex.html @@ -0,0 +1,85 @@ + + +
+ + ++ Returns an image id for an image loaded into memory +
++ + + \ 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..0391f49 --- /dev/null +++ b/doc/doc_files/loadmeshfroman8.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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/loadmusic.html b/doc/doc_files/loadmusic.html new file mode 100644 index 0000000..9566386 --- /dev/null +++ b/doc/doc_files/loadmusic.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e9a5bdb --- /dev/null +++ b/doc/doc_files/loadsound.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..229dc33 --- /dev/null +++ b/doc/doc_files/loadvideo.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3082ace --- /dev/null +++ b/doc/doc_files/log.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e633f15 --- /dev/null +++ b/doc/doc_files/loopactoranimation.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5ba04d1 --- /dev/null +++ b/doc/doc_files/loops.html @@ -0,0 +1,151 @@ + + +
+ + ++ 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..e9e5f3e --- /dev/null +++ b/doc/doc_files/ltrim.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..70e1acd --- /dev/null +++ b/doc/doc_files/makedir.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..daa77fb --- /dev/null +++ b/doc/doc_files/materialexists.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..a0de05f --- /dev/null +++ b/doc/doc_files/materialisaplhablend.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4e596ac --- /dev/null +++ b/doc/doc_files/materialisgouraudshaded.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..498acc4 --- /dev/null +++ b/doc/doc_files/materialislit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3008d95 --- /dev/null +++ b/doc/doc_files/materialisnormalized.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..453313c --- /dev/null +++ b/doc/doc_files/materialispointcloud.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..aaf8e8b --- /dev/null +++ b/doc/doc_files/materialistransparent.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8134d94 --- /dev/null +++ b/doc/doc_files/materialiswireframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7b3ddbf --- /dev/null +++ b/doc/doc_files/matrixfrombuffer.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..bc5fbf2 --- /dev/null +++ b/doc/doc_files/matrixvalue.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f083ceb --- /dev/null +++ b/doc/doc_files/max.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..e14fd93 --- /dev/null +++ b/doc/doc_files/maximizewindow.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..201cba6 --- /dev/null +++ b/doc/doc_files/messagebox.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fc50628 --- /dev/null +++ b/doc/doc_files/mid.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9c41eb4 --- /dev/null +++ b/doc/doc_files/min.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..41a86ec --- /dev/null +++ b/doc/doc_files/minimizewindow.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..710d9f4 --- /dev/null +++ b/doc/doc_files/mousebutton.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e9aba58 --- /dev/null +++ b/doc/doc_files/mouseisvisible.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..5a32f16 --- /dev/null +++ b/doc/doc_files/mousewheelx.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a89fc0a --- /dev/null +++ b/doc/doc_files/mousewheely.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d7959f0 --- /dev/null +++ b/doc/doc_files/mousex.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..27d9ec4 --- /dev/null +++ b/doc/doc_files/mousey.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2f8d149 --- /dev/null +++ b/doc/doc_files/movefile.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..1c19c3f --- /dev/null +++ b/doc/doc_files/multiplymatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5729b0d --- /dev/null +++ b/doc/doc_files/musicexists.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fcf1947 --- /dev/null +++ b/doc/doc_files/musicisplaying.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f8c4234 --- /dev/null +++ b/doc/doc_files/nav_bottom.html @@ -0,0 +1,2153 @@ + + + +
+ + + + ++ 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..3fe4fe6 --- /dev/null +++ b/doc/doc_files/numactoranimationloops.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..63d0f3b --- /dev/null +++ b/doc/doc_files/numberarraycopy.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..95a07b6 --- /dev/null +++ b/doc/doc_files/numberarraydim.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..2bc1241 --- /dev/null +++ b/doc/doc_files/numberarrayfill.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..267cabe --- /dev/null +++ b/doc/doc_files/numberarraysize.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..56c1179 --- /dev/null +++ b/doc/doc_files/numcommands.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ff7e3a6 --- /dev/null +++ b/doc/doc_files/numcpus.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7587a3a --- /dev/null +++ b/doc/doc_files/numfingers.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..66dea1c --- /dev/null +++ b/doc/doc_files/numgyros.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5243fff --- /dev/null +++ b/doc/doc_files/numjoyaxes.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..fb9fee9 --- /dev/null +++ b/doc/doc_files/numjoybuttons.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b5a8261 --- /dev/null +++ b/doc/doc_files/numjoyhats.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1f00182 --- /dev/null +++ b/doc/doc_files/numjoysticks.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5463c1d --- /dev/null +++ b/doc/doc_files/numjoytrackballs.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cd2b6b5 --- /dev/null +++ b/doc/doc_files/numsoundchannels.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d8becf9 --- /dev/null +++ b/doc/doc_files/numspriteanimationloops.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..be9871d --- /dev/null +++ b/doc/doc_files/opencanvas.html @@ -0,0 +1,103 @@ + + +
+ + ++ 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..1c9b150 --- /dev/null +++ b/doc/doc_files/opencanvas3d.html @@ -0,0 +1,98 @@ + + +
+ + ++ 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..988c026 --- /dev/null +++ b/doc/doc_files/opencanvasspritelayer.html @@ -0,0 +1,95 @@ + + +
+ + ++ 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..6ef1986 --- /dev/null +++ b/doc/doc_files/openfile.html @@ -0,0 +1,134 @@ + + +
+ + ++ 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..c308376 --- /dev/null +++ b/doc/doc_files/openspritecanvas.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..611018c --- /dev/null +++ b/doc/doc_files/openurl.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2fc741e --- /dev/null +++ b/doc/doc_files/openwindow.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..acc6447 --- /dev/null +++ b/doc/doc_files/openwindowex.html @@ -0,0 +1,109 @@ + + +
+ + ++ 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..dedc5f4 --- /dev/null +++ b/doc/doc_files/operators.html @@ -0,0 +1,203 @@ + +
+ + + +| 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..146026d --- /dev/null +++ b/doc/doc_files/os.html @@ -0,0 +1,111 @@ + + +
+ + ++ 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..df09ab1 --- /dev/null +++ b/doc/doc_files/particleisusingeverymeshvertex.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a30cc46 --- /dev/null +++ b/doc/doc_files/particleisusingnormaldirection.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..8f4c9f8 --- /dev/null +++ b/doc/doc_files/particleisusingoutlineonly.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..519e190 --- /dev/null +++ b/doc/doc_files/pausemusic.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..7ab5bf7 --- /dev/null +++ b/doc/doc_files/pausesound.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bfb29db --- /dev/null +++ b/doc/doc_files/pausevideo.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..34f30b8 --- /dev/null +++ b/doc/doc_files/playmusic.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..73ed088 --- /dev/null +++ b/doc/doc_files/playsound.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d859a44 --- /dev/null +++ b/doc/doc_files/playsoundtimed.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..23146d9 --- /dev/null +++ b/doc/doc_files/playvideo.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..786eb3b --- /dev/null +++ b/doc/doc_files/pointinquad.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..888fe77 --- /dev/null +++ b/doc/doc_files/pointintri.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..019ca64 --- /dev/null +++ b/doc/doc_files/poly.html @@ -0,0 +1,101 @@ + + +
+ + ++ 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..1d3d9bb --- /dev/null +++ b/doc/doc_files/pop_n.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..62c0627 --- /dev/null +++ b/doc/doc_files/pop_s.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..eeb7836 --- /dev/null +++ b/doc/doc_files/prefpath.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ecf729f --- /dev/null +++ b/doc/doc_files/preupdate.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..13939a5 --- /dev/null +++ b/doc/doc_files/pset.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2d418c1 --- /dev/null +++ b/doc/doc_files/push_n.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3e39c23 --- /dev/null +++ b/doc/doc_files/push_s.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..c1b1950 --- /dev/null +++ b/doc/doc_files/queryaudiospec.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ca91a86 --- /dev/null +++ b/doc/doc_files/radians.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..09ca747 --- /dev/null +++ b/doc/doc_files/raisewindow.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..43a83ce --- /dev/null +++ b/doc/doc_files/rand.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c0d9bee --- /dev/null +++ b/doc/doc_files/randomize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7e02546 --- /dev/null +++ b/doc/doc_files/randomizematrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ Stores random values between vmin and vmax in the matrix mA +
++ + + \ No newline at end of file diff --git a/doc/doc_files/readbyte.html b/doc/doc_files/readbyte.html new file mode 100644 index 0000000..77ccf6b --- /dev/null +++ b/doc/doc_files/readbyte.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..52bc28d --- /dev/null +++ b/doc/doc_files/readbytebuffer.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..bff6106 --- /dev/null +++ b/doc/doc_files/readinput_settext.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..72566e3 --- /dev/null +++ b/doc/doc_files/readinput_start.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cb44ebc --- /dev/null +++ b/doc/doc_files/readinput_stop.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..42d8e82 --- /dev/null +++ b/doc/doc_files/readinput_text.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bbc97a0 --- /dev/null +++ b/doc/doc_files/readinput_togglebackspace.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b5240cd --- /dev/null +++ b/doc/doc_files/readline.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..420290e --- /dev/null +++ b/doc/doc_files/rect.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..859cac2 --- /dev/null +++ b/doc/doc_files/rectfill.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..08d9e68 --- /dev/null +++ b/doc/doc_files/removeactorshadow.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..212b451 --- /dev/null +++ b/doc/doc_files/removedir.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..161d5b9 --- /dev/null +++ b/doc/doc_files/removefile.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..29306ad --- /dev/null +++ b/doc/doc_files/removescenesky.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..d9d7d34 --- /dev/null +++ b/doc/doc_files/renamefile.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f2fd5d9 --- /dev/null +++ b/doc/doc_files/replace.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..58cc7ac --- /dev/null +++ b/doc/doc_files/replacesubstr.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..09c938a --- /dev/null +++ b/doc/doc_files/restorewindow.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d9c7253 --- /dev/null +++ b/doc/doc_files/resumemusic.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..463bf70 --- /dev/null +++ b/doc/doc_files/resumesound.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..6db6bd5 --- /dev/null +++ b/doc/doc_files/resumevideo.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..72c4818 --- /dev/null +++ b/doc/doc_files/reverse.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..3c71ebb --- /dev/null +++ b/doc/doc_files/rewindmusic.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5ebccf8 --- /dev/null +++ b/doc/doc_files/rgb.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..916c558 --- /dev/null +++ b/doc/doc_files/rgba.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..70e1314 --- /dev/null +++ b/doc/doc_files/right.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..db9a1a1 --- /dev/null +++ b/doc/doc_files/rotateactor.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..dc0c88e --- /dev/null +++ b/doc/doc_files/rotatecamera.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..e82ef5c --- /dev/null +++ b/doc/doc_files/rotatesprite.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..6ab3be7 --- /dev/null +++ b/doc/doc_files/round.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..86778df --- /dev/null +++ b/doc/doc_files/rtrim.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..694d1aa --- /dev/null +++ b/doc/doc_files/runtime.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0b861b0 --- /dev/null +++ b/doc/doc_files/runtime_utility_message.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..eeabe7c --- /dev/null +++ b/doc/doc_files/scalarmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fd044db --- /dev/null +++ b/doc/doc_files/scalarmatrixcolumns.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e26288d --- /dev/null +++ b/doc/doc_files/scalarmatrixrows.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..15f9bbf --- /dev/null +++ b/doc/doc_files/scaleactor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..63172a0 --- /dev/null +++ b/doc/doc_files/scalesprite.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..a88da7a --- /dev/null +++ b/doc/doc_files/scaleterraintexture.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..059fe62 --- /dev/null +++ b/doc/doc_files/scope.html @@ -0,0 +1,98 @@ + + +
+ + ++ 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..e24e1d2 --- /dev/null +++ b/doc/doc_files/seek.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..7092fce --- /dev/null +++ b/doc/doc_files/setactorangularfactor.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..09cf557 --- /dev/null +++ b/doc/doc_files/setactorangularvelocitylocal.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..3ec44d5 --- /dev/null +++ b/doc/doc_files/setactorangularvelocityworld.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..732c6e2 --- /dev/null +++ b/doc/doc_files/setactoranimation.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..5fdf1b7 --- /dev/null +++ b/doc/doc_files/setactoranimationframes.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..65cd549 --- /dev/null +++ b/doc/doc_files/setactoranimationspeed.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..ffe6002 --- /dev/null +++ b/doc/doc_files/setactorautoculling.html @@ -0,0 +1,108 @@ + + +
+ + ++ 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..5e12dfa --- /dev/null +++ b/doc/doc_files/setactorcollisionshape.html @@ -0,0 +1,117 @@ + + +
+ + ++ 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..7cc9eef --- /dev/null +++ b/doc/doc_files/setactordamping.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..55985d4 --- /dev/null +++ b/doc/doc_files/setactorframe.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..e262851 --- /dev/null +++ b/doc/doc_files/setactorgravity.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..8e216fb --- /dev/null +++ b/doc/doc_files/setactorinverseinertiadiaglocal.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..54eba77 --- /dev/null +++ b/doc/doc_files/setactorlinearfactor.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..e4bc08d --- /dev/null +++ b/doc/doc_files/setactorlinearvelocitylocal.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..1d203ae --- /dev/null +++ b/doc/doc_files/setactorlinearvelocityworld.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..ab18e9b --- /dev/null +++ b/doc/doc_files/setactormassproperties.html @@ -0,0 +1,108 @@ + + +
+ + ++ 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..3fb15b5 --- /dev/null +++ b/doc/doc_files/setactormaterial.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..81c39e2 --- /dev/null +++ b/doc/doc_files/setactormaterialflag.html @@ -0,0 +1,157 @@ + + +
+ + ++ 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..ecdcf23 --- /dev/null +++ b/doc/doc_files/setactormaterialtype.html @@ -0,0 +1,172 @@ + + +
+ + ++ 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..25ce4e2 --- /dev/null +++ b/doc/doc_files/setactormd2animation.html @@ -0,0 +1,156 @@ + + +
+ + ++ 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..06df5c8 --- /dev/null +++ b/doc/doc_files/setactormd2animationbyname.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..eadbec7 --- /dev/null +++ b/doc/doc_files/setactorposition.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..bb11f21 --- /dev/null +++ b/doc/doc_files/setactorrotation.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..5d86ee2 --- /dev/null +++ b/doc/doc_files/setactorscale.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..c311543 --- /dev/null +++ b/doc/doc_files/setactorsleepstate.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..a6e0a19 --- /dev/null +++ b/doc/doc_files/setactorsleepthresholds.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..b5eae40 --- /dev/null +++ b/doc/doc_files/setactorsolid.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..fbf559b --- /dev/null +++ b/doc/doc_files/setactortexture.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..7ca58be --- /dev/null +++ b/doc/doc_files/setactorvisible.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..5ea9371 --- /dev/null +++ b/doc/doc_files/setbilinearfilter.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b522183 --- /dev/null +++ b/doc/doc_files/setblendmode.html @@ -0,0 +1,126 @@ + + +
+ + ++ 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..8cf06f7 --- /dev/null +++ b/doc/doc_files/setcameraaspectratio.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..551f6eb --- /dev/null +++ b/doc/doc_files/setcamerafarvalue.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..632c375 --- /dev/null +++ b/doc/doc_files/setcamerafov.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f877008 --- /dev/null +++ b/doc/doc_files/setcameranearvalue.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..03baece --- /dev/null +++ b/doc/doc_files/setcameraposition.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..240b27c --- /dev/null +++ b/doc/doc_files/setcameraprojectionmatrix.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..71b7c3f --- /dev/null +++ b/doc/doc_files/setcamerarotation.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..f3675ba --- /dev/null +++ b/doc/doc_files/setcanvas3d.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..3400c4d --- /dev/null +++ b/doc/doc_files/setcanvasalpha.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0d3cd95 --- /dev/null +++ b/doc/doc_files/setcanvascolormod.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0d60a7a --- /dev/null +++ b/doc/doc_files/setcanvasoffset.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..6d4bb6e --- /dev/null +++ b/doc/doc_files/setcanvasphysics2d.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..dbde163 --- /dev/null +++ b/doc/doc_files/setcanvasviewport.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..beff6cc --- /dev/null +++ b/doc/doc_files/setcanvasvisible.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..e2c1e37 --- /dev/null +++ b/doc/doc_files/setcanvasz.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..8139277 --- /dev/null +++ b/doc/doc_files/setchanneldistance.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..6f2c79b --- /dev/null +++ b/doc/doc_files/setchannelpanning.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..569fd1a --- /dev/null +++ b/doc/doc_files/setchannelspaceposition.html @@ -0,0 +1,92 @@ + + +
+ + ++ 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..0556ee5 --- /dev/null +++ b/doc/doc_files/setchannelvolume.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..68bc8e0 --- /dev/null +++ b/doc/doc_files/setclearcolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..bac808f --- /dev/null +++ b/doc/doc_files/setclipboardtext.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9309f2c --- /dev/null +++ b/doc/doc_files/setcolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a89c560 --- /dev/null +++ b/doc/doc_files/setconedamping.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8131b62 --- /dev/null +++ b/doc/doc_files/setconefixthresh.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7a83983 --- /dev/null +++ b/doc/doc_files/setconelimit.html @@ -0,0 +1,97 @@ + + +
+ + ++ 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..e1f4348 --- /dev/null +++ b/doc/doc_files/setconstraintangularonly.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..bc96755 --- /dev/null +++ b/doc/doc_files/setconstraintbreakingimpulsethreshold.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3ce6e38 --- /dev/null +++ b/doc/doc_files/setconstraintframes.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..931a2f1 --- /dev/null +++ b/doc/doc_files/setconstraintsolveriterations.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d84c3c4 --- /dev/null +++ b/doc/doc_files/setenv.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d14ed23 --- /dev/null +++ b/doc/doc_files/setfont.html @@ -0,0 +1,88 @@ + + +
+ + ++ Sets the active font for text rendering +
+Related: + DrawText +
++ + + \ 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..22cd8e8 --- /dev/null +++ b/doc/doc_files/setgravity3d.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b63d5f7 --- /dev/null +++ b/doc/doc_files/sethingeaxis.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9882c97 --- /dev/null +++ b/doc/doc_files/sethingelimit.html @@ -0,0 +1,111 @@ + + +
+ + ++ 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..751577d --- /dev/null +++ b/doc/doc_files/setidentitymatrix.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d1d5898 --- /dev/null +++ b/doc/doc_files/setimagealpha.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..260c4f4 --- /dev/null +++ b/doc/doc_files/setimagecolormod.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..450c971 --- /dev/null +++ b/doc/doc_files/setlightambientcolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4a12967 --- /dev/null +++ b/doc/doc_files/setlightattenuation.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f4312b7 --- /dev/null +++ b/doc/doc_files/setlightdiffusecolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fd23eca --- /dev/null +++ b/doc/doc_files/setlightfalloff.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..dbd7ab9 --- /dev/null +++ b/doc/doc_files/setlightinnercone.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..86cff6b --- /dev/null +++ b/doc/doc_files/setlightoutercone.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4a94aa2 --- /dev/null +++ b/doc/doc_files/setlightradius.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3f2a735 --- /dev/null +++ b/doc/doc_files/setlightshadowcast.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2a87a84 --- /dev/null +++ b/doc/doc_files/setlightspecularcolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..949c33d --- /dev/null +++ b/doc/doc_files/setlighttype.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..766b959 --- /dev/null +++ b/doc/doc_files/setmaterialambientcolor.html @@ -0,0 +1,85 @@ + + + + + ++ 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..1585ad8 --- /dev/null +++ b/doc/doc_files/setmaterialantialiasing.html @@ -0,0 +1,114 @@ + + +
+ + ++ 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..cc90768 --- /dev/null +++ b/doc/doc_files/setmaterialbackfaceculling.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f1cc495 --- /dev/null +++ b/doc/doc_files/setmaterialblendfactor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..54c98e5 --- /dev/null +++ b/doc/doc_files/setmaterialblendmode.html @@ -0,0 +1,123 @@ + + +
+ + ++ 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..32a8156 --- /dev/null +++ b/doc/doc_files/setmaterialcolormask.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..e30adbb --- /dev/null +++ b/doc/doc_files/setmaterialcolormode.html @@ -0,0 +1,111 @@ + + +
+ + ++ 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..6d2cc6d --- /dev/null +++ b/doc/doc_files/setmaterialdiffusecolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..de2eeea --- /dev/null +++ b/doc/doc_files/setmaterialemissivecolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..635a8b9 --- /dev/null +++ b/doc/doc_files/setmaterialflag.html @@ -0,0 +1,154 @@ + + +
+ + ++ 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..5da1d82 --- /dev/null +++ b/doc/doc_files/setmaterialfog.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..546476e --- /dev/null +++ b/doc/doc_files/setmaterialfrontfaceculling.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..79055c7 --- /dev/null +++ b/doc/doc_files/setmaterialgouraudshading.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..85cf3d4 --- /dev/null +++ b/doc/doc_files/setmateriallighting.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8e8a254 --- /dev/null +++ b/doc/doc_files/setmaterialnormalize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0013d57 --- /dev/null +++ b/doc/doc_files/setmaterialpointcloud.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..46a712d --- /dev/null +++ b/doc/doc_files/setmaterialshininess.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9b15bd3 --- /dev/null +++ b/doc/doc_files/setmaterialspecularcolor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..39da6d7 --- /dev/null +++ b/doc/doc_files/setmaterialtexture.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9094568 --- /dev/null +++ b/doc/doc_files/setmaterialtexturecanvas.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4fb4e6b --- /dev/null +++ b/doc/doc_files/setmaterialthickness.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2b94412 --- /dev/null +++ b/doc/doc_files/setmaterialtype.html @@ -0,0 +1,168 @@ + + +
+ + ++ 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..67167e2 --- /dev/null +++ b/doc/doc_files/setmaterialwireframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c079207 --- /dev/null +++ b/doc/doc_files/setmatrixrotation.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f039934 --- /dev/null +++ b/doc/doc_files/setmatrixscale.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5849547 --- /dev/null +++ b/doc/doc_files/setmatrixtranslation.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d4c6c4a --- /dev/null +++ b/doc/doc_files/setmatrixvalue.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4f65ea8 --- /dev/null +++ b/doc/doc_files/setmaxparticlespersecond.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..2c930d4 --- /dev/null +++ b/doc/doc_files/setminparticlespersecond.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..6369a34 --- /dev/null +++ b/doc/doc_files/setmouserelative.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bcefa5d --- /dev/null +++ b/doc/doc_files/setmousezone.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d3d5516 --- /dev/null +++ b/doc/doc_files/setmusicposition.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ef19d40 --- /dev/null +++ b/doc/doc_files/setmusicvolume.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4bb8c8b --- /dev/null +++ b/doc/doc_files/setparticlebox.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bc5c6a2 --- /dev/null +++ b/doc/doc_files/setparticlecenter.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..58ddabd --- /dev/null +++ b/doc/doc_files/setparticledirection.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..c18ff25 --- /dev/null +++ b/doc/doc_files/setparticlelength.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..329f36e --- /dev/null +++ b/doc/doc_files/setparticlemaxangle.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..0983532 --- /dev/null +++ b/doc/doc_files/setparticlemaxlife.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..57b4c14 --- /dev/null +++ b/doc/doc_files/setparticlemaxstartcolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d34aff1 --- /dev/null +++ b/doc/doc_files/setparticlemaxstartsize.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..0a0b35c --- /dev/null +++ b/doc/doc_files/setparticlemesh.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..20a673c --- /dev/null +++ b/doc/doc_files/setparticleminlife.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..0644ac9 --- /dev/null +++ b/doc/doc_files/setparticleminstartcolor.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a4ea28b --- /dev/null +++ b/doc/doc_files/setparticleminstartsize.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..1bd8468 --- /dev/null +++ b/doc/doc_files/setparticlenormal.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..1b5c193 --- /dev/null +++ b/doc/doc_files/setparticlenormaldirectionmod.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..d40868e --- /dev/null +++ b/doc/doc_files/setparticleradius.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..9384f1c --- /dev/null +++ b/doc/doc_files/setparticleringthickness.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..3fc7cb7 --- /dev/null +++ b/doc/doc_files/setpointpivota.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..5a09453 --- /dev/null +++ b/doc/doc_files/setpointpivotb.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..35bdfa9 --- /dev/null +++ b/doc/doc_files/setprojectionmatrix.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..3a9b7fa --- /dev/null +++ b/doc/doc_files/setslidedampingdirang.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0baea00 --- /dev/null +++ b/doc/doc_files/setslidedampingdirlin.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9c4b048 --- /dev/null +++ b/doc/doc_files/setslidedampinglimang.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9c8089e --- /dev/null +++ b/doc/doc_files/setslidedampinglimlin.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..b922406 --- /dev/null +++ b/doc/doc_files/setslidedampingorthoang.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..1c03050 --- /dev/null +++ b/doc/doc_files/setslidedampingortholin.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a10ad2e --- /dev/null +++ b/doc/doc_files/setslideloweranglimit.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..8d0d748 --- /dev/null +++ b/doc/doc_files/setslidelowerlinlimit.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..bfc2cd2 --- /dev/null +++ b/doc/doc_files/setsliderestitutiondirang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..40c2f69 --- /dev/null +++ b/doc/doc_files/setsliderestitutiondirlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..ad362ba --- /dev/null +++ b/doc/doc_files/setsliderestitutionlimang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..40d0cd1 --- /dev/null +++ b/doc/doc_files/setsliderestitutionlimlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..071f517 --- /dev/null +++ b/doc/doc_files/setsliderestitutionorthoang.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..c5c9ac7 --- /dev/null +++ b/doc/doc_files/setsliderestitutionortholin.html @@ -0,0 +1,94 @@ + + +
+ + ++ 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..b6d74da --- /dev/null +++ b/doc/doc_files/setslidesoftnessdirang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..2196ca6 --- /dev/null +++ b/doc/doc_files/setslidesoftnessdirlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..b8a1f7f --- /dev/null +++ b/doc/doc_files/setslidesoftnesslimang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..3541365 --- /dev/null +++ b/doc/doc_files/setslidesoftnesslimlin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..2b7dadd --- /dev/null +++ b/doc/doc_files/setslidesoftnessorthoang.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..6eaaaad --- /dev/null +++ b/doc/doc_files/setslidesoftnessortholin.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..4a3d2ab --- /dev/null +++ b/doc/doc_files/setslideupperanglimit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..894e62a --- /dev/null +++ b/doc/doc_files/setslideupperlinlimit.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..53e991d --- /dev/null +++ b/doc/doc_files/setsoundchannels.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1f1af8f --- /dev/null +++ b/doc/doc_files/setsoundvolume.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7f7fd9a --- /dev/null +++ b/doc/doc_files/setspriteanimation.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..c6bc981 --- /dev/null +++ b/doc/doc_files/setspriteanimationframe.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..bd43200 --- /dev/null +++ b/doc/doc_files/setspriteanimationlength.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..c25c0d8 --- /dev/null +++ b/doc/doc_files/setspriteanimationloops.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2e39855 --- /dev/null +++ b/doc/doc_files/setspriteanimationspeed.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..aa39045 --- /dev/null +++ b/doc/doc_files/setspriteframe.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c6651f6 --- /dev/null +++ b/doc/doc_files/setspriteposition.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..73d5d7a --- /dev/null +++ b/doc/doc_files/setspriterotation.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..c7c6ef5 --- /dev/null +++ b/doc/doc_files/setspritescale.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..97daab7 --- /dev/null +++ b/doc/doc_files/setspritesolid.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..9d86acd --- /dev/null +++ b/doc/doc_files/setspritesource.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..626ed70 --- /dev/null +++ b/doc/doc_files/setspritetype.html @@ -0,0 +1,99 @@ + + +
+ + ++ 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..1a8b82b --- /dev/null +++ b/doc/doc_files/setspritevisible.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2f55f11 --- /dev/null +++ b/doc/doc_files/setspritez.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..6d599b7 --- /dev/null +++ b/doc/doc_files/setterraincameramovementdelta.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2e216ab --- /dev/null +++ b/doc/doc_files/setterraincamerarotationdelta.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..45f9244 --- /dev/null +++ b/doc/doc_files/setterrainloddistance.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f7de770 --- /dev/null +++ b/doc/doc_files/setterrainpatchlod.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..aee4217 --- /dev/null +++ b/doc/doc_files/settile.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..458b4c8 --- /dev/null +++ b/doc/doc_files/settileanimationframe.html @@ -0,0 +1,102 @@ + + +
+ + ++ 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..a2a34c2 --- /dev/null +++ b/doc/doc_files/settileanimationlength.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..b41e583 --- /dev/null +++ b/doc/doc_files/settileanimationspeed.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d022540 --- /dev/null +++ b/doc/doc_files/settilemapsize.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..7a5cdd8 --- /dev/null +++ b/doc/doc_files/setup.html @@ -0,0 +1,131 @@ + + +
+ + ++
+ 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..98cebcf --- /dev/null +++ b/doc/doc_files/setvideodrawrect.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..a82cb8b --- /dev/null +++ b/doc/doc_files/setvideoposition.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..fd01c7a --- /dev/null +++ b/doc/doc_files/setvideovolume.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2f7b668 --- /dev/null +++ b/doc/doc_files/setwatercolor.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..462dfbb --- /dev/null +++ b/doc/doc_files/setwatercolorblendfactor.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..68c0fb2 --- /dev/null +++ b/doc/doc_files/setwaterwaveheight.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..bdb6da9 --- /dev/null +++ b/doc/doc_files/setwaterwinddirection.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..7809329 --- /dev/null +++ b/doc/doc_files/setwaterwindforce.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..24acc07 --- /dev/null +++ b/doc/doc_files/setwindowalwaysontop.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7f5712b --- /dev/null +++ b/doc/doc_files/setwindowautoclose.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..974bd75 --- /dev/null +++ b/doc/doc_files/setwindowbordered.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f125139 --- /dev/null +++ b/doc/doc_files/setwindowfullscreen.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..34cd2de --- /dev/null +++ b/doc/doc_files/setwindowicon.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cd2a323 --- /dev/null +++ b/doc/doc_files/setwindowmaxsize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b58b5c6 --- /dev/null +++ b/doc/doc_files/setwindowminsize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..43ac377 --- /dev/null +++ b/doc/doc_files/setwindowposition.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..875165b --- /dev/null +++ b/doc/doc_files/setwindowresizable.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..aa7c7a0 --- /dev/null +++ b/doc/doc_files/setwindowsize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2a3b26d --- /dev/null +++ b/doc/doc_files/setwindowtitle.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..0799490 --- /dev/null +++ b/doc/doc_files/setwindowvsync.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..2cc7933 --- /dev/null +++ b/doc/doc_files/setworld3ddeltatime.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..0991841 --- /dev/null +++ b/doc/doc_files/setworld3dmaxsubsteps.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..e7a6393 --- /dev/null +++ b/doc/doc_files/setworld3dtimestep.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..e448b39 --- /dev/null +++ b/doc/doc_files/showmouse.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d7f2182 --- /dev/null +++ b/doc/doc_files/showwindow.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c06fd43 --- /dev/null +++ b/doc/doc_files/sign.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..d031605 --- /dev/null +++ b/doc/doc_files/sin.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..6c63792 --- /dev/null +++ b/doc/doc_files/size.html @@ -0,0 +1,92 @@ + + +
+ + ++ 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..854f22f --- /dev/null +++ b/doc/doc_files/solvematrix.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..f45ea76 --- /dev/null +++ b/doc/doc_files/sound.html @@ -0,0 +1,105 @@ + + +
+ + ++ 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..3180e1c --- /dev/null +++ b/doc/doc_files/soundexists.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ff4b8c8 --- /dev/null +++ b/doc/doc_files/soundisenabled.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..bb642fa --- /dev/null +++ b/doc/doc_files/spriteanimationisplaying.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..8e13e36 --- /dev/null +++ b/doc/doc_files/spriteheight.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..d6a59d3 --- /dev/null +++ b/doc/doc_files/spriteissolid.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..8a60bb8 --- /dev/null +++ b/doc/doc_files/spriteisvisible.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..38fe752 --- /dev/null +++ b/doc/doc_files/spritewidth.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..81e1fd6 --- /dev/null +++ b/doc/doc_files/spritex.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..a305c55 --- /dev/null +++ b/doc/doc_files/spritey.html @@ -0,0 +1,90 @@ + + +
+ + ++ 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..89fc9bc --- /dev/null +++ b/doc/doc_files/spritez.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7cae23f --- /dev/null +++ b/doc/doc_files/sqrt.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d69e9e7 --- /dev/null +++ b/doc/doc_files/squarematrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9b2f5d6 --- /dev/null +++ b/doc/doc_files/stack_size_n.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2b84710 --- /dev/null +++ b/doc/doc_files/stack_size_s.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1956e46 --- /dev/null +++ b/doc/doc_files/startactortransition.html @@ -0,0 +1,97 @@ + + +
+ + ++ 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..f912fc0 --- /dev/null +++ b/doc/doc_files/startparticleemitter.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..2c25701 --- /dev/null +++ b/doc/doc_files/stopactortransition.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..98b8896 --- /dev/null +++ b/doc/doc_files/stopmusic.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..4f51952 --- /dev/null +++ b/doc/doc_files/stopparticleemitter.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..bb8c098 --- /dev/null +++ b/doc/doc_files/stopsound.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..adf2051 --- /dev/null +++ b/doc/doc_files/stopvideo.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..171ba9e --- /dev/null +++ b/doc/doc_files/str.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..dd8e440 --- /dev/null +++ b/doc/doc_files/str_f.html @@ -0,0 +1,92 @@ + + +
+ + ++ 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..02ed66a --- /dev/null +++ b/doc/doc_files/str_s.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..8141492 --- /dev/null +++ b/doc/doc_files/stringarraycopy.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..7272d1d --- /dev/null +++ b/doc/doc_files/stringarraydim.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..45c4d3a --- /dev/null +++ b/doc/doc_files/stringarrayfill.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..e79a480 --- /dev/null +++ b/doc/doc_files/stringarraysize.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..a7f2a56 --- /dev/null +++ b/doc/doc_files/stringfill.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c5bd384 --- /dev/null +++ b/doc/doc_files/stringfrombuffer.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b7a6eac --- /dev/null +++ b/doc/doc_files/subtractmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1b5a479 --- /dev/null +++ b/doc/doc_files/swapmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b8388f6 --- /dev/null +++ b/doc/doc_files/swapmatrixcolumn.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8b2430d --- /dev/null +++ b/doc/doc_files/swapmatrixrow.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..522b419 --- /dev/null +++ b/doc/doc_files/system.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..918d39c --- /dev/null +++ b/doc/doc_files/systemram.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..1322180 --- /dev/null +++ b/doc/doc_files/systemreturnstdout.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..1fa1168 --- /dev/null +++ b/doc/doc_files/tally.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ec5f49b --- /dev/null +++ b/doc/doc_files/tan.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9b34cba --- /dev/null +++ b/doc/doc_files/tcp_acceptsocket.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..08b6057 --- /dev/null +++ b/doc/doc_files/tcp_closesocket.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fb25aad --- /dev/null +++ b/doc/doc_files/tcp_getdata.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..7167b7e --- /dev/null +++ b/doc/doc_files/tcp_opensocket.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..cb44c8d --- /dev/null +++ b/doc/doc_files/tcp_remotehost.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b5588cb --- /dev/null +++ b/doc/doc_files/tcp_remoteport.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..343e4b9 --- /dev/null +++ b/doc/doc_files/tcp_senddata.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5c0857c --- /dev/null +++ b/doc/doc_files/tcp_socketready.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4551ccb --- /dev/null +++ b/doc/doc_files/tell.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b07367f --- /dev/null +++ b/doc/doc_files/textheight.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..9a6a349 --- /dev/null +++ b/doc/doc_files/textwidth.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..5ad4548 --- /dev/null +++ b/doc/doc_files/ticks.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4c28ae2 --- /dev/null +++ b/doc/doc_files/time.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2301b07 --- /dev/null +++ b/doc/doc_files/timer.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ebf7c45 --- /dev/null +++ b/doc/doc_files/touchpressure.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c34124c --- /dev/null +++ b/doc/doc_files/translateactor.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..d983327 --- /dev/null +++ b/doc/doc_files/translateactorlocal.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f79f08e --- /dev/null +++ b/doc/doc_files/translateactorworld.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f723832 --- /dev/null +++ b/doc/doc_files/translatecamera.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..a4e87ed --- /dev/null +++ b/doc/doc_files/translatesprite.html @@ -0,0 +1,92 @@ + + +
+ + ++ 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..3460ac6 --- /dev/null +++ b/doc/doc_files/transposematrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b122fd2 --- /dev/null +++ b/doc/doc_files/trim.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..38c7b9c --- /dev/null +++ b/doc/doc_files/tst.html @@ -0,0 +1,82 @@ + + +
+ + ++ + + \ 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..63b6e8d --- /dev/null +++ b/doc/doc_files/typearraycopy.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..ba8cbf6 --- /dev/null +++ b/doc/doc_files/typearraydim.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..669c1b0 --- /dev/null +++ b/doc/doc_files/typearrayfill.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..c5de63c --- /dev/null +++ b/doc/doc_files/typearraysize.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..ddfde07 --- /dev/null +++ b/doc/doc_files/ucase.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d757658 --- /dev/null +++ b/doc/doc_files/udp_closesocket.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c25a0a3 --- /dev/null +++ b/doc/doc_files/udp_getdata.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..d727ce5 --- /dev/null +++ b/doc/doc_files/udp_length.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..dd1e304 --- /dev/null +++ b/doc/doc_files/udp_maxlength.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..fc48521 --- /dev/null +++ b/doc/doc_files/udp_opensocket.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..655595b --- /dev/null +++ b/doc/doc_files/udp_remotehost.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..99ad5a3 --- /dev/null +++ b/doc/doc_files/udp_remoteport.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b5f064f --- /dev/null +++ b/doc/doc_files/udp_senddata.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..5495e75 --- /dev/null +++ b/doc/doc_files/udp_socketready.html @@ -0,0 +1,93 @@ + + +
+ + ++ 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..bd19039 --- /dev/null +++ b/doc/doc_files/udt.html @@ -0,0 +1,141 @@ + + +
+ + ++ 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..7257d84 --- /dev/null +++ b/doc/doc_files/unaugmentmatrix.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ecdd590 --- /dev/null +++ b/doc/doc_files/update.html @@ -0,0 +1,105 @@ + + +
+ + ++ 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..c2a7757 --- /dev/null +++ b/doc/doc_files/updateactorinertiatensor.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..c5e6c7d --- /dev/null +++ b/doc/doc_files/useconstraintframeoffset.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..eaedabe --- /dev/null +++ b/doc/doc_files/usehingereferenceframea.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..db7e0df --- /dev/null +++ b/doc/doc_files/useparticleeverymeshvertex.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..8a1e167 --- /dev/null +++ b/doc/doc_files/useparticlenormaldirection.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..4365ed2 --- /dev/null +++ b/doc/doc_files/useparticleoutlineonly.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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..586690d --- /dev/null +++ b/doc/doc_files/val.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..208e4d9 --- /dev/null +++ b/doc/doc_files/var_data.html @@ -0,0 +1,127 @@ + + +
+ + ++ 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..ce7208c --- /dev/null +++ b/doc/doc_files/videoend.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..efbbfa0 --- /dev/null +++ b/doc/doc_files/videoexists.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..08d6200 --- /dev/null +++ b/doc/doc_files/videoisplaying.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b8e5101 --- /dev/null +++ b/doc/doc_files/wait.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..8024d2c --- /dev/null +++ b/doc/doc_files/waitkey.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..262bdb1 --- /dev/null +++ b/doc/doc_files/warpmouse.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..20d326a --- /dev/null +++ b/doc/doc_files/warpmouseglobal.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e733f60 --- /dev/null +++ b/doc/doc_files/windowclip.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..c3e464e --- /dev/null +++ b/doc/doc_files/windowevent_close.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..78741ad --- /dev/null +++ b/doc/doc_files/windowevent_maximize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f47f79e --- /dev/null +++ b/doc/doc_files/windowevent_minimize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..4a275c1 --- /dev/null +++ b/doc/doc_files/windowevent_resize.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..e8f8ee3 --- /dev/null +++ b/doc/doc_files/windowexists.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..6264a44 --- /dev/null +++ b/doc/doc_files/windowhasinputfocus.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..2470453 --- /dev/null +++ b/doc/doc_files/windowhasmousefocus.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..f1da443 --- /dev/null +++ b/doc/doc_files/windowisbordered.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b8dc373 --- /dev/null +++ b/doc/doc_files/windowisfullscreen.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..237203c --- /dev/null +++ b/doc/doc_files/windowisgrabbed.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..9b5c1d5 --- /dev/null +++ b/doc/doc_files/windowismaximized.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..b2ce0ce --- /dev/null +++ b/doc/doc_files/windowisminimized.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..ca3c295 --- /dev/null +++ b/doc/doc_files/windowisresizable.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..495c7db --- /dev/null +++ b/doc/doc_files/windowisvisible.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..30359d7 --- /dev/null +++ b/doc/doc_files/windowmode.html @@ -0,0 +1,107 @@ + + +
+ + ++ 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..77e81b2 --- /dev/null +++ b/doc/doc_files/windowtitle.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..579d13c --- /dev/null +++ b/doc/doc_files/write.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..ed57daa --- /dev/null +++ b/doc/doc_files/writebyte.html @@ -0,0 +1,88 @@ + + +
+ + ++ 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..3b6f8c3 --- /dev/null +++ b/doc/doc_files/writebytebuffer.html @@ -0,0 +1,85 @@ + + +
+ + ++ 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..41f3826 --- /dev/null +++ b/doc/doc_files/writeline.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..7180656 --- /dev/null +++ b/doc/doc_files/xorbit.html @@ -0,0 +1,89 @@ + + +
+ + ++ 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..7eb10a2 --- /dev/null +++ b/doc/doc_files/zeromatrix.html @@ -0,0 +1,91 @@ + + +
+ + ++ 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/conditions.txt b/doc/files/conditions.txt index 071cc7f..261e49a 100644 --- a/doc/files/conditions.txt +++ b/doc/files/conditions.txt @@ -2,7 +2,7 @@ #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 @@ -10,11 +10,12 @@ ElseIf 5 < 6 Then 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" @@ -25,8 +26,10 @@ Default ' 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" @@ -35,5 +38,6 @@ Case 4, 5 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.txt b/doc/files/constants.txt index e03751c..a658c22 100644 --- a/doc/files/constants.txt +++ b/doc/files/constants.txt @@ -1,5 +1,5 @@ #title RCBasic Constants [RCBasic Doc] -#header CONTANTS +#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 diff --git a/doc/files/license.txt b/doc/files/license.txt index 41f7588..bec8934 100644 --- a/doc/files/license.txt +++ b/doc/files/license.txt @@ -15,7 +15,9 @@ freely, subject to the following restrictions: 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/setup.txt b/doc/files/setup.txt index 54c2bff..f8fe786 100644 --- a/doc/files/setup.txt +++ b/doc/files/setup.txt @@ -1,12 +1,11 @@ #title RCBasic Setup [RCBasic Doc] - -