Serenity3D Actors API

Function Serenity_GetActorIndex(actor_name$)

• Returns the Serenity Actor Index which is used to access actor data in the API

Function Serenity_GetActorCount()

• Returns the number of actors in the current stage
  • NOTE: This count only includes actors that were created in Serenity3D

Function Serenity_GetActorID(actor_index)

• Returns the RCBasic Actor ID

Function Serenity_GetActorName$(actor_index)

• Returns the name of the actor from the given Serenity Actor Index

Function Serenity_GetActorType(actor_index)

• Returns the actor type
• Possible values are
  • SN_ACTOR_TYPE_ANIMATED
  • SN_ACTOR_TYPE_OCTREE
  • SN_ACTOR_TYPE_LIGHT
  • SN_ACTOR_TYPE_BILLBOARD
  • SN_ACTOR_TYPE_TERRAIN
  • SN_ACTOR_TYPE_WATER
  • SN_ACTOR_TYPE_PARTICLE
  • SN_ACTOR_TYPE_CUBE
  • SN_ACTOR_TYPE_SPHERE
  • SN_ACTOR_TYPE_PLANE

Function Serenity_GetActorMeshIndex(actor_index)

• Returns the Serenity Mesh index the actor was created from

Function Serenity_GetActorOverrideMaterialIndex(actor_index)

• Returns the material index set in an actors properties on the Stage Editor tab

Function Serenity_GetActorTerrainHeightMap$(actor_index)

• Returns the height map file for a terrain actor

Function Serenity_GetActorCubeSize(actor_index)

• Returns the cube size for a cube actor

Function Serenity_GetActorSphereRadius(actor_index)

• Returns the sphere radius for a sphere actor

Function Serenity_GetActorGroupIndex(actor_index)

• Returns the Serenity Group Index the actor is grouped in or -1 if the actor is not part of a group