Serenity3D Stages API

Function Serenity_GetSkyShape()

• Returns the Serenity Actor Index which is used to access actor data in the API
• Possible values are:
  • SN_SKY_TYPE_NONE
  • SN_SKY_TYPE_BOX
  • SN_SKY_TYPE_DOME

Function Serenity_GetSkyBox() As Serenity_Sky_Box

• Returns the sky box for the current stage

Function Serenity_GetSkyDome() As Serenity_Sky_Dome

• Returns the sky dome for the current stage

Function Serenity_StageHasSky()

• Returns TRUE if the stage has a sky object and FALSE otherwise

Function Serenity_GetStageIndex(stage_name$)

• Returns the Serenity Stage Index or -1 if the stage name was not found in the project

Function Serenity_GetStageName$(stage_index)

• Returns the name of the stage from the index

Function Serenity_GetStageCount()

• Returns the number of stages in the project

Sub Serenity_ClearStage()

• Clears the currently loaded stage

Sub Serenity_LoadStage(stage_name$)

• Loads a stage
  • NOTE: Its a good idea to get the stage index first to make sure the stage exists

Function Serenity_GetCurrentStageIndex()

• Returns the index of the currently loaded stage

Function Serenity_GetActorIndexFromStage(stage_actor_index)

• Returns the actor index based on the order it was created in the current stage
• NOTE: This is mainly for when you want to loop through all the actors a stage.