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

Added new functions to documentation

Browse Source
This commit is contained in:
n00b87
2025-08-13 19:20:25 -05:00
parent 6ad655f40d
commit 4b2f517de4
152 changed files with 8947 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

175
doc/serenity_docs/serenity_api_actors.html Normal file
View File

@@ -0,0 +1,175 @@
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="style.css">
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>Serenity3D [RCBasic Doc] </title>
</head>
<body>
<p><h2>Serenity3D Actors API </h2></p>
<p>
<b>Function Serenity_GetActorIndex(actor_name$)</b>
</p>
<ul>
<li>
Returns the Serenity Actor Index which is used to access actor data in the API
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorCount()</b>
</p>
<ul>
<li>
Returns the number of actors in the current stage
<ul>
<li>
NOTE: This count only includes actors that were created in Serenity3D
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorID(actor_index)</b>
</p>
<ul>
<li>
Returns the RCBasic Actor ID
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorName$(actor_index)</b>
</p>
<ul>
<li>
Returns the name of the actor from the given Serenity Actor Index
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorType(actor_index)</b>
</p>
<ul>
<li>
Returns the actor type
</li>
<li>
Possible values are
<ul>
<li>
SN_ACTOR_TYPE_ANIMATED
</li>
<li>
SN_ACTOR_TYPE_OCTREE
</li>
<li>
SN_ACTOR_TYPE_LIGHT
</li>
<li>
SN_ACTOR_TYPE_BILLBOARD
</li>
<li>
SN_ACTOR_TYPE_TERRAIN
</li>
<li>
SN_ACTOR_TYPE_WATER
</li>
<li>
SN_ACTOR_TYPE_PARTICLE
</li>
<li>
SN_ACTOR_TYPE_CUBE
</li>
<li>
SN_ACTOR_TYPE_SPHERE
</li>
<li>
SN_ACTOR_TYPE_PLANE
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorMeshIndex(actor_index)</b>
</p>
<ul>
<li>
Returns the Serenity Mesh index the actor was created from
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorOverrideMaterialIndex(actor_index)</b>
</p>
<ul>
<li>
Returns the material index set in an actors properties on the Stage Editor tab
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorTerrainHeightMap$(actor_index)</b>
</p>
<ul>
<li>
Returns the height map file for a terrain actor
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorCubeSize(actor_index)</b>
</p>
<ul>
<li>
Returns the cube size for a cube actor
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorSphereRadius(actor_index)</b>
</p>
<ul>
<li>
Returns the sphere radius for a sphere actor
</li>
</ul>
<p>
<br>
</p>
<p>
<b>Function Serenity_GetActorGroupIndex(actor_index)</b>
</p>
<ul>
<li>
Returns the Serenity Group Index the actor is grouped in or -1 if the actor is not part of a group
</li>
</ul>
<p>
<br>
</p>
<p>
</body>
</html>