HPL3/SOMA/Scripting/Scripting Api/cScene

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Jump to navigation Jump to search
Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type Function and Description
cCamera cScene_CreateCamera(eCameraMoveMode aMoveMode)
cViewport cScene_CreateViewport(cCamera @apCamera, cWorld @apWorld, bool abAddLast)
cWorld cScene_CreateWorld(const tString &in asName)
void cScene_DestroyCamera(cCamera@ apCam)
void cScene_DestroyViewport(cViewport@ apViewPort)
void cScene_DestroyWorld(cWorld@ apWorld)
void cScene_FadeGradingTexture(cWorld@ apWorld, iTexture@ apGrading, float afTime)
cWorld cScene_LoadWorld(const tString &in asFile, int aFlags)
void cScene_Reset()
void cScene_SetCurrentListener(cViewport@ apViewPort)
cBeam cScene_ToBeam(iEntity3D@ apEntity)
cBillboard cScene_ToBillboard(iEntity3D@ apEntity)
cForceField cScene_ToForceField(iEntity3D@ apEntity)
cLensFlare cScene_ToLensFlare(iEntity3D@ apEntity)
cLightBox cScene_ToLightBox(iLight@ apLight)
cLightDirectional cScene_ToLightDirectional(iLight@ apLight)
cLightPoint cScene_ToLightPoint(iLight@ apLight)
cLightSpot cScene_ToLightSpot(iLight@ apLight)
cMeshEntity cScene_ToMeshEntity(iEntity3D@ apEntity)
iRopeEntity cScene_ToRopeEntity(iEntity3D@ apEntity)
cRopeEntity3D cScene_ToRopeEntity3D(iEntity3D@ apEntity)
cRopeEntityBillboard cScene_ToRopeEntityBillboard(iEntity3D@ apEntity)
cSoundEntity cScene_ToSoundEntity(iEntity3D@ apEntity)
cSubMeshEntity cScene_ToSubMeshEntity(iEntity3D@ apEntity)
bool cScene_ViewportExists(cViewport@ apViewPort)
void cScene_WorldExists(cWorld@ apWorld)

Function Detail

cScene_CreateCamera

cCamera@ cScene_CreateCamera(eCameraMoveMode aMoveMode)


Parameters

Returns:

  • cCamera@—

cScene_CreateViewport

cViewport@ cScene_CreateViewport(cCamera @apCamera,
                                 cWorld @apWorld,
                                 bool abAddLast)


Parameters

  • @apCamera (cCamera) —
  • @apWorld (cWorld) —
  • abAddLast (bool) —

Returns:

  • cViewport@—

cScene_CreateWorld

cWorld@ cScene_CreateWorld(const tString &in asName)


Parameters

Returns:

  • cWorld@—

cScene_DestroyCamera

void cScene_DestroyCamera(cCamera@ apCam)


Parameters

Returns:

  • void

cScene_DestroyViewport

void cScene_DestroyViewport(cViewport@ apViewPort)


Parameters

Returns:

  • void

cScene_DestroyWorld

void cScene_DestroyWorld(cWorld@ apWorld)


Parameters

Returns:

  • void

cScene_FadeGradingTexture

void cScene_FadeGradingTexture(cWorld@ apWorld,
                               iTexture@ apGrading,
                               float afTime)


Parameters

Returns:

  • void

cScene_LoadWorld

cWorld@ cScene_LoadWorld(const tString &in asFile,
                         int aFlags)


Parameters

  • asFile (tString) —
  • aFlags (int) —

Returns:

  • cWorld@—

cScene_Reset

void cScene_Reset()

Returns:

  • void

cScene_SetCurrentListener

void cScene_SetCurrentListener(cViewport@ apViewPort)


Parameters

Returns:

  • void

cScene_ToBeam

cBeam@ cScene_ToBeam(iEntity3D@ apEntity)


Parameters

Returns:

  • cBeam@—

cScene_ToBillboard

cBillboard@ cScene_ToBillboard(iEntity3D@ apEntity)


Parameters

Returns:

  • cBillboard@—

cScene_ToForceField

cForceField@ cScene_ToForceField(iEntity3D@ apEntity)


Parameters

Returns:

  • cForceField@—

cScene_ToLensFlare

cLensFlare@ cScene_ToLensFlare(iEntity3D@ apEntity)


Parameters

Returns:

  • cLensFlare@—

cScene_ToLightBox

cLightBox@ cScene_ToLightBox(iLight@ apLight)


Parameters

Returns:

  • cLightBox@—

cScene_ToLightDirectional

cLightDirectional@ cScene_ToLightDirectional(iLight@ apLight)


Parameters

Returns:

  • cLightDirectional@—

cScene_ToLightPoint

cLightPoint@ cScene_ToLightPoint(iLight@ apLight)


Parameters

Returns:

  • cLightPoint@—

cScene_ToLightSpot

cLightSpot@ cScene_ToLightSpot(iLight@ apLight)


Parameters

Returns:

  • cLightSpot@—

cScene_ToMeshEntity

cMeshEntity@ cScene_ToMeshEntity(iEntity3D@ apEntity)


Parameters

Returns:

  • cMeshEntity@—

cScene_ToRopeEntity

iRopeEntity@ cScene_ToRopeEntity(iEntity3D@ apEntity)


Parameters

Returns:

  • iRopeEntity@—

cScene_ToRopeEntity3D

cRopeEntity3D@ cScene_ToRopeEntity3D(iEntity3D@ apEntity)


Parameters

Returns:

  • cRopeEntity3D@—

cScene_ToRopeEntityBillboard

cRopeEntityBillboard@ cScene_ToRopeEntityBillboard(iEntity3D@ apEntity)


Parameters

Returns:

  • cRopeEntityBillboard@—

cScene_ToSoundEntity

cSoundEntity@ cScene_ToSoundEntity(iEntity3D@ apEntity)


Parameters

Returns:

  • cSoundEntity@—

cScene_ToSubMeshEntity

cSubMeshEntity@ cScene_ToSubMeshEntity(iEntity3D@ apEntity)


Parameters

Returns:

  • cSubMeshEntity@—

cScene_ViewportExists

bool cScene_ViewportExists(cViewport@ apViewPort)


Parameters

Returns:

  • bool—

cScene_WorldExists

void cScene_WorldExists(cWorld@ apWorld)


Parameters

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/cScene&oldid=5023"