HPL3/Amnesia: Rebirth/Scripting/cLightPoint

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 23:20, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cLightPoint has no public fields. ==Funct...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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!

Contents

Fields

cLightPoint has no public fields.

Functions

Return Type Function And Description
void AddChild(iEntity3D@ apEntity)
void AttachBillboard(cBillboard@ apBillboard, const cColor &in aBaseColor, float afBaseBrightness)
void AttachParticleSystem(cParticleSystem@ apPS)
bool CollidesWithBV(cBoundingVolume@+ apBV)
bool CollidesWithFrustum(cFrustum@ apFrustum)
void FadeBrightnessTo(float afBrightness, float afTime, eEasing aEasing = eEasing_Linear)
void FadeBrightnessToDefault(float afTime, eEasing aEasing = eEasing_Linear)
void FadeTo(const cColor &in aCol, float afRadius, float afTime)
cBoundingVolume GetBoundingVolume()
float GetBrightness()
bool GetCastDiffuseLight()
bool GetCastShadows()
bool GetCastSpecularLight()
bool GetCastTerrainShadow()
cEntity3DIterator GetChildIterator()
float GetCoverageAmount()
float GetDefaultBrightness()
cColor GetDefaultDiffuseColor()
cColor GetDestColor()
float GetDestRadius()
cColor GetDiffuseColor()
iEntity3D GetEntityParent()
eEntityType GetEntityType()
float GetFalloffPow()
bool GetFlickerActive()
bool GetFlickerFade()
cColor GetFlickerOffColor()
float GetFlickerOffFadeMaxLength()
float GetFlickerOffFadeMinLength()
float GetFlickerOffMaxLength()
float GetFlickerOffMinLength()
tString GetFlickerOffPS()
float GetFlickerOffRadius()
tString GetFlickerOffSound()
cColor GetFlickerOnColor()
float GetFlickerOnFadeMaxLength()
float GetFlickerOnFadeMinLength()
float GetFlickerOnMaxLength()
float GetFlickerOnMinLength()
tString GetFlickerOnPS()
float GetFlickerOnRadius()
tString GetFlickerOnSound()
float GetGoboAnimFrameTime()
eTextureAnimMode GetGoboAnimMode()
float GetGoboAnimStartTime()
int GetGoboNextFrame()
iTexture GetGoboTexture()
tID GetID()
cColor GetIlluminationColor()
eLightType GetLightType()
float GetLiquidAmount()
cMatrixf GetLocalMatrix()
cVector3f GetLocalPosition()
cLightMaskBox GetMask()
cMaterial GetMaterial()
int GetMatrixUpdateCount()
tString GetName()
bool GetOcclusionCullShadowCasters()
float GetRadius()
cBoundingVolume GetRenderBV()
bool GetRenderFlagBit(int alFlagBit)
int GetRenderFlags()
int GetRenderFrameCount()
int GetRenderLayer()
tString GetRenderName()
eRenderableType GetRenderType()
bool GetScriptableIsSaved()
int GetShadowCastersAffected()
float GetShadowMapBiasMul()
eShadowMapResolution GetShadowMapResolution()
float GetShadowMapSlopeScaleBiasMul()
float GetSourceRadius()
cColor GetSpecularColor()
int GetTransformUpdateCount()
float GetTranslucency()
int GetUniqueID()
iVertexBuffer GetVertexBuffer()
bool GetVisibleVar()
cVector3f GetWorldCenterPosition()
cMatrixf GetWorldMatrix()
cVector3f GetWorldPosition()
bool HasParent()
bool IsActive()
bool IsChild(iEntity3D@ apEntity)
bool IsFading()
bool IsOccluder()
bool IsStatic()
bool IsVisible()
void RemoveBillboard(cBillboard@ apBillboard)
void RemoveChild(iEntity3D@ apEntity)
void RemoveParticleSystem(cParticleSystem@ apPS)
void SetActive(bool abActive)
void SetBrightness(float afX)
void SetCastDiffuseLight(bool afX)
void SetCastShadows(bool afX)
void SetCastSpecularLight(bool afX)
void SetCastTerrainShadow(bool abX)
void SetCoverageAmount(float afX)
void SetDefaultBrightness(float afX)
void SetDefaultDiffuseColor(const cColor &in aColor)
void SetDiffuseColor(const cColor &in aColor)
void SetFalloffPow(float afX)
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)
void SetFlickerActive(bool abX)
void SetFlickerOnColor(const cColor &in aColor)
void SetGoboAnimFrameTime(float afX)
void SetGoboAnimMode(eTextureAnimMode aMode)
void SetGoboAnimStartTime(float afX)
void SetGoboTexture(iTexture@ apTexture)
void SetIlluminationColor(const cColor &in aColor)
void SetLiquidAmount(float afX)
void SetMask(cLightMaskBox@ apMask)
void SetMatrix(const cMatrixf &in a_mtxTransform)
void SetName(const tString &in asName)
void SetOcclusionCullShadowCasters(bool abX)
void SetPosition(const cVector3f &in avPos)
void SetRadius(float afX)
void SetRenderFlagBit(int alFlagBit, bool abSet)
void SetRenderFrameCount(int alCount)
void SetRenderLayer(int alX)
void SetScriptableIsSaved(bool abX)
void SetShadowCastersAffected(int alX)
void SetShadowMapBiasMul(float afX)
void SetShadowMapResolution(eShadowMapResolution aQuality)
void SetShadowMapSlopeScaleBiasMul(float afX)
void SetSourceRadius(float afX)
void SetSpecularColor(const cColor &in aColor)
void SetTranslucency(float afX)
void SetVisible(bool abVisible)
void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)
void SetWorldPosition(const cVector3f &in avWorldPos)
void StopFading()
void UpdateLogic(float afTimeStep)
void UseAutomaticLiquidAmount(float afTime = 0)

Details

AddChild

void AddChild(iEntity3D@ apEntity)


Parameters

Returns:

  • void

AttachBillboard

void AttachBillboard(cBillboard@ apBillboard,
                     const cColor &in aBaseColor,
                     float afBaseBrightness)


Parameters

Returns:

  • void

AttachParticleSystem

void AttachParticleSystem(cParticleSystem@ apPS)


Parameters

Returns:

  • void

CollidesWithBV

bool CollidesWithBV(cBoundingVolume@+ apBV)


Parameters

Returns:

  • bool—

CollidesWithFrustum

bool CollidesWithFrustum(cFrustum@ apFrustum)


Parameters

Returns:

  • bool—

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

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&—

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&—

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—

GetShadowCastersAffected

int GetShadowCastersAffected()

Returns:

  • int—

GetShadowMapBiasMul

float GetShadowMapBiasMul()

Returns:

  • float—

GetShadowMapResolution

eShadowMapResolution GetShadowMapResolution()

Returns:

  • eShadowMapResolution—

GetShadowMapSlopeScaleBiasMul

float GetShadowMapSlopeScaleBiasMul()

Returns:

  • float—

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

bool IsChild(iEntity3D@ apEntity)


Parameters

Returns:

  • bool—

IsFading

bool IsFading()

Returns:

  • bool—

IsOccluder

bool IsOccluder()

Returns:

  • bool—

IsStatic

bool IsStatic()

Returns:

  • bool—

IsVisible

bool IsVisible()

Returns:

  • bool—

RemoveBillboard

void RemoveBillboard(cBillboard@ apBillboard)


Parameters

Returns:

  • void

RemoveChild

void RemoveChild(iEntity3D@ apEntity)


Parameters

Returns:

  • void

RemoveParticleSystem

void RemoveParticleSystem(cParticleSystem@ apPS)


Parameters

Returns:

  • void

SetActive

void SetActive(bool abActive)


Parameters

  • abActive (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

void SetDefaultDiffuseColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetDiffuseColor

void SetDiffuseColor(const cColor &in aColor)


Parameters

Returns:

  • void

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

void SetFlickerOnColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetGoboAnimFrameTime

void SetGoboAnimFrameTime(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetGoboAnimMode

void SetGoboAnimMode(eTextureAnimMode aMode)


Parameters

Returns:

  • void

SetGoboAnimStartTime

void SetGoboAnimStartTime(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetGoboTexture

void SetGoboTexture(iTexture@ apTexture)


Parameters

Returns:

  • void

SetIlluminationColor

void SetIlluminationColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetLiquidAmount

void SetLiquidAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMask

void SetMask(cLightMaskBox@ apMask)


Parameters

Returns:

  • void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)


Parameters

Returns:

  • void

SetName

void SetName(const tString &in asName)


Parameters

Returns:

  • void

SetOcclusionCullShadowCasters

void SetOcclusionCullShadowCasters(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

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

SetShadowCastersAffected

void SetShadowCastersAffected(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetShadowMapBiasMul

void SetShadowMapBiasMul(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetShadowMapResolution

void SetShadowMapResolution(eShadowMapResolution aQuality)


Parameters

Returns:

  • void

SetShadowMapSlopeScaleBiasMul

void SetShadowMapSlopeScaleBiasMul(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSourceRadius

void SetSourceRadius(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetSpecularColor

void SetSpecularColor(const cColor &in aColor)


Parameters

Returns:

  • void

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

Returns:

  • void

SetWorldPosition

void SetWorldPosition(const cVector3f &in avWorldPos)


Parameters

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

References

See all references...

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cLightPoint&oldid=5739"