HPL3/Amnesia: Rebirth/Scripting/cWorld

From Frictional Wiki
Jump to navigation Jump to search

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

Contents

Fields

cWorld has no public fields.

Functions

Return Type Function And Description
void AddBillboardToGroup(cBillboard@ apObject, cBillboardGroup@ apGroup)
void Compile(bool abCalcPhysicsWorldSize)
cBeam CreateBeam(const tString &in asName, bool abStatic)
tID CreateBeamID(const tString &in asName, bool abStatic)
cBillboard CreateBillboard(const tString &in asName, const cVector2f &in avSize, eBillboardType aType, const tString &in asMaterial, bool abStatic)
cBillboardGroup CreateBillboardGroup(const tString &in asName, const tString &in asMaterial, bool abStatic)
tID CreateBillboardGroupID(const tString &in asName, const tString &in asMaterial, bool abStatic)
tID CreateBillboardID(const tString &in asName, const cVector2f &in avSize, eBillboardType aType, const tString &in asMaterial, bool abStatic)
cClothEntity CreateClothEntity(const tString &in asName, iPhysicsCloth@ apCloth, const tString &in asMaterial = "")
tID CreateClothEntityID(const tString &in asName, iPhysicsCloth@ apCloth, const tString &in asMaterial = "")
cExposureArea CreateExposureArea(const tString &in asName)
tID CreateExposureAreaID(const tString &in asName)
cFogArea CreateFogArea(const tString &in asName, bool abStatic)
tID CreateFogAreaID(const tString &in asName, bool abStatic)
cForceField CreateForceField(const tString &in asName, bool abAutoRemove, bool abStatic)
tID CreateForceFieldID(const tString &in asName, bool abAutoRemove, bool abStatic)
cGuiSetEntity CreateGuiSetEntity(const tString &in asName, cGuiSet@ apSet, bool abStatic)
tID CreateGuiSetEntityID(const tString &in asName, cGuiSet@ apSet, bool abStatic)
cLensFlare CreateLensFlare(const tString &in asName, const cVector2f &in avSize, const tString &in asMaterial, bool abStatic)
tID CreateLensFlareID(const tString &in asName, const cVector2f &in avSize, const tString &in asMaterial, bool abStatic)
cLightBox CreateLightBox(const tString &in asName, bool abStatic)
tID CreateLightBoxID(const tString &in asName, bool abStatic)
cLightPoint CreateLightPoint(const tString &in asName, const tString &in asGobo, bool abStatic)
tID CreateLightPointID(const tString &in asName, const tString &in asGobo, bool abStatic)
cLightSpot CreateLightSpot(const tString &in asName, const tString &in asGobo, bool abStatic)
tID CreateLightSpotID(const tString &in asName, const tString &in asGobo, bool abStatic)
cMeshEntity CreateMeshEntity(const tString &in asName, cMesh@ apMesh, bool abStatic)
tID CreateMeshEntityID(const tString &in asName, cMesh@ apMesh, bool abStatic)
cParticleSystem CreateParticleSystem(const tString &in asName, const tString &in asType, const cVector3f &in avSize, bool abRemoveWhenDead, bool abStatic)
tID CreateParticleSystemID(const tString &in asName, const tString &in asType, const cVector3f &in avSize, bool abRemoveWhenDead, bool abStatic)
iRopeEntity CreateRopeEntity(const tString &in asName, eRopeType aRopeType, iPhysicsRope@ apRope, int alMaxSegments, int alRingSegments = 3)
tID CreateRopeEntityID(const tString &in asName, eRopeType aRopeType, iPhysicsRope@ apRope, int alMaxSegments, int alRingSegments = 3)
cSoundEntity CreateSoundEntity(const tString &in asName, const tString &in asSoundDataFile, bool abRemoveWhenOver)
cSoundEntity CreateSoundEntityEx(const tString &in asName, const tString &in asSoundDataFile, bool abRemoveWhenOver, bool abNonBlockLoad)
tID CreateSoundEntityExID(const tString &in asName, const tString &in asSoundDataFile, bool abRemoveWhenOver, bool abNonBlockLoad)
tID CreateSoundEntityID(const tString &in asName, const tString &in asSoundDataFile, bool abRemoveWhenOver)
void DestroyAllParticleSystems()
void DestroyAllSoundEntities()
void DestroyBeam(cBeam@ apObject)
void DestroyBillboard(cBillboard@ apObject)
void DestroyBillboardGroup(cBillboardGroup@ apObject)
void DestroyClothEntity(cClothEntity@ apCloth)
void DestroyExposureArea(cExposureArea@ apExposureArea)
void DestroyFogArea(cFogArea@ apFogArea)
void DestroyForceField(cForceField@ apForce)
void DestroyGuiSetEntity(cGuiSetEntity@ apObject)
void DestroyLensFlare(cLensFlare@ apObject)
void DestroyLight(iLight@ apLight)
void DestroyMeshEntity(cMeshEntity@ apMesh)
void DestroyParticleSystem(cParticleSystem@ apPS)
void DestroyRopeEntity(iRopeEntity@ apRope)
void DestroySoundEntity(cSoundEntity@ apEntity)
void FadeGradingTexture(const tString &in asTexture, float afTime)
void FadeInIrradianceSet(const tString &in asSetName, float afTime)
void FadeToneMappingExposure(float afX, float afTime)
void FadeToneMappingWhiteCut(float afX, float afTime)
cBeam GetBeam(const tString &in asName)
cBeam GetBeamFromID(tID alID)
cBeamIterator GetBeamIterator()
cBillboard GetBillboard(const tString &in asName)
cBillboard GetBillboardFromID(tID alID)
cBillboardGroup GetBillboardGroup(const tString &in asName)
cBillboardGroup GetBillboardGroupFromID(tID alID)
cBillboardGroupIterator GetBillboardGroupIterator()
cBillboardIterator GetBillboardIterator()
cClothEntity GetClothEntity(const tString &in asName)
cClothEntity GetClothEntityFromID(tID alID)
cClothEntityIterator GetClothEntityIterator()
eIDSpace GetCurrentIDSpace()
iTexture GetDepthOfFieldBokehTexture()
float GetDepthOfFieldFalloff()
float GetDepthOfFieldFocusEnd()
float GetDepthOfFieldFocusStart()
cLightDirectional GetDirectionalLight()
bool GetDirectionalLightActive()
bool GetDistanceCullActive()
float GetDistanceCullFadeSpeed()
float GetDistanceCullMaxRange()
float GetDistanceCullMinRange()
float GetDistanceCullRandomSize()
float GetDistanceCullScreenSize()
cMeshEntity GetDynamicMeshEntity(const tString &in asName)
cMeshEntityIterator GetDynamicMeshEntityIterator()
iEntity3D GetEntityFromID(tID aID)
int GetEnvironmentParticleNum()
cEnvironmentParticles GetEnvironmentParticles(int i)
bool GetEnvironmentParticlesActive()
cExposureArea GetExposureArea(const tString &in asName)
cExposureArea GetExposureAreaFromID(tID alID)
cExposureAreaIterator GetExposureAreaIterator()
bool GetFogActive()
bool GetFogApplyAfterFogAreas()
cFogArea GetFogArea(const tString &in asName)
cFogArea GetFogAreaFromID(tID alID)
cFogAreaIterator GetFogAreaIterator()
float GetFogBrightness()
cColor GetFogColor()
bool GetFogCulling()
float GetFogDensity()
float GetFogEnd()
bool GetFogExponential()
float GetFogFalloffExp()
bool GetFogHeightBased()
float GetFogHeightDensity()
float GetFogHeightHorizon()
bool GetFogLighten()
iTexture GetFogSkyboxTexture()
float GetFogStart()
bool GetFogUnderwater()
bool GetFogUseSkybox()
cForceField GetForceField(const tString &in asName)
cForceField GetForceFieldFromID(tID alID)
cForceFieldIterator GetForceFieldIterator()
cGuiSetEntity GetGuiSetEntity(const tString &in asName)
cGuiSetEntity GetGuiSetEntityFromID(tID alID)
cGuiSetEntityIterator GetGuiSetEntityIterator()
cLensFlare GetLensFlare(const tString &in asName)
cLensFlare GetLensFlareFromID(tID alID)
cLensFlareIterator GetLensFlareIterator()
iLight GetLight(const tString &in asName)
iLight GetLightFromID(tID aID)
cLightListIterator GetLightIterator()
cLightMaskBox GetLightMask(const tString &in asName)
cLightMaskBoxListIterator GetLightMaskBoxIterator()
cMeshEntity GetMeshEntityFromID(tID aID)
tString GetName()
float GetNightVisionBrightness()
cColor GetNightVisionColor()
float GetNightVisionFalloff()
float GetNightVisionRadiusMax()
float GetNightVisionRadiusMin()
bool GetNightVisionVisible()
cParticleSystem GetParticleSystem(const tString &in asName)
cParticleSystem GetParticleSystemFromID(tID alID)
cParticleSystemIterator GetParticleSystemIterator()
iPhysicsWorld GetPhysicsWorld()
iRopeEntity GetRopeEntity(const tString &in asName)
iRopeEntity GetRopeEntityFromID(tID alID)
cRopeEntityIterator GetRopeEntityIterator()
bool GetSecondaryFogActive()
float GetSecondaryFogBrightness()
cColor GetSecondaryFogColor()
float GetSecondaryFogDensity()
float GetSecondaryFogEnd()
float GetSecondaryFogFalloffExp()
float GetSecondaryFogHeightDensity()
float GetSecondaryFogHeightHorizon()
float GetSecondaryFogStart()
bool GetSkyBoxActive()
float GetSkyBoxBrightness()
cColor GetSkyBoxColor()
cVector3f GetSkyboxRotation()
iTexture GetSkyBoxTexture()
iVertexBuffer GetSkyBoxVertexBuffer()
cSoundEntity GetSoundEntity(const tString &in asName)
cSoundEntity GetSoundEntityFromCreationID(int alID)
cSoundEntity GetSoundEntityFromID(tID alID)
cSoundEntityIterator GetSoundEntityIterator()
cMeshEntityIterator GetStaticMeshEntityIterator()
cSubMeshEntity GetSubMeshEntityFromID(tID aID)
void GetSubMeshEntityInArea(array<cSubMeshEntity@> avObjects, const cVector3f &in avMin, const cVector3f &in avMax)
cTerrain GetTerrain()
bool GetTerrainActive()
float GetToneMappingExposure()
float GetToneMappingFadeTime()
float GetToneMappingKey()
float GetToneMappingWhiteCut()
cVector3f GetWorldSize()
bool IsActive()
bool IsDepthOfFieldActive()
bool IsValid(cSoundEntity@ apEntity)
bool ParticleSystemExists(cParticleSystem@ apPS)
void RemoveBillboardFromGroup(cBillboard@ apObject, cBillboardGroup@ apGroup)
void SetActive(bool abX)
void SetCurrentIDSpace(eIDSpace aSpace)
void SetDefaultGradingTexture(iTexture@ apGrading)
void SetDepthOfFieldActive(bool abX)
void SetDepthOfFieldBokehTexture(iTexture@ apTexture)
void SetDepthOfFieldFalloff(float afX)
void SetDepthOfFieldFocusEnd(float afX)
void SetDepthOfFieldFocusStart(float afX)
void SetDirectionalLightActive(bool abX)
void SetDistanceCullActive(bool abX)
void SetDistanceCullFadeSpeed(float afX)
void SetDistanceCullMaxRange(float afX)
void SetDistanceCullMinRange(float afX)
void SetDistanceCullRandomSize(float afX)
void SetDistanceCullScreenSize(float afX)
tID SetEntityID(iEntity3D@ apEntity, tID alID)
tID SetEntityID(iEntity3D@ apEntity, eIDSpace aSpace, uint alLocation, uint alInner)
void SetEnvironmentParticlesActive(bool abX)
void SetFogActive(bool abX)
void SetFogApplyAfterFogAreas(bool abX)
void SetFogBrightness(float afX)
void SetFogColor(const cColor &in aCol)
void SetFogCulling(bool abX)
void SetFogDensity(float afX)
void SetFogEnd(float afX)
void SetFogExponential(bool abX)
void SetFogFalloffExp(float afX)
void SetFogHeightBased(bool abX)
void SetFogHeightDensity(float afX)
void SetFogHeightHorizon(float afX)
void SetFogLighten(bool abX)
void SetFogSkyboxTexture(iTexture@ apTexture)
void SetFogStart(float afX)
void SetFogUnderwater(bool abX)
void SetFogUseSkybox(bool abX)
void SetMainRenderableContainerVisible(bool abX)
void SetNightVisionBrightness(float afBrightness)
void SetNightVisionColor(const cColor &in aColor)
void SetNightVisionFalloff(float afFalloff)
void SetNightVisionRadiusMax(float afRadius)
void SetNightVisionRadiusMin(float afRadius)
void SetPhysicsWorld(iPhysicsWorld@ apWorld, bool abAutoDelete)
void SetSecondaryFogActive(bool abX)
void SetSecondaryFogBrightness(float afX)
void SetSecondaryFogColor(const cColor &in aCol)
void SetSecondaryFogDensity(float afX)
void SetSecondaryFogEnd(float afX)
void SetSecondaryFogFalloffExp(float afX)
void SetSecondaryFogHeightDensity(float afX)
void SetSecondaryFogHeightHorizon(float afX)
void SetSecondaryFogStart(float afX)
void SetSkyBox(iTexture@ apTexture, bool abAutoDestroy)
void SetSkyBoxActive(bool abX)
void SetSkyBoxBrightness(float afX)
void SetSkyBoxColor(const cColor &in aColor)
void SetSkyboxRotation(const cVector3f &in avX)
void SetTerrainActive(bool abX)
void SetToneMappingKey(float afX)
bool SoundEntityExists(cSoundEntity@ apEntity, int alCreationID)
void Update(float afTimeStep)

Details

AddBillboardToGroup

void AddBillboardToGroup(cBillboard@ apObject,
                         cBillboardGroup@ apGroup)


Parameters

Returns:

  • void

Compile

void Compile(bool abCalcPhysicsWorldSize)


Parameters

  • abCalcPhysicsWorldSize (bool) —

Returns:

  • void

CreateBeam

cBeam@ CreateBeam(const tString &in asName,
                  bool abStatic)


Parameters

  • asName (tString) —
  • abStatic (bool) —

Returns:

  • cBeam@

CreateBeamID

tID CreateBeamID(const tString &in asName,
                 bool abStatic)


Parameters

  • asName (tString) —
  • abStatic (bool) —

Returns:

  • tID

CreateBillboard

cBillboard@ CreateBillboard(const tString &in asName,
                            const cVector2f &in avSize,
                            eBillboardType aType,
                            const tString &in asMaterial,
                            bool abStatic)


Parameters

Returns:

  • cBillboard@

CreateBillboardGroup

cBillboardGroup@ CreateBillboardGroup(const tString &in asName,
                                      const tString &in asMaterial,
                                      bool abStatic)


Parameters

Returns:

  • cBillboardGroup@

CreateBillboardGroupID

tID CreateBillboardGroupID(const tString &in asName,
                           const tString &in asMaterial,
                           bool abStatic)


Parameters

Returns:

  • tID

CreateBillboardID

tID CreateBillboardID(const tString &in asName,
                      const cVector2f &in avSize,
                      eBillboardType aType,
                      const tString &in asMaterial,
                      bool abStatic)


Parameters

Returns:

  • tID

CreateClothEntity

cClothEntity@ CreateClothEntity(const tString &in asName,
                                iPhysicsCloth@ apCloth,
                                const tString &in asMaterial = "")


Parameters

Returns:

  • cClothEntity@

CreateClothEntityID

tID CreateClothEntityID(const tString &in asName,
                        iPhysicsCloth@ apCloth,
                        const tString &in asMaterial = "")


Parameters

Returns:

  • tID

CreateExposureArea

cExposureArea@ CreateExposureArea(const tString &in asName)


Parameters

Returns:

  • cExposureArea@

CreateExposureAreaID

tID CreateExposureAreaID(const tString &in asName)


Parameters

Returns:

  • tID

CreateFogArea

cFogArea@ CreateFogArea(const tString &in asName,
                        bool abStatic)


Parameters

  • asName (tString) —
  • abStatic (bool) —

Returns:

  • cFogArea@

CreateFogAreaID

tID CreateFogAreaID(const tString &in asName,
                    bool abStatic)


Parameters

  • asName (tString) —
  • abStatic (bool) —

Returns:

  • tID

CreateForceField

cForceField@ CreateForceField(const tString &in asName,
                              bool abAutoRemove,
                              bool abStatic)


Parameters

  • asName (tString) —
  • abAutoRemove (bool) —
  • abStatic (bool) —

Returns:

  • cForceField@

CreateForceFieldID

tID CreateForceFieldID(const tString &in asName,
                       bool abAutoRemove,
                       bool abStatic)


Parameters

  • asName (tString) —
  • abAutoRemove (bool) —
  • abStatic (bool) —

Returns:

  • tID

CreateGuiSetEntity

cGuiSetEntity@ CreateGuiSetEntity(const tString &in asName,
                                  cGuiSet@ apSet,
                                  bool abStatic)


Parameters

Returns:

  • cGuiSetEntity@

CreateGuiSetEntityID

tID CreateGuiSetEntityID(const tString &in asName,
                         cGuiSet@ apSet,
                         bool abStatic)


Parameters

Returns:

  • tID

CreateLensFlare

cLensFlare@ CreateLensFlare(const tString &in asName,
                            const cVector2f &in avSize,
                            const tString &in asMaterial,
                            bool abStatic)


Parameters

Returns:

  • cLensFlare@

CreateLensFlareID

tID CreateLensFlareID(const tString &in asName,
                      const cVector2f &in avSize,
                      const tString &in asMaterial,
                      bool abStatic)


Parameters

Returns:

  • tID

CreateLightBox

cLightBox@ CreateLightBox(const tString &in asName,
                          bool abStatic)


Parameters

  • asName (tString) —
  • abStatic (bool) —

Returns:

  • cLightBox@

CreateLightBoxID

tID CreateLightBoxID(const tString &in asName,
                     bool abStatic)


Parameters

  • asName (tString) —
  • abStatic (bool) —

Returns:

  • tID

CreateLightPoint

cLightPoint@ CreateLightPoint(const tString &in asName,
                              const tString &in asGobo,
                              bool abStatic)


Parameters

Returns:

  • cLightPoint@

CreateLightPointID

tID CreateLightPointID(const tString &in asName,
                       const tString &in asGobo,
                       bool abStatic)


Parameters

Returns:

  • tID

CreateLightSpot

cLightSpot@ CreateLightSpot(const tString &in asName,
                            const tString &in asGobo,
                            bool abStatic)


Parameters

Returns:

  • cLightSpot@

CreateLightSpotID

tID CreateLightSpotID(const tString &in asName,
                      const tString &in asGobo,
                      bool abStatic)


Parameters

Returns:

  • tID

CreateMeshEntity

cMeshEntity@ CreateMeshEntity(const tString &in asName,
                              cMesh@ apMesh,
                              bool abStatic)


Parameters

Returns:

  • cMeshEntity@

CreateMeshEntityID

tID CreateMeshEntityID(const tString &in asName,
                       cMesh@ apMesh,
                       bool abStatic)


Parameters

Returns:

  • tID

CreateParticleSystem

cParticleSystem@ CreateParticleSystem(const tString &in asName,
                                      const tString &in asType,
                                      const cVector3f &in avSize,
                                      bool abRemoveWhenDead,
                                      bool abStatic)


Parameters

Returns:

  • cParticleSystem@

CreateParticleSystemID

tID CreateParticleSystemID(const tString &in asName,
                           const tString &in asType,
                           const cVector3f &in avSize,
                           bool abRemoveWhenDead,
                           bool abStatic)


Parameters

Returns:

  • tID

CreateRopeEntity

iRopeEntity@ CreateRopeEntity(const tString &in asName,
                              eRopeType aRopeType,
                              iPhysicsRope@ apRope,
                              int alMaxSegments,
                              int alRingSegments = 3)


Parameters

Returns:

  • iRopeEntity@

CreateRopeEntityID

tID CreateRopeEntityID(const tString &in asName,
                       eRopeType aRopeType,
                       iPhysicsRope@ apRope,
                       int alMaxSegments,
                       int alRingSegments = 3)


Parameters

Returns:

  • tID

CreateSoundEntity

cSoundEntity@ CreateSoundEntity(const tString &in asName,
                                const tString &in asSoundDataFile,
                                bool abRemoveWhenOver)


Parameters

  • asName (tString) —
  • asSoundDataFile (tString) —
  • abRemoveWhenOver (bool) —

Returns:

  • cSoundEntity@

CreateSoundEntityEx

cSoundEntity@ CreateSoundEntityEx(const tString &in asName,
                                  const tString &in asSoundDataFile,
                                  bool abRemoveWhenOver,
                                  bool abNonBlockLoad)


Parameters

  • asName (tString) —
  • asSoundDataFile (tString) —
  • abRemoveWhenOver (bool) —
  • abNonBlockLoad (bool) —

Returns:

  • cSoundEntity@

CreateSoundEntityExID

tID CreateSoundEntityExID(const tString &in asName,
                          const tString &in asSoundDataFile,
                          bool abRemoveWhenOver,
                          bool abNonBlockLoad)


Parameters

  • asName (tString) —
  • asSoundDataFile (tString) —
  • abRemoveWhenOver (bool) —
  • abNonBlockLoad (bool) —

Returns:

  • tID

CreateSoundEntityID

tID CreateSoundEntityID(const tString &in asName,
                        const tString &in asSoundDataFile,
                        bool abRemoveWhenOver)


Parameters

  • asName (tString) —
  • asSoundDataFile (tString) —
  • abRemoveWhenOver (bool) —

Returns:

  • tID

DestroyAllParticleSystems

void DestroyAllParticleSystems()

Returns:

  • void

DestroyAllSoundEntities

void DestroyAllSoundEntities()

Returns:

  • void

DestroyBeam

void DestroyBeam(cBeam@ apObject)


Parameters

Returns:

  • void

DestroyBillboard

void DestroyBillboard(cBillboard@ apObject)


Parameters

Returns:

  • void

DestroyBillboardGroup

void DestroyBillboardGroup(cBillboardGroup@ apObject)


Parameters

Returns:

  • void

DestroyClothEntity

void DestroyClothEntity(cClothEntity@ apCloth)


Parameters

Returns:

  • void

DestroyExposureArea

void DestroyExposureArea(cExposureArea@ apExposureArea)


Parameters

Returns:

  • void

DestroyFogArea

void DestroyFogArea(cFogArea@ apFogArea)


Parameters

Returns:

  • void

DestroyForceField

void DestroyForceField(cForceField@ apForce)


Parameters

Returns:

  • void

DestroyGuiSetEntity

void DestroyGuiSetEntity(cGuiSetEntity@ apObject)


Parameters

Returns:

  • void

DestroyLensFlare

void DestroyLensFlare(cLensFlare@ apObject)


Parameters

Returns:

  • void

DestroyLight

void DestroyLight(iLight@ apLight)


Parameters

Returns:

  • void

DestroyMeshEntity

void DestroyMeshEntity(cMeshEntity@ apMesh)


Parameters

Returns:

  • void

DestroyParticleSystem

void DestroyParticleSystem(cParticleSystem@ apPS)


Parameters

Returns:

  • void

DestroyRopeEntity

void DestroyRopeEntity(iRopeEntity@ apRope)


Parameters

Returns:

  • void

DestroySoundEntity

void DestroySoundEntity(cSoundEntity@ apEntity)


Parameters

Returns:

  • void

FadeGradingTexture

void FadeGradingTexture(const tString &in asTexture,
                        float afTime)


Parameters

  • asTexture (tString) —
  • afTime (float) —

Returns:

  • void

FadeInIrradianceSet

void FadeInIrradianceSet(const tString &in asSetName,
                         float afTime)


Parameters

  • asSetName (tString) —
  • afTime (float) —

Returns:

  • void

FadeToneMappingExposure

void FadeToneMappingExposure(float afX,
                             float afTime)


Parameters

  • afX (float) —
  • afTime (float) —

Returns:

  • void

FadeToneMappingWhiteCut

void FadeToneMappingWhiteCut(float afX,
                             float afTime)


Parameters

  • afX (float) —
  • afTime (float) —

Returns:

  • void

GetBeam

cBeam@ GetBeam(const tString &in asName)


Parameters

Returns:

  • cBeam@

GetBeamFromID

cBeam@ GetBeamFromID(tID alID)


Parameters

Returns:

  • cBeam@

GetBeamIterator

cBeamIterator@ GetBeamIterator()

Returns:

  • cBeamIterator@

GetBillboard

cBillboard@ GetBillboard(const tString &in asName)


Parameters

Returns:

  • cBillboard@

GetBillboardFromID

cBillboard@ GetBillboardFromID(tID alID)


Parameters

Returns:

  • cBillboard@

GetBillboardGroup

cBillboardGroup@ GetBillboardGroup(const tString &in asName)


Parameters

Returns:

  • cBillboardGroup@

GetBillboardGroupFromID

cBillboardGroup@ GetBillboardGroupFromID(tID alID)


Parameters

Returns:

  • cBillboardGroup@

GetBillboardGroupIterator

cBillboardGroupIterator@ GetBillboardGroupIterator()

Returns:

  • cBillboardGroupIterator@

GetBillboardIterator

cBillboardIterator@ GetBillboardIterator()

Returns:

  • cBillboardIterator@

GetClothEntity

cClothEntity@ GetClothEntity(const tString &in asName)


Parameters

Returns:

  • cClothEntity@

GetClothEntityFromID

cClothEntity@ GetClothEntityFromID(tID alID)


Parameters

Returns:

  • cClothEntity@

GetClothEntityIterator

cClothEntityIterator@ GetClothEntityIterator()

Returns:

  • cClothEntityIterator@

GetCurrentIDSpace

eIDSpace GetCurrentIDSpace()

Returns:

  • eIDSpace

GetDepthOfFieldBokehTexture

iTexture@ GetDepthOfFieldBokehTexture()

Returns:

  • iTexture@

GetDepthOfFieldFalloff

float GetDepthOfFieldFalloff()

Returns:

  • float

GetDepthOfFieldFocusEnd

float GetDepthOfFieldFocusEnd()

Returns:

  • float

GetDepthOfFieldFocusStart

float GetDepthOfFieldFocusStart()

Returns:

  • float

GetDirectionalLight

cLightDirectional@ GetDirectionalLight()

Returns:

  • cLightDirectional@

GetDirectionalLightActive

bool GetDirectionalLightActive()

Returns:

  • bool

GetDistanceCullActive

bool GetDistanceCullActive()

Returns:

  • bool

GetDistanceCullFadeSpeed

float GetDistanceCullFadeSpeed()

Returns:

  • float

GetDistanceCullMaxRange

float GetDistanceCullMaxRange()

Returns:

  • float

GetDistanceCullMinRange

float GetDistanceCullMinRange()

Returns:

  • float

GetDistanceCullRandomSize

float GetDistanceCullRandomSize()

Returns:

  • float

GetDistanceCullScreenSize

float GetDistanceCullScreenSize()

Returns:

  • float

GetDynamicMeshEntity

cMeshEntity@ GetDynamicMeshEntity(const tString &in asName)


Parameters

Returns:

  • cMeshEntity@

GetDynamicMeshEntityIterator

cMeshEntityIterator@ GetDynamicMeshEntityIterator()

Returns:

  • cMeshEntityIterator@

GetEntityFromID

iEntity3D@ GetEntityFromID(tID aID)


Parameters

Returns:

  • iEntity3D@

GetEnvironmentParticleNum

int GetEnvironmentParticleNum()

Returns:

  • int

GetEnvironmentParticles

cEnvironmentParticles@ GetEnvironmentParticles(int i)


Parameters

  • i (int) —

Returns:

  • cEnvironmentParticles@

GetEnvironmentParticlesActive

bool GetEnvironmentParticlesActive()

Returns:

  • bool

GetExposureArea

cExposureArea@ GetExposureArea(const tString &in asName)


Parameters

Returns:

  • cExposureArea@

GetExposureAreaFromID

cExposureArea@ GetExposureAreaFromID(tID alID)


Parameters

Returns:

  • cExposureArea@

GetExposureAreaIterator

cExposureAreaIterator@ GetExposureAreaIterator()

Returns:

  • cExposureAreaIterator@

GetFogActive

bool GetFogActive()

Returns:

  • bool

GetFogApplyAfterFogAreas

bool GetFogApplyAfterFogAreas()

Returns:

  • bool

GetFogArea

cFogArea@ GetFogArea(const tString &in asName)


Parameters

Returns:

  • cFogArea@

GetFogAreaFromID

cFogArea@ GetFogAreaFromID(tID alID)


Parameters

Returns:

  • cFogArea@

GetFogAreaIterator

cFogAreaIterator@ GetFogAreaIterator()

Returns:

  • cFogAreaIterator@

GetFogBrightness

float GetFogBrightness()

Returns:

  • float

GetFogColor

const cColor& GetFogColor()

Returns:

  • const cColor&

GetFogCulling

bool GetFogCulling()

Returns:

  • bool

GetFogDensity

float GetFogDensity()

Returns:

  • float

GetFogEnd

float GetFogEnd()

Returns:

  • float

GetFogExponential

bool GetFogExponential()

Returns:

  • bool

GetFogFalloffExp

float GetFogFalloffExp()

Returns:

  • float

GetFogHeightBased

bool GetFogHeightBased()

Returns:

  • bool

GetFogHeightDensity

float GetFogHeightDensity()

Returns:

  • float

GetFogHeightHorizon

float GetFogHeightHorizon()

Returns:

  • float

GetFogLighten

bool GetFogLighten()

Returns:

  • bool

GetFogSkyboxTexture

iTexture@ GetFogSkyboxTexture()

Returns:

  • iTexture@

GetFogStart

float GetFogStart()

Returns:

  • float

GetFogUnderwater

bool GetFogUnderwater()

Returns:

  • bool

GetFogUseSkybox

bool GetFogUseSkybox()

Returns:

  • bool

GetForceField

cForceField@ GetForceField(const tString &in asName)


Parameters

Returns:

  • cForceField@

GetForceFieldFromID

cForceField@ GetForceFieldFromID(tID alID)


Parameters

Returns:

  • cForceField@

GetForceFieldIterator

cForceFieldIterator@ GetForceFieldIterator()

Returns:

  • cForceFieldIterator@

GetGuiSetEntity

cGuiSetEntity@ GetGuiSetEntity(const tString &in asName)


Parameters

Returns:

  • cGuiSetEntity@

GetGuiSetEntityFromID

cGuiSetEntity@ GetGuiSetEntityFromID(tID alID)


Parameters

Returns:

  • cGuiSetEntity@

GetGuiSetEntityIterator

cGuiSetEntityIterator@ GetGuiSetEntityIterator()

Returns:

  • cGuiSetEntityIterator@

GetLensFlare

cLensFlare@ GetLensFlare(const tString &in asName)


Parameters

Returns:

  • cLensFlare@

GetLensFlareFromID

cLensFlare@ GetLensFlareFromID(tID alID)


Parameters

Returns:

  • cLensFlare@

GetLensFlareIterator

cLensFlareIterator@ GetLensFlareIterator()

Returns:

  • cLensFlareIterator@

GetLight

iLight@ GetLight(const tString &in asName)


Parameters

Returns:

  • iLight@

GetLightFromID

iLight@ GetLightFromID(tID aID)


Parameters

Returns:

  • iLight@

GetLightIterator

cLightListIterator@ GetLightIterator()

Returns:

  • cLightListIterator@

GetLightMask

cLightMaskBox@ GetLightMask(const tString &in asName)


Parameters

Returns:

  • cLightMaskBox@

GetLightMaskBoxIterator

cLightMaskBoxListIterator@ GetLightMaskBoxIterator()

Returns:

  • cLightMaskBoxListIterator@

GetMeshEntityFromID

cMeshEntity@ GetMeshEntityFromID(tID aID)


Parameters

Returns:

  • cMeshEntity@

GetName

tString GetName()

Returns:

  • tString

GetNightVisionBrightness

float GetNightVisionBrightness()

Returns:

  • float

GetNightVisionColor

const cColor& GetNightVisionColor()

Returns:

  • const cColor&

GetNightVisionFalloff

float GetNightVisionFalloff()

Returns:

  • float

GetNightVisionRadiusMax

float GetNightVisionRadiusMax()

Returns:

  • float

GetNightVisionRadiusMin

float GetNightVisionRadiusMin()

Returns:

  • float

GetNightVisionVisible

bool GetNightVisionVisible()

Returns:

  • bool

GetParticleSystem

cParticleSystem@ GetParticleSystem(const tString &in asName)


Parameters

Returns:

  • cParticleSystem@

GetParticleSystemFromID

cParticleSystem@ GetParticleSystemFromID(tID alID)


Parameters

Returns:

  • cParticleSystem@

GetParticleSystemIterator

cParticleSystemIterator@ GetParticleSystemIterator()

Returns:

  • cParticleSystemIterator@

GetPhysicsWorld

iPhysicsWorld@ GetPhysicsWorld()

Returns:

  • iPhysicsWorld@

GetRopeEntity

iRopeEntity@ GetRopeEntity(const tString &in asName)


Parameters

Returns:

  • iRopeEntity@

GetRopeEntityFromID

iRopeEntity@ GetRopeEntityFromID(tID alID)


Parameters

Returns:

  • iRopeEntity@

GetRopeEntityIterator

cRopeEntityIterator@ GetRopeEntityIterator()

Returns:

  • cRopeEntityIterator@

GetSecondaryFogActive

bool GetSecondaryFogActive()

Returns:

  • bool

GetSecondaryFogBrightness

float GetSecondaryFogBrightness()

Returns:

  • float

GetSecondaryFogColor

const cColor& GetSecondaryFogColor()

Returns:

  • const cColor&

GetSecondaryFogDensity

float GetSecondaryFogDensity()

Returns:

  • float

GetSecondaryFogEnd

float GetSecondaryFogEnd()

Returns:

  • float

GetSecondaryFogFalloffExp

float GetSecondaryFogFalloffExp()

Returns:

  • float

GetSecondaryFogHeightDensity

float GetSecondaryFogHeightDensity()

Returns:

  • float

GetSecondaryFogHeightHorizon

float GetSecondaryFogHeightHorizon()

Returns:

  • float

GetSecondaryFogStart

float GetSecondaryFogStart()

Returns:

  • float

GetSkyBoxActive

bool GetSkyBoxActive()

Returns:

  • bool

GetSkyBoxBrightness

float GetSkyBoxBrightness()

Returns:

  • float

GetSkyBoxColor

const cColor& GetSkyBoxColor()

Returns:

  • const cColor&

GetSkyboxRotation

const cVector3f& GetSkyboxRotation()

Returns:

  • const cVector3f&

GetSkyBoxTexture

iTexture@ GetSkyBoxTexture()

Returns:

  • iTexture@

GetSkyBoxVertexBuffer

iVertexBuffer@ GetSkyBoxVertexBuffer()

Returns:

  • iVertexBuffer@

GetSoundEntity

cSoundEntity@ GetSoundEntity(const tString &in asName)


Parameters

Returns:

  • cSoundEntity@

GetSoundEntityFromCreationID

cSoundEntity@ GetSoundEntityFromCreationID(int alID)


Parameters

  • alID (int) —

Returns:

  • cSoundEntity@

GetSoundEntityFromID

cSoundEntity@ GetSoundEntityFromID(tID alID)


Parameters

Returns:

  • cSoundEntity@

GetSoundEntityIterator

cSoundEntityIterator@ GetSoundEntityIterator()

Returns:

  • cSoundEntityIterator@

GetStaticMeshEntityIterator

cMeshEntityIterator@ GetStaticMeshEntityIterator()

Returns:

  • cMeshEntityIterator@

GetSubMeshEntityFromID

cSubMeshEntity@ GetSubMeshEntityFromID(tID aID)


Parameters

Returns:

  • cSubMeshEntity@

GetSubMeshEntityInArea

void GetSubMeshEntityInArea(cSubMeshEntity@ avObjects,
                            const cVector3f &in avMin,
                            const cVector3f &in avMax)


Parameters

Returns:

  • void

GetTerrain

cTerrain@ GetTerrain()

Returns:

  • cTerrain@

GetTerrainActive

bool GetTerrainActive()

Returns:

  • bool

GetToneMappingExposure

float GetToneMappingExposure()

Returns:

  • float

GetToneMappingFadeTime

float GetToneMappingFadeTime()

Returns:

  • float

GetToneMappingKey

float GetToneMappingKey()

Returns:

  • float

GetToneMappingWhiteCut

float GetToneMappingWhiteCut()

Returns:

  • float

GetWorldSize

const cVector3f& GetWorldSize()

Returns:

  • const cVector3f&

IsActive

bool IsActive()

Returns:

  • bool

IsDepthOfFieldActive

bool IsDepthOfFieldActive()

Returns:

  • bool

IsValid

bool IsValid(cSoundEntity@ apEntity)


Parameters

Returns:

  • bool

ParticleSystemExists

bool ParticleSystemExists(cParticleSystem@ apPS)


Parameters

Returns:

  • bool

RemoveBillboardFromGroup

void RemoveBillboardFromGroup(cBillboard@ apObject,
                              cBillboardGroup@ apGroup)


Parameters

Returns:

  • void

SetActive

void SetActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetCurrentIDSpace

void SetCurrentIDSpace(eIDSpace aSpace)


Parameters

Returns:

  • void

SetDefaultGradingTexture

void SetDefaultGradingTexture(iTexture@ apGrading)


Parameters

Returns:

  • void

SetDepthOfFieldActive

void SetDepthOfFieldActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetDepthOfFieldBokehTexture

void SetDepthOfFieldBokehTexture(iTexture@ apTexture)


Parameters

Returns:

  • void

SetDepthOfFieldFalloff

void SetDepthOfFieldFalloff(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDepthOfFieldFocusEnd

void SetDepthOfFieldFocusEnd(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDepthOfFieldFocusStart

void SetDepthOfFieldFocusStart(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDirectionalLightActive

void SetDirectionalLightActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetDistanceCullActive

void SetDistanceCullActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetDistanceCullFadeSpeed

void SetDistanceCullFadeSpeed(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDistanceCullMaxRange

void SetDistanceCullMaxRange(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDistanceCullMinRange

void SetDistanceCullMinRange(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDistanceCullRandomSize

void SetDistanceCullRandomSize(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDistanceCullScreenSize

void SetDistanceCullScreenSize(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetEntityID

tID SetEntityID(iEntity3D@ apEntity,
                tID alID)


Parameters

Returns:

  • tID

SetEntityID

tID SetEntityID(iEntity3D@ apEntity,
                eIDSpace aSpace,
                uint alLocation,
                uint alInner)


Parameters

Returns:

  • tID

SetEnvironmentParticlesActive

void SetEnvironmentParticlesActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogActive

void SetFogActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogApplyAfterFogAreas

void SetFogApplyAfterFogAreas(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogBrightness

void SetFogBrightness(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFogColor

void SetFogColor(const cColor &in aCol)


Parameters

Returns:

  • void

SetFogCulling

void SetFogCulling(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogDensity

void SetFogDensity(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFogEnd

void SetFogEnd(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFogExponential

void SetFogExponential(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogFalloffExp

void SetFogFalloffExp(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFogHeightBased

void SetFogHeightBased(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogHeightDensity

void SetFogHeightDensity(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFogHeightHorizon

void SetFogHeightHorizon(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFogLighten

void SetFogLighten(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogSkyboxTexture

void SetFogSkyboxTexture(iTexture@ apTexture)


Parameters

Returns:

  • void

SetFogStart

void SetFogStart(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFogUnderwater

void SetFogUnderwater(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFogUseSkybox

void SetFogUseSkybox(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetMainRenderableContainerVisible

void SetMainRenderableContainerVisible(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetNightVisionBrightness

void SetNightVisionBrightness(float afBrightness)


Parameters

  • afBrightness (float) —

Returns:

  • void

SetNightVisionColor

void SetNightVisionColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetNightVisionFalloff

void SetNightVisionFalloff(float afFalloff)


Parameters

  • afFalloff (float) —

Returns:

  • void

SetNightVisionRadiusMax

void SetNightVisionRadiusMax(float afRadius)


Parameters

  • afRadius (float) —

Returns:

  • void

SetNightVisionRadiusMin

void SetNightVisionRadiusMin(float afRadius)


Parameters

  • afRadius (float) —

Returns:

  • void

SetPhysicsWorld

void SetPhysicsWorld(iPhysicsWorld@ apWorld,
                     bool abAutoDelete)


Parameters

Returns:

  • void

SetSecondaryFogActive

void SetSecondaryFogActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSecondaryFogBrightness

void SetSecondaryFogBrightness(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSecondaryFogColor

void SetSecondaryFogColor(const cColor &in aCol)


Parameters

Returns:

  • void

SetSecondaryFogDensity

void SetSecondaryFogDensity(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSecondaryFogEnd

void SetSecondaryFogEnd(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSecondaryFogFalloffExp

void SetSecondaryFogFalloffExp(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSecondaryFogHeightDensity

void SetSecondaryFogHeightDensity(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSecondaryFogHeightHorizon

void SetSecondaryFogHeightHorizon(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSecondaryFogStart

void SetSecondaryFogStart(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSkyBox

void SetSkyBox(iTexture@ apTexture,
               bool abAutoDestroy)


Parameters

  • apTexture (iTexture@) —
  • abAutoDestroy (bool) —

Returns:

  • void

SetSkyBoxActive

void SetSkyBoxActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSkyBoxBrightness

void SetSkyBoxBrightness(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSkyBoxColor

void SetSkyBoxColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetSkyboxRotation

void SetSkyboxRotation(const cVector3f &in avX)


Parameters

Returns:

  • void

SetTerrainActive

void SetTerrainActive(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetToneMappingKey

void SetToneMappingKey(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SoundEntityExists

bool SoundEntityExists(cSoundEntity@ apEntity,
                       int alCreationID)


Parameters

Returns:

  • bool

Update

void Update(float afTimeStep)


Parameters

  • afTimeStep (float) —

Returns:

  • void

References

See all references...