Returns true if an actors animation is set to looped.
- Note: Actor animation is set to looped with the loopActorAnimation() function. + Note: Actor animation is set to looped with the LoopActorAnimation() function.
Related: - loopActorAnimation + LoopActorAnimation
diff --git a/doc/files/actoranimationislooped.txt b/doc/files/actoranimationislooped.txt index b583e76..81c89ee 100644 --- a/doc/files/actoranimationislooped.txt +++ b/doc/files/actoranimationislooped.txt @@ -1,8 +1,8 @@ -#title actorAnimationIsLooped [RCBasic Doc] -#header function actorAnimationIsLooped( actor ) +#title ActorAnimationIsLooped [RCBasic Doc] +#header function ActorAnimationIsLooped( actor ) Returns true if an actors animation is set to looped. -Note: Actor animation is set to looped with the loopActorAnimation() function. +Note: Actor animation is set to looped with the LoopActorAnimation() function. -#ref loopActorAnimation +#ref LoopActorAnimation diff --git a/doc/files/actorexists.html b/doc/files/actorexists.html index 642ccd7..63778ab 100644 --- a/doc/files/actorexists.html +++ b/doc/files/actorexists.html @@ -9,6 +9,9 @@
+ Returns true if the id passed is a valid actor +
+\ No newline at end of file diff --git a/doc/files/actorexists.txt b/doc/files/actorexists.txt index bba61ed..2b585c8 100644 --- a/doc/files/actorexists.txt +++ b/doc/files/actorexists.txt @@ -1,4 +1,4 @@ #title ActorExists [RCBasic Doc] #header function ActorExists( actor ) - +Returns true if the id passed is a valid actor diff --git a/doc/files/applyactorimpulseworld.html b/doc/files/applyactorimpulseworld.html index 8d8b6c4..b2a8d08 100644 --- a/doc/files/applyactorimpulseworld.html +++ b/doc/files/applyactorimpulseworld.html @@ -3,11 +3,11 @@
-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.
diff --git a/doc/files/applyactorimpulseworld.txt b/doc/files/applyactorimpulseworld.txt index 8ab74b3..92d6da9 100644 --- a/doc/files/applyactorimpulseworld.txt +++ b/doc/files/applyactorimpulseworld.txt @@ -1,5 +1,5 @@ -#title applyActorImpulseWorld [RCBasic Doc] -#header sub applyActorImpulseWorld( actor, x, y, z, rel_x, rel_y, rel_z) +#title ApplyActorImpulseWorld [RCBasic Doc] +#header Sub ApplyActorImpulseWorld( actor, x, y, z, rel_x, rel_y, rel_z) Applies an impulse to an actor at a specific point. Unlike ApplyActorCentralImpulse(local/world), which applies impulse only at the center of mass (affecting linear velocity), this can generate both linear motion and rotation (torque), depending on where the force is applied relative to the center of mass. diff --git a/doc/files/applyactortorqueimpulselocal.html b/doc/files/applyactortorqueimpulselocal.html index c738226..9c4ef56 100644 --- a/doc/files/applyactortorqueimpulselocal.html +++ b/doc/files/applyactortorqueimpulselocal.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/applyactortorqueimpulselocal.txt b/doc/files/applyactortorqueimpulselocal.txt index 819c097..9ed03df 100644 --- a/doc/files/applyactortorqueimpulselocal.txt +++ b/doc/files/applyactortorqueimpulselocal.txt @@ -1,5 +1,5 @@ -#title applyActorTorqueImpulseLocal [RCBasic Doc] -#header sub applyActorTorqueImpulseLocal( actor, x, y, z) +#title ApplyActorTorqueImpulseLocal [RCBasic Doc] +#header Sub ApplyActorTorqueImpulseLocal( actor, x, y, z) Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. diff --git a/doc/files/applyactortorqueimpulseworld.html b/doc/files/applyactortorqueimpulseworld.html index ffc8248..ff2c529 100644 --- a/doc/files/applyactortorqueimpulseworld.html +++ b/doc/files/applyactortorqueimpulseworld.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/applyactortorqueimpulseworld.txt b/doc/files/applyactortorqueimpulseworld.txt index d6d4ede..e8126f5 100644 --- a/doc/files/applyactortorqueimpulseworld.txt +++ b/doc/files/applyactortorqueimpulseworld.txt @@ -1,5 +1,5 @@ -#title applyActorTorqueImpulseWorld [RCBasic Doc] -#header sub applyActorTorqueImpulseWorld( actor, x, y, z) +#title ApplyActorTorqueImpulseWorld [RCBasic Doc] +#header Sub ApplyActorTorqueImpulseWorld( actor, x, y, z) Applies an impulse that directly affects the angular velocity of an actor, causing it to rotate. This is similar to applying an impulse, but instead of changing the linear velocity (which applyActorCentralImpulse does), it alters the body's rotational motion (angular velocity) instantaneously. diff --git a/doc/files/applyactortorquelocal.html b/doc/files/applyactortorquelocal.html index 02b61a4..04a2a1d 100644 --- a/doc/files/applyactortorquelocal.html +++ b/doc/files/applyactortorquelocal.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/applyactortorquelocal.txt b/doc/files/applyactortorquelocal.txt index c931a18..4e3a0ee 100644 --- a/doc/files/applyactortorquelocal.txt +++ b/doc/files/applyactortorquelocal.txt @@ -1,5 +1,5 @@ -#title applyActorTorqueLocal [RCBasic Doc] -#header sub applyActorTorqueLocal( actor, x, y, z) +#title ApplyActorTorqueLocal [RCBasic Doc] +#header Sub ApplyActorTorqueLocal( actor, x, y, z) Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. diff --git a/doc/files/applyactortorqueworld.html b/doc/files/applyactortorqueworld.html index d2265c8..70fc39e 100644 --- a/doc/files/applyactortorqueworld.html +++ b/doc/files/applyactortorqueworld.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/applyactortorqueworld.txt b/doc/files/applyactortorqueworld.txt index 5dd6b8c..cde6ac9 100644 --- a/doc/files/applyactortorqueworld.txt +++ b/doc/files/applyactortorqueworld.txt @@ -1,5 +1,5 @@ -#title applyActorTorqueWorld [RCBasic Doc] -#header sub applyActorTorqueWorld( actor, x, y, z) +#title ApplyActorTorqueWorld [RCBasic Doc] +#header Sub ApplyActorTorqueWorld( actor, x, y, z) Applies a continuous torque to an actor, causing it to accelerate its rotational motion over time. Unlike applyActorTorqueImpulse, which causes an immediate change in angular velocity, this applies a torque force gradually, leading to a continuous rotational effect, similar to applying a force to linear motion. diff --git a/doc/files/arrayfill.html b/doc/files/arrayfill.html index c6c12c0..3a86c70 100644 --- a/doc/files/arrayfill.html +++ b/doc/files/arrayfill.html @@ -7,7 +7,7 @@ -Fills all the elements in an array with the value in fdata
diff --git a/doc/files/arrayfill.txt b/doc/files/arrayfill.txt index 254fd76..08ff811 100644 --- a/doc/files/arrayfill.txt +++ b/doc/files/arrayfill.txt @@ -1,5 +1,5 @@ #title ArrayFill [RCBasic Doc] -#header sub ArrayFill(ByRef src, fdata) +#header Sub ArrayFill(ByRef src, fdata) Fills all the elements in an array with the value in fdata diff --git a/doc/files/arraysize.html b/doc/files/arraysize.html index 20f1cce..704c5a3 100644 --- a/doc/files/arraysize.html +++ b/doc/files/arraysize.html @@ -7,7 +7,7 @@ -Returns the number of elements in the given dimension of an array
diff --git a/doc/files/arraysize.txt b/doc/files/arraysize.txt index d4ca82d..e05767e 100644 --- a/doc/files/arraysize.txt +++ b/doc/files/arraysize.txt @@ -1,5 +1,5 @@ #title ArraySize [RCBasic Doc] -#header function ArraySize(Byref id, array_dim) +#header Function ArraySize(Byref id, array_dim) Returns the number of elements in the given dimension of an array diff --git a/doc/files/asc.html b/doc/files/asc.html index 07241b9..14aa178 100644 --- a/doc/files/asc.html +++ b/doc/files/asc.html @@ -7,7 +7,7 @@ -Returns the ASCII value of a character.
diff --git a/doc/files/asc.txt b/doc/files/asc.txt index 84a418d..6450a9e 100644 --- a/doc/files/asc.txt +++ b/doc/files/asc.txt @@ -1,4 +1,4 @@ #title Asc [RCBasic Doc] -#header function Asc(c$) +#header Function Asc(c$) Returns the ASCII value of a character. diff --git a/doc/files/asin.html b/doc/files/asin.html index ad191a6..53ff2c3 100644 --- a/doc/files/asin.html +++ b/doc/files/asin.html @@ -7,7 +7,7 @@ -Returns the ArcSine of a number.
diff --git a/doc/files/asin.txt b/doc/files/asin.txt index fb1fe18..c1ab938 100644 --- a/doc/files/asin.txt +++ b/doc/files/asin.txt @@ -1,4 +1,4 @@ #title Asin [RCBasic Doc] -#header function Asin(n) +#header Function Asin(n) Returns the ArcSine of a number. diff --git a/doc/files/atan.html b/doc/files/atan.html index b8cf337..06fe174 100644 --- a/doc/files/atan.html +++ b/doc/files/atan.html @@ -7,7 +7,7 @@ -Returns the ArcTangent of a number.
diff --git a/doc/files/atan.txt b/doc/files/atan.txt index d1761ed..f23eeaf 100644 --- a/doc/files/atan.txt +++ b/doc/files/atan.txt @@ -1,4 +1,4 @@ #title Atan [RCBasic Doc] -#header function Atan(n) +#header Function Atan(n) Returns the ArcTangent of a number. diff --git a/doc/files/box3d.html b/doc/files/box3d.html new file mode 100644 index 0000000..d8dd34b --- /dev/null +++ b/doc/files/box3d.html @@ -0,0 +1,17 @@ + + + + + ++ Draws a box in 3D space +
++ + + \ No newline at end of file diff --git a/doc/files/box3d.txt b/doc/files/box3d.txt new file mode 100644 index 0000000..c750680 --- /dev/null +++ b/doc/files/box3d.txt @@ -0,0 +1,4 @@ +#title Box3D [RCBasic Doc] +#header sub Box3D(min_x, min_y, min_z, max_x, max_y, max_z) + +Draws a box in 3D space diff --git a/doc/files/castray2d.html b/doc/files/castray2d.html new file mode 100644 index 0000000..c460985 --- /dev/null +++ b/doc/files/castray2d.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and get the closest hit on the ray +
++ Returns 1 if there is a hit and 0 if not +
++ NOTE: GetRayHit2D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D + CastRay3D_All + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/castray2d_all.html b/doc/files/castray2d_all.html new file mode 100644 index 0000000..2b2f9bb --- /dev/null +++ b/doc/files/castray2d_all.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and gets all hits on the ray +
++ Returns the number of hits from the ray cast +
++ NOTE: GetRayHit2D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D + CastRay3D_All + CastRay2D + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/castray3d.html b/doc/files/castray3d.html new file mode 100644 index 0000000..0847b09 --- /dev/null +++ b/doc/files/castray3d.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and get the closest hit on the ray +
++ Returns 1 if there is a hit and 0 if not +
++ NOTE: GetRayHit3D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D_All + CastRay2D + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/castray3d_all.html b/doc/files/castray3d_all.html new file mode 100644 index 0000000..38fdbfa --- /dev/null +++ b/doc/files/castray3d_all.html @@ -0,0 +1,30 @@ + + +
+ + ++ Cast a ray and gets all hits on the ray +
++ Returns the number of hits from the ray cast +
++ NOTE: GetRayHit3D is used to read each hit +
+Related: + GetRayHit3D + CastRay3D + CastRay2D + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/clearcanvas.html b/doc/files/clearcanvas.html index e8e98ca..338383d 100644 --- a/doc/files/clearcanvas.html +++ b/doc/files/clearcanvas.html @@ -12,6 +12,9 @@ Clears the active drawing canvas
+ NOTE: This is only for drawing canvases (ie. Those opened with OpenCanvas()) +
+\ No newline at end of file diff --git a/doc/files/clearcanvas.txt b/doc/files/clearcanvas.txt index e952865..3deb5fe 100644 --- a/doc/files/clearcanvas.txt +++ b/doc/files/clearcanvas.txt @@ -2,3 +2,5 @@ #header sub ClearCanvas() Clears the active drawing canvas + +NOTE: This is only for drawing canvases (ie. Those opened with OpenCanvas()) diff --git a/doc/files/computeactorangularimpulsedenominator.html b/doc/files/computeactorangularimpulsedenominator.html index 06962d3..c65a4ff 100644 --- a/doc/files/computeactorangularimpulsedenominator.html +++ b/doc/files/computeactorangularimpulsedenominator.html @@ -7,7 +7,7 @@
-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.
diff --git a/doc/files/computeactorangularimpulsedenominator.txt b/doc/files/computeactorangularimpulsedenominator.txt index 1a66853..ecf5e43 100644 --- a/doc/files/computeactorangularimpulsedenominator.txt +++ b/doc/files/computeactorangularimpulsedenominator.txt @@ -1,5 +1,5 @@ #title ComputeActorAngularImpulseDenominator [RCBasic Doc] -#header function ComputeActorAngularImpulseDenominator( actor, x, y, z) +#header function ComputeActorAngularImpulseDenominator( actor, x, y, z) Computes a scalar value that represents how an actor will respond to an angular impulse at a given point, taking into account the actor's inertia tensor (which governs how the object resists rotation). This function is particularly useful in calculating the actor's rotational response to an impulse, typically during collision resolution or constraints involving rotation. diff --git a/doc/files/computeactorgyroimpulselocal.html b/doc/files/computeactorgyroimpulselocal.html index f18826e..265ce83 100644 --- a/doc/files/computeactorgyroimpulselocal.html +++ b/doc/files/computeactorgyroimpulselocal.html @@ -7,7 +7,7 @@ -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.
diff --git a/doc/files/computeactorgyroimpulselocal.txt b/doc/files/computeactorgyroimpulselocal.txt index 4f91f63..bafdf61 100644 --- a/doc/files/computeactorgyroimpulselocal.txt +++ b/doc/files/computeactorgyroimpulselocal.txt @@ -1,5 +1,5 @@ #title ComputeActorGyroImpulseLocal [RCBasic Doc] -#header sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z) +#header sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z) Computes the gyroscopic impulse for an actor in an implicit manner, based on the actor's current angular velocity and inertia. This function is used to simulate the gyroscopic effect—also known as gyroscopic precession—which occurs when a rotating object experiences a torque that causes its axis of rotation to change. diff --git a/doc/files/computeactorgyroimpulseworld.html b/doc/files/computeactorgyroimpulseworld.html index bad5d65..431aebd 100644 --- a/doc/files/computeactorgyroimpulseworld.html +++ b/doc/files/computeactorgyroimpulseworld.html @@ -7,7 +7,7 @@ -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.
diff --git a/doc/files/computeactorgyroimpulseworld.txt b/doc/files/computeactorgyroimpulseworld.txt index cb04f05..875f3fb 100644 --- a/doc/files/computeactorgyroimpulseworld.txt +++ b/doc/files/computeactorgyroimpulseworld.txt @@ -1,5 +1,5 @@ #title ComputeActorGyroImpulseWorld [RCBasic Doc] -#header sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z) +#header sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z) Computes the gyroscopic impulse for an actor in an implicit manner, but in this case, it performs the calculation relative to the world frame of reference, rather than the actor’s local frame. This function is used to handle the gyroscopic effects (i.e., gyroscopic precession) of a rotating object when a torque is applied, affecting its axis of rotation. diff --git a/doc/files/computeactorimpulsedenominator.html b/doc/files/computeactorimpulsedenominator.html index a3ce3de..7082ceb 100644 --- a/doc/files/computeactorimpulsedenominator.html +++ b/doc/files/computeactorimpulsedenominator.html @@ -7,7 +7,7 @@ -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.
diff --git a/doc/files/computeactorimpulsedenominator.txt b/doc/files/computeactorimpulsedenominator.txt index 53250fe..c0b0cc0 100644 --- a/doc/files/computeactorimpulsedenominator.txt +++ b/doc/files/computeactorimpulsedenominator.txt @@ -1,5 +1,5 @@ #title ComputeActorImpulseDenominator [RCBasic Doc] -#header function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z) +#header function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z) Computes a scalar value related to how a rigid body will respond to an applied impulse at a given point. It’s primarily used internally in the physics engine to calculate how an object’s mass, inertia, and shape will affect the outcome of impulses, particularly in collisions or constraints like contact points between objects. diff --git a/doc/files/constraintexists.html b/doc/files/constraintexists.html index 9ac8234..42300e5 100644 --- a/doc/files/constraintexists.html +++ b/doc/files/constraintexists.html @@ -9,6 +9,9 @@+ Returns true if the id passed is a valid constraint +
+\ No newline at end of file diff --git a/doc/files/constraintexists.txt b/doc/files/constraintexists.txt index fc1851e..1ada7e3 100644 --- a/doc/files/constraintexists.txt +++ b/doc/files/constraintexists.txt @@ -1,4 +1,4 @@ #title ConstraintExists [RCBasic Doc] #header function ConstraintExists( constraint_id ) - +Returns true if the id passed is a valid constraint diff --git a/doc/files/copyactormaterial.html b/doc/files/copyactormaterial.html index acbb09c..1e3aac6 100644 --- a/doc/files/copyactormaterial.html +++ b/doc/files/copyactormaterial.html @@ -3,11 +3,11 @@
-Returns a material id for a copy of an actor's material
diff --git a/doc/files/copyactormaterial.txt b/doc/files/copyactormaterial.txt index 6fc5ce6..30c9ba3 100644 --- a/doc/files/copyactormaterial.txt +++ b/doc/files/copyactormaterial.txt @@ -1,4 +1,4 @@ -#title copyActorMaterial [RCBasic Doc] -#header function copyActorMaterial( actor, material_num) +#title CopyActorMaterial [RCBasic Doc] +#header function CopyActorMaterial( actor, material_num) Returns a material id for a copy of an actor's material diff --git a/doc/files/copymaterial.html b/doc/files/copymaterial.html index 075a306..7140ec2 100644 --- a/doc/files/copymaterial.html +++ b/doc/files/copymaterial.html @@ -3,11 +3,11 @@ -Returns a copy of a material
diff --git a/doc/files/copymaterial.txt b/doc/files/copymaterial.txt index ec68fbe..4f7cb7e 100644 --- a/doc/files/copymaterial.txt +++ b/doc/files/copymaterial.txt @@ -1,4 +1,4 @@ -#title copyMaterial [RCBasic Doc] -#header function copyMaterial( smaterial_id) +#title CopyMaterial [RCBasic Doc] +#header function CopyMaterial( smaterial_id) Returns a copy of a material diff --git a/doc/files/createhingeconstraint.html b/doc/files/createhingeconstraint.html index 3b5cc44..32b22cc 100644 --- a/doc/files/createhingeconstraint.html +++ b/doc/files/createhingeconstraint.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/createhingeconstraint.txt b/doc/files/createhingeconstraint.txt index 0fc595e..9bab6d9 100644 --- a/doc/files/createhingeconstraint.txt +++ b/doc/files/createhingeconstraint.txt @@ -1,5 +1,5 @@ -#title createHingeConstraint [RCBasic Doc] -#header function createHingeConstraint( actorA, frameA, useReferenceFrameA ) +#title CreateHingeConstraint [RCBasic Doc] +#header function CreateHingeConstraint( actorA, frameA, useReferenceFrameA ) Simulates a hinge joint, which allows two actors (or an actor and the world) to rotate around a single axis while restricting movement along the other axes. This is similar to the way a door swings on its hinges or how an elbow joint functions in the human body. diff --git a/doc/files/createhingeconstraintex.html b/doc/files/createhingeconstraintex.html index 5f2467b..9e1e9bd 100644 --- a/doc/files/createhingeconstraintex.html +++ b/doc/files/createhingeconstraintex.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/createhingeconstraintex.txt b/doc/files/createhingeconstraintex.txt index d68b2e6..ea53632 100644 --- a/doc/files/createhingeconstraintex.txt +++ b/doc/files/createhingeconstraintex.txt @@ -1,5 +1,5 @@ -#title createHingeConstraintEx [RCBasic Doc] -#header function createHingeConstraintEx( actorA, actorB, frameA, frameB, useReferenceFrameA) +#title CreateHingeConstraintEx [RCBasic Doc] +#header Function CreateHingeConstraintEx( actorA, actorB, frameA, frameB, useReferenceFrameA) Simulates a hinge joint, which allows two actors (or an actor and the world) to rotate around a single axis while restricting movement along the other axes. This is similar to the way a door swings on its hinges or how an elbow joint functions in the human body. diff --git a/doc/files/createmeshoctreeactor.txt b/doc/files/createmeshoctreeactor.txt deleted file mode 100644 index 633ffe8..0000000 --- a/doc/files/createmeshoctreeactor.txt +++ /dev/null @@ -1,8 +0,0 @@ -#title CreateMeshOctreeActor [RCBasic Doc] -#header function CreateMeshOctreeActor( mesh ) - -Returns a mesh actor optimized for large objects (such as levels) - -#ref CreateMesh LoadMesh -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.
diff --git a/doc/files/createpointconstraint.txt b/doc/files/createpointconstraint.txt index b1376a9..351ed56 100644 --- a/doc/files/createpointconstraint.txt +++ b/doc/files/createpointconstraint.txt @@ -1,5 +1,5 @@ -#title createPointConstraint [RCBasic Doc] -#header function createPointConstraint( actorA, pxA, pyA, pzA) +#title CreatePointConstraint [RCBasic Doc] +#header Function CreatePointConstraint( actorA, pxA, pyA, pzA) A type of constraint that allows two actors (or an actor and the world) to move freely relative to each other while ensuring that one point on each body remains coincident. Essentially, it ensures that the two actors stay connected at a single point, but without restricting their relative rotations. This kind of constraint is useful when you need a connection that allows full rotation in all directions, such as a pendulum, ball joint, or even some suspension systems. diff --git a/doc/files/createpointconstraintex.html b/doc/files/createpointconstraintex.html index b603e5d..1741ed2 100644 --- a/doc/files/createpointconstraintex.html +++ b/doc/files/createpointconstraintex.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/createpointconstraintex.txt b/doc/files/createpointconstraintex.txt index f17b183..9817321 100644 --- a/doc/files/createpointconstraintex.txt +++ b/doc/files/createpointconstraintex.txt @@ -1,5 +1,5 @@ -#title createPointConstraintEx [RCBasic Doc] -#header function createPointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB) +#title CreatePointConstraintEx [RCBasic Doc] +#header function CreatePointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB) A type of constraint that allows two actors (or an actor and the world) to move freely relative to each other while ensuring that one point on each body remains coincident. Essentially, it ensures that the two actors stay connected at a single point, but without restricting their relative rotations. This kind of constraint is useful when you need a connection that allows full rotation in all directions, such as a pendulum, ball joint, or even some suspension systems. diff --git a/doc/files/createslideconstraint.html b/doc/files/createslideconstraint.html index d1f8c1e..2db0edc 100644 --- a/doc/files/createslideconstraint.html +++ b/doc/files/createslideconstraint.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/createslideconstraint.txt b/doc/files/createslideconstraint.txt index 5063718..03bd6cb 100644 --- a/doc/files/createslideconstraint.txt +++ b/doc/files/createslideconstraint.txt @@ -1,5 +1,5 @@ -#title createSlideConstraint [RCBasic Doc] -#header function createSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA) +#title CreateSlideConstraint [RCBasic Doc] +#header function CreateSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA) A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems. diff --git a/doc/files/createslideconstraintex.html b/doc/files/createslideconstraintex.html index 00371f4..b139388 100644 --- a/doc/files/createslideconstraintex.html +++ b/doc/files/createslideconstraintex.html @@ -3,11 +3,11 @@ -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.
diff --git a/doc/files/createslideconstraintex.txt b/doc/files/createslideconstraintex.txt index 9aeeebe..3acc1cd 100644 --- a/doc/files/createslideconstraintex.txt +++ b/doc/files/createslideconstraintex.txt @@ -1,5 +1,5 @@ -#title createSlideConstraintEx [RCBasic Doc] -#header function createSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA) +#title CreateSlideConstraintEx [RCBasic Doc] +#header function CreateSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA) A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems. diff --git a/doc/files/deleteactor.html b/doc/files/deleteactor.html index 0695d93..7efb430 100644 --- a/doc/files/deleteactor.html +++ b/doc/files/deleteactor.html @@ -12,6 +12,9 @@ Removes an actor from the scene and frees its memory+ NOTE: Actors are all removed on clearScene so make sure you don't continue using the id after that. +
+\ No newline at end of file diff --git a/doc/files/deleteactor.txt b/doc/files/deleteactor.txt index 38b80e9..3c7250d 100644 --- a/doc/files/deleteactor.txt +++ b/doc/files/deleteactor.txt @@ -2,3 +2,5 @@ #header sub DeleteActor( actor ) Removes an actor from the scene and frees its memory + +NOTE: Actors are all removed on clearScene so make sure you don't continue using the id after that. diff --git a/doc/files/deleteconstraint.html b/doc/files/deleteconstraint.html index d4ec770..2dca7ba 100644 --- a/doc/files/deleteconstraint.html +++ b/doc/files/deleteconstraint.html @@ -3,11 +3,11 @@
-Removes a constraint
diff --git a/doc/files/deleteconstraint.txt b/doc/files/deleteconstraint.txt index fe8dd8e..71ab51b 100644 --- a/doc/files/deleteconstraint.txt +++ b/doc/files/deleteconstraint.txt @@ -1,4 +1,4 @@ -#title deleteConstraint [RCBasic Doc] -#header sub deleteConstraint( constraint_id) +#title DeleteConstraint [RCBasic Doc] +#header Sub DeleteConstraint( constraint_id) Removes a constraint diff --git a/doc/files/deletefont.html b/doc/files/deletefont.html index a4e5d82..65a1bca 100644 --- a/doc/files/deletefont.html +++ b/doc/files/deletefont.html @@ -7,7 +7,7 @@ -Frees a font from memory
diff --git a/doc/files/deletefont.txt b/doc/files/deletefont.txt index 4a5f97e..097249b 100644 --- a/doc/files/deletefont.txt +++ b/doc/files/deletefont.txt @@ -1,4 +1,4 @@ #title DeleteFont [RCBasic Doc] -#header sub DeleteFont(font_id) +#header Sub DeleteFont(font_id) Frees a font from memory diff --git a/doc/files/deleteimage.html b/doc/files/deleteimage.html index 43ba22b..507d13f 100644 --- a/doc/files/deleteimage.html +++ b/doc/files/deleteimage.html @@ -7,7 +7,7 @@ -Removes an image from memory
diff --git a/doc/files/deleteimage.txt b/doc/files/deleteimage.txt index 164f0d0..db62800 100644 --- a/doc/files/deleteimage.txt +++ b/doc/files/deleteimage.txt @@ -1,4 +1,4 @@ #title DeleteImage [RCBasic Doc] -#header sub DeleteImage(img) +#header Sub DeleteImage(img) Removes an image from memory diff --git a/doc/files/deletematerial.html b/doc/files/deletematerial.html index 7424dda..9a41461 100644 --- a/doc/files/deletematerial.html +++ b/doc/files/deletematerial.html @@ -3,15 +3,18 @@ -Removes a material from memory
+ NOTE: In the case of actor materials, this will simple drop the reference to it but it will not remove the material from the actor. +
+\ No newline at end of file diff --git a/doc/files/deletematerial.txt b/doc/files/deletematerial.txt index 5e4d8a5..65d6173 100644 --- a/doc/files/deletematerial.txt +++ b/doc/files/deletematerial.txt @@ -1,4 +1,6 @@ -#title deleteMaterial [RCBasic Doc] -#header sub deleteMaterial( material_id) +#title DeleteMaterial [RCBasic Doc] +#header Sub DeleteMaterial( material_id) Removes a material from memory + +NOTE: In the case of actor materials, this will simple drop the reference to it but it will not remove the material from the actor. diff --git a/doc/files/drawimage_rotateex.txt b/doc/files/drawimage_rotateex.txt index 6473745..ccf321b 100644 --- a/doc/files/drawimage_rotateex.txt +++ b/doc/files/drawimage_rotateex.txt @@ -1,4 +1,4 @@ #title DrawImage_RotateEx [RCBasic Doc] #header sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle) - Draws a portion of an image to the current canvas rotated by a given angle. +Draws a portion of an image to the current canvas rotated by a given angle. diff --git a/doc/files/floodfill.html b/doc/files/floodfill.html index ac60db3..afd743c 100644 --- a/doc/files/floodfill.html +++ b/doc/files/floodfill.html @@ -12,6 +12,9 @@ Fills a closed shape in with the current draw color
+ NOTE: It is not recommended to floodfill the full screen since its prone to stack overload +
+\ No newline at end of file diff --git a/doc/files/floodfill.txt b/doc/files/floodfill.txt index be4b414..4b6ad3a 100644 --- a/doc/files/floodfill.txt +++ b/doc/files/floodfill.txt @@ -2,3 +2,5 @@ #header sub FloodFill(x,y) Fills a closed shape in with the current draw color + +NOTE: It is not recommended to floodfill the full screen since its prone to stack overload diff --git a/doc/files/fprint.html b/doc/files/fprint.html index 28a21af..ef37dea 100644 --- a/doc/files/fprint.html +++ b/doc/files/fprint.html @@ -12,6 +12,9 @@ Outputs text to the console
+ NOTE: It does the exact same thing as Print. This is here for legacy reasons (ie. I am too lazy to remove it.) +
+\ No newline at end of file diff --git a/doc/files/fprint.txt b/doc/files/fprint.txt index 97b35de..e2cc2f5 100644 --- a/doc/files/fprint.txt +++ b/doc/files/fprint.txt @@ -2,3 +2,5 @@ #header sub Fprint(txt$) Outputs text to the console + +NOTE: It does the exact same thing as Print. This is here for legacy reasons (ie. I am too lazy to remove it.) diff --git a/doc/files/getactorrotationq.html b/doc/files/getactorrotationq.html index f79bb42..4775951 100644 --- a/doc/files/getactorrotationq.html +++ b/doc/files/getactorrotationq.html @@ -12,7 +12,7 @@ Gets the actors rotation as a quaternion.
- Note: This is useful for calculations that require quaternion but most developers should just use GetActorRotation() + Note: This is useful for calculations that require quaternion but most developers should just use GetActorTransform()
Related: GetActorRotation diff --git a/doc/files/getactorrotationq.txt b/doc/files/getactorrotationq.txt index b7c0450..0197547 100644 --- a/doc/files/getactorrotationq.txt +++ b/doc/files/getactorrotationq.txt @@ -3,6 +3,6 @@ Gets the actors rotation as a quaternion. -Note: This is useful for calculations that require quaternion but most developers should just use GetActorRotation() +Note: This is useful for calculations that require quaternion but most developers should just use GetActorTransform() #ref GetActorRotation SetActorRotation diff --git a/doc/files/getrayhit2d.html b/doc/files/getrayhit2d.html new file mode 100644 index 0000000..a3cd111 --- /dev/null +++ b/doc/files/getrayhit2d.html @@ -0,0 +1,35 @@ + + +
+ + ++ This function will get the collision point and the normal of a ray hit. +
++ NOTES: +
+Related: + GetRayHit3D + CastRay3D + CastRay3D_All + CastRay2D + CastRay2D_All +
++ + + \ No newline at end of file diff --git a/doc/files/getrayhit3d.html b/doc/files/getrayhit3d.html new file mode 100644 index 0000000..83d13c6 --- /dev/null +++ b/doc/files/getrayhit3d.html @@ -0,0 +1,35 @@ + + +
+ + ++ This function will get the collision point and the normal of a ray hit. +
++ NOTES: +
+Related: + CastRay3D + CastRay3D_All + CastRay2D + CastRay2D_All + GetRayHit2D +
++ + + \ No newline at end of file diff --git a/doc/files/getwatercolor.txt b/doc/files/getwatercolor.txt deleted file mode 100644 index d228770..0000000 --- a/doc/files/getwatercolor.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title getWaterColor [RCBasic Doc] -#header function getWaterColor( actor) - - diff --git a/doc/files/getwatercolorblendfactor.txt b/doc/files/getwatercolorblendfactor.txt deleted file mode 100644 index 95cf8bd..0000000 --- a/doc/files/getwatercolorblendfactor.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title getWaterColorBlendFactor [RCBasic Doc] -#header function getWaterColorBlendFactor( actor) - - diff --git a/doc/files/getwaterwaveheight.txt b/doc/files/getwaterwaveheight.txt deleted file mode 100644 index cfa0909..0000000 --- a/doc/files/getwaterwaveheight.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title getWaterWaveHeight [RCBasic Doc] -#header function getWaterWaveHeight( actor) - - diff --git a/doc/files/getwaterwinddirection.txt b/doc/files/getwaterwinddirection.txt deleted file mode 100644 index e2f6112..0000000 --- a/doc/files/getwaterwinddirection.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title getWaterWindDirection [RCBasic Doc] -#header sub getWaterWindDirection( actor, ByRef x, ByRef z) - - diff --git a/doc/files/getwaterwindforce.txt b/doc/files/getwaterwindforce.txt deleted file mode 100644 index 4216525..0000000 --- a/doc/files/getwaterwindforce.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title getWaterWindForce [RCBasic Doc] -#header function getWaterWindForce( actor) - - diff --git a/doc/files/lcase.html b/doc/files/lcase.html index cee7ca8..e0fdcff 100644 --- a/doc/files/lcase.html +++ b/doc/files/lcase.html @@ -3,11 +3,11 @@
-Returns src$ converted to a completely lower-case string
diff --git a/doc/files/lcase.txt b/doc/files/lcase.txt index fb701e7..240b219 100644 --- a/doc/files/lcase.txt +++ b/doc/files/lcase.txt @@ -1,4 +1,4 @@ -#title Lcase$ [RCBasic Doc] -#header function Lcase$(src$) +#title LCase$ [RCBasic Doc] +#header function LCase$(src$) Returns src$ converted to a completely lower-case string diff --git a/doc/files/line3d.html b/doc/files/line3d.html new file mode 100644 index 0000000..2fb3b2a --- /dev/null +++ b/doc/files/line3d.html @@ -0,0 +1,17 @@ + + + + + ++ Draws a line in 3D space +
++ + + \ No newline at end of file diff --git a/doc/files/line3d.txt b/doc/files/line3d.txt new file mode 100644 index 0000000..a9ce8a9 --- /dev/null +++ b/doc/files/line3d.txt @@ -0,0 +1,4 @@ +#title Line3D [RCBasic Doc] +#header sub Line3D(x1, y1, z1, x2, y2, z2) + +Draws a line in 3D space diff --git a/doc/files/loopactoranimation.html b/doc/files/loopactoranimation.html index 834ce51..4f2c970 100644 --- a/doc/files/loopactoranimation.html +++ b/doc/files/loopactoranimation.html @@ -3,11 +3,11 @@
-Enables or disables actor animation loop
diff --git a/doc/files/loopactoranimation.txt b/doc/files/loopactoranimation.txt index 9b049a4..e4343a2 100644 --- a/doc/files/loopactoranimation.txt +++ b/doc/files/loopactoranimation.txt @@ -1,4 +1,4 @@ -#title loopActorAnimation [RCBasic Doc] -#header sub loopActorAnimation( actor, flag ) +#title LoopActorAnimation [RCBasic Doc] +#header sub LoopActorAnimation( actor, flag ) Enables or disables actor animation loop diff --git a/doc/files/ltrim.html b/doc/files/ltrim.html index eaeefe6..ef3f472 100644 --- a/doc/files/ltrim.html +++ b/doc/files/ltrim.html @@ -3,14 +3,18 @@ -Returns src$ with all the spaces before the first non-space character removed.
+diff --git a/doc/files/ltrim.txt b/doc/files/ltrim.txt index df9fce2..c6cdb3c 100644 --- a/doc/files/ltrim.txt +++ b/doc/files/ltrim.txt @@ -1,4 +1,6 @@ -#title Ltrim$ [RCBasic Doc] -#header function Ltrim$(src$) +#title LTrim$ [RCBasic Doc] +#header function LTrim$(src$) Returns src$ with all the spaces before the first non-space character removed. + +#ref RTrim Trim diff --git a/doc/files/materialexists.html b/doc/files/materialexists.html index 28d8e90..19dd058 100644 --- a/doc/files/materialexists.html +++ b/doc/files/materialexists.html @@ -9,6 +9,9 @@
+ Returns true if the material id is an existing material +
+\ No newline at end of file diff --git a/doc/files/materialexists.txt b/doc/files/materialexists.txt index afd5574..f18ad2c 100644 --- a/doc/files/materialexists.txt +++ b/doc/files/materialexists.txt @@ -1,4 +1,4 @@ #title MaterialExists [RCBasic Doc] #header function MaterialExists( material ) - +Returns true if the material id is an existing material diff --git a/doc/files/materialisaplhablend.html b/doc/files/materialisaplhablend.html index 30353a3..638739e 100644 --- a/doc/files/materialisaplhablend.html +++ b/doc/files/materialisaplhablend.html @@ -3,11 +3,11 @@
-Returns true if alpha blending is enabled for a material
diff --git a/doc/files/materialisaplhablend.txt b/doc/files/materialisaplhablend.txt index 0ef6991..01037bf 100644 --- a/doc/files/materialisaplhablend.txt +++ b/doc/files/materialisaplhablend.txt @@ -1,4 +1,4 @@ -#title materialIsAplhaBlend [RCBasic Doc] -#header function materialIsAplhaBlend( material_id) +#title MaterialIsAplhaBlend [RCBasic Doc] +#header function MaterialIsAplhaBlend( material_id) Returns true if alpha blending is enabled for a material diff --git a/doc/files/materialisgouraudshaded.html b/doc/files/materialisgouraudshaded.html index e889bb9..5e9c3d8 100644 --- a/doc/files/materialisgouraudshaded.html +++ b/doc/files/materialisgouraudshaded.html @@ -3,11 +3,11 @@ -Returns true if material is set to goraud shading
diff --git a/doc/files/materialisgouraudshaded.txt b/doc/files/materialisgouraudshaded.txt index f6b94b9..be61944 100644 --- a/doc/files/materialisgouraudshaded.txt +++ b/doc/files/materialisgouraudshaded.txt @@ -1,4 +1,4 @@ -#title materialIsGouraudShaded [RCBasic Doc] -#header function materialIsGouraudShaded( material_id) +#title MaterialIsGouraudShaded [RCBasic Doc] +#header function MaterialIsGouraudShaded( material_id ) Returns true if material is set to goraud shading diff --git a/doc/files/materialislit.html b/doc/files/materialislit.html index 30c2f01..8d8cccb 100644 --- a/doc/files/materialislit.html +++ b/doc/files/materialislit.html @@ -3,11 +3,11 @@ -Returns true if a material is affected by lights in the scene
diff --git a/doc/files/materialislit.txt b/doc/files/materialislit.txt index 9607570..42ad3c8 100644 --- a/doc/files/materialislit.txt +++ b/doc/files/materialislit.txt @@ -1,5 +1,5 @@ -#title materialIsLit [RCBasic Doc] -#header function materialIsLit( material_id) +#title MaterialIsLit [RCBasic Doc] +#header function MaterialIsLit( material_id ) Returns true if a material is affected by lights in the scene diff --git a/doc/files/materialisnormalized.html b/doc/files/materialisnormalized.html index 34cf5a2..97072ff 100644 --- a/doc/files/materialisnormalized.html +++ b/doc/files/materialisnormalized.html @@ -3,11 +3,11 @@ -Returns true if material has normalized normals
diff --git a/doc/files/materialisnormalized.txt b/doc/files/materialisnormalized.txt index fdd280f..8fa2590 100644 --- a/doc/files/materialisnormalized.txt +++ b/doc/files/materialisnormalized.txt @@ -1,4 +1,4 @@ -#title materialIsNormalized [RCBasic Doc] -#header function materialIsNormalized( material_id) +#title MaterialIsNormalized [RCBasic Doc] +#header function MaterialIsNormalized( material_id ) Returns true if material has normalized normals diff --git a/doc/files/materialispointcloud.html b/doc/files/materialispointcloud.html index d71a5e0..e978c96 100644 --- a/doc/files/materialispointcloud.html +++ b/doc/files/materialispointcloud.html @@ -3,11 +3,11 @@ -Returns true if material is set to render with point cloud
diff --git a/doc/files/materialispointcloud.txt b/doc/files/materialispointcloud.txt index 3c703f3..5796a38 100644 --- a/doc/files/materialispointcloud.txt +++ b/doc/files/materialispointcloud.txt @@ -1,4 +1,4 @@ -#title materialIsPointCloud [RCBasic Doc] -#header function materialIsPointCloud( material_id) +#title MaterialIsPointCloud [RCBasic Doc] +#header function MaterialIsPointCloud( material_id ) Returns true if material is set to render with point cloud diff --git a/doc/files/materialistransparent.html b/doc/files/materialistransparent.html index e16d041..5dc3329 100644 --- a/doc/files/materialistransparent.html +++ b/doc/files/materialistransparent.html @@ -3,11 +3,11 @@ -Returns true if material is transparent
diff --git a/doc/files/materialistransparent.txt b/doc/files/materialistransparent.txt index 92bdce5..5e2d102 100644 --- a/doc/files/materialistransparent.txt +++ b/doc/files/materialistransparent.txt @@ -1,4 +1,4 @@ -#title materialIsTransparent [RCBasic Doc] -#header function materialIsTransparent( material_id) +#title MaterialIsTransparent [RCBasic Doc] +#header function MaterialIsTransparent( material_id) Returns true if material is transparent diff --git a/doc/files/materialiswireframe.html b/doc/files/materialiswireframe.html index 0a706d7..4aa8ba5 100644 --- a/doc/files/materialiswireframe.html +++ b/doc/files/materialiswireframe.html @@ -3,11 +3,11 @@ -Returns true if the material is rendered with non-filled triangles
diff --git a/doc/files/materialiswireframe.txt b/doc/files/materialiswireframe.txt index aafe744..391e01b 100644 --- a/doc/files/materialiswireframe.txt +++ b/doc/files/materialiswireframe.txt @@ -1,4 +1,4 @@ -#title materialIsWireframe [RCBasic Doc] -#header function materialIsWireframe( material_id) +#title MaterialIsWireframe [RCBasic Doc] +#header function MaterialIsWireframe( material_id ) Returns true if the material is rendered with non-filled triangles diff --git a/doc/files/setcanvas3d.txt b/doc/files/setcanvas3d.txt deleted file mode 100644 index 6a06036..0000000 --- a/doc/files/setcanvas3d.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title SetCanvas3D [RCBasic Doc] -#header Sub SetCanvas3D(c_num, flag) - - diff --git a/doc/files/setwatercolor.txt b/doc/files/setwatercolor.txt deleted file mode 100644 index 77c2e57..0000000 --- a/doc/files/setwatercolor.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title setWaterColor [RCBasic Doc] -#header sub setWaterColor( actor, c) - - diff --git a/doc/files/setwatercolorblendfactor.txt b/doc/files/setwatercolorblendfactor.txt deleted file mode 100644 index f2c07a6..0000000 --- a/doc/files/setwatercolorblendfactor.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title setWaterColorBlendFactor [RCBasic Doc] -#header sub setWaterColorBlendFactor( actor, cbfactor) - - diff --git a/doc/files/setwaterwaveheight.txt b/doc/files/setwaterwaveheight.txt deleted file mode 100644 index 631b22d..0000000 --- a/doc/files/setwaterwaveheight.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title setWaterWaveHeight [RCBasic Doc] -#header sub setWaterWaveHeight( actor, h) - - diff --git a/doc/files/setwaterwinddirection.txt b/doc/files/setwaterwinddirection.txt deleted file mode 100644 index bda16fe..0000000 --- a/doc/files/setwaterwinddirection.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title setWaterWindDirection [RCBasic Doc] -#header sub setWaterWindDirection( actor, x, z) - - diff --git a/doc/files/setwaterwindforce.txt b/doc/files/setwaterwindforce.txt deleted file mode 100644 index fd95393..0000000 --- a/doc/files/setwaterwindforce.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title setWaterWindForce [RCBasic Doc] -#header sub setWaterWindForce( actor, f) - - diff --git a/doc/files/setworld3ddeltatime.txt b/doc/files/setworld3ddeltatime.txt deleted file mode 100644 index ef089fb..0000000 --- a/doc/files/setworld3ddeltatime.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title SetWorld3DDeltaTime [RCBasic Doc] -#header sub SetWorld3DDeltaTime( dt ) - - diff --git a/doc/files/tcp_acceptsocket.html b/doc/files/tcp_acceptsocket.html index 7708fc2..57af5b0 100644 --- a/doc/files/tcp_acceptsocket.html +++ b/doc/files/tcp_acceptsocket.html @@ -7,9 +7,9 @@ -- 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. + Attempts to accept a connection from a server socket. If successful it will return a client socket id. If it fails it will return -1.
diff --git a/doc/files/translateactor.txt b/doc/files/translateactor.txt deleted file mode 100644 index 5d8b8e9..0000000 --- a/doc/files/translateactor.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title TranslateActor [RCBasic Doc] -#header sub TranslateActor( actor, x, y, z ) - - diff --git a/doc/files/triangle.html b/doc/files/triangle.html new file mode 100644 index 0000000..ab9dc03 --- /dev/null +++ b/doc/files/triangle.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a filled Triangle +
++ + + \ No newline at end of file diff --git a/doc/files/triangle.txt b/doc/files/triangle.txt new file mode 100644 index 0000000..baf8414 --- /dev/null +++ b/doc/files/triangle.txt @@ -0,0 +1,5 @@ +#title Triangle [RCBasic Doc] +#header sub Triangle(x1, y1, x2, y2, x3, y3) + +Draws a filled Triangle + diff --git a/doc/files/triangle3d.html b/doc/files/triangle3d.html new file mode 100644 index 0000000..95dd959 --- /dev/null +++ b/doc/files/triangle3d.html @@ -0,0 +1,17 @@ + + +
+ + ++ Draws a triangle in 3D space +
++ + + \ No newline at end of file diff --git a/doc/files/triangle3d.txt b/doc/files/triangle3d.txt new file mode 100644 index 0000000..8a070f8 --- /dev/null +++ b/doc/files/triangle3d.txt @@ -0,0 +1,4 @@ +#title Triangle3D [RCBasic Doc] +#header sub Triangle3D(x1, y1, z1, x2, y2, z2, x3, y3, z3) + +Draws a triangle in 3D space diff --git a/doc/files/tst.txt b/doc/files/tst.txt deleted file mode 100644 index d7bf91f..0000000 --- a/doc/files/tst.txt +++ /dev/null @@ -1,4 +0,0 @@ -#title tst [RCBasic Doc] -#header sub tst() - - diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..50cfb82 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,65 @@ +table, th, td { border: 1px solid black; } th, td { padding: 10px; } +body { background-color: #064066; color: #FFFFFF; } +a { color: #40bfb8; } +a::before { + content: "---"; + font-family: monospace, monospace; + display: inline-block; + margin-right: 6px; + color: #064066; +} + +.rc_number { color: #0b9898; } +.rc_string { color: #dd4040; } +.rc_keyword { color: #6084a8; font-weight: bold; } +.rc_comment { color: #6e716e; } +#rc_code { font-family: Consolas,"courier new"; background-color: #2d3335; padding: 2px; font-size: 105%; } + + +ul, #myUL { + list-style-type: none; +} + +#myUL { + margin: 0; + padding: 0; +} + +.box { + cursor: pointer; + -webkit-user-select: none; /* Safari 3.1+ */ + -moz-user-select: none; /* Firefox 2+ */ + -ms-user-select: none; /* IE 10+ */ + user-select: none; +} + +.box::before { + content: "[+]"; + font-family: monospace, monospace; + font-weight: bold; + color: #40bfb8; + display: inline-block; + margin-right: 6px; +} + +.box { + font-weight: bold; + color: #40bfb8; + text-decoration: underline; +} + +.check-box::before { + content: "[-]"; + font-family: monospace, monospace; + font-weight: bold; + //color: dodgerblue; + color: #40bfb8; +} + +.nested { + display: none; +} + +.active { + display: block; +}