HPL3/Amnesia: Rebirth/Scripting/cLensFlare

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 22:18, 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== cLensFlare has no public fields. ==Functi...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

cLensFlare has no public fields.

Functions

Return Type Function And Description
void AddChild(iEntity3D@ apEntity)
bool CollidesWithBV(cBoundingVolume@+ apBV)
bool CollidesWithFrustum(cFrustum@ apFrustum)
void DisableRangeMax()
void DisableRangeMin()
void FadeIn(float afTime)
void FadeOut(float afTime)
cBoundingVolume GetBoundingVolume()
float GetBrightness()
cEntity3DIterator GetChildIterator()
float GetCoverageAmount()
iEntity3D GetEntityParent()
eEntityType GetEntityType()
eLensFlareType GetFirstActiveType()
cColor GetFlareColor(eLensFlareType aType)
cVector2f GetFlareSize(eLensFlareType aType)
cVector3f GetFlareSourceSize()
float GetGlareBrightness()
float GetGlareFieldOfView()
float GetGlareRangeMaxEnd()
float GetGlareRangeMaxStart()
tID GetID()
cColor GetIlluminationColor()
float GetInnerFieldOfView()
float GetLiquidAmount()
cMatrixf GetLocalMatrix()
cVector3f GetLocalPosition()
cMaterial GetMaterial()
int GetMatrixUpdateCount()
int GetMultiIrisCount()
int GetMultiIrisSeed()
cVector2l GetMultiIrisTextureAtlasGrid()
bool GetMultiplyGlareWithMultiIris()
tString GetName()
float GetOuterFieldOfView()
float GetRangeMaxEnd()
float GetRangeMaxStart()
float GetRangeMinEnd()
float GetRangeMinStart()
cBoundingVolume GetRenderBV()
bool GetRenderFlagBit(int alFlagBit)
int GetRenderFlags()
int GetRenderFrameCount()
int GetRenderLayer()
tString GetRenderName()
eRenderableType GetRenderType()
bool GetScriptableIsSaved()
bool GetShrinkWhenOccluded()
float GetSizeChangeBasedOnDistance()
int GetTransformUpdateCount()
int GetUniqueID()
bool GetUseParentMeshForOcclusion()
iVertexBuffer GetVertexBuffer()
bool GetVisibleVar()
cVector3f GetWorldCenterPosition()
cMatrixf GetWorldMatrix()
cVector3f GetWorldPosition()
bool HasParent()
bool IsActive()
bool IsChild(iEntity3D@ apEntity)
bool IsFlareActive(eLensFlareType aType)
bool IsOccluder()
bool IsStatic()
bool IsVisible()
void RemoveChild(iEntity3D@ apEntity)
void SetActive(bool abActive)
void SetAsPointLight()
void SetBrightness(float afX)
void SetCoverageAmount(float afX)
void SetFlareActive(eLensFlareType aType, bool abValue)
void SetFlareColor(eLensFlareType aType, cColor aValue)
void SetFlareSize(eLensFlareType aType, cVector2f avSize)
void SetFlareSourceSize(cVector3f avSize)
void SetGlareBrightness(float afBrightness)
void SetGlareFieldOfView(float afAngle)
void SetGlareRange(float afRangeMaxStart, float afRangeMaxEnd)
void SetGlareStareAt(float afGlare)
void SetIlluminationColor(const cColor &in aColor)
void SetInnerFieldOfView(float afAngle)
void SetLiquidAmount(float afX)
void SetMaterial(eLensFlareType aType, cMaterial@ apMaterial)
void SetMatrix(const cMatrixf &in a_mtxTransform)
void SetMultiIrisCount(int alCount)
void SetMultiIrisSeed(int alSeed)
void SetMultiIrisTextureAtlasGrid(cVector2l avMultiIrisGrid)
void SetMultiplyGlareWithMultiIris(bool abValue)
void SetName(const tString &in asName)
void SetOuterFieldOfView(float afAngle)
void SetPosition(const cVector3f &in avPos)
void SetRangeMax(float afRangeMaxStart, float afRangeMaxEnd)
void SetRangeMin(float afRangeMinStart, float afRangeMinEnd)
void SetRenderFlagBit(int alFlagBit, bool abSet)
void SetRenderFrameCount(int alCount)
void SetRenderLayer(int alX)
void SetScriptableIsSaved(bool abX)
void SetShrinkWhenOccluded(bool abValue)
void SetSizeChangeBasedOnDistance(float afPercent)
void SetUseParentMeshForOcclusion(bool abValue)
void SetVisible(bool abVisible)
void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)
void SetWorldPosition(const cVector3f &in avWorldPos)
void UpdateLogic(float afTimeStep)
void UseAutomaticLiquidAmount(float afTime = 0)

Details

AddChild

void AddChild(iEntity3D@ apEntity)


Parameters

Returns:

  • void

CollidesWithBV

bool CollidesWithBV(cBoundingVolume@+ apBV)


Parameters

Returns:

  • bool

CollidesWithFrustum

bool CollidesWithFrustum(cFrustum@ apFrustum)


Parameters

Returns:

  • bool

DisableRangeMax

void DisableRangeMax()

Returns:

  • void

DisableRangeMin

void DisableRangeMin()

Returns:

  • void

FadeIn

void FadeIn(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

FadeOut

void FadeOut(float afTime)


Parameters

  • afTime (float) —

Returns:

  • void

GetBoundingVolume

cBoundingVolume@+ GetBoundingVolume()

Returns:

  • cBoundingVolume@+

GetBrightness

float GetBrightness()

Returns:

  • float

GetChildIterator

cEntity3DIterator@ GetChildIterator()

Returns:

  • cEntity3DIterator@

GetCoverageAmount

float GetCoverageAmount()

Returns:

  • float

GetEntityParent

iEntity3D@ GetEntityParent()

Returns:

  • iEntity3D@

GetEntityType

eEntityType GetEntityType()

Returns:

  • eEntityType

GetFirstActiveType

eLensFlareType GetFirstActiveType()

Returns:

  • eLensFlareType

GetFlareColor

cColor GetFlareColor(eLensFlareType aType)


Parameters

Returns:

  • cColor

GetFlareSize

cVector2f GetFlareSize(eLensFlareType aType)


Parameters

Returns:

  • cVector2f

GetFlareSourceSize

cVector3f GetFlareSourceSize()

Returns:

  • cVector3f

GetGlareBrightness

float GetGlareBrightness()

Returns:

  • float

GetGlareFieldOfView

float GetGlareFieldOfView()

Returns:

  • float

GetGlareRangeMaxEnd

float GetGlareRangeMaxEnd()

Returns:

  • float

GetGlareRangeMaxStart

float GetGlareRangeMaxStart()

Returns:

  • float

GetID

tID GetID()

Returns:

  • tID

GetIlluminationColor

const cColor& GetIlluminationColor()

Returns:

  • const cColor&

GetInnerFieldOfView

float GetInnerFieldOfView()

Returns:

  • float

GetLiquidAmount

float GetLiquidAmount()

Returns:

  • float

GetLocalMatrix

cMatrixf& GetLocalMatrix()

Returns:

  • cMatrixf&

GetLocalPosition

cVector3f GetLocalPosition()

Returns:

  • cVector3f

GetMaterial

cMaterial@ GetMaterial()

Returns:

  • cMaterial@

GetMatrixUpdateCount

int GetMatrixUpdateCount()

Returns:

  • int

GetMultiIrisCount

int GetMultiIrisCount()

Returns:

  • int

GetMultiIrisSeed

int GetMultiIrisSeed()

Returns:

  • int

GetMultiIrisTextureAtlasGrid

cVector2l GetMultiIrisTextureAtlasGrid()

Returns:

  • cVector2l

GetMultiplyGlareWithMultiIris

bool GetMultiplyGlareWithMultiIris()

Returns:

  • bool

GetName

const tString& GetName()

Returns:

  • const tString&

GetOuterFieldOfView

float GetOuterFieldOfView()

Returns:

  • float

GetRangeMaxEnd

float GetRangeMaxEnd()

Returns:

  • float

GetRangeMaxStart

float GetRangeMaxStart()

Returns:

  • float

GetRangeMinEnd

float GetRangeMinEnd()

Returns:

  • float

GetRangeMinStart

float GetRangeMinStart()

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

GetShrinkWhenOccluded

bool GetShrinkWhenOccluded()

Returns:

  • bool

GetSizeChangeBasedOnDistance

float GetSizeChangeBasedOnDistance()

Returns:

  • float

GetTransformUpdateCount

int GetTransformUpdateCount()

Returns:

  • int

GetUniqueID

int GetUniqueID()

Returns:

  • int

GetUseParentMeshForOcclusion

bool GetUseParentMeshForOcclusion()

Returns:

  • bool

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

IsFlareActive

bool IsFlareActive(eLensFlareType aType)


Parameters

Returns:

  • bool

IsOccluder

bool IsOccluder()

Returns:

  • bool

IsStatic

bool IsStatic()

Returns:

  • bool

IsVisible

bool IsVisible()

Returns:

  • bool

RemoveChild

void RemoveChild(iEntity3D@ apEntity)


Parameters

Returns:

  • void

SetActive

void SetActive(bool abActive)


Parameters

  • abActive (bool) —

Returns:

  • void

SetAsPointLight

void SetAsPointLight()

Returns:

  • void

SetBrightness

void SetBrightness(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetCoverageAmount

void SetCoverageAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetFlareActive

void SetFlareActive(eLensFlareType aType,
                    bool abValue)


Parameters

Returns:

  • void

SetFlareColor

void SetFlareColor(eLensFlareType aType,
                   cColor aValue)


Parameters

Returns:

  • void

SetFlareSize

void SetFlareSize(eLensFlareType aType,
                  cVector2f avSize)


Parameters

Returns:

  • void

SetFlareSourceSize

void SetFlareSourceSize(cVector3f avSize)


Parameters

Returns:

  • void

SetGlareBrightness

void SetGlareBrightness(float afBrightness)


Parameters

  • afBrightness (float) —

Returns:

  • void

SetGlareFieldOfView

void SetGlareFieldOfView(float afAngle)


Parameters

  • afAngle (float) —

Returns:

  • void

SetGlareRange

void SetGlareRange(float afRangeMaxStart,
                   float afRangeMaxEnd)


Parameters

  • afRangeMaxStart (float) —
  • afRangeMaxEnd (float) —

Returns:

  • void

SetGlareStareAt

void SetGlareStareAt(float afGlare)


Parameters

  • afGlare (float) —

Returns:

  • void

SetIlluminationColor

void SetIlluminationColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetInnerFieldOfView

void SetInnerFieldOfView(float afAngle)


Parameters

  • afAngle (float) —

Returns:

  • void

SetLiquidAmount

void SetLiquidAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMaterial

void SetMaterial(eLensFlareType aType,
                 cMaterial@ apMaterial)


Parameters

Returns:

  • void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)


Parameters

Returns:

  • void

SetMultiIrisCount

void SetMultiIrisCount(int alCount)


Parameters

  • alCount (int) —

Returns:

  • void

SetMultiIrisSeed

void SetMultiIrisSeed(int alSeed)


Parameters

  • alSeed (int) —

Returns:

  • void

SetMultiIrisTextureAtlasGrid

void SetMultiIrisTextureAtlasGrid(cVector2l avMultiIrisGrid)


Parameters

Returns:

  • void

SetMultiplyGlareWithMultiIris

void SetMultiplyGlareWithMultiIris(bool abValue)


Parameters

  • abValue (bool) —

Returns:

  • void

SetName

void SetName(const tString &in asName)


Parameters

Returns:

  • void

SetOuterFieldOfView

void SetOuterFieldOfView(float afAngle)


Parameters

  • afAngle (float) —

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

SetRangeMax

void SetRangeMax(float afRangeMaxStart,
                 float afRangeMaxEnd)


Parameters

  • afRangeMaxStart (float) —
  • afRangeMaxEnd (float) —

Returns:

  • void

SetRangeMin

void SetRangeMin(float afRangeMinStart,
                 float afRangeMinEnd)


Parameters

  • afRangeMinStart (float) —
  • afRangeMinEnd (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

SetShrinkWhenOccluded

void SetShrinkWhenOccluded(bool abValue)


Parameters

  • abValue (bool) —

Returns:

  • void

SetSizeChangeBasedOnDistance

void SetSizeChangeBasedOnDistance(float afPercent)


Parameters

  • afPercent (float) —

Returns:

  • void

SetUseParentMeshForOcclusion

void SetUseParentMeshForOcclusion(bool abValue)


Parameters

  • abValue (bool) —

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

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...