HPL3/Amnesia: Rebirth/Scripting/cWorld
![]() |
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!
Contents
- 1 Fields
- 2 Functions
- 3 Details
- 3.1 AddBillboardToGroup
- 3.2 Compile
- 3.3 CreateBeam
- 3.4 CreateBeamID
- 3.5 CreateBillboard
- 3.6 CreateBillboardGroup
- 3.7 CreateBillboardGroupID
- 3.8 CreateBillboardID
- 3.9 CreateClothEntity
- 3.10 CreateClothEntityID
- 3.11 CreateExposureArea
- 3.12 CreateExposureAreaID
- 3.13 CreateFogArea
- 3.14 CreateFogAreaID
- 3.15 CreateForceField
- 3.16 CreateForceFieldID
- 3.17 CreateGuiSetEntity
- 3.18 CreateGuiSetEntityID
- 3.19 CreateLensFlare
- 3.20 CreateLensFlareID
- 3.21 CreateLightBox
- 3.22 CreateLightBoxID
- 3.23 CreateLightPoint
- 3.24 CreateLightPointID
- 3.25 CreateLightSpot
- 3.26 CreateLightSpotID
- 3.27 CreateMeshEntity
- 3.28 CreateMeshEntityID
- 3.29 CreateParticleSystem
- 3.30 CreateParticleSystemID
- 3.31 CreateRopeEntity
- 3.32 CreateRopeEntityID
- 3.33 CreateSoundEntity
- 3.34 CreateSoundEntityEx
- 3.35 CreateSoundEntityExID
- 3.36 CreateSoundEntityID
- 3.37 DestroyAllParticleSystems
- 3.38 DestroyAllSoundEntities
- 3.39 DestroyBeam
- 3.40 DestroyBillboard
- 3.41 DestroyBillboardGroup
- 3.42 DestroyClothEntity
- 3.43 DestroyExposureArea
- 3.44 DestroyFogArea
- 3.45 DestroyForceField
- 3.46 DestroyGuiSetEntity
- 3.47 DestroyLensFlare
- 3.48 DestroyLight
- 3.49 DestroyMeshEntity
- 3.50 DestroyParticleSystem
- 3.51 DestroyRopeEntity
- 3.52 DestroySoundEntity
- 3.53 FadeGradingTexture
- 3.54 FadeInIrradianceSet
- 3.55 FadeToneMappingExposure
- 3.56 FadeToneMappingWhiteCut
- 3.57 GetBeam
- 3.58 GetBeamFromID
- 3.59 GetBeamIterator
- 3.60 GetBillboard
- 3.61 GetBillboardFromID
- 3.62 GetBillboardGroup
- 3.63 GetBillboardGroupFromID
- 3.64 GetBillboardGroupIterator
- 3.65 GetBillboardIterator
- 3.66 GetClothEntity
- 3.67 GetClothEntityFromID
- 3.68 GetClothEntityIterator
- 3.69 GetCurrentIDSpace
- 3.70 GetDepthOfFieldBokehTexture
- 3.71 GetDepthOfFieldFalloff
- 3.72 GetDepthOfFieldFocusEnd
- 3.73 GetDepthOfFieldFocusStart
- 3.74 GetDirectionalLight
- 3.75 GetDirectionalLightActive
- 3.76 GetDistanceCullActive
- 3.77 GetDistanceCullFadeSpeed
- 3.78 GetDistanceCullMaxRange
- 3.79 GetDistanceCullMinRange
- 3.80 GetDistanceCullRandomSize
- 3.81 GetDistanceCullScreenSize
- 3.82 GetDynamicMeshEntity
- 3.83 GetDynamicMeshEntityIterator
- 3.84 GetEntityFromID
- 3.85 GetEnvironmentParticleNum
- 3.86 GetEnvironmentParticles
- 3.87 GetEnvironmentParticlesActive
- 3.88 GetExposureArea
- 3.89 GetExposureAreaFromID
- 3.90 GetExposureAreaIterator
- 3.91 GetFogActive
- 3.92 GetFogApplyAfterFogAreas
- 3.93 GetFogArea
- 3.94 GetFogAreaFromID
- 3.95 GetFogAreaIterator
- 3.96 GetFogBrightness
- 3.97 GetFogColor
- 3.98 GetFogCulling
- 3.99 GetFogDensity
- 3.100 GetFogEnd
- 3.101 GetFogExponential
- 3.102 GetFogFalloffExp
- 3.103 GetFogHeightBased
- 3.104 GetFogHeightDensity
- 3.105 GetFogHeightHorizon
- 3.106 GetFogLighten
- 3.107 GetFogSkyboxTexture
- 3.108 GetFogStart
- 3.109 GetFogUnderwater
- 3.110 GetFogUseSkybox
- 3.111 GetForceField
- 3.112 GetForceFieldFromID
- 3.113 GetForceFieldIterator
- 3.114 GetGuiSetEntity
- 3.115 GetGuiSetEntityFromID
- 3.116 GetGuiSetEntityIterator
- 3.117 GetLensFlare
- 3.118 GetLensFlareFromID
- 3.119 GetLensFlareIterator
- 3.120 GetLight
- 3.121 GetLightFromID
- 3.122 GetLightIterator
- 3.123 GetLightMask
- 3.124 GetLightMaskBoxIterator
- 3.125 GetMeshEntityFromID
- 3.126 GetName
- 3.127 GetNightVisionBrightness
- 3.128 GetNightVisionColor
- 3.129 GetNightVisionFalloff
- 3.130 GetNightVisionRadiusMax
- 3.131 GetNightVisionRadiusMin
- 3.132 GetNightVisionVisible
- 3.133 GetParticleSystem
- 3.134 GetParticleSystemFromID
- 3.135 GetParticleSystemIterator
- 3.136 GetPhysicsWorld
- 3.137 GetRopeEntity
- 3.138 GetRopeEntityFromID
- 3.139 GetRopeEntityIterator
- 3.140 GetSecondaryFogActive
- 3.141 GetSecondaryFogBrightness
- 3.142 GetSecondaryFogColor
- 3.143 GetSecondaryFogDensity
- 3.144 GetSecondaryFogEnd
- 3.145 GetSecondaryFogFalloffExp
- 3.146 GetSecondaryFogHeightDensity
- 3.147 GetSecondaryFogHeightHorizon
- 3.148 GetSecondaryFogStart
- 3.149 GetSkyBoxActive
- 3.150 GetSkyBoxBrightness
- 3.151 GetSkyBoxColor
- 3.152 GetSkyboxRotation
- 3.153 GetSkyBoxTexture
- 3.154 GetSkyBoxVertexBuffer
- 3.155 GetSoundEntity
- 3.156 GetSoundEntityFromCreationID
- 3.157 GetSoundEntityFromID
- 3.158 GetSoundEntityIterator
- 3.159 GetStaticMeshEntityIterator
- 3.160 GetSubMeshEntityFromID
- 3.161 GetSubMeshEntityInArea
- 3.162 GetTerrain
- 3.163 GetTerrainActive
- 3.164 GetToneMappingExposure
- 3.165 GetToneMappingFadeTime
- 3.166 GetToneMappingKey
- 3.167 GetToneMappingWhiteCut
- 3.168 GetWorldSize
- 3.169 IsActive
- 3.170 IsDepthOfFieldActive
- 3.171 IsValid
- 3.172 ParticleSystemExists
- 3.173 RemoveBillboardFromGroup
- 3.174 SetActive
- 3.175 SetCurrentIDSpace
- 3.176 SetDefaultGradingTexture
- 3.177 SetDepthOfFieldActive
- 3.178 SetDepthOfFieldBokehTexture
- 3.179 SetDepthOfFieldFalloff
- 3.180 SetDepthOfFieldFocusEnd
- 3.181 SetDepthOfFieldFocusStart
- 3.182 SetDirectionalLightActive
- 3.183 SetDistanceCullActive
- 3.184 SetDistanceCullFadeSpeed
- 3.185 SetDistanceCullMaxRange
- 3.186 SetDistanceCullMinRange
- 3.187 SetDistanceCullRandomSize
- 3.188 SetDistanceCullScreenSize
- 3.189 SetEntityID
- 3.190 SetEntityID
- 3.191 SetEnvironmentParticlesActive
- 3.192 SetFogActive
- 3.193 SetFogApplyAfterFogAreas
- 3.194 SetFogBrightness
- 3.195 SetFogColor
- 3.196 SetFogCulling
- 3.197 SetFogDensity
- 3.198 SetFogEnd
- 3.199 SetFogExponential
- 3.200 SetFogFalloffExp
- 3.201 SetFogHeightBased
- 3.202 SetFogHeightDensity
- 3.203 SetFogHeightHorizon
- 3.204 SetFogLighten
- 3.205 SetFogSkyboxTexture
- 3.206 SetFogStart
- 3.207 SetFogUnderwater
- 3.208 SetFogUseSkybox
- 3.209 SetMainRenderableContainerVisible
- 3.210 SetNightVisionBrightness
- 3.211 SetNightVisionColor
- 3.212 SetNightVisionFalloff
- 3.213 SetNightVisionRadiusMax
- 3.214 SetNightVisionRadiusMin
- 3.215 SetPhysicsWorld
- 3.216 SetSecondaryFogActive
- 3.217 SetSecondaryFogBrightness
- 3.218 SetSecondaryFogColor
- 3.219 SetSecondaryFogDensity
- 3.220 SetSecondaryFogEnd
- 3.221 SetSecondaryFogFalloffExp
- 3.222 SetSecondaryFogHeightDensity
- 3.223 SetSecondaryFogHeightHorizon
- 3.224 SetSecondaryFogStart
- 3.225 SetSkyBox
- 3.226 SetSkyBoxActive
- 3.227 SetSkyBoxBrightness
- 3.228 SetSkyBoxColor
- 3.229 SetSkyboxRotation
- 3.230 SetTerrainActive
- 3.231 SetToneMappingKey
- 3.232 SoundEntityExists
- 3.233 Update
- 4 References
Fields
cWorld has no public fields.
Functions
Details
AddBillboardToGroup
void AddBillboardToGroup(cBillboard@ apObject,
cBillboardGroup@ apGroup)
Parameters
- apObject (cBillboard@) —
- apGroup (cBillboardGroup@) —
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
- asName (tString) —
- avSize (cVector2f) —
- aType (eBillboardType) —
- asMaterial (tString) —
- abStatic (bool) —
Returns:
- cBillboard@—
CreateBillboardGroup
CreateBillboardGroupID
CreateBillboardID
tID CreateBillboardID(const tString &in asName,
const cVector2f &in avSize,
eBillboardType aType,
const tString &in asMaterial,
bool abStatic)
Parameters
- asName (tString) —
- avSize (cVector2f) —
- aType (eBillboardType) —
- asMaterial (tString) —
- abStatic (bool) —
Returns:
- tID—
CreateClothEntity
cClothEntity@ CreateClothEntity(const tString &in asName,
iPhysicsCloth@ apCloth,
const tString &in asMaterial = "")
Parameters
- asName (tString) —
- apCloth (iPhysicsCloth@) —
- asMaterial (tString) —
Returns:
- cClothEntity@—
CreateClothEntityID
tID CreateClothEntityID(const tString &in asName,
iPhysicsCloth@ apCloth,
const tString &in asMaterial = "")
Parameters
- asName (tString) —
- apCloth (iPhysicsCloth@) —
- asMaterial (tString) —
Returns:
- tID—
CreateExposureArea
cExposureArea@ CreateExposureArea(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cExposureArea@—
CreateExposureAreaID
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
CreateGuiSetEntityID
CreateLensFlare
CreateLensFlareID
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
CreateLightPointID
CreateLightSpot
CreateLightSpotID
CreateMeshEntity
CreateMeshEntityID
CreateParticleSystem
CreateParticleSystemID
CreateRopeEntity
iRopeEntity@ CreateRopeEntity(const tString &in asName,
eRopeType aRopeType,
iPhysicsRope@ apRope,
int alMaxSegments,
int alRingSegments = 3)
Parameters
- asName (tString) —
- aRopeType (eRopeType) —
- apRope (iPhysicsRope@) —
- alMaxSegments (int) —
- alRingSegments (int) —
Returns:
- iRopeEntity@—
CreateRopeEntityID
tID CreateRopeEntityID(const tString &in asName,
eRopeType aRopeType,
iPhysicsRope@ apRope,
int alMaxSegments,
int alRingSegments = 3)
Parameters
- asName (tString) —
- aRopeType (eRopeType) —
- apRope (iPhysicsRope@) —
- alMaxSegments (int) —
- alRingSegments (int) —
Returns:
- tID—
CreateSoundEntity
CreateSoundEntityEx
CreateSoundEntityExID
CreateSoundEntityID
DestroyAllParticleSystems
void DestroyAllParticleSystems()
Returns:
- void
DestroyAllSoundEntities
void DestroyAllSoundEntities()
Returns:
- void
DestroyBeam
DestroyBillboard
DestroyBillboardGroup
void DestroyBillboardGroup(cBillboardGroup@ apObject)
Parameters
- apObject (cBillboardGroup@) —
Returns:
- void
DestroyClothEntity
DestroyExposureArea
void DestroyExposureArea(cExposureArea@ apExposureArea)
Parameters
- apExposureArea (cExposureArea@) —
Returns:
- void
DestroyFogArea
DestroyForceField
DestroyGuiSetEntity
void DestroyGuiSetEntity(cGuiSetEntity@ apObject)
Parameters
- apObject (cGuiSetEntity@) —
Returns:
- void
DestroyLensFlare
DestroyLight
DestroyMeshEntity
DestroyParticleSystem
void DestroyParticleSystem(cParticleSystem@ apPS)
Parameters
- apPS (cParticleSystem@) —
Returns:
- void
DestroyRopeEntity
DestroySoundEntity
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
GetBeamFromID
GetBeamIterator
cBeamIterator@ GetBeamIterator()
Returns:
- cBeamIterator@—
GetBillboard
cBillboard@ GetBillboard(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cBillboard@—
GetBillboardFromID
GetBillboardGroup
cBillboardGroup@ GetBillboardGroup(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cBillboardGroup@—
GetBillboardGroupFromID
cBillboardGroup@ GetBillboardGroupFromID(tID alID)
Parameters
- alID (tID) —
Returns:
- cBillboardGroup@—
GetBillboardGroupIterator
cBillboardGroupIterator@ GetBillboardGroupIterator()
Returns:
- cBillboardGroupIterator@—
GetBillboardIterator
cBillboardIterator@ GetBillboardIterator()
Returns:
- cBillboardIterator@—
GetClothEntity
cClothEntity@ GetClothEntity(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cClothEntity@—
GetClothEntityFromID
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
- asName (tString) —
Returns:
- cMeshEntity@—
GetDynamicMeshEntityIterator
cMeshEntityIterator@ GetDynamicMeshEntityIterator()
Returns:
- cMeshEntityIterator@—
GetEntityFromID
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
- asName (tString) —
Returns:
- cExposureArea@—
GetExposureAreaFromID
GetExposureAreaIterator
cExposureAreaIterator@ GetExposureAreaIterator()
Returns:
- cExposureAreaIterator@—
GetFogActive
bool GetFogActive()
Returns:
- bool—
GetFogApplyAfterFogAreas
bool GetFogApplyAfterFogAreas()
Returns:
- bool—
GetFogArea
GetFogAreaFromID
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
- asName (tString) —
Returns:
- cForceField@—
GetForceFieldFromID
GetForceFieldIterator
cForceFieldIterator@ GetForceFieldIterator()
Returns:
- cForceFieldIterator@—
GetGuiSetEntity
cGuiSetEntity@ GetGuiSetEntity(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cGuiSetEntity@—
GetGuiSetEntityFromID
GetGuiSetEntityIterator
cGuiSetEntityIterator@ GetGuiSetEntityIterator()
Returns:
- cGuiSetEntityIterator@—
GetLensFlare
cLensFlare@ GetLensFlare(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cLensFlare@—
GetLensFlareFromID
GetLensFlareIterator
cLensFlareIterator@ GetLensFlareIterator()
Returns:
- cLensFlareIterator@—
GetLight
GetLightFromID
GetLightIterator
cLightListIterator@ GetLightIterator()
Returns:
- cLightListIterator@—
GetLightMask
cLightMaskBox@ GetLightMask(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cLightMaskBox@—
GetLightMaskBoxIterator
cLightMaskBoxListIterator@ GetLightMaskBoxIterator()
Returns:
- cLightMaskBoxListIterator@—
GetMeshEntityFromID
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
- asName (tString) —
Returns:
- cParticleSystem@—
GetParticleSystemFromID
cParticleSystem@ GetParticleSystemFromID(tID alID)
Parameters
- alID (tID) —
Returns:
- cParticleSystem@—
GetParticleSystemIterator
cParticleSystemIterator@ GetParticleSystemIterator()
Returns:
- cParticleSystemIterator@—
GetPhysicsWorld
iPhysicsWorld@ GetPhysicsWorld()
Returns:
- iPhysicsWorld@—
GetRopeEntity
iRopeEntity@ GetRopeEntity(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- iRopeEntity@—
GetRopeEntityFromID
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
- asName (tString) —
Returns:
- cSoundEntity@—
GetSoundEntityFromCreationID
cSoundEntity@ GetSoundEntityFromCreationID(int alID)
Parameters
- alID (int) —
Returns:
- cSoundEntity@—
GetSoundEntityFromID
GetSoundEntityIterator
cSoundEntityIterator@ GetSoundEntityIterator()
Returns:
- cSoundEntityIterator@—
GetStaticMeshEntityIterator
cMeshEntityIterator@ GetStaticMeshEntityIterator()
Returns:
- cMeshEntityIterator@—
GetSubMeshEntityFromID
GetSubMeshEntityInArea
void GetSubMeshEntityInArea(cSubMeshEntity@ avObjects,
const cVector3f &in avMin,
const cVector3f &in avMax)
Parameters
- avObjects (cSubMeshEntity@) —
- avMin (cVector3f) —
- avMax (cVector3f) —
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
ParticleSystemExists
bool ParticleSystemExists(cParticleSystem@ apPS)
Parameters
- apPS (cParticleSystem@) —
Returns:
- bool—
RemoveBillboardFromGroup
void RemoveBillboardFromGroup(cBillboard@ apObject,
cBillboardGroup@ apGroup)
Parameters
- apObject (cBillboard@) —
- apGroup (cBillboardGroup@) —
Returns:
- void
SetActive
void SetActive(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetCurrentIDSpace
SetDefaultGradingTexture
SetDepthOfFieldActive
void SetDepthOfFieldActive(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetDepthOfFieldBokehTexture
void SetDepthOfFieldBokehTexture(iTexture@ apTexture)
Parameters
- apTexture (iTexture@) —
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
- apEntity (iEntity3D@) —
- alID (tID) —
Returns:
- tID—
SetEntityID
tID SetEntityID(iEntity3D@ apEntity,
eIDSpace aSpace,
uint alLocation,
uint alInner)
Parameters
- apEntity (iEntity3D@) —
- aSpace (eIDSpace) —
- alLocation (uint) —
- alInner (uint) —
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
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
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
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
- apWorld (iPhysicsWorld@) —
- abAutoDelete (bool) —
Returns:
- void
SetSecondaryFogActive
void SetSecondaryFogActive(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetSecondaryFogBrightness
void SetSecondaryFogBrightness(float afX)
Parameters
- afX (float) —
Returns:
- void
SetSecondaryFogColor
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
SetSkyboxRotation
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
- apEntity (cSoundEntity@) —
- alCreationID (int) —
Returns:
- bool—
Update
void Update(float afTimeStep)
Parameters
- afTimeStep (float) —
Returns:
- void
References
- HPL3/Amnesia: Rebirth/Scripting/Scripting Api (← links)
- HPL3/Amnesia: Rebirth/Scripting/cLuxMap (← links)
- HPL3/Amnesia: Rebirth/Scripting/cViewport (← links)
- HPL3/Amnesia: Rebirth/Scripting/iScrAgent Interface (← links)
- HPL3/Amnesia: Rebirth/Scripting/iScrArea Interface (← links)
- HPL3/Amnesia: Rebirth/Scripting/iScrCritter Interface (← links)
- HPL3/Amnesia: Rebirth/Scripting/iScrLiquidArea Interface (← links)
- HPL3/Amnesia: Rebirth/Scripting/iScrProp Interface (← links)
- HPL3/Amnesia: Rebirth/Scripting/iScrPushableFogArea Interface (← links)
- HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cScene (← links)