HPL3/Amnesia: Rebirth/Scripting/cLuxMap

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!

Fields

cLuxMap has no public fields.

Functions

Return Type	Function And Description
void	AddDissolveEntity(cMeshEntity@ apMeshEntity, float afTime, float afAlpha = 1.0f)
void	AddEntityComponent(iLuxEntityComponent@ apComp)
void	AddTimer(const tString &in asName, float afTime, const tString &in asFunction)
void	BroadcastSoundHeardEvent(const tString &in asName, const cVector3f &in avPosition, float afRadius, int alPrio, bool abPhysicsObject = false)
void	CheckLineOfSight(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avEnd, bool abCheckOnlyShadowCasters, bool abCheckOnlyStatic)
bool	CloneProp(const tString &in asPropSource, const tString &in asPropDest)
bool	CopyPropState(const tString &in asPropSource, const tString &in asPropDest)
void	CreateEntity(const tString &in asName, const tString &in asFile, const cMatrixf &in a_mtxTransform, const cVector3f &in avScale)
bool	DestroyEntity(iLuxEntity@ apEntity)
bool	EntityExists(iLuxEntity@ apEntity)
bool	EntityWasDestroyed()
void	GetClosestBody(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, int alUserValue = 0)
void	GetClosestCharCollideBody(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength)
void	GetClosestCharCollider(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, bool abCheckDynamic)
void	GetClosestEntity(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, int alInteractType, bool abCheckLineOfSight)
uint	GetCollideFlag(const tString &in asGroupName)
tString	GetDisplayNameEntry()
float	GetElapsedTime(int alTimeStamp)
bool	GetEntityArray(const tString &in asName, eLuxEntityType aType, const tString &in asClassName, array<iLuxEntity@> avOutEntities)
bool	GetEntityArrayID(const tString &in asName, eLuxEntityType aType, const tString &in asClassName, array<tID> avOutEntities)
iLuxEntity	GetEntityByID(tID alID, eLuxEntityType aType = eLuxEntityType_LastEnum, const tString &in asClassName = "")
iLuxEntity	GetEntityByName(const tString &in asName, eLuxEntityType aType = eLuxEntityType_LastEnum, const tString &in asClassName = "")
iLuxEntityComponent	GetEntityComponent(int aType, const tString &in asName)
cLuxEntityComponentIterator	GetEntityComponentIterator(int aType)
tID	GetEntityIDByName(const tString &in asName, eLuxEntityType aType = eLuxEntityType_LastEnum, const tString &in asClassName = "")
tString	GetFileName()
cNode3D	GetHackNode()
bool	GetIsUnderwater()
iLuxEntity	GetLatestEntity()
void	GetLightLevelAtPos(const tString &in asCallbackFunc, const cVector3f &in avPos, iLight@ apSkipLight, float afRadiusAdd)
float	GetMaxInteractDistance()
tString	GetName()
int	GetNewAttackInstanceID()
iPhysicsWorld	GetPhysicsWorld()
iLuxEntity	GetPlayerEntity()
bool	GetPlayerTerrainCollision()
bool	GetReturnBool()
float	GetReturnFloat()
int	GetReturnInt()
tString	GetReturnString()
bool	GetTimersNamed(const tString &in asPattern, array<tString> avOutNames)
float	GetTimerTime(const tString &in asName)
float	GetTimerUserVarFloat(const tString &in asName)
int	GetTimerUserVarInt(const tString &in asName)
tString	GetTimerUserVarString(const tString &in asName)
int	GetTimeStamp()
iLuxEntity	GetVoiceSourceEntity(const tString &in asCharacter)
cWorld	GetWorld()
float	IncTimerUserVarFloat(const tString &in asName, float afX)
int	IncTimerUserVarInt(const tString &in asName, int alX)
bool	IsActive()
bool	IsDeletingAllWorldEntities()
void	PlacePlayerAtStartPos(const tString &in asName)
void	PostUpdate(float afTimeStep)
void	PreloadEntity(const tString &in asFile)
void	PreloadGuiGfx(const tString &in asFile, eImGuiGfx aType)
void	PreloadMaterial(const tString &in asFile)
void	PreloadParticleSystem(const tString &in asFile)
void	RemoveEntityComponent(iLuxEntityComponent@ apComp)
void	RemoveTimer(const tString &in asName)
void	ResetLatestEntity()
void	RestartCurrentTimer(float afNewTime = -1)
bool	ScriptExecute()
bool	ScriptMethodExists(const tString &in asMethod)
bool	ScriptMethodExistsFast(const tString &in asMethod, int alId)
bool	ScriptPrepare(const tString &in asMethod)
bool	ScriptPrepareFast(const tString &in asMethod, int alId)
void	SetActive(bool abX)
void	SetArgBool(int alArgNum, bool abVal)
void	SetArgFloat(int alArg, float afX)
void	SetArgInt(int alArg, int alX)
void	SetArgString(int alArg, const tString &in asStr)
void	SetArgVector2f(int alArg, const cVector2f &in avX)
void	SetArgVector2l(int alArg, const cVector2l &in avX)
void	SetArgVector3f(int alArg, const cVector3f &in avX)
void	SetArgVector3l(int alArg, const cVector3l &in avX)
void	SetDisplayNameEntry(const tString &in asEntry)
void	SetIsUnderwater(bool abX)
void	SetMaxInteractDistance(float afX)
void	SetPlayerTerrainCollision(bool abX)
void	SetTimerPaused(const tString &in asName, bool abX)
void	SetTimerUserVarFloat(const tString &in asName, float afX)
void	SetTimerUserVarInt(const tString &in asName, int alX)
void	SetTimerUserVarString(const tString &in asName, const tString &in asX)
void	SetVoiceSource(const tString &in asCharacter, const tString &in asEntityName, float afMinDistance, float afMaxDistance, bool abUse3D, float afMaxPlayerListeningRange, float afMinFreq = 22000, float afMaxFreq = 22000, uint aFrequencyFlag = 0)
void	Update(float afTimeStep)
void	VariableUpdate(float afDeltaTime)

Details

AddDissolveEntity

void AddDissolveEntity(cMeshEntity@ apMeshEntity,
                       float afTime,
                       float afAlpha = 1.0f)

Parameters

apMeshEntity (cMeshEntity@) —
afTime (float) —
afAlpha (float) —

Returns:

void

AddEntityComponent

void AddEntityComponent(iLuxEntityComponent@ apComp)

Parameters

apComp (iLuxEntityComponent@) —

Returns:

void

AddTimer

void AddTimer(const tString &in asName,
              float afTime,
              const tString &in asFunction)

Parameters

asName (tString) —
afTime (float) —
asFunction (tString) —

Returns:

void

BroadcastSoundHeardEvent

void BroadcastSoundHeardEvent(const tString &in asName,
                              const cVector3f &in avPosition,
                              float afRadius,
                              int alPrio,
                              bool abPhysicsObject = false)

Parameters

asName (tString) —
avPosition (cVector3f) —
afRadius (float) —
alPrio (int) —
abPhysicsObject (bool) —

Returns:

void

CheckLineOfSight

void CheckLineOfSight(const tString &in asCallbackFunc,
                      const cVector3f &in avStart,
                      const cVector3f &in avEnd,
                      bool abCheckOnlyShadowCasters,
                      bool abCheckOnlyStatic)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avEnd (cVector3f) —
abCheckOnlyShadowCasters (bool) —
abCheckOnlyStatic (bool) —

Returns:

void

CloneProp

bool CloneProp(const tString &in asPropSource,
               const tString &in asPropDest)

Parameters

asPropSource (tString) —
asPropDest (tString) —

Returns:

bool—

CopyPropState

bool CopyPropState(const tString &in asPropSource,
                   const tString &in asPropDest)

Parameters

asPropSource (tString) —
asPropDest (tString) —

Returns:

bool—

CreateEntity

void CreateEntity(const tString &in asName,
                  const tString &in asFile,
                  const cMatrixf &in a_mtxTransform,
                  const cVector3f &in avScale)

Parameters

asName (tString) —
asFile (tString) —
a_mtxTransform (cMatrixf) —
avScale (cVector3f) —

Returns:

void

DestroyEntity

bool DestroyEntity(iLuxEntity@ apEntity)

Parameters

apEntity (iLuxEntity@) —

Returns:

bool—

EntityExists

bool EntityExists(iLuxEntity@ apEntity)

Parameters

apEntity (iLuxEntity@) —

Returns:

bool—

EntityWasDestroyed

bool EntityWasDestroyed()

Returns:

bool—

GetClosestBody

void GetClosestBody(const tString &in asCallbackFunc,
                    const cVector3f &in avStart,
                    const cVector3f &in avDir,
                    float afRayLength,
                    int alUserValue = 0)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
alUserValue (int) —

Returns:

void

GetClosestCharCollideBody

void GetClosestCharCollideBody(const tString &in asCallbackFunc,
                               const cVector3f &in avStart,
                               const cVector3f &in avDir,
                               float afRayLength)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —

Returns:

void

GetClosestCharCollider

void GetClosestCharCollider(const tString &in asCallbackFunc,
                            const cVector3f &in avStart,
                            const cVector3f &in avDir,
                            float afRayLength,
                            bool abCheckDynamic)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
abCheckDynamic (bool) —

Returns:

void

GetClosestEntity

void GetClosestEntity(const tString &in asCallbackFunc,
                      const cVector3f &in avStart,
                      const cVector3f &in avDir,
                      float afRayLength,
                      int alInteractType,
                      bool abCheckLineOfSight)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
alInteractType (int) —
abCheckLineOfSight (bool) —

Returns:

void

GetCollideFlag

uint GetCollideFlag(const tString &in asGroupName)

Parameters

asGroupName (tString) —

Returns:

uint—

GetDisplayNameEntry

const tString& GetDisplayNameEntry()

Returns:

const tString&—

GetElapsedTime

float GetElapsedTime(int alTimeStamp)

Parameters

alTimeStamp (int) —

Returns:

float—

GetEntityArray

bool GetEntityArray(const tString &in asName,
                    eLuxEntityType aType,
                    const tString &in asClassName,
                    iLuxEntity@ avOutEntities)

Parameters

asName (tString) —
aType (eLuxEntityType) —
asClassName (tString) —
avOutEntities (iLuxEntity@) —

Returns:

bool—

GetEntityArrayID

bool GetEntityArrayID(const tString &in asName,
                      eLuxEntityType aType,
                      const tString &in asClassName,
                      tID avOutEntities)

Parameters

asName (tString) —
aType (eLuxEntityType) —
asClassName (tString) —
avOutEntities (tID) —

Returns:

bool—

GetEntityByID

iLuxEntity@ GetEntityByID(tID alID,
                          eLuxEntityType aType = eLuxEntityType_LastEnum,
                          const tString &in asClassName = "")

Parameters

alID (tID) —
aType (eLuxEntityType) —
asClassName (tString) —

Returns:

iLuxEntity@—

GetEntityByName

iLuxEntity@ GetEntityByName(const tString &in asName,
                            eLuxEntityType aType = eLuxEntityType_LastEnum,
                            const tString &in asClassName = "")

Parameters

asName (tString) —
aType (eLuxEntityType) —
asClassName (tString) —

Returns:

iLuxEntity@—

GetEntityComponent

iLuxEntityComponent@ GetEntityComponent(int aType,
                                        const tString &in asName)

Parameters

aType (int) —
asName (tString) —

Returns:

iLuxEntityComponent@—

GetEntityComponentIterator

cLuxEntityComponentIterator@ GetEntityComponentIterator(int aType)

Parameters

aType (int) —

Returns:

cLuxEntityComponentIterator@—

GetEntityIDByName

tID GetEntityIDByName(const tString &in asName,
                      eLuxEntityType aType = eLuxEntityType_LastEnum,
                      const tString &in asClassName = "")

Parameters

asName (tString) —
aType (eLuxEntityType) —
asClassName (tString) —

Returns:

tID—

GetFileName

const tString& GetFileName()

Returns:

const tString&—

GetHackNode

cNode3D@ GetHackNode()

Returns:

cNode3D@—

GetIsUnderwater

bool GetIsUnderwater()

Returns:

bool—

GetLatestEntity

iLuxEntity@ GetLatestEntity()

Returns:

iLuxEntity@—

GetLightLevelAtPos

void GetLightLevelAtPos(const tString &in asCallbackFunc,
                        const cVector3f &in avPos,
                        iLight@ apSkipLight,
                        float afRadiusAdd)

Parameters

asCallbackFunc (tString) —
avPos (cVector3f) —
apSkipLight (iLight@) —
afRadiusAdd (float) —

Returns:

void

GetMaxInteractDistance

float GetMaxInteractDistance()

Returns:

float—

GetName

const tString& GetName()

Returns:

const tString&—

GetNewAttackInstanceID

int GetNewAttackInstanceID()

Returns:

int—

GetPhysicsWorld

iPhysicsWorld@ GetPhysicsWorld()

Returns:

iPhysicsWorld@—

GetPlayerEntity

iLuxEntity@ GetPlayerEntity()

Returns:

iLuxEntity@—

GetPlayerTerrainCollision

bool GetPlayerTerrainCollision()

Returns:

bool—

GetReturnBool

bool GetReturnBool()

Returns:

bool—

GetReturnFloat

float GetReturnFloat()

Returns:

float—

GetReturnInt

int GetReturnInt()

Returns:

int—

GetReturnString

tString GetReturnString()

Returns:

tString—

GetTimersNamed

bool GetTimersNamed(const tString &in asPattern,
                    tString avOutNames)

Parameters

asPattern (tString) —
avOutNames (tString) —

Returns:

bool—

GetTimerTime

float GetTimerTime(const tString &in asName)

Parameters

asName (tString) —

Returns:

float—

GetTimerUserVarFloat

float GetTimerUserVarFloat(const tString &in asName)

Parameters

asName (tString) —

Returns:

float—

GetTimerUserVarInt

int GetTimerUserVarInt(const tString &in asName)

Parameters

asName (tString) —

Returns:

int—

GetTimerUserVarString

const tString& GetTimerUserVarString(const tString &in asName)

Parameters

asName (tString) —

Returns:

const tString&—

GetTimeStamp

int GetTimeStamp()

Returns:

int—

GetVoiceSourceEntity

iLuxEntity@ GetVoiceSourceEntity(const tString &in asCharacter)

Parameters

asCharacter (tString) —

Returns:

iLuxEntity@—

GetWorld

cWorld@ GetWorld()

Returns:

cWorld@—

IncTimerUserVarFloat

float IncTimerUserVarFloat(const tString &in asName,
                           float afX)

Parameters

asName (tString) —
afX (float) —

Returns:

float—

IncTimerUserVarInt

int IncTimerUserVarInt(const tString &in asName,
                       int alX)

Parameters

asName (tString) —
alX (int) —

Returns:

int—

IsActive

bool IsActive()

Returns:

bool—

IsDeletingAllWorldEntities

bool IsDeletingAllWorldEntities()

Returns:

bool—

PlacePlayerAtStartPos

void PlacePlayerAtStartPos(const tString &in asName)

Parameters

asName (tString) —

Returns:

void

PostUpdate

void PostUpdate(float afTimeStep)

Parameters

afTimeStep (float) —

Returns:

void

PreloadEntity

void PreloadEntity(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

PreloadGuiGfx

void PreloadGuiGfx(const tString &in asFile,
                   eImGuiGfx aType)

Parameters

asFile (tString) —
aType (eImGuiGfx) —

Returns:

void

PreloadMaterial

void PreloadMaterial(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

PreloadParticleSystem

void PreloadParticleSystem(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

RemoveEntityComponent

void RemoveEntityComponent(iLuxEntityComponent@ apComp)

Parameters

apComp (iLuxEntityComponent@) —

Returns:

void

RemoveTimer

void RemoveTimer(const tString &in asName)

Parameters

asName (tString) —

Returns:

void

ResetLatestEntity

void ResetLatestEntity()

Returns:

void

RestartCurrentTimer

void RestartCurrentTimer(float afNewTime = -1)

Parameters

afNewTime (float) —

Returns:

void

ScriptExecute

bool ScriptExecute()

Returns:

bool—

ScriptMethodExists

bool ScriptMethodExists(const tString &in asMethod)

Parameters

asMethod (tString) —

Returns:

bool—

ScriptMethodExistsFast

bool ScriptMethodExistsFast(const tString &in asMethod,
                            int alId)

Parameters

asMethod (tString) —
alId (int) —

Returns:

bool—

ScriptPrepare

bool ScriptPrepare(const tString &in asMethod)

Parameters

asMethod (tString) —

Returns:

bool—

ScriptPrepareFast

bool ScriptPrepareFast(const tString &in asMethod,
                       int alId)

Parameters

asMethod (tString) —
alId (int) —

Returns:

bool—

SetActive

void SetActive(bool abX)

Parameters

abX (bool) —

Returns:

void

SetArgBool

void SetArgBool(int alArgNum,
                bool abVal)

Parameters

alArgNum (int) —
abVal (bool) —

Returns:

void

SetArgFloat

void SetArgFloat(int alArg,
                 float afX)

Parameters

alArg (int) —
afX (float) —

Returns:

void

SetArgInt

void SetArgInt(int alArg,
               int alX)

Parameters

alArg (int) —
alX (int) —

Returns:

void

SetArgString

void SetArgString(int alArg,
                  const tString &in asStr)

Parameters

alArg (int) —
asStr (tString) —

Returns:

void

SetArgVector2f

void SetArgVector2f(int alArg,
                    const cVector2f &in avX)

Parameters

alArg (int) —
avX (cVector2f) —

Returns:

void

SetArgVector2l

void SetArgVector2l(int alArg,
                    const cVector2l &in avX)

Parameters

alArg (int) —
avX (cVector2l) —

Returns:

void

SetArgVector3f

void SetArgVector3f(int alArg,
                    const cVector3f &in avX)

Parameters

alArg (int) —
avX (cVector3f) —

Returns:

void

SetArgVector3l

void SetArgVector3l(int alArg,
                    const cVector3l &in avX)

Parameters

alArg (int) —
avX (cVector3l) —

Returns:

void

SetDisplayNameEntry

void SetDisplayNameEntry(const tString &in asEntry)

Parameters

asEntry (tString) —

Returns:

void

SetIsUnderwater

void SetIsUnderwater(bool abX)

Parameters

abX (bool) —

Returns:

void

SetMaxInteractDistance

void SetMaxInteractDistance(float afX)

Parameters

afX (float) —

Returns:

void

SetPlayerTerrainCollision

void SetPlayerTerrainCollision(bool abX)

Parameters

abX (bool) —

Returns:

void

SetTimerPaused

void SetTimerPaused(const tString &in asName,
                    bool abX)

Parameters

asName (tString) —
abX (bool) —

Returns:

void

SetTimerUserVarFloat

void SetTimerUserVarFloat(const tString &in asName,
                          float afX)

Parameters

asName (tString) —
afX (float) —

Returns:

void

SetTimerUserVarInt

void SetTimerUserVarInt(const tString &in asName,
                        int alX)

Parameters

asName (tString) —
alX (int) —

Returns:

void

SetTimerUserVarString

void SetTimerUserVarString(const tString &in asName,
                           const tString &in asX)

Parameters

asName (tString) —
asX (tString) —

Returns:

void

SetVoiceSource

void SetVoiceSource(const tString &in asCharacter,
                    const tString &in asEntityName,
                    float afMinDistance,
                    float afMaxDistance,
                    bool abUse3D,
                    float afMaxPlayerListeningRange,
                    float afMinFreq = 22000,
                    float afMaxFreq = 22000,
                    uint aFrequencyFlag = 0)

Parameters

asCharacter (tString) —
asEntityName (tString) —
afMinDistance (float) —
afMaxDistance (float) —
abUse3D (bool) —
afMaxPlayerListeningRange (float) —
afMinFreq (float) —
afMaxFreq (float) —
aFrequencyFlag (uint) —

Returns:

void

Update

void Update(float afTimeStep)

Parameters

afTimeStep (float) —

Returns:

void

VariableUpdate

void VariableUpdate(float afDeltaTime)

Parameters

afDeltaTime (float) —

Returns:

void

References

See all references...

HPL3/Amnesia: Rebirth/Scripting/cLuxMap

Contents

Fields

Functions

Details

AddDissolveEntity

AddEntityComponent

AddTimer

BroadcastSoundHeardEvent

CheckLineOfSight

CloneProp

CopyPropState

CreateEntity

DestroyEntity

EntityExists

EntityWasDestroyed

GetClosestBody

GetClosestCharCollideBody

GetClosestCharCollider

GetClosestEntity

GetCollideFlag

GetDisplayNameEntry

GetElapsedTime

GetEntityArray

GetEntityArrayID

GetEntityByID

GetEntityByName

GetEntityComponent

GetEntityComponentIterator

GetEntityIDByName

GetFileName

GetHackNode

GetIsUnderwater

GetLatestEntity

GetLightLevelAtPos

GetMaxInteractDistance

GetName

GetNewAttackInstanceID

GetPhysicsWorld

GetPlayerEntity

GetPlayerTerrainCollision

GetReturnBool

GetReturnFloat

GetReturnInt

GetReturnString

GetTimersNamed

GetTimerTime

GetTimerUserVarFloat

GetTimerUserVarInt

GetTimerUserVarString

GetTimeStamp

GetVoiceSourceEntity

GetWorld

IncTimerUserVarFloat

IncTimerUserVarInt

IsActive

IsDeletingAllWorldEntities

PlacePlayerAtStartPos

PostUpdate

PreloadEntity

PreloadGuiGfx

PreloadMaterial

PreloadParticleSystem

RemoveEntityComponent

RemoveTimer

ResetLatestEntity

RestartCurrentTimer

ScriptExecute

ScriptMethodExists

ScriptMethodExistsFast

ScriptPrepare

ScriptPrepareFast

SetActive

SetArgBool

SetArgFloat

SetArgInt

SetArgString

SetArgVector2f

SetArgVector2l

SetArgVector3f