HPL3/Amnesia: Rebirth/Scripting/cLightDirectional
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 AddChild
- 3.2 AttachBillboard
- 3.3 AttachParticleSystem
- 3.4 CollidesWithBV
- 3.5 CollidesWithFrustum
- 3.6 FadeBrightnessTo
- 3.7 FadeBrightnessToDefault
- 3.8 FadeTo
- 3.9 GetAmbientColorGround
- 3.10 GetAmbientColorSky
- 3.11 GetAutoShadowSliceLogTerm
- 3.12 GetAutoShadowSliceSettings
- 3.13 GetBoundingVolume
- 3.14 GetBrightness
- 3.15 GetCastDiffuseLight
- 3.16 GetCastShadows
- 3.17 GetCastSpecularLight
- 3.18 GetCastTerrainShadow
- 3.19 GetChildIterator
- 3.20 GetCoverageAmount
- 3.21 GetDefaultBrightness
- 3.22 GetDefaultDiffuseColor
- 3.23 GetDestColor
- 3.24 GetDestRadius
- 3.25 GetDiffuseColor
- 3.26 GetDirection
- 3.27 GetEntityParent
- 3.28 GetEntityType
- 3.29 GetFalloffPow
- 3.30 GetFlickerActive
- 3.31 GetFlickerFade
- 3.32 GetFlickerOffColor
- 3.33 GetFlickerOffFadeMaxLength
- 3.34 GetFlickerOffFadeMinLength
- 3.35 GetFlickerOffMaxLength
- 3.36 GetFlickerOffMinLength
- 3.37 GetFlickerOffPS
- 3.38 GetFlickerOffRadius
- 3.39 GetFlickerOffSound
- 3.40 GetFlickerOnColor
- 3.41 GetFlickerOnFadeMaxLength
- 3.42 GetFlickerOnFadeMinLength
- 3.43 GetFlickerOnMaxLength
- 3.44 GetFlickerOnMinLength
- 3.45 GetFlickerOnPS
- 3.46 GetFlickerOnRadius
- 3.47 GetFlickerOnSound
- 3.48 GetFrustum
- 3.49 GetGoboAnimFrameTime
- 3.50 GetGoboAnimMode
- 3.51 GetGoboAnimStartTime
- 3.52 GetGoboNextFrame
- 3.53 GetGoboTexture
- 3.54 GetID
- 3.55 GetIlluminationColor
- 3.56 GetLightType
- 3.57 GetLiquidAmount
- 3.58 GetLocalMatrix
- 3.59 GetLocalPosition
- 3.60 GetMask
- 3.61 GetMaterial
- 3.62 GetMatrixUpdateCount
- 3.63 GetName
- 3.64 GetOcclusionCullShadowCasters
- 3.65 GetRadius
- 3.66 GetRenderBV
- 3.67 GetRenderFlagBit
- 3.68 GetRenderFlags
- 3.69 GetRenderFrameCount
- 3.70 GetRenderLayer
- 3.71 GetRenderName
- 3.72 GetRenderType
- 3.73 GetScriptableIsSaved
- 3.74 GetShadowCasterDistance
- 3.75 GetShadowCastersAffected
- 3.76 GetShadowDistance
- 3.77 GetShadowMapBiasMul
- 3.78 GetShadowMapResolution
- 3.79 GetShadowMapSlopeScaleBiasMul
- 3.80 GetShadowSliceProperties
- 3.81 GetSourceRadius
- 3.82 GetSpecularColor
- 3.83 GetTransformUpdateCount
- 3.84 GetTranslucency
- 3.85 GetUniqueID
- 3.86 GetVertexBuffer
- 3.87 GetVisibleVar
- 3.88 GetWorldCenterPosition
- 3.89 GetWorldMatrix
- 3.90 GetWorldPosition
- 3.91 HasParent
- 3.92 IsActive
- 3.93 IsChild
- 3.94 IsFading
- 3.95 IsOccluder
- 3.96 IsStatic
- 3.97 IsVisible
- 3.98 RemoveBillboard
- 3.99 RemoveChild
- 3.100 RemoveParticleSystem
- 3.101 SetActive
- 3.102 SetAmbientColorGround
- 3.103 SetAmbientColorSky
- 3.104 SetAutoShadowSliceLogTerm
- 3.105 SetAutoShadowSliceSettings
- 3.106 SetBrightness
- 3.107 SetCastDiffuseLight
- 3.108 SetCastShadows
- 3.109 SetCastSpecularLight
- 3.110 SetCastTerrainShadow
- 3.111 SetCoverageAmount
- 3.112 SetDefaultBrightness
- 3.113 SetDefaultDiffuseColor
- 3.114 SetDiffuseColor
- 3.115 SetDirection
- 3.116 SetFalloffPow
- 3.117 SetFlicker
- 3.118 SetFlickerActive
- 3.119 SetFlickerOnColor
- 3.120 SetGoboAnimFrameTime
- 3.121 SetGoboAnimMode
- 3.122 SetGoboAnimStartTime
- 3.123 SetGoboTexture
- 3.124 SetIlluminationColor
- 3.125 SetLiquidAmount
- 3.126 SetMask
- 3.127 SetMatrix
- 3.128 SetName
- 3.129 SetOcclusionCullShadowCasters
- 3.130 SetPosition
- 3.131 SetRadius
- 3.132 SetRenderFlagBit
- 3.133 SetRenderFrameCount
- 3.134 SetRenderLayer
- 3.135 SetScriptableIsSaved
- 3.136 SetShadowCasterDistance
- 3.137 SetShadowCastersAffected
- 3.138 SetShadowDistance
- 3.139 SetShadowMapBiasMul
- 3.140 SetShadowMapResolution
- 3.141 SetShadowMapSlopeScaleBiasMul
- 3.142 SetSourceRadius
- 3.143 SetSpecularColor
- 3.144 SetTranslucency
- 3.145 SetVisible
- 3.146 SetWorldMatrix
- 3.147 SetWorldPosition
- 3.148 StopFading
- 3.149 UpdateLogic
- 3.150 UseAutomaticLiquidAmount
- 4 References
Fields
cLightDirectional has no public fields.
Functions
Details
AddChild
AttachBillboard
void AttachBillboard(cBillboard@ apBillboard,
const cColor &in aBaseColor,
float afBaseBrightness)
Parameters
- apBillboard (cBillboard@) —
- aBaseColor (cColor) —
- afBaseBrightness (float) —
Returns:
- void
AttachParticleSystem
CollidesWithBV
CollidesWithFrustum
FadeBrightnessTo
void FadeBrightnessTo(float afBrightness,
float afTime,
eEasing aEasing = eEasing_Linear)
Parameters
- afBrightness (float) —
- afTime (float) —
- aEasing (eEasing) —
Returns:
- void
FadeBrightnessToDefault
void FadeBrightnessToDefault(float afTime,
eEasing aEasing = eEasing_Linear)
Parameters
- afTime (float) —
- aEasing (eEasing) —
Returns:
- void
FadeTo
void FadeTo(const cColor &in aCol,
float afRadius,
float afTime)
Parameters
- aCol (cColor) —
- afRadius (float) —
- afTime (float) —
Returns:
- void
GetAmbientColorGround
const cColor& GetAmbientColorGround()
Returns:
- const cColor&—
GetAmbientColorSky
const cColor& GetAmbientColorSky()
Returns:
- const cColor&—
GetAutoShadowSliceLogTerm
float GetAutoShadowSliceLogTerm()
Returns:
- float—
GetAutoShadowSliceSettings
bool GetAutoShadowSliceSettings()
Returns:
- bool—
GetBoundingVolume
cBoundingVolume@+ GetBoundingVolume()
Returns:
- cBoundingVolume@+—
GetBrightness
float GetBrightness()
Returns:
- float—
GetCastDiffuseLight
bool GetCastDiffuseLight()
Returns:
- bool—
GetCastShadows
bool GetCastShadows()
Returns:
- bool—
GetCastSpecularLight
bool GetCastSpecularLight()
Returns:
- bool—
GetCastTerrainShadow
bool GetCastTerrainShadow()
Returns:
- bool—
GetChildIterator
cEntity3DIterator@ GetChildIterator()
Returns:
- cEntity3DIterator@—
GetCoverageAmount
float GetCoverageAmount()
Returns:
- float—
GetDefaultBrightness
float GetDefaultBrightness()
Returns:
- float—
GetDefaultDiffuseColor
const cColor& GetDefaultDiffuseColor()
Returns:
- const cColor&—
GetDestColor
const cColor& GetDestColor()
Returns:
- const cColor&—
GetDestRadius
float GetDestRadius()
Returns:
- float—
GetDiffuseColor
const cColor& GetDiffuseColor()
Returns:
- const cColor&—
GetDirection
const cVector3f& GetDirection()
Returns:
- const cVector3f&—
GetEntityParent
iEntity3D@ GetEntityParent()
Returns:
- iEntity3D@—
GetEntityType
eEntityType GetEntityType()
Returns:
- eEntityType—
GetFalloffPow
float GetFalloffPow()
Returns:
- float—
GetFlickerActive
bool GetFlickerActive()
Returns:
- bool—
GetFlickerFade
bool GetFlickerFade()
Returns:
- bool—
GetFlickerOffColor
const cColor& GetFlickerOffColor()
Returns:
- const cColor&—
GetFlickerOffFadeMaxLength
float GetFlickerOffFadeMaxLength()
Returns:
- float—
GetFlickerOffFadeMinLength
float GetFlickerOffFadeMinLength()
Returns:
- float—
GetFlickerOffMaxLength
float GetFlickerOffMaxLength()
Returns:
- float—
GetFlickerOffMinLength
float GetFlickerOffMinLength()
Returns:
- float—
GetFlickerOffPS
const tString& GetFlickerOffPS()
Returns:
- const tString&—
GetFlickerOffRadius
float GetFlickerOffRadius()
Returns:
- float—
GetFlickerOffSound
const tString& GetFlickerOffSound()
Returns:
- const tString&—
GetFlickerOnColor
const cColor& GetFlickerOnColor()
Returns:
- const cColor&—
GetFlickerOnFadeMaxLength
float GetFlickerOnFadeMaxLength()
Returns:
- float—
GetFlickerOnFadeMinLength
float GetFlickerOnFadeMinLength()
Returns:
- float—
GetFlickerOnMaxLength
float GetFlickerOnMaxLength()
Returns:
- float—
GetFlickerOnMinLength
float GetFlickerOnMinLength()
Returns:
- float—
GetFlickerOnPS
const tString& GetFlickerOnPS()
Returns:
- const tString&—
GetFlickerOnRadius
float GetFlickerOnRadius()
Returns:
- float—
GetFlickerOnSound
const tString& GetFlickerOnSound()
Returns:
- const tString&—
GetFrustum
cFrustum@+ GetFrustum()
Returns:
- cFrustum@+—
GetGoboAnimFrameTime
float GetGoboAnimFrameTime()
Returns:
- float—
GetGoboAnimMode
eTextureAnimMode GetGoboAnimMode()
Returns:
- eTextureAnimMode—
GetGoboAnimStartTime
float GetGoboAnimStartTime()
Returns:
- float—
GetGoboNextFrame
int GetGoboNextFrame()
Returns:
- int—
GetGoboTexture
iTexture@ GetGoboTexture()
Returns:
- iTexture@—
GetID
tID GetID()
Returns:
- tID—
GetIlluminationColor
const cColor& GetIlluminationColor()
Returns:
- const cColor&—
GetLightType
eLightType GetLightType()
Returns:
- eLightType—
GetLiquidAmount
float GetLiquidAmount()
Returns:
- float—
GetLocalMatrix
cMatrixf& GetLocalMatrix()
Returns:
- cMatrixf&—
GetLocalPosition
cVector3f GetLocalPosition()
Returns:
- cVector3f—
GetMask
cLightMaskBox@ GetMask()
Returns:
- cLightMaskBox@—
GetMaterial
cMaterial@ GetMaterial()
Returns:
- cMaterial@—
GetMatrixUpdateCount
int GetMatrixUpdateCount()
Returns:
- int—
GetName
const tString& GetName()
Returns:
- const tString&—
GetOcclusionCullShadowCasters
bool GetOcclusionCullShadowCasters()
Returns:
- bool—
GetRadius
float GetRadius()
Returns:
- float—
GetRenderBV
cBoundingVolume@+ GetRenderBV()
Returns:
- cBoundingVolume@+—
GetRenderFlagBit
bool GetRenderFlagBit(int alFlagBit)
Parameters
- alFlagBit (int) —
Returns:
- bool—
GetRenderFlags
int GetRenderFlags()
Returns:
- int—
GetRenderFrameCount
int GetRenderFrameCount()
Returns:
- int—
GetRenderLayer
int GetRenderLayer()
Returns:
- int—
GetRenderName
const tString& GetRenderName()
Returns:
- const tString&—
GetRenderType
eRenderableType GetRenderType()
Returns:
- eRenderableType—
GetScriptableIsSaved
bool GetScriptableIsSaved()
Returns:
- bool—
GetShadowCasterDistance
float GetShadowCasterDistance()
Returns:
- float—
GetShadowCastersAffected
int GetShadowCastersAffected()
Returns:
- int—
GetShadowDistance
float GetShadowDistance()
Returns:
- float—
GetShadowMapBiasMul
float GetShadowMapBiasMul()
Returns:
- float—
GetShadowMapResolution
eShadowMapResolution GetShadowMapResolution()
Returns:
- eShadowMapResolution—
GetShadowMapSlopeScaleBiasMul
float GetShadowMapSlopeScaleBiasMul()
Returns:
- float—
GetShadowSliceProperties
cLightDirectional_ShadowSlice@ GetShadowSliceProperties(int alIdx)
Parameters
- alIdx (int) —
Returns:
- cLightDirectional_ShadowSlice@—
GetSourceRadius
float GetSourceRadius()
Returns:
- float—
GetSpecularColor
const cColor& GetSpecularColor()
Returns:
- const cColor&—
GetTransformUpdateCount
int GetTransformUpdateCount()
Returns:
- int—
GetTranslucency
float GetTranslucency()
Returns:
- float—
GetUniqueID
int GetUniqueID()
Returns:
- int—
GetVertexBuffer
iVertexBuffer@ GetVertexBuffer()
Returns:
- iVertexBuffer@—
GetVisibleVar
bool GetVisibleVar()
Returns:
- bool—
GetWorldCenterPosition
cVector3f GetWorldCenterPosition()
Returns:
- cVector3f—
GetWorldMatrix
cMatrixf& GetWorldMatrix()
Returns:
- cMatrixf&—
GetWorldPosition
cVector3f GetWorldPosition()
Returns:
- cVector3f—
HasParent
bool HasParent()
Returns:
- bool—
IsActive
bool IsActive()
Returns:
- bool—
IsChild
IsFading
bool IsFading()
Returns:
- bool—
IsOccluder
bool IsOccluder()
Returns:
- bool—
IsStatic
bool IsStatic()
Returns:
- bool—
IsVisible
bool IsVisible()
Returns:
- bool—
RemoveBillboard
RemoveChild
RemoveParticleSystem
SetActive
void SetActive(bool abActive)
Parameters
- abActive (bool) —
Returns:
- void
SetAmbientColorGround
SetAmbientColorSky
SetAutoShadowSliceLogTerm
void SetAutoShadowSliceLogTerm(float afX)
Parameters
- afX (float) —
Returns:
- void
SetAutoShadowSliceSettings
void SetAutoShadowSliceSettings(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetBrightness
void SetBrightness(float afX)
Parameters
- afX (float) —
Returns:
- void
SetCastDiffuseLight
void SetCastDiffuseLight(bool afX)
Parameters
- afX (bool) —
Returns:
- void
SetCastShadows
void SetCastShadows(bool afX)
Parameters
- afX (bool) —
Returns:
- void
SetCastSpecularLight
void SetCastSpecularLight(bool afX)
Parameters
- afX (bool) —
Returns:
- void
SetCastTerrainShadow
void SetCastTerrainShadow(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetCoverageAmount
void SetCoverageAmount(float afX)
Parameters
- afX (float) —
Returns:
- void
SetDefaultBrightness
void SetDefaultBrightness(float afX)
Parameters
- afX (float) —
Returns:
- void
SetDefaultDiffuseColor
SetDiffuseColor
SetDirection
SetFalloffPow
void SetFalloffPow(float afX)
Parameters
- afX (float) —
Returns:
- void
SetFlicker
void SetFlicker(const cColor &in aOffCol,
float afOffRadius,
float afOnMinLength,
float afOnMaxLength,
const tString &in asOnSound,
const tString &in asOnPS,
float afOffMinLength,
float afOffMaxLength,
const tString &in asOffSound,
const tString &in asOffPS,
bool abFade,
float afOnFadeMinLength,
float afOnFadeMaxLength,
float afOffFadeMinLength,
float afOffFadeMaxLength)
Parameters
- aOffCol (cColor) —
- afOffRadius (float) —
- afOnMinLength (float) —
- afOnMaxLength (float) —
- asOnSound (tString) —
- asOnPS (tString) —
- afOffMinLength (float) —
- afOffMaxLength (float) —
- asOffSound (tString) —
- asOffPS (tString) —
- abFade (bool) —
- afOnFadeMinLength (float) —
- afOnFadeMaxLength (float) —
- afOffFadeMinLength (float) —
- afOffFadeMaxLength (float) —
Returns:
- void
SetFlickerActive
void SetFlickerActive(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetFlickerOnColor
SetGoboAnimFrameTime
void SetGoboAnimFrameTime(float afX)
Parameters
- afX (float) —
Returns:
- void
SetGoboAnimMode
SetGoboAnimStartTime
void SetGoboAnimStartTime(float afX)
Parameters
- afX (float) —
Returns:
- void
SetGoboTexture
SetIlluminationColor
SetLiquidAmount
void SetLiquidAmount(float afX)
Parameters
- afX (float) —
Returns:
- void
SetMask
SetMatrix
void SetMatrix(const cMatrixf &in a_mtxTransform)
Parameters
- a_mtxTransform (cMatrixf) —
Returns:
- void
SetName
SetOcclusionCullShadowCasters
void SetOcclusionCullShadowCasters(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetPosition
SetRadius
void SetRadius(float afX)
Parameters
- afX (float) —
Returns:
- void
SetRenderFlagBit
void SetRenderFlagBit(int alFlagBit,
bool abSet)
Parameters
- alFlagBit (int) —
- abSet (bool) —
Returns:
- void
SetRenderFrameCount
void SetRenderFrameCount(int alCount)
Parameters
- alCount (int) —
Returns:
- void
SetRenderLayer
void SetRenderLayer(int alX)
Parameters
- alX (int) —
Returns:
- void
SetScriptableIsSaved
void SetScriptableIsSaved(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetShadowCasterDistance
void SetShadowCasterDistance(float afX)
Parameters
- afX (float) —
Returns:
- void
SetShadowCastersAffected
void SetShadowCastersAffected(int alX)
Parameters
- alX (int) —
Returns:
- void
SetShadowDistance
void SetShadowDistance(float afX)
Parameters
- afX (float) —
Returns:
- void
SetShadowMapBiasMul
void SetShadowMapBiasMul(float afX)
Parameters
- afX (float) —
Returns:
- void
SetShadowMapResolution
void SetShadowMapResolution(eShadowMapResolution aQuality)
Parameters
- aQuality (eShadowMapResolution) —
Returns:
- void
SetShadowMapSlopeScaleBiasMul
void SetShadowMapSlopeScaleBiasMul(float afX)
Parameters
- afX (float) —
Returns:
- void
SetSourceRadius
void SetSourceRadius(float afX)
Parameters
- afX (float) —
Returns:
- void
SetSpecularColor
SetTranslucency
void SetTranslucency(float afX)
Parameters
- afX (float) —
Returns:
- void
SetVisible
void SetVisible(bool abVisible)
Parameters
- abVisible (bool) —
Returns:
- void
SetWorldMatrix
void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)
Parameters
- a_mtxWorldTransform (cMatrixf) —
Returns:
- void
SetWorldPosition
void SetWorldPosition(const cVector3f &in avWorldPos)
Parameters
- avWorldPos (cVector3f) —
Returns:
- void
StopFading
void StopFading()
Returns:
- void
UpdateLogic
void UpdateLogic(float afTimeStep)
Parameters
- afTimeStep (float) —
Returns:
- void
UseAutomaticLiquidAmount
void UseAutomaticLiquidAmount(float afTime = 0)
Parameters
- afTime (float) —
Returns:
- void