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

Updated docs

Browse Source
This commit is contained in:
n00b
2024-12-15 23:12:45 -05:00
parent 7181b6924a
commit 3a03aaa148
124 changed files with 518 additions and 202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 48 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

8
doc/files/actoranimationislooped.html
View File

@@ -3,19 +3,19 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>actorAnimationIsLooped [RCBasic Doc] </title> <title>ActorAnimationIsLooped [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function actorAnimationIsLooped( actor ) </h2></p> <p><h2>function ActorAnimationIsLooped( actor ) </h2></p>
<p> <p>
Returns true if an actors animation is set to looped. Returns true if an actors animation is set to looped.
</p> </p>
<p> <p>
Note: Actor animation is set to looped with the loopActorAnimation() function. Note: Actor animation is set to looped with the LoopActorAnimation() function.
</p> </p>
<br><p>Related: <br><p>Related:
<a href="loopactoranimation.html">loopActorAnimation</a> <a href="loopactoranimation.html">LoopActorAnimation</a>
</p> </p>
<p> <p>

8
doc/files/actoranimationislooped.txt
View File

@@ -1,8 +1,8 @@
#title actorAnimationIsLooped [RCBasic Doc] #title ActorAnimationIsLooped [RCBasic Doc]
#header function actorAnimationIsLooped( actor ) #header function ActorAnimationIsLooped( actor )
Returns true if an actors animation is set to looped. 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

3
doc/files/actorexists.html
View File

@@ -9,6 +9,9 @@
<body> <body>
<p><h2>function ActorExists( actor ) </h2></p> <p><h2>function ActorExists( actor ) </h2></p>
<p> <p>
Returns true if the id passed is a valid actor
</p>
<p>
</body> </body>
</html> </html>

2
doc/files/actorexists.txt
View File

@@ -1,4 +1,4 @@
#title ActorExists [RCBasic Doc] #title ActorExists [RCBasic Doc]
#header function ActorExists( actor ) #header function ActorExists( actor )
Returns true if the id passed is a valid actor

4
doc/files/applyactorimpulseworld.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>applyActorImpulseWorld [RCBasic Doc] </title> <title>ApplyActorImpulseWorld [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub applyActorImpulseWorld( actor, x, y, z, rel_x, rel_y, rel_z) </h2></p> <p><h2>Sub ApplyActorImpulseWorld( actor, x, y, z, rel_x, rel_y, rel_z) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/applyactorimpulseworld.txt
View File

@@ -1,5 +1,5 @@
#title applyActorImpulseWorld [RCBasic Doc] #title ApplyActorImpulseWorld [RCBasic Doc]
#header sub applyActorImpulseWorld( actor, x, y, z, rel_x, rel_y, rel_z) #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. 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.

4
doc/files/applyactortorqueimpulselocal.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>applyActorTorqueImpulseLocal [RCBasic Doc] </title> <title>ApplyActorTorqueImpulseLocal [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub applyActorTorqueImpulseLocal( actor, x, y, z) </h2></p> <p><h2>Sub ApplyActorTorqueImpulseLocal( actor, x, y, z) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/applyactortorqueimpulselocal.txt
View File

@@ -1,5 +1,5 @@
#title applyActorTorqueImpulseLocal [RCBasic Doc] #title ApplyActorTorqueImpulseLocal [RCBasic Doc]
#header sub applyActorTorqueImpulseLocal( actor, x, y, z) #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. 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.

4
doc/files/applyactortorqueimpulseworld.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>applyActorTorqueImpulseWorld [RCBasic Doc] </title> <title>ApplyActorTorqueImpulseWorld [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub applyActorTorqueImpulseWorld( actor, x, y, z) </h2></p> <p><h2>Sub ApplyActorTorqueImpulseWorld( actor, x, y, z) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/applyactortorqueimpulseworld.txt
View File

@@ -1,5 +1,5 @@
#title applyActorTorqueImpulseWorld [RCBasic Doc] #title ApplyActorTorqueImpulseWorld [RCBasic Doc]
#header sub applyActorTorqueImpulseWorld( actor, x, y, z) #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. 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.

4
doc/files/applyactortorquelocal.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>applyActorTorqueLocal [RCBasic Doc] </title> <title>ApplyActorTorqueLocal [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub applyActorTorqueLocal( actor, x, y, z) </h2></p> <p><h2>Sub ApplyActorTorqueLocal( actor, x, y, z) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/applyactortorquelocal.txt
View File

@@ -1,5 +1,5 @@
#title applyActorTorqueLocal [RCBasic Doc] #title ApplyActorTorqueLocal [RCBasic Doc]
#header sub applyActorTorqueLocal( actor, x, y, z) #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. 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.

4
doc/files/applyactortorqueworld.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>applyActorTorqueWorld [RCBasic Doc] </title> <title>ApplyActorTorqueWorld [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub applyActorTorqueWorld( actor, x, y, z) </h2></p> <p><h2>Sub ApplyActorTorqueWorld( actor, x, y, z) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/applyactortorqueworld.txt
View File

@@ -1,5 +1,5 @@
#title applyActorTorqueWorld [RCBasic Doc] #title ApplyActorTorqueWorld [RCBasic Doc]
#header sub applyActorTorqueWorld( actor, x, y, z) #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. 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.

2
doc/files/arrayfill.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>sub ArrayFill(ByRef src, fdata) </h2></p> <p><h2>Sub ArrayFill(ByRef src, fdata) </h2></p>
<p> <p>
Fills all the elements in an array with the value in fdata Fills all the elements in an array with the value in fdata
</p> </p>

2
doc/files/arrayfill.txt
View File

@@ -1,5 +1,5 @@
#title ArrayFill [RCBasic Doc] #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 Fills all the elements in an array with the value in fdata

2
doc/files/arraysize.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>function ArraySize(Byref id, array_dim) </h2></p> <p><h2>Function ArraySize(Byref id, array_dim) </h2></p>
<p> <p>
Returns the number of elements in the given dimension of an array Returns the number of elements in the given dimension of an array
</p> </p>

2
doc/files/arraysize.txt
View File

@@ -1,5 +1,5 @@
#title ArraySize [RCBasic Doc] #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 Returns the number of elements in the given dimension of an array

2
doc/files/asc.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>function Asc(c$) </h2></p> <p><h2>Function Asc(c$) </h2></p>
<p> <p>
Returns the ASCII value of a character. Returns the ASCII value of a character.
</p> </p>

2
doc/files/asc.txt
View File

@@ -1,4 +1,4 @@
#title Asc [RCBasic Doc] #title Asc [RCBasic Doc]
#header function Asc(c$) #header Function Asc(c$)
Returns the ASCII value of a character. Returns the ASCII value of a character.

2
doc/files/asin.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>function Asin(n) </h2></p> <p><h2>Function Asin(n) </h2></p>
<p> <p>
Returns the ArcSine of a number. Returns the ArcSine of a number.
</p> </p>

2
doc/files/asin.txt
View File

@@ -1,4 +1,4 @@
#title Asin [RCBasic Doc] #title Asin [RCBasic Doc]
#header function Asin(n) #header Function Asin(n)
Returns the ArcSine of a number. Returns the ArcSine of a number.

2
doc/files/atan.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>function Atan(n) </h2></p> <p><h2>Function Atan(n) </h2></p>
<p> <p>
Returns the ArcTangent of a number. Returns the ArcTangent of a number.
</p> </p>

2
doc/files/atan.txt
View File

@@ -1,4 +1,4 @@
#title Atan [RCBasic Doc] #title Atan [RCBasic Doc]
#header function Atan(n) #header Function Atan(n)
Returns the ArcTangent of a number. Returns the ArcTangent of a number.

17
doc/files/box3d.html Normal file
View File

@@ -0,0 +1,17 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Box3D [RCBasic Doc] </title>
</head>
<body>
<p><h2>sub Box3D(min_x, min_y, min_z, max_x, max_y, max_z) </h2></p>
<p>
Draws a box in 3D space
</p>
<p>
</body>
</html>

4
doc/files/box3d.txt Normal file
View File

@@ -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

30
doc/files/castray2d.html Normal file
View File

@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>CastRay2D [RCBasic Doc] </title>
</head>
<body>
<p><h2>function CastRay2D( from_x, from_y, to_x, to_y ) </h2></p>
<p>
Cast a ray and get the closest hit on the ray
</p>
<p>
Returns 1 if there is a hit and 0 if not
</p>
<p>
NOTE: GetRayHit2D is used to read each hit
</p>
<br><p>Related:
<a href="getrayhit3d.html">GetRayHit3D</a>
<a href="castray3d.html">CastRay3D</a>
<a href="castray3d_all.html">CastRay3D_All</a>
<a href="castray2d_all.html">CastRay2D_All</a>
<a href="getrayhit2d.html">GetRayHit2D</a>
</p>
<p>
</body>
</html>

30
doc/files/castray2d_all.html Normal file
View File

@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>CastRay2D_All [RCBasic Doc] </title>
</head>
<body>
<p><h2>function CastRay2D_All( from_x, from_y, to_x, to_y ) </h2></p>
<p>
Cast a ray and gets all hits on the ray
</p>
<p>
Returns the number of hits from the ray cast
</p>
<p>
NOTE: GetRayHit2D is used to read each hit
</p>
<br><p>Related:
<a href="getrayhit3d.html">GetRayHit3D</a>
<a href="castray3d.html">CastRay3D</a>
<a href="castray3d_all.html">CastRay3D_All</a>
<a href="castray2d.html">CastRay2D</a>
<a href="getrayhit2d.html">GetRayHit2D</a>
</p>
<p>
</body>
</html>

30
doc/files/castray3d.html Normal file
View File

@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>CastRay3D [RCBasic Doc] </title>
</head>
<body>
<p><h2>function CastRay3D( from_x, from_y, from_z, to_x, to_y, to_z ) </h2></p>
<p>
Cast a ray and get the closest hit on the ray
</p>
<p>
Returns 1 if there is a hit and 0 if not
</p>
<p>
NOTE: GetRayHit3D is used to read each hit
</p>
<br><p>Related:
<a href="getrayhit3d.html">GetRayHit3D</a>
<a href="castray3d_all.html">CastRay3D_All</a>
<a href="castray2d.html">CastRay2D</a>
<a href="castray2d_all.html">CastRay2D_All</a>
<a href="getrayhit2d.html">GetRayHit2D</a>
</p>
<p>
</body>
</html>

30
doc/files/castray3d_all.html Normal file
View File

@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>CastRay3D_All [RCBasic Doc] </title>
</head>
<body>
<p><h2>function CastRay3D_All( from_x, from_y, from_z, to_x, to_y, to_z ) </h2></p>
<p>
Cast a ray and gets all hits on the ray
</p>
<p>
Returns the number of hits from the ray cast
</p>
<p>
NOTE: GetRayHit3D is used to read each hit
</p>
<br><p>Related:
<a href="getrayhit3d.html">GetRayHit3D</a>
<a href="castray3d.html">CastRay3D</a>
<a href="castray2d.html">CastRay2D</a>
<a href="castray2d_all.html">CastRay2D_All</a>
<a href="getrayhit2d.html">GetRayHit2D</a>
</p>
<p>
</body>
</html>

3
doc/files/clearcanvas.html
View File

@@ -12,6 +12,9 @@
Clears the active drawing canvas Clears the active drawing canvas
</p> </p>
<p> <p>
NOTE: This is only for drawing canvases (ie. Those opened with OpenCanvas())
</p>
<p>
</body> </body>
</html> </html>

2
doc/files/clearcanvas.txt
View File

@@ -2,3 +2,5 @@
#header sub ClearCanvas() #header sub ClearCanvas()
Clears the active drawing canvas Clears the active drawing canvas
NOTE: This is only for drawing canvases (ie. Those opened with OpenCanvas())

2
doc/files/computeactorangularimpulsedenominator.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>function ComputeActorAngularImpulseDenominator( actor, x, y, z) </h2></p> <p><h2>function ComputeActorAngularImpulseDenominator( actor, x, y, z) </h2></p>
<p> <p>
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. 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.
</p> </p>

2
doc/files/computeactorangularimpulsedenominator.txt
View File

@@ -1,5 +1,5 @@
#title ComputeActorAngularImpulseDenominator [RCBasic Doc] #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. 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.

2
doc/files/computeactorgyroimpulselocal.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z) </h2></p> <p><h2>sub ComputeActorGyroImpulseLocal( actor, dt, ByRef x, ByRef y, ByRef z) </h2></p>
<p> <p>
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. 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.
</p> </p>

2
doc/files/computeactorgyroimpulselocal.txt
View File

@@ -1,5 +1,5 @@
#title ComputeActorGyroImpulseLocal [RCBasic Doc] #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. 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.

2
doc/files/computeactorgyroimpulseworld.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z) </h2></p> <p><h2>sub ComputeActorGyroImpulseWorld( actor, dt, ByRef x, ByRef y, ByRef z) </h2></p>
<p> <p>
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. 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.
</p> </p>

2
doc/files/computeactorgyroimpulseworld.txt
View File

@@ -1,5 +1,5 @@
#title ComputeActorGyroImpulseWorld [RCBasic Doc] #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. 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.

2
doc/files/computeactorimpulsedenominator.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z) </h2></p> <p><h2>function ComputeActorImpulseDenominator( actor, pos_x, pos_y, pos_z, normal_x, normal_y, normal_z) </h2></p>
<p> <p>
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. 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.
</p> </p>

2
doc/files/computeactorimpulsedenominator.txt
View File

@@ -1,5 +1,5 @@
#title ComputeActorImpulseDenominator [RCBasic Doc] #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. 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.

3
doc/files/constraintexists.html
View File

@@ -9,6 +9,9 @@
<body> <body>
<p><h2>function ConstraintExists( constraint_id ) </h2></p> <p><h2>function ConstraintExists( constraint_id ) </h2></p>
<p> <p>
Returns true if the id passed is a valid constraint
</p>
<p>
</body> </body>
</html> </html>

2
doc/files/constraintexists.txt
View File

@@ -1,4 +1,4 @@
#title ConstraintExists [RCBasic Doc] #title ConstraintExists [RCBasic Doc]
#header function ConstraintExists( constraint_id ) #header function ConstraintExists( constraint_id )
Returns true if the id passed is a valid constraint

4
doc/files/copyactormaterial.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>copyActorMaterial [RCBasic Doc] </title> <title>CopyActorMaterial [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function copyActorMaterial( actor, material_num) </h2></p> <p><h2>function CopyActorMaterial( actor, material_num) </h2></p>
<p> <p>
Returns a material id for a copy of an actor's material Returns a material id for a copy of an actor's material
</p> </p>

4
doc/files/copyactormaterial.txt
View File

@@ -1,4 +1,4 @@
#title copyActorMaterial [RCBasic Doc] #title CopyActorMaterial [RCBasic Doc]
#header function copyActorMaterial( actor, material_num) #header function CopyActorMaterial( actor, material_num)
Returns a material id for a copy of an actor's material Returns a material id for a copy of an actor's material

4
doc/files/copymaterial.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>copyMaterial [RCBasic Doc] </title> <title>CopyMaterial [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function copyMaterial( smaterial_id) </h2></p> <p><h2>function CopyMaterial( smaterial_id) </h2></p>
<p> <p>
Returns a copy of a material Returns a copy of a material
</p> </p>

4
doc/files/copymaterial.txt
View File

@@ -1,4 +1,4 @@
#title copyMaterial [RCBasic Doc] #title CopyMaterial [RCBasic Doc]
#header function copyMaterial( smaterial_id) #header function CopyMaterial( smaterial_id)
Returns a copy of a material Returns a copy of a material

4
doc/files/createhingeconstraint.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>createHingeConstraint [RCBasic Doc] </title> <title>CreateHingeConstraint [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function createHingeConstraint( actorA, frameA, useReferenceFrameA ) </h2></p> <p><h2>function CreateHingeConstraint( actorA, frameA, useReferenceFrameA ) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/createhingeconstraint.txt
View File

@@ -1,5 +1,5 @@
#title createHingeConstraint [RCBasic Doc] #title CreateHingeConstraint [RCBasic Doc]
#header function createHingeConstraint( actorA, frameA, useReferenceFrameA ) #header function CreateHingeConstraint( actorA, frameA, useReferenceFrameA )
Simulates a hinge joint, which allows two actors (or an actor and the world) to rotate around a single axis while restricting movement along the other axes. This is similar to the way a door swings on its hinges or how an elbow joint functions in the human body. 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.

4
doc/files/createhingeconstraintex.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>createHingeConstraintEx [RCBasic Doc] </title> <title>CreateHingeConstraintEx [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function createHingeConstraintEx( actorA, actorB, frameA, frameB, useReferenceFrameA) </h2></p> <p><h2>Function CreateHingeConstraintEx( actorA, actorB, frameA, frameB, useReferenceFrameA) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/createhingeconstraintex.txt
View File

@@ -1,5 +1,5 @@
#title createHingeConstraintEx [RCBasic Doc] #title CreateHingeConstraintEx [RCBasic Doc]
#header function createHingeConstraintEx( actorA, actorB, frameA, frameB, useReferenceFrameA) #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. 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.

8
doc/files/createmeshoctreeactor.txt
View File

@@ -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
<br>
#ref CreateMeshActor CreateCubeActor CreateSphereActor CreateWaterPlaneActor CreateLightActor CreateBillboardActor CreateTerrainActor

4
doc/files/createpointconstraint.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>createPointConstraint [RCBasic Doc] </title> <title>CreatePointConstraint [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function createPointConstraint( actorA, pxA, pyA, pzA) </h2></p> <p><h2>Function CreatePointConstraint( actorA, pxA, pyA, pzA) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/createpointconstraint.txt
View File

@@ -1,5 +1,5 @@
#title createPointConstraint [RCBasic Doc] #title CreatePointConstraint [RCBasic Doc]
#header function createPointConstraint( actorA, pxA, pyA, pzA) #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. 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.

4
doc/files/createpointconstraintex.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>createPointConstraintEx [RCBasic Doc] </title> <title>CreatePointConstraintEx [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function createPointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB) </h2></p> <p><h2>function CreatePointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/createpointconstraintex.txt
View File

@@ -1,5 +1,5 @@
#title createPointConstraintEx [RCBasic Doc] #title CreatePointConstraintEx [RCBasic Doc]
#header function createPointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB) #header function CreatePointConstraintEx( actorA, actorB, pxA, pyA, pzA, pxB, pyB, pzB)
A type of constraint that allows two actors (or an actor and the world) to move freely relative to each other while ensuring that one point on each body remains coincident. Essentially, it ensures that the two actors stay connected at a single point, but without restricting their relative rotations. This kind of constraint is useful when you need a connection that allows full rotation in all directions, such as a pendulum, ball joint, or even some suspension systems. 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.

4
doc/files/createslideconstraint.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>createSlideConstraint [RCBasic Doc] </title> <title>CreateSlideConstraint [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function createSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA) </h2></p> <p><h2>function CreateSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/createslideconstraint.txt
View File

@@ -1,5 +1,5 @@
#title createSlideConstraint [RCBasic Doc] #title CreateSlideConstraint [RCBasic Doc]
#header function createSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA) #header function CreateSlideConstraint( actorA, frameInB_matrix, useLinearReferenceFrameA)
A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems. 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.

4
doc/files/createslideconstraintex.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>createSlideConstraintEx [RCBasic Doc] </title> <title>CreateSlideConstraintEx [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function createSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA) </h2></p> <p><h2>function CreateSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA) </h2></p>
<p> <p>
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. 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.
</p> </p>

4
doc/files/createslideconstraintex.txt
View File

@@ -1,5 +1,5 @@
#title createSlideConstraintEx [RCBasic Doc] #title CreateSlideConstraintEx [RCBasic Doc]
#header function createSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA) #header function CreateSlideConstraintEx( actorA, actorB, frameInA_matrix, frameInB_matrix, useLinearReferenceFrameA)
A type of constraint that restricts the motion between two actors (or between an actor and the world) in such a way that they can slide along a specific axis and rotate around the same axis, while limiting or allowing movement along other axes. This constraint is similar to a prismatic joint with added rotational freedom, making it useful for simulating objects like pistons, sliding doors, or rail systems. 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.

3
doc/files/deleteactor.html
View File

@@ -12,6 +12,9 @@
Removes an actor from the scene and frees its memory Removes an actor from the scene and frees its memory
</p> </p>
<p> <p>
NOTE: Actors are all removed on clearScene so make sure you don't continue using the id after that.
</p>
<p>
</body> </body>
</html> </html>

2
doc/files/deleteactor.txt
View File

@@ -2,3 +2,5 @@
#header sub DeleteActor( actor ) #header sub DeleteActor( actor )
Removes an actor from the scene and frees its memory 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.

4
doc/files/deleteconstraint.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>deleteConstraint [RCBasic Doc] </title> <title>DeleteConstraint [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub deleteConstraint( constraint_id) </h2></p> <p><h2>Sub DeleteConstraint( constraint_id) </h2></p>
<p> <p>
Removes a constraint Removes a constraint
</p> </p>

4
doc/files/deleteconstraint.txt
View File

@@ -1,4 +1,4 @@
#title deleteConstraint [RCBasic Doc] #title DeleteConstraint [RCBasic Doc]
#header sub deleteConstraint( constraint_id) #header Sub DeleteConstraint( constraint_id)
Removes a constraint Removes a constraint

2
doc/files/deletefont.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>sub DeleteFont(font_id) </h2></p> <p><h2>Sub DeleteFont(font_id) </h2></p>
<p> <p>
Frees a font from memory Frees a font from memory
</p> </p>

2
doc/files/deletefont.txt
View File

@@ -1,4 +1,4 @@
#title DeleteFont [RCBasic Doc] #title DeleteFont [RCBasic Doc]
#header sub DeleteFont(font_id) #header Sub DeleteFont(font_id)
Frees a font from memory Frees a font from memory

2
doc/files/deleteimage.html
View File

@@ -7,7 +7,7 @@
</head> </head>
<body> <body>
<p><h2>sub DeleteImage(img) </h2></p> <p><h2>Sub DeleteImage(img) </h2></p>
<p> <p>
Removes an image from memory Removes an image from memory
</p> </p>

2
doc/files/deleteimage.txt
View File

@@ -1,4 +1,4 @@
#title DeleteImage [RCBasic Doc] #title DeleteImage [RCBasic Doc]
#header sub DeleteImage(img) #header Sub DeleteImage(img)
Removes an image from memory Removes an image from memory

7
doc/files/deletematerial.html
View File

@@ -3,15 +3,18 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>deleteMaterial [RCBasic Doc] </title> <title>DeleteMaterial [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub deleteMaterial( material_id) </h2></p> <p><h2>Sub DeleteMaterial( material_id) </h2></p>
<p> <p>
Removes a material from memory Removes a material from memory
</p> </p>
<p> <p>
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.
</p>
<p>
</body> </body>
</html> </html>

6
doc/files/deletematerial.txt
View File

@@ -1,4 +1,6 @@
#title deleteMaterial [RCBasic Doc] #title DeleteMaterial [RCBasic Doc]
#header sub deleteMaterial( material_id) #header Sub DeleteMaterial( material_id)
Removes a material from memory 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.

2
doc/files/drawimage_rotateex.txt
View File

@@ -1,4 +1,4 @@
#title DrawImage_RotateEx [RCBasic Doc] #title DrawImage_RotateEx [RCBasic Doc]
#header sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle) #header sub DrawImage_RotateEx(slot, x, y, src_x, src_y, src_w, src_h, angle)
Draws a portion of an image to the current canvas rotated by a given angle. Draws a portion of an image to the current canvas rotated by a given angle.

3
doc/files/floodfill.html
View File

@@ -12,6 +12,9 @@
Fills a closed shape in with the current draw color Fills a closed shape in with the current draw color
</p> </p>
<p> <p>
NOTE: It is not recommended to floodfill the full screen since its prone to stack overload
</p>
<p>
</body> </body>
</html> </html>

2
doc/files/floodfill.txt
View File

@@ -2,3 +2,5 @@
#header sub FloodFill(x,y) #header sub FloodFill(x,y)
Fills a closed shape in with the current draw color 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

3
doc/files/fprint.html
View File

@@ -12,6 +12,9 @@
Outputs text to the console Outputs text to the console
</p> </p>
<p> <p>
NOTE: It does the exact same thing as Print. This is here for legacy reasons (ie. I am too lazy to remove it.)
</p>
<p>
</body> </body>
</html> </html>

2
doc/files/fprint.txt
View File

@@ -2,3 +2,5 @@
#header sub Fprint(txt$) #header sub Fprint(txt$)
Outputs text to the console 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.)

2
doc/files/getactorrotationq.html
View File

@@ -12,7 +12,7 @@
Gets the actors rotation as a quaternion. Gets the actors rotation as a quaternion.
</p> </p>
<p> <p>
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()
</p> </p>
<br><p>Related: <br><p>Related:
<a href="getactorrotation.html">GetActorRotation</a> <a href="getactorrotation.html">GetActorRotation</a>

2
doc/files/getactorrotationq.txt
View File

@@ -3,6 +3,6 @@
Gets the actors rotation as a quaternion. 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 #ref GetActorRotation SetActorRotation

35
doc/files/getrayhit2d.html Normal file
View File

@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetRayHit2D [RCBasic Doc] </title>
</head>
<body>
<p><h2>sub GetRayHit2D( index, ByRef spr_id, ByRef x, ByRef y, ByRef normal_x, ByRef normal_y ) </h2></p>
<p>
This function will get the collision point and the normal of a ray hit.
</p>
<p>
NOTES:
</p>
<ul>
<li>
CastRay2D or CastRay2D_All must be called prior to calling this function
</li>
<li>
spr_id will return -1 if there was not a hit at the specified index
</li>
</ul>
<br><p>Related:
<a href="getrayhit3d.html">GetRayHit3D</a>
<a href="castray3d.html">CastRay3D</a>
<a href="castray3d_all.html">CastRay3D_All</a>
<a href="castray2d.html">CastRay2D</a>
<a href="castray2d_all.html">CastRay2D_All</a>
</p>
<p>
</body>
</html>

35
doc/files/getrayhit3d.html Normal file
View File

@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>GetRayHit3D [RCBasic Doc] </title>
</head>
<body>
<p><h2>sub GetRayHit3D( index, ByRef actor_id, ByRef x, ByRef y, ByRef z, ByRef normal_x, ByRef normal_y, ByRef normal_z ) </h2></p>
<p>
This function will get the collision point and the normal of a ray hit.
</p>
<p>
NOTES:
</p>
<ul>
<li>
CastRay3D or CastRay3D_All must be called prior to calling this function
</li>
<li>
actor_id will return -1 if there was not a hit at the specified index
</li>
</ul>
<br><p>Related:
<a href="castray3d.html">CastRay3D</a>
<a href="castray3d_all.html">CastRay3D_All</a>
<a href="castray2d.html">CastRay2D</a>
<a href="castray2d_all.html">CastRay2D_All</a>
<a href="getrayhit2d.html">GetRayHit2D</a>
</p>
<p>
</body>
</html>

4
doc/files/getwatercolor.txt
View File

@@ -1,4 +0,0 @@
#title getWaterColor [RCBasic Doc]
#header function getWaterColor( actor)

4
doc/files/getwatercolorblendfactor.txt
View File

@@ -1,4 +0,0 @@
#title getWaterColorBlendFactor [RCBasic Doc]
#header function getWaterColorBlendFactor( actor)

4
doc/files/getwaterwaveheight.txt
View File

@@ -1,4 +0,0 @@
#title getWaterWaveHeight [RCBasic Doc]
#header function getWaterWaveHeight( actor)

4
doc/files/getwaterwinddirection.txt
View File

@@ -1,4 +0,0 @@
#title getWaterWindDirection [RCBasic Doc]
#header sub getWaterWindDirection( actor, ByRef x, ByRef z)

4
doc/files/getwaterwindforce.txt
View File

@@ -1,4 +0,0 @@
#title getWaterWindForce [RCBasic Doc]
#header function getWaterWindForce( actor)

4
doc/files/lcase.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Lcase$ [RCBasic Doc] </title> <title>LCase$ [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function Lcase$(src$) </h2></p> <p><h2>function LCase$(src$) </h2></p>
<p> <p>
Returns src$ converted to a completely lower-case string Returns src$ converted to a completely lower-case string
</p> </p>

4
doc/files/lcase.txt
View File

@@ -1,4 +1,4 @@
#title Lcase$ [RCBasic Doc] #title LCase$ [RCBasic Doc]
#header function Lcase$(src$) #header function LCase$(src$)
Returns src$ converted to a completely lower-case string Returns src$ converted to a completely lower-case string

17
doc/files/line3d.html Normal file
View File

@@ -0,0 +1,17 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Line3D [RCBasic Doc] </title>
</head>
<body>
<p><h2>sub Line3D(x1, y1, z1, x2, y2, z2) </h2></p>
<p>
Draws a line in 3D space
</p>
<p>
</body>
</html>

4
doc/files/line3d.txt Normal file
View File

@@ -0,0 +1,4 @@
#title Line3D [RCBasic Doc]
#header sub Line3D(x1, y1, z1, x2, y2, z2)
Draws a line in 3D space

4
doc/files/loopactoranimation.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>loopActorAnimation [RCBasic Doc] </title> <title>LoopActorAnimation [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>sub loopActorAnimation( actor, flag ) </h2></p> <p><h2>sub LoopActorAnimation( actor, flag ) </h2></p>
<p> <p>
Enables or disables actor animation loop Enables or disables actor animation loop
</p> </p>

4
doc/files/loopactoranimation.txt
View File

@@ -1,4 +1,4 @@
#title loopActorAnimation [RCBasic Doc] #title LoopActorAnimation [RCBasic Doc]
#header sub loopActorAnimation( actor, flag ) #header sub LoopActorAnimation( actor, flag )
Enables or disables actor animation loop Enables or disables actor animation loop

8
doc/files/ltrim.html
View File

@@ -3,14 +3,18 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Ltrim$ [RCBasic Doc] </title> <title>LTrim$ [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function Ltrim$(src$) </h2></p> <p><h2>function LTrim$(src$) </h2></p>
<p> <p>
Returns src$ with all the spaces before the first non-space character removed. Returns src$ with all the spaces before the first non-space character removed.
</p> </p>
<br><p>Related:
<a href="rtrim.html">RTrim</a>
<a href="trim.html">Trim</a>
</p>
<p> <p>
</body> </body>

6
doc/files/ltrim.txt
View File

@@ -1,4 +1,6 @@
#title Ltrim$ [RCBasic Doc] #title LTrim$ [RCBasic Doc]
#header function Ltrim$(src$) #header function LTrim$(src$)
Returns src$ with all the spaces before the first non-space character removed. Returns src$ with all the spaces before the first non-space character removed.
#ref RTrim Trim

3
doc/files/materialexists.html
View File

@@ -9,6 +9,9 @@
<body> <body>
<p><h2>function MaterialExists( material ) </h2></p> <p><h2>function MaterialExists( material ) </h2></p>
<p> <p>
Returns true if the material id is an existing material
</p>
<p>
</body> </body>
</html> </html>

2
doc/files/materialexists.txt
View File

@@ -1,4 +1,4 @@
#title MaterialExists [RCBasic Doc] #title MaterialExists [RCBasic Doc]
#header function MaterialExists( material ) #header function MaterialExists( material )
Returns true if the material id is an existing material

4
doc/files/materialisaplhablend.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>materialIsAplhaBlend [RCBasic Doc] </title> <title>MaterialIsAplhaBlend [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function materialIsAplhaBlend( material_id) </h2></p> <p><h2>function MaterialIsAplhaBlend( material_id) </h2></p>
<p> <p>
Returns true if alpha blending is enabled for a material Returns true if alpha blending is enabled for a material
</p> </p>

4
doc/files/materialisaplhablend.txt
View File

@@ -1,4 +1,4 @@
#title materialIsAplhaBlend [RCBasic Doc] #title MaterialIsAplhaBlend [RCBasic Doc]
#header function materialIsAplhaBlend( material_id) #header function MaterialIsAplhaBlend( material_id)
Returns true if alpha blending is enabled for a material Returns true if alpha blending is enabled for a material

4
doc/files/materialisgouraudshaded.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>materialIsGouraudShaded [RCBasic Doc] </title> <title>MaterialIsGouraudShaded [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function materialIsGouraudShaded( material_id) </h2></p> <p><h2>function MaterialIsGouraudShaded( material_id ) </h2></p>
<p> <p>
Returns true if material is set to goraud shading Returns true if material is set to goraud shading
</p> </p>

4
doc/files/materialisgouraudshaded.txt
View File

@@ -1,4 +1,4 @@
#title materialIsGouraudShaded [RCBasic Doc] #title MaterialIsGouraudShaded [RCBasic Doc]
#header function materialIsGouraudShaded( material_id) #header function MaterialIsGouraudShaded( material_id )
Returns true if material is set to goraud shading Returns true if material is set to goraud shading

4
doc/files/materialislit.html
View File

@@ -3,11 +3,11 @@
<head> <head>
<link rel="stylesheet" href="style.css"> <link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type"> <meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>materialIsLit [RCBasic Doc] </title> <title>MaterialIsLit [RCBasic Doc] </title>
</head> </head>
<body> <body>
<p><h2>function materialIsLit( material_id) </h2></p> <p><h2>function MaterialIsLit( material_id ) </h2></p>
<p> <p>
Returns true if a material is affected by lights in the scene Returns true if a material is affected by lights in the scene
</p> </p>

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