HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux

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!

Summary

Return Type	Function and Description
void	cLux_AddAIDebugMessage(const tString &in asText, bool abAddToDebugLog, bool abCheckForDuplicates)
void	cLux_AddAIDebugMessage(const tString &in asText)
void	cLux_AddAreaType(const tString &in asName, const tString &in asScriptFile, const tString &in asScriptClass, bool abForceFullGameSave)
void	cLux_AddCritterType(const tString &in asName, const tString &in asScriptFile, const tString &in asScriptClass, bool abForceFullGameSave)
void	cLux_AddDebugMessage(const tString &in asText, bool abCheckForDuplicates)
void	cLux_AddDebugMessage(const tString &in asText)
void	cLux_AddEntityToInteractionWhiteList(iLuxEntity@ apEntity)
void	cLux_AddIgnoredLight(tID a_idLight)
void	cLux_AddLiquidAreaType(const tString &in asName, const tString &in asScriptFile, const tString &in asScriptClass, bool abForceFullGameSave)
void	cLux_AddModule(const tString &in asName, const tString &in asScriptFile, const tString &in asScriptClass, int alId, bool abIsGlobal, const tString &in sContainer, bool abUseInputCallbacks)
void	cLux_AddPropType(const tString &in asName, const tString &in asScriptFile, const tString &in asScriptClass, bool abForceFullGameSave)
void	cLux_AddTodoMessage(const tString &in asText, bool abCheckForDuplicates)
void	cLux_AddTodoMessage(const tString &in asText)
bool	cLux_ApplyUserConfig()
void	cLux_CacheAddMaterial(const tString &in asFile)
void	cLux_CacheAddMesh(const tString &in asFile)
void	cLux_CacheRemoveMaterial(const tString &in asFile)
void	cLux_CacheRemoveMesh(const tString &in asFile)
bool	cLux_CanContinue()
void	cLux_ChangeMap(const tString &in asMapName, const tString &in asStartPos, const tString &in asTransferArea, const tString &in asStartSound, const tString &in asEndSound, bool abShowLoadingScreen, float afFadeInTime = -1.0f)
void	cLux_ChangeMapDebug(const tString &in asMap)
bool	cLux_CheckIsInDirectLight(const cVector3f &in avPos)
bool	cLux_CheckLineOfSight(const cVector3f &in avStart, const cVector3f &in avEnd, bool abCheckOnlyShadowCasters, bool abCheckOnlyStatic, iLuxEntity@ apSkipEntity = null)
void	cLux_CleanupData()
void	cLux_ClearAllMapSaveData()
void	cLux_ClearIgnoredLights()
void	cLux_ClearMapSaveData(const tString &in asMapName)
void	cLux_ClearPlayedVoiceLines()
void	cLux_Continue()
cLuxAttackDamage	cLux_CreateEntityComponent_AttackDamage(iLuxEntity @apEntity)
cLuxBackboneTail	cLux_CreateEntityComponent_BackboneTail(iLuxEntity @apEntity)
cLuxBarkMachine	cLux_CreateEntityComponent_BarkMachine(iLuxEntity @apEntity)
cLuxCharMover	cLux_CreateEntityComponent_CharMover(iLuxEntity @apEntity, iCharacterBody @apCharBody)
cLuxEdgeGlow	cLux_CreateEntityComponent_EdgeGlow(iLuxEntity @apEntity)
cLuxFootPlacement	cLux_CreateEntityComponent_FootPlacement(iLuxEntity @apEntity)
cLuxForceEmitter	cLux_CreateEntityComponent_ForceEmitter(iLuxEntity @apEntity)
cLuxHandPlacement	cLux_CreateEntityComponent_HandPlacement(iLuxEntity @apEntity)
cLuxHeadTracker	cLux_CreateEntityComponent_HeadTracker(iLuxEntity @apEntity)
cLuxLightSensor	cLux_CreateEntityComponent_LightSensor(iLuxEntity @apEntity)
cLuxPathfinder	cLux_CreateEntityComponent_Pathfinder(iLuxEntity @apEntity)
cLuxProximitySensor	cLux_CreateEntityComponent_ProximitySensor(iLuxEntity @apEntity)
cLuxSoundListener	cLux_CreateEntityComponent_SoundListener(iLuxEntity @apEntity)
cLuxStateMachine	cLux_CreateEntityComponent_StateMachine(iLuxEntity @apEntity)
cLuxVerletAnimation	cLux_CreateEntityComponent_VerletAnimation(iLuxEntity @apEntity)
tString	cLux_CreateHTMLImage(const tString &in asSrc, const tString &in asTitle = "", const cVector2l &in avSize = cVector2l_MinusOne)
tString	cLux_CreateHTMLParagraph(const tString &in asContent)
tString	cLux_CreateHTMLTag(const tString &in asTag, const tString &in asContent = "", const tString &in asParams = "")
cLuxScriptImGui	cLux_CreateScriptImGui(const tString &in asName, bool abRegisterForDrawing, bool abSkipResetOnRegistration = true)
iScrUserComponent_Interface	cLux_CreateUserComponent(iLuxEntity@ apEntity, const tString &in asComponentName, const tString &in asScriptFile, const tString &in asScriptClass, int alID)
bool	cLux_DebugModeOn()
void	cLux_DecUnderwaterEffectUserCount()
void	cLux_DeloadMap(const tString &in asTransferArea)
void	cLux_DisableSaving(float afDuration)
float	cLux_DrawDebugText(const tString &in asText, float afY, float afSize = 14, cColor aColor = cColor, ../../ 1, ../../ 1, bool abAddNewLine = true)
void	cLux_DrawHint(cImGui @apImGui, float afTimeStep, const cImGuiLabelData &in aLabel, const cVector3f &in avPosition, float afLineWidth, float afLineSpacing, const array<tWString> &in avTextLines, const array<cLuxScreenTextIcon@> &in avIcons, const array<array> &in avIconsPerLine)
void	cLux_DrawScreenText(cImGui @apImGui, float afTimeStep, const cImGuiLabelData &in aLabel, const cVector3f &in avPosition, float afLineWidth, float afLineSpacing, const array<tWString> &in avTextLines, const array<cLuxScreenTextIcon@> &in avIcons, const array<array> &in avIconsPerLine)
void	cLux_DrawSetToScreen(bool abClearScreen, const cColor &in aCol, cGuiSet@ apSet)
void	cLux_DropPageFocus(const tString &in asX)
void	cLux_EnableSaving()
void	cLux_Exit()
iLuxAchievementHandler	cLux_GetAchievementHandler()
float	cLux_GetAverageBrightness()
iLuxEntity	cLux_GetBodyEntity(iPhysicsBody @apBody)
iPhysicsBody	cLux_GetClosestBody(const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, float &out afDistance, cVector3f &out avSurfaceNormal)
iPhysicsBody	cLux_GetClosestCharCollideBody(const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, float &out afDistance, cVector3f &out avSurfaceNormal)
bool	cLux_GetClosestCharCollider(const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, bool abCheckDynamic, cLuxClosestCharCollider @apOutput)
bool	cLux_GetClosestEntity(const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, int alIteractType, bool abCheckLineOfSight, cLuxClosestEntityData @apOutput)
void	cLux_GetConsoleMaps(array<tString> &out avMaps)
cImGui	cLux_GetCurrentImGui()
tString	cLux_GetCurrentLanguage()
cLuxMap	cLux_GetCurrentMap()
tWString	cLux_GetCurrentUserProfilePath()
int	cLux_GetDebugGameSpeed()
iFontData	cLux_GetDefaultFont()
tString	cLux_GetDefaultGameLanguage()
cLuxDialogHandler	cLux_GetDialogHandler()
cLuxEffectHandler	cLux_GetEffectHandler()
cLuxEventDatabaseHandler	cLux_GetEventDatabaseHandler()
cConfigFile	cLux_GetGameConfig()
cImGui	cLux_GetGameHudImGui()
cGuiSet	cLux_GetGameHudSet()
tString	cLux_GetGameLanguageFolder()
bool	cLux_GetGamePaused()
double	cLux_GetGameTime()
bool	cLux_GetGodModeActivated()
cLuxGuiHandler	cLux_GetGuiHandler()
cGuiSet	cLux_GetHelpGuiSet()
bool	cLux_GetHideCrosshair()
bool	cLux_GetHideHints()
bool	cLux_GetHidePopupIcons()
bool	cLux_GetHidingEffectsActive()
float	cLux_GetHudDisplayScale()
cVector2f	cLux_GetHudVirtualCenterScreenSize()
cVector3f	cLux_GetHudVirtualCenterScreenStartPos()
cVector2f	cLux_GetHudVirtualCenterSize()
cVector2f	cLux_GetHudVirtualOffset()
cVector2f	cLux_GetHudVirtualSize()
cVector3f	cLux_GetHudVirtualStartPos()
cImGui	cLux_GetInputFocusImGui()
cLuxInputHandler	cLux_GetInputHandler()
bool	cLux_GetInteractionWhiteListActive()
cConfigFile	cLux_GetKeyConfig()
float	cLux_GetLightLeveAtPosWithoutIgnoredLights(const cVector3f &in avPos, float afRadiusAdd)
float	cLux_GetLightLevelAtPos(const cVector3f &in avPos, iLight @apSkipLight, float afRadiusAdd)
float	cLux_GetLogAverageBrightness()
bool	cLux_GetLookAtCallbacksActive()
tString	cLux_GetMainMenuFile()
cLuxModHandler	cLux_GetModHandler()
cLuxMusicHandler	cLux_GetMusicHandler()
cLuxPlayer	cLux_GetPlayer()
cLuxMap	cLux_GetPreloadMap()
cImGui	cLux_GetPrevInputFocusImGui()
int	cLux_GetProfilerActive()
bool	cLux_GetSaveConfigAtExit()
cLuxSaveHandler	cLux_GetSaveHandler()
bool	cLux_GetSavingEnabled()
float	cLux_GetSingleLightLevelAtPos(const cVector3f &in avPos, tID a_idLight, float afRadiusAdd)
cLuxSoundscapeHandler	cLux_GetSoundscapeHandler()
void	cLux_GetStartPositions(array<tString> &out avStartPos)
float	cLux_GetStringDuration(const tWString &in asStr)
tWString	cLux_GetStringWFromDate(const cDate &in aDate)
void	cLux_GetTextCatAndEntryFromString(const tString &in asData, tString &out asOutCat, tString &out asOutEntry)
bool	cLux_GetUnderwaterEffectsActive()
iScrUserComponent_Interface	cLux_GetUserComponent(iLuxEntity@ apEntity, int alID)
iScrUserComponent_Interface	cLux_GetUserComponentScriptInterface(iLuxEntityComponent@ apComponent)
cConfigFile	cLux_GetUserConfig()
iScrUserModule_Interface	cLux_GetUserModuleFromID(int alID, bool abSilent = false)
iScrUserModule_Interface	cLux_GetUserModuleFromName(const tString &in asName)
cViewport	cLux_GetViewport()
cLuxVoiceHandler	cLux_GetVoiceHandler()
bool	cLux_HasConfigLoadError(tString &out asError)
bool	cLux_HasTranslation(const tString &in asCat, const tString &in asEntry)
bool	cLux_HasUnderwaterEffectUsers()
bool	cLux_HideDebugOutputOn()
cLuxAgent	cLux_ID_Agent(tID aID)
cLuxArea	cLux_ID_Area(tID aID)
cBeam	cLux_ID_Beam(tID aID)
cBillboard	cLux_ID_Billboard(tID aID)
cBillboardGroup	cLux_ID_BillboardGroup(tID aID)
iPhysicsBody	cLux_ID_Body(tID aID)
iCharacterBody	cLux_ID_CharacterBody(tID aID)
cClothEntity	cLux_ID_ClothEntity(tID aID)
cLuxCritter	cLux_ID_Critter(tID aID)
iLuxEntity	cLux_ID_Entity(tID aID)
iEntity3D	cLux_ID_Entity3D(tID aID)
cExposureArea	cLux_ID_ExposureArea(tID aID)
cFogArea	cLux_ID_FogArea(tID aID)
cForceField	cLux_ID_ForceField(tID aID)
cGuiSetEntity	cLux_ID_GuiSetEntity(tID aID)
iPhysicsJoint	cLux_ID_Joint(tID aID)
cLensFlare	cLux_ID_LensFlare(tID aID)
iLight	cLux_ID_Light(tID aID)
cLightMaskBox	cLux_ID_LightMaskBox(tID aID)
cLuxLiquidArea	cLux_ID_LiquidArea(tID aID)
cMeshEntity	cLux_ID_MeshEntity(tID aID)
cParticleSystem	cLux_ID_ParticleSystem(tID aID)
cLuxProp	cLux_ID_Prop(tID aID)
cLuxPushableFogArea	cLux_ID_PushableFogArea(tID aID)
cLuxSoundscapeArea	cLux_ID_ReverbArea(tID aID)
iRopeEntity	cLux_ID_RopeEntity(tID aID)
cSoundEntity	cLux_ID_SoundEntity(tID aID)
cSubMeshEntity	cLux_ID_SubMeshEntity(tID aID)
void	cLux_IncUnderwaterEffectUserCount()
bool	cLux_IsChangingMap()
bool	cLux_IsLoadingScreenVisible()
bool	cLux_IsPlayGoReady(int64 &out alETA)
bool	cLux_IsReadyToChangeMap()
bool	cLux_IsStreamingMap()
void	cLux_LoadScreenSetBarPosAndSize(const cVector2f &in avPos, const cVector2f &in avSize)
void	cLux_LoadScreenSetForceBackground(bool abX)
void	cLux_LoadScreenShowLoadingIcon(float afTime)
bool	cLux_MapChangeIsTransfer()
bool	cLux_MapIsLoaded()
void	cLux_OutputTextToFile(const tWString &in asPath, const tString &in asText)
tWString	cLux_ParseString(const tWString &in asInput)
void	cLux_ParseStringIntoScreenText(const tWString &in asInput, cImGui @apImGui, const cLuxScreenTextFormatParameters & aFormatParams, array<tWString> &out aOutLines, array<cLuxScreenTextIcon@> &out aIconArray, array<array> &out aOutIconsPerLine, float &out afMaxLineHeight, float &out afDisplayTime, bool abTriggeredByGamepad)
bool	cLux_PlayGuiSoundData(const tString &in asName, eSoundEntryType aDestType, float afVolMul, bool abSkipPreviousRandom)
bool	cLux_PlayGuiSoundDataEx(const tString &in asName, eSoundEntryType aDestType, float afVolMul, bool abSkipPreviousRandom, cLuxSoundExtraData @apExtraData)
void	cLux_PreloadEntity(const tString &in asFile)
void	cLux_PreloadGuiGfx(const tString &in asFile, eImGuiGfx aType)
void	cLux_PreloadMap(const tString &in asMapName, eWorldStreamPriority aPrio = eWorldStreamPriority_Normal)
void	cLux_PreloadMaterial(const tString &in asFile)
void	cLux_PreloadParticleSystem(const tString &in asFile)
void	cLux_PreloadSound(const tString &in asFile)
void	cLux_PreloadWebpage(const tString &in asX)
void	cLux_ProfileEnd(const tString &in asMarker)
void	cLux_ProfileStart(const tString &in asMarker)
void	cLux_RayDamage(const cVector3f &in avStart, const cVector3f &in avDirection, float afRayLength, float afDamage, float afForce, float afMaxImpulse, int alStrength, float afHitSpeed, int aDamageType, bool abCheckAgents, bool abCheckPlayer, bool abCheckProps, bool abLethalForPlayer, tID a_idSource, int alInstanceId)
void	cLux_RegisterCollisionRadius(int alX)
void	cLux_RegisterEventListenerUserModule_AgentSetActive(const tString &in asModuleName)
void	cLux_ReloadGame()
void	cLux_RenderBackgroundScreen(bool abDrawFullHUD)
void	cLux_ResetShudderEffects(int alX)
void	cLux_RunTestButton(int alX)
void	cLux_SaveScreenshotToFile(const tWString &in asPath, const cVector2l &in avSize = cVector2l_MinusOne, bool abKeepAspect = true, float afBrightness = 1.0f)
bool	cLux_ScriptDebugOn()
void	cLux_SendInputToGui(bool abX)
void	cLux_SetAreaOffline(int alX)
void	cLux_SetComputeAverageFrameColor(bool abActive)
void	cLux_SetDebugGameSpeed(int alX)
void	cLux_SetDebugInfoWindowText(const tString &in asText)
void	cLux_SetGamePaused(bool abX, bool abPauseMusic, bool abPauseSounds, bool abPauseAmbience)
void	cLux_SetGodModeActivated(bool abActive)
void	cLux_SetHideDebugOutputOn(bool abActive)
void	cLux_SetHideModeEffectsActive(bool abX)
void	cLux_SetImGuiInputFocus(cImGui@ apImGui, bool abShowMouse)
void	cLux_SetInteractionWhiteListActive(bool abX, bool abClearList)
void	cLux_SetLookAtCallbacksActive(bool abX)
void	cLux_SetMapPreloadPriority(eWorldStreamPriority aPrio)
void	cLux_SetProfilerActive(int alMode)
void	cLux_SetProfilerFilter(const tString &in asFilter)
void	cLux_SetProfilerPauseInterval(float afInterval)
void	cLux_SetScriptDebugOn(bool abActive)
void	cLux_SetTerrainSettings(int alTextureSize, int alDiffuseTexelsPerMeter, int alNormalTexelsPerMeter, int alSpecTexelsPerMeter)
void	cLux_SetUnderwaterEffectsActive(bool abX, bool abUseStartAndEndEffects)
void	cLux_SetupDefaultGlobalReverb(eSoundReverbPreset aType, float afFadeTime)
void	cLux_ShapeDamage(iCollideShape @apShape, const cMatrixf &in a_mtxTransform, const cVector3f &in avOrigin, float afDamage, float afForce, float afMaxImpulse, int alStrength, float afHitSpeed, int aDamageType, bool abCheckAgents, bool abCheckPlayer, bool abCheckProps, bool abLethalForPlayer, tID a_idSource, int alInstanceId)
bool	cLux_ShowEntityInfoOn()
void	cLux_StartMap(const tString &in asMapName)
void	cLux_StartNewGame()
void	cLux_TeleportToStartPos(const tString &in asStartPos)
bool	cLux_TestModeOn()
cLuxAgent	cLux_ToAgent(iLuxEntity @apEntity)
cLuxArea	cLux_ToArea(iLuxEntity @apEntity)
cLuxCritter	cLux_ToCritter(iLuxEntity @apEntity)
cLuxLiquidArea	cLux_ToLiquidArea(iLuxEntity @apEntity)
cLuxProp	cLux_ToProp(iLuxEntity @apEntity)
cLuxPushableFogArea	cLux_ToPushableFogArea(iLuxEntity @apEntity)
tWString	cLux_Translate(const tString &in asCat, const tString &in asEntry)
tWString	cLux_TranslatePlatformSpecific(const tString &in asCat, const tString &in asEntry)
void	cLux_TruncateTextFile(const tWString &in asPath, const tString &in asPattern, int alTimes)

Function Detail

cLux_AddAIDebugMessage

void cLux_AddAIDebugMessage(const tString &in asText,
                            bool abAddToDebugLog,
                            bool abCheckForDuplicates)

Parameters

asText (tString) —
abAddToDebugLog (bool) —
abCheckForDuplicates (bool) —

Returns:

void

cLux_AddAIDebugMessage

void cLux_AddAIDebugMessage(const tString &in asText)

Parameters

asText (tString) —

Returns:

void

cLux_AddAreaType

void cLux_AddAreaType(const tString &in asName,
                      const tString &in asScriptFile,
                      const tString &in asScriptClass,
                      bool abForceFullGameSave)

Parameters

asName (tString) —
asScriptFile (tString) —
asScriptClass (tString) —
abForceFullGameSave (bool) —

Returns:

void

cLux_AddCritterType

void cLux_AddCritterType(const tString &in asName,
                         const tString &in asScriptFile,
                         const tString &in asScriptClass,
                         bool abForceFullGameSave)

Parameters

asName (tString) —
asScriptFile (tString) —
asScriptClass (tString) —
abForceFullGameSave (bool) —

Returns:

void

cLux_AddDebugMessage

void cLux_AddDebugMessage(const tString &in asText,
                          bool abCheckForDuplicates)

Parameters

asText (tString) —
abCheckForDuplicates (bool) —

Returns:

void

cLux_AddDebugMessage

void cLux_AddDebugMessage(const tString &in asText)

Parameters

asText (tString) —

Returns:

void

cLux_AddEntityToInteractionWhiteList

void cLux_AddEntityToInteractionWhiteList(iLuxEntity@ apEntity)

Parameters

apEntity (iLuxEntity@) —

Returns:

void

cLux_AddIgnoredLight

void cLux_AddIgnoredLight(tID a_idLight)

Parameters

a_idLight (tID) —

Returns:

void

cLux_AddLiquidAreaType

void cLux_AddLiquidAreaType(const tString &in asName,
                            const tString &in asScriptFile,
                            const tString &in asScriptClass,
                            bool abForceFullGameSave)

Parameters

asName (tString) —
asScriptFile (tString) —
asScriptClass (tString) —
abForceFullGameSave (bool) —

Returns:

void

cLux_AddModule

void cLux_AddModule(const tString &in asName,
                    const tString &in asScriptFile,
                    const tString &in asScriptClass,
                    int alId,
                    bool abIsGlobal,
                    const tString &in sContainer,
                    bool abUseInputCallbacks)

Parameters

asName (tString) —
asScriptFile (tString) —
asScriptClass (tString) —
alId (int) —
abIsGlobal (bool) —
sContainer (tString) —
abUseInputCallbacks (bool) —

Returns:

void

cLux_AddPropType

void cLux_AddPropType(const tString &in asName,
                      const tString &in asScriptFile,
                      const tString &in asScriptClass,
                      bool abForceFullGameSave)

Parameters

asName (tString) —
asScriptFile (tString) —
asScriptClass (tString) —
abForceFullGameSave (bool) —

Returns:

void

cLux_AddTodoMessage

void cLux_AddTodoMessage(const tString &in asText,
                         bool abCheckForDuplicates)

Parameters

asText (tString) —
abCheckForDuplicates (bool) —

Returns:

void

cLux_AddTodoMessage

void cLux_AddTodoMessage(const tString &in asText)

Parameters

asText (tString) —

Returns:

void

cLux_ApplyUserConfig

bool cLux_ApplyUserConfig()

Returns:

bool—

cLux_CacheAddMaterial

void cLux_CacheAddMaterial(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_CacheAddMesh

void cLux_CacheAddMesh(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_CacheRemoveMaterial

void cLux_CacheRemoveMaterial(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_CacheRemoveMesh

void cLux_CacheRemoveMesh(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_CanContinue

bool cLux_CanContinue()

Returns:

bool—

cLux_ChangeMap

void cLux_ChangeMap(const tString &in asMapName,
                    const tString &in asStartPos,
                    const tString &in asTransferArea,
                    const tString &in asStartSound,
                    const tString &in asEndSound,
                    bool abShowLoadingScreen,
                    float afFadeInTime = -1.0f)

Parameters

asMapName (tString) —
asStartPos (tString) —
asTransferArea (tString) —
asStartSound (tString) —
asEndSound (tString) —
abShowLoadingScreen (bool) —
afFadeInTime (float) —

Returns:

void

cLux_ChangeMapDebug

void cLux_ChangeMapDebug(const tString &in asMap)

Parameters

asMap (tString) —

Returns:

void

cLux_CheckIsInDirectLight

bool cLux_CheckIsInDirectLight(const cVector3f &in avPos)

Parameters

avPos (cVector3f) —

Returns:

bool—

cLux_CheckLineOfSight

bool cLux_CheckLineOfSight(const cVector3f &in avStart,
                           const cVector3f &in avEnd,
                           bool abCheckOnlyShadowCasters,
                           bool abCheckOnlyStatic,
                           iLuxEntity@ apSkipEntity = null)

Parameters

avStart (cVector3f) —
avEnd (cVector3f) —
abCheckOnlyShadowCasters (bool) —
abCheckOnlyStatic (bool) —
apSkipEntity (iLuxEntity@) —

Returns:

bool—

cLux_CleanupData

void cLux_CleanupData()

Returns:

void

cLux_ClearAllMapSaveData

void cLux_ClearAllMapSaveData()

Returns:

void

cLux_ClearIgnoredLights

void cLux_ClearIgnoredLights()

Returns:

void

cLux_ClearMapSaveData

void cLux_ClearMapSaveData(const tString &in asMapName)

Parameters

asMapName (tString) —

Returns:

void

cLux_ClearPlayedVoiceLines

void cLux_ClearPlayedVoiceLines()

Returns:

void

cLux_Continue

void cLux_Continue()

Returns:

void

cLux_CreateEntityComponent_AttackDamage

cLuxAttackDamage@ cLux_CreateEntityComponent_AttackDamage(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxAttackDamage@—

cLux_CreateEntityComponent_BackboneTail

cLuxBackboneTail@ cLux_CreateEntityComponent_BackboneTail(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxBackboneTail@—

cLux_CreateEntityComponent_BarkMachine

cLuxBarkMachine@ cLux_CreateEntityComponent_BarkMachine(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxBarkMachine@—

cLux_CreateEntityComponent_CharMover

cLuxCharMover@ cLux_CreateEntityComponent_CharMover(iLuxEntity @apEntity,
                                                    iCharacterBody @apCharBody)

Parameters

@apEntity (iLuxEntity) —
@apCharBody (iCharacterBody) —

Returns:

cLuxCharMover@—

cLux_CreateEntityComponent_EdgeGlow

cLuxEdgeGlow@ cLux_CreateEntityComponent_EdgeGlow(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxEdgeGlow@—

cLux_CreateEntityComponent_FootPlacement

cLuxFootPlacement@ cLux_CreateEntityComponent_FootPlacement(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxFootPlacement@—

cLux_CreateEntityComponent_ForceEmitter

cLuxForceEmitter@ cLux_CreateEntityComponent_ForceEmitter(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxForceEmitter@—

cLux_CreateEntityComponent_HandPlacement

cLuxHandPlacement@ cLux_CreateEntityComponent_HandPlacement(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxHandPlacement@—

cLux_CreateEntityComponent_HeadTracker

cLuxHeadTracker@ cLux_CreateEntityComponent_HeadTracker(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxHeadTracker@—

cLux_CreateEntityComponent_LightSensor

cLuxLightSensor@ cLux_CreateEntityComponent_LightSensor(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxLightSensor@—

cLux_CreateEntityComponent_Pathfinder

cLuxPathfinder@ cLux_CreateEntityComponent_Pathfinder(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxPathfinder@—

cLux_CreateEntityComponent_ProximitySensor

cLuxProximitySensor@ cLux_CreateEntityComponent_ProximitySensor(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxProximitySensor@—

cLux_CreateEntityComponent_SoundListener

cLuxSoundListener@ cLux_CreateEntityComponent_SoundListener(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxSoundListener@—

cLux_CreateEntityComponent_StateMachine

cLuxStateMachine@ cLux_CreateEntityComponent_StateMachine(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxStateMachine@—

cLux_CreateEntityComponent_VerletAnimation

cLuxVerletAnimation@ cLux_CreateEntityComponent_VerletAnimation(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxVerletAnimation@—

cLux_CreateHTMLImage

tString cLux_CreateHTMLImage(const tString &in asSrc,
                             const tString &in asTitle = "",
                             const cVector2l &in avSize = cVector2l_MinusOne)

Parameters

asSrc (tString) —
asTitle (tString) —
avSize (cVector2l) —

Returns:

tString—

cLux_CreateHTMLParagraph

tString cLux_CreateHTMLParagraph(const tString &in asContent)

Parameters

asContent (tString) —

Returns:

tString—

cLux_CreateHTMLTag

tString cLux_CreateHTMLTag(const tString &in asTag,
                           const tString &in asContent = "",
                           const tString &in asParams = "")

Parameters

asTag (tString) —
asContent (tString) —
asParams (tString) —

Returns:

tString—

cLux_CreateScriptImGui

cLuxScriptImGui@ cLux_CreateScriptImGui(const tString &in asName,
                                        bool abRegisterForDrawing,
                                        bool abSkipResetOnRegistration = true)

Parameters

asName (tString) —
abRegisterForDrawing (bool) —
abSkipResetOnRegistration (bool) —

Returns:

cLuxScriptImGui@—

cLux_CreateUserComponent

iScrUserComponent_Interface@ cLux_CreateUserComponent(iLuxEntity@ apEntity,
                                                      const tString &in asComponentName,
                                                      const tString &in asScriptFile,
                                                      const tString &in asScriptClass,
                                                      int alID)

Parameters

apEntity (iLuxEntity@) —
asComponentName (tString) —
asScriptFile (tString) —
asScriptClass (tString) —
alID (int) —

Returns:

iScrUserComponent_Interface@—

cLux_DebugModeOn

bool cLux_DebugModeOn()

Returns:

bool—

cLux_DecUnderwaterEffectUserCount

void cLux_DecUnderwaterEffectUserCount()

Returns:

void

cLux_DeloadMap

void cLux_DeloadMap(const tString &in asTransferArea)

Parameters

asTransferArea (tString) —

Returns:

void

cLux_DisableSaving

void cLux_DisableSaving(float afDuration)

Parameters

afDuration (float) —

Returns:

void

cLux_DrawDebugText

float cLux_DrawDebugText(const tString &in asText,
                         float afY,
                         float afSize = 14,
                         cColor aColor = cColor,
                          1,
                          1,
                         bool abAddNewLine = true)

Parameters

asText (tString) —
afY (float) —
afSize (float) —
aColor (cColor) —
1 (../../) —
1 (../../) —
abAddNewLine (bool) —

Returns:

float—

cLux_DrawHint

void cLux_DrawHint(cImGui @apImGui,
                   float afTimeStep,
                   const cImGuiLabelData &in aLabel,
                   const cVector3f &in avPosition,
                   float afLineWidth,
                   float afLineSpacing,
                   const tWString &in avTextLines,
                   const cLuxScreenTextIcon@ &in avIcons,
                   const array &in avIconsPerLine)

Parameters

@apImGui (cImGui) —
afTimeStep (float) —
aLabel (cImGuiLabelData) —
avPosition (cVector3f) —
afLineWidth (float) —
afLineSpacing (float) —
avTextLines (tWString) —
avIcons (cLuxScreenTextIcon@) —
avIconsPerLine (array) —

Returns:

void

cLux_DrawScreenText

void cLux_DrawScreenText(cImGui @apImGui,
                         float afTimeStep,
                         const cImGuiLabelData &in aLabel,
                         const cVector3f &in avPosition,
                         float afLineWidth,
                         float afLineSpacing,
                         const tWString &in avTextLines,
                         const cLuxScreenTextIcon@ &in avIcons,
                         const array &in avIconsPerLine)

Parameters

@apImGui (cImGui) —
afTimeStep (float) —
aLabel (cImGuiLabelData) —
avPosition (cVector3f) —
afLineWidth (float) —
afLineSpacing (float) —
avTextLines (tWString) —
avIcons (cLuxScreenTextIcon@) —
avIconsPerLine (array) —

Returns:

void

cLux_DrawSetToScreen

void cLux_DrawSetToScreen(bool abClearScreen,
                          const cColor &in aCol,
                          cGuiSet@ apSet)

Parameters

abClearScreen (bool) —
aCol (cColor) —
apSet (cGuiSet@) —

Returns:

void

cLux_DropPageFocus

void cLux_DropPageFocus(const tString &in asX)

Parameters

asX (tString) —

Returns:

void

cLux_EnableSaving

void cLux_EnableSaving()

Returns:

void

cLux_Exit

void cLux_Exit()

Returns:

void

cLux_GetAchievementHandler

iLuxAchievementHandler@ cLux_GetAchievementHandler()

Returns:

iLuxAchievementHandler@—

cLux_GetAverageBrightness

float cLux_GetAverageBrightness()

Returns:

float—

cLux_GetBodyEntity

iLuxEntity@ cLux_GetBodyEntity(iPhysicsBody @apBody)

Parameters

@apBody (iPhysicsBody) —

Returns:

iLuxEntity@—

cLux_GetClosestBody

iPhysicsBody@ cLux_GetClosestBody(const cVector3f &in avStart,
                                  const cVector3f &in avDir,
                                  float afRayLength,
                                  float &out afDistance,
                                  cVector3f &out avSurfaceNormal)

Parameters

avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
afDistance (float) —
avSurfaceNormal (cVector3f) —

Returns:

iPhysicsBody@—

cLux_GetClosestCharCollideBody

iPhysicsBody@ cLux_GetClosestCharCollideBody(const cVector3f &in avStart,
                                             const cVector3f &in avDir,
                                             float afRayLength,
                                             float &out afDistance,
                                             cVector3f &out avSurfaceNormal)

Parameters

avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
afDistance (float) —
avSurfaceNormal (cVector3f) —

Returns:

iPhysicsBody@—

cLux_GetClosestCharCollider

bool cLux_GetClosestCharCollider(const cVector3f &in avStart,
                                 const cVector3f &in avDir,
                                 float afRayLength,
                                 bool abCheckDynamic,
                                 cLuxClosestCharCollider @apOutput)

Parameters

avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
abCheckDynamic (bool) —
@apOutput (cLuxClosestCharCollider) —

Returns:

bool—

cLux_GetClosestEntity

bool cLux_GetClosestEntity(const cVector3f &in avStart,
                           const cVector3f &in avDir,
                           float afRayLength,
                           int alIteractType,
                           bool abCheckLineOfSight,
                           cLuxClosestEntityData @apOutput)

Parameters

avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
alIteractType (int) —
abCheckLineOfSight (bool) —
@apOutput (cLuxClosestEntityData) —

Returns:

bool—

cLux_GetConsoleMaps

void cLux_GetConsoleMaps(tString &out avMaps)

Parameters

avMaps (tString) —

Returns:

void

cLux_GetCurrentImGui

cImGui@ cLux_GetCurrentImGui()

Returns:

cImGui@—

cLux_GetCurrentLanguage

const tString& cLux_GetCurrentLanguage()

Returns:

const tString&—

cLux_GetCurrentMap

cLuxMap@ cLux_GetCurrentMap()

Returns:

cLuxMap@—

cLux_GetCurrentUserProfilePath

tWString cLux_GetCurrentUserProfilePath()

Returns:

tWString—

cLux_GetDebugGameSpeed

int cLux_GetDebugGameSpeed()

Returns:

int—

cLux_GetDefaultFont

iFontData@ cLux_GetDefaultFont()

Returns:

iFontData@—

cLux_GetDefaultGameLanguage

tString cLux_GetDefaultGameLanguage()

Returns:

tString—

cLux_GetDialogHandler

cLuxDialogHandler@ cLux_GetDialogHandler()

Returns:

cLuxDialogHandler@—

cLux_GetEffectHandler

cLuxEffectHandler@ cLux_GetEffectHandler()

Returns:

cLuxEffectHandler@—

cLux_GetEventDatabaseHandler

cLuxEventDatabaseHandler@ cLux_GetEventDatabaseHandler()

Returns:

cLuxEventDatabaseHandler@—

cLux_GetGameConfig

cConfigFile@ cLux_GetGameConfig()

Returns:

cConfigFile@—

cLux_GetGameHudImGui

cImGui@ cLux_GetGameHudImGui()

Returns:

cImGui@—

cLux_GetGameHudSet

cGuiSet@ cLux_GetGameHudSet()

Returns:

cGuiSet@—

cLux_GetGameLanguageFolder

tString cLux_GetGameLanguageFolder()

Returns:

tString—

cLux_GetGamePaused

bool cLux_GetGamePaused()

Returns:

bool—

cLux_GetGameTime

double cLux_GetGameTime()

Returns:

double—

cLux_GetGodModeActivated

bool cLux_GetGodModeActivated()

Returns:

bool—

cLux_GetGuiHandler

cLuxGuiHandler@ cLux_GetGuiHandler()

Returns:

cLuxGuiHandler@—

cLux_GetHelpGuiSet

cGuiSet@ cLux_GetHelpGuiSet()

Returns:

cGuiSet@—

cLux_GetHideCrosshair

bool cLux_GetHideCrosshair()

Returns:

bool—

cLux_GetHideHints

bool cLux_GetHideHints()

Returns:

bool—

cLux_GetHidePopupIcons

bool cLux_GetHidePopupIcons()

Returns:

bool—

cLux_GetHidingEffectsActive

bool cLux_GetHidingEffectsActive()

Returns:

bool—

cLux_GetHudDisplayScale

float cLux_GetHudDisplayScale()

Returns:

float—

cLux_GetHudVirtualCenterScreenSize

const cVector2f& cLux_GetHudVirtualCenterScreenSize()

Returns:

const cVector2f&—

cLux_GetHudVirtualCenterScreenStartPos

const cVector3f& cLux_GetHudVirtualCenterScreenStartPos()

Returns:

const cVector3f&—

cLux_GetHudVirtualCenterSize

const cVector2f& cLux_GetHudVirtualCenterSize()

Returns:

const cVector2f&—

cLux_GetHudVirtualOffset

const cVector2f& cLux_GetHudVirtualOffset()

Returns:

const cVector2f&—

cLux_GetHudVirtualSize

const cVector2f& cLux_GetHudVirtualSize()

Returns:

const cVector2f&—

cLux_GetHudVirtualStartPos

const cVector3f& cLux_GetHudVirtualStartPos()

Returns:

const cVector3f&—

cLux_GetInputFocusImGui

cImGui@ cLux_GetInputFocusImGui()

Returns:

cImGui@—

cLux_GetInputHandler

cLuxInputHandler@ cLux_GetInputHandler()

Returns:

cLuxInputHandler@—

cLux_GetInteractionWhiteListActive

bool cLux_GetInteractionWhiteListActive()

Returns:

bool—

cLux_GetKeyConfig

cConfigFile@ cLux_GetKeyConfig()

Returns:

cConfigFile@—

cLux_GetLightLeveAtPosWithoutIgnoredLights

float cLux_GetLightLeveAtPosWithoutIgnoredLights(const cVector3f &in avPos,
                                                 float afRadiusAdd)

Parameters

avPos (cVector3f) —
afRadiusAdd (float) —

Returns:

float—

cLux_GetLightLevelAtPos

float cLux_GetLightLevelAtPos(const cVector3f &in avPos,
                              iLight @apSkipLight,
                              float afRadiusAdd)

Parameters

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

Returns:

float—

cLux_GetLogAverageBrightness

float cLux_GetLogAverageBrightness()

Returns:

float—

cLux_GetLookAtCallbacksActive

bool cLux_GetLookAtCallbacksActive()

Returns:

bool—

cLux_GetMainMenuFile

const tString& cLux_GetMainMenuFile()

Returns:

const tString&—

cLux_GetModHandler

cLuxModHandler@ cLux_GetModHandler()

Returns:

cLuxModHandler@—

cLux_GetMusicHandler

cLuxMusicHandler@ cLux_GetMusicHandler()

Returns:

cLuxMusicHandler@—

cLux_GetPlayer

cLuxPlayer@ cLux_GetPlayer()

Returns:

cLuxPlayer@—

cLux_GetPreloadMap

cLuxMap@ cLux_GetPreloadMap()

Returns:

cLuxMap@—

cLux_GetPrevInputFocusImGui

cImGui@ cLux_GetPrevInputFocusImGui()

Returns:

cImGui@—

cLux_GetProfilerActive

int cLux_GetProfilerActive()

Returns:

int—

cLux_GetSaveConfigAtExit

bool cLux_GetSaveConfigAtExit()

Returns:

bool—

cLux_GetSaveHandler

cLuxSaveHandler@ cLux_GetSaveHandler()

Returns:

cLuxSaveHandler@—

cLux_GetSavingEnabled

bool cLux_GetSavingEnabled()

Returns:

bool—

cLux_GetSingleLightLevelAtPos

float cLux_GetSingleLightLevelAtPos(const cVector3f &in avPos,
                                    tID a_idLight,
                                    float afRadiusAdd)

Parameters

avPos (cVector3f) —
a_idLight (tID) —
afRadiusAdd (float) —

Returns:

float—

cLux_GetSoundscapeHandler

cLuxSoundscapeHandler@ cLux_GetSoundscapeHandler()

Returns:

cLuxSoundscapeHandler@—

cLux_GetStartPositions

void cLux_GetStartPositions(tString &out avStartPos)

Parameters

avStartPos (tString) —

Returns:

void

cLux_GetStringDuration

float cLux_GetStringDuration(const tWString &in asStr)

Parameters

asStr (tWString) —

Returns:

float—

cLux_GetStringWFromDate

tWString cLux_GetStringWFromDate(const cDate &in aDate)

Parameters

aDate (cDate) —

Returns:

tWString—

cLux_GetTextCatAndEntryFromString

void cLux_GetTextCatAndEntryFromString(const tString &in asData,
                                       tString &out asOutCat,
                                       tString &out asOutEntry)

Parameters

asData (tString) —
asOutCat (tString) —
asOutEntry (tString) —

Returns:

void

cLux_GetUnderwaterEffectsActive

bool cLux_GetUnderwaterEffectsActive()

Returns:

bool—

cLux_GetUserComponent

iScrUserComponent_Interface@ cLux_GetUserComponent(iLuxEntity@ apEntity,
                                                   int alID)

Parameters

apEntity (iLuxEntity@) —
alID (int) —

Returns:

iScrUserComponent_Interface@—

cLux_GetUserComponentScriptInterface

iScrUserComponent_Interface@ cLux_GetUserComponentScriptInterface(iLuxEntityComponent@ apComponent)

Parameters

apComponent (iLuxEntityComponent@) —

Returns:

iScrUserComponent_Interface@—

cLux_GetUserConfig

cConfigFile@ cLux_GetUserConfig()

Returns:

cConfigFile@—

cLux_GetUserModuleFromID

iScrUserModule_Interface@ cLux_GetUserModuleFromID(int alID,
                                                   bool abSilent = false)

Parameters

alID (int) —
abSilent (bool) —

Returns:

iScrUserModule_Interface@—

cLux_GetUserModuleFromName

iScrUserModule_Interface@ cLux_GetUserModuleFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

iScrUserModule_Interface@—

cLux_GetViewport

cViewport@ cLux_GetViewport()

Returns:

cViewport@—

cLux_GetVoiceHandler

cLuxVoiceHandler@ cLux_GetVoiceHandler()

Returns:

cLuxVoiceHandler@—

cLux_HasConfigLoadError

bool cLux_HasConfigLoadError(tString &out asError)

Parameters

asError (tString) —

Returns:

bool—

cLux_HasTranslation

bool cLux_HasTranslation(const tString &in asCat,
                         const tString &in asEntry)

Parameters

asCat (tString) —
asEntry (tString) —

Returns:

bool—

cLux_HasUnderwaterEffectUsers

bool cLux_HasUnderwaterEffectUsers()

Returns:

bool—

cLux_HideDebugOutputOn

bool cLux_HideDebugOutputOn()

Returns:

bool—

cLux_ID_Agent

cLuxAgent@ cLux_ID_Agent(tID aID)

Parameters

aID (tID) —

Returns:

cLuxAgent@—

cLux_ID_Area

cLuxArea@ cLux_ID_Area(tID aID)

Parameters

aID (tID) —

Returns:

cLuxArea@—

cLux_ID_Beam

cBeam@ cLux_ID_Beam(tID aID)

Parameters

aID (tID) —

Returns:

cBeam@—

cLux_ID_Billboard

cBillboard@ cLux_ID_Billboard(tID aID)

Parameters

aID (tID) —

Returns:

cBillboard@—

cLux_ID_BillboardGroup

cBillboardGroup@ cLux_ID_BillboardGroup(tID aID)

Parameters

aID (tID) —

Returns:

cBillboardGroup@—

cLux_ID_Body

iPhysicsBody@ cLux_ID_Body(tID aID)

Parameters

aID (tID) —

Returns:

iPhysicsBody@—

cLux_ID_CharacterBody

iCharacterBody@ cLux_ID_CharacterBody(tID aID)

Parameters

aID (tID) —

Returns:

iCharacterBody@—

cLux_ID_ClothEntity

cClothEntity@ cLux_ID_ClothEntity(tID aID)

Parameters

aID (tID) —

Returns:

cClothEntity@—

cLux_ID_Critter

cLuxCritter@ cLux_ID_Critter(tID aID)

Parameters

aID (tID) —

Returns:

cLuxCritter@—

cLux_ID_Entity

iLuxEntity@ cLux_ID_Entity(tID aID)

Parameters

aID (tID) —

Returns:

iLuxEntity@—

cLux_ID_Entity3D

iEntity3D@ cLux_ID_Entity3D(tID aID)

Parameters

aID (tID) —

Returns:

iEntity3D@—

cLux_ID_ExposureArea

cExposureArea@ cLux_ID_ExposureArea(tID aID)

Parameters

aID (tID) —

Returns:

cExposureArea@—

cLux_ID_FogArea

cFogArea@ cLux_ID_FogArea(tID aID)

Parameters

aID (tID) —

Returns:

cFogArea@—

cLux_ID_ForceField

cForceField@ cLux_ID_ForceField(tID aID)

Parameters

aID (tID) —

Returns:

cForceField@—

cLux_ID_GuiSetEntity

cGuiSetEntity@ cLux_ID_GuiSetEntity(tID aID)

Parameters

aID (tID) —

Returns:

cGuiSetEntity@—

cLux_ID_Joint

iPhysicsJoint@ cLux_ID_Joint(tID aID)

Parameters

aID (tID) —

Returns:

iPhysicsJoint@—

cLux_ID_LensFlare

cLensFlare@ cLux_ID_LensFlare(tID aID)

Parameters

aID (tID) —

Returns:

cLensFlare@—

cLux_ID_Light

iLight@ cLux_ID_Light(tID aID)

Parameters

aID (tID) —

Returns:

iLight@—

cLux_ID_LightMaskBox

cLightMaskBox@ cLux_ID_LightMaskBox(tID aID)

Parameters

aID (tID) —

Returns:

cLightMaskBox@—

cLux_ID_LiquidArea

cLuxLiquidArea@ cLux_ID_LiquidArea(tID aID)

Parameters

aID (tID) —

Returns:

cLuxLiquidArea@—

cLux_ID_MeshEntity

cMeshEntity@ cLux_ID_MeshEntity(tID aID)

Parameters

aID (tID) —

Returns:

cMeshEntity@—

cLux_ID_ParticleSystem

cParticleSystem@ cLux_ID_ParticleSystem(tID aID)

Parameters

aID (tID) —

Returns:

cParticleSystem@—

cLux_ID_Prop

cLuxProp@ cLux_ID_Prop(tID aID)

Parameters

aID (tID) —

Returns:

cLuxProp@—

cLux_ID_PushableFogArea

cLuxPushableFogArea@ cLux_ID_PushableFogArea(tID aID)

Parameters

aID (tID) —

Returns:

cLuxPushableFogArea@—

cLux_ID_ReverbArea

cLuxSoundscapeArea@ cLux_ID_ReverbArea(tID aID)

Parameters

aID (tID) —

Returns:

cLuxSoundscapeArea@—

cLux_ID_RopeEntity

iRopeEntity@ cLux_ID_RopeEntity(tID aID)

Parameters

aID (tID) —

Returns:

iRopeEntity@—

cLux_ID_SoundEntity

cSoundEntity@ cLux_ID_SoundEntity(tID aID)

Parameters

aID (tID) —

Returns:

cSoundEntity@—

cLux_ID_SubMeshEntity

cSubMeshEntity@ cLux_ID_SubMeshEntity(tID aID)

Parameters

aID (tID) —

Returns:

cSubMeshEntity@—

cLux_IncUnderwaterEffectUserCount

void cLux_IncUnderwaterEffectUserCount()

Returns:

void

cLux_IsChangingMap

bool cLux_IsChangingMap()

Returns:

bool—

cLux_IsLoadingScreenVisible

bool cLux_IsLoadingScreenVisible()

Returns:

bool—

cLux_IsPlayGoReady

bool cLux_IsPlayGoReady(int64 &out alETA)

Parameters

alETA (int64) —

Returns:

bool—

cLux_IsReadyToChangeMap

bool cLux_IsReadyToChangeMap()

Returns:

bool—

cLux_IsStreamingMap

bool cLux_IsStreamingMap()

Returns:

bool—

cLux_LoadScreenSetBarPosAndSize

void cLux_LoadScreenSetBarPosAndSize(const cVector2f &in avPos,
                                     const cVector2f &in avSize)

Parameters

avPos (cVector2f) —
avSize (cVector2f) —

Returns:

void

cLux_LoadScreenSetForceBackground

void cLux_LoadScreenSetForceBackground(bool abX)

Parameters

abX (bool) —

Returns:

void

cLux_LoadScreenShowLoadingIcon

void cLux_LoadScreenShowLoadingIcon(float afTime)

Parameters

afTime (float) —

Returns:

void

cLux_MapChangeIsTransfer

bool cLux_MapChangeIsTransfer()

Returns:

bool—

cLux_MapIsLoaded

bool cLux_MapIsLoaded()

Returns:

bool—

cLux_OutputTextToFile

void cLux_OutputTextToFile(const tWString &in asPath,
                           const tString &in asText)

Parameters

asPath (tWString) —
asText (tString) —

Returns:

void

cLux_ParseString

tWString cLux_ParseString(const tWString &in asInput)

Parameters

asInput (tWString) —

Returns:

tWString—

cLux_ParseStringIntoScreenText

void cLux_ParseStringIntoScreenText(const tWString &in asInput,
                                    cImGui @apImGui,
                                    const cLuxScreenTextFormatParameters & aFormatParams,
                                    tWString &out aOutLines,
                                    cLuxScreenTextIcon@ &out aIconArray,
                                    array &out aOutIconsPerLine,
                                    float &out afMaxLineHeight,
                                    float &out afDisplayTime,
                                    bool abTriggeredByGamepad)

Parameters

asInput (tWString) —
@apImGui (cImGui) —
aFormatParams (cLuxScreenTextFormatParameters) —
aOutLines (tWString) —
aIconArray (cLuxScreenTextIcon@) —
aOutIconsPerLine (array) —
afMaxLineHeight (float) —
afDisplayTime (float) —
abTriggeredByGamepad (bool) —

Returns:

void

cLux_PlayGuiSoundData

bool cLux_PlayGuiSoundData(const tString &in asName,
                           eSoundEntryType aDestType,
                           float afVolMul,
                           bool abSkipPreviousRandom)

Parameters

asName (tString) —
aDestType (eSoundEntryType) —
afVolMul (float) —
abSkipPreviousRandom (bool) —

Returns:

bool—

cLux_PlayGuiSoundDataEx

bool cLux_PlayGuiSoundDataEx(const tString &in asName,
                             eSoundEntryType aDestType,
                             float afVolMul,
                             bool abSkipPreviousRandom,
                             cLuxSoundExtraData @apExtraData)

Parameters

asName (tString) —
aDestType (eSoundEntryType) —
afVolMul (float) —
abSkipPreviousRandom (bool) —
@apExtraData (cLuxSoundExtraData) —

Returns:

bool—

cLux_PreloadEntity

void cLux_PreloadEntity(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_PreloadGuiGfx

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

Parameters

asFile (tString) —
aType (eImGuiGfx) —

Returns:

void

cLux_PreloadMap

void cLux_PreloadMap(const tString &in asMapName,
                     eWorldStreamPriority aPrio = eWorldStreamPriority_Normal)

Parameters

asMapName (tString) —
aPrio (eWorldStreamPriority) —

Returns:

void

cLux_PreloadMaterial

void cLux_PreloadMaterial(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_PreloadParticleSystem

void cLux_PreloadParticleSystem(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_PreloadSound

void cLux_PreloadSound(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

cLux_PreloadWebpage

void cLux_PreloadWebpage(const tString &in asX)

Parameters

asX (tString) —

Returns:

void

cLux_ProfileEnd

void cLux_ProfileEnd(const tString &in asMarker)

Parameters

asMarker (tString) —

Returns:

void

cLux_ProfileStart

void cLux_ProfileStart(const tString &in asMarker)

Parameters

asMarker (tString) —

Returns:

void

cLux_RayDamage

void cLux_RayDamage(const cVector3f &in avStart,
                    const cVector3f &in avDirection,
                    float afRayLength,
                    float afDamage,
                    float afForce,
                    float afMaxImpulse,
                    int alStrength,
                    float afHitSpeed,
                    int aDamageType,
                    bool abCheckAgents,
                    bool abCheckPlayer,
                    bool abCheckProps,
                    bool abLethalForPlayer,
                    tID a_idSource,
                    int alInstanceId)

Parameters

avStart (cVector3f) —
avDirection (cVector3f) —
afRayLength (float) —
afDamage (float) —
afForce (float) —
afMaxImpulse (float) —
alStrength (int) —
afHitSpeed (float) —
aDamageType (int) —
abCheckAgents (bool) —
abCheckPlayer (bool) —
abCheckProps (bool) —
abLethalForPlayer (bool) —
a_idSource (tID) —
alInstanceId (int) —

Returns:

void

cLux_RegisterCollisionRadius

void cLux_RegisterCollisionRadius(int alX)

Parameters

alX (int) —

Returns:

void

cLux_RegisterEventListenerUserModule_AgentSetActive

void cLux_RegisterEventListenerUserModule_AgentSetActive(const tString &in asModuleName)

Parameters

asModuleName (tString) —

Returns:

void

cLux_ReloadGame

void cLux_ReloadGame()

Returns:

void

cLux_RenderBackgroundScreen

void cLux_RenderBackgroundScreen(bool abDrawFullHUD)

Parameters

abDrawFullHUD (bool) —

Returns:

void

cLux_ResetShudderEffects

void cLux_ResetShudderEffects(int alX)

Parameters

alX (int) —

Returns:

void

cLux_RunTestButton

void cLux_RunTestButton(int alX)

Parameters

alX (int) —

Returns:

void

cLux_SaveScreenshotToFile

void cLux_SaveScreenshotToFile(const tWString &in asPath,
                               const cVector2l &in avSize = cVector2l_MinusOne,
                               bool abKeepAspect = true,
                               float afBrightness = 1.0f)

Parameters

asPath (tWString) —
avSize (cVector2l) —
abKeepAspect (bool) —
afBrightness (float) —

Returns:

void

cLux_ScriptDebugOn

bool cLux_ScriptDebugOn()

Returns:

bool—

cLux_SendInputToGui

void cLux_SendInputToGui(bool abX)

Parameters

abX (bool) —

Returns:

void

cLux_SetAreaOffline

void cLux_SetAreaOffline(int alX)

Parameters

alX (int) —

Returns:

void

cLux_SetComputeAverageFrameColor

void cLux_SetComputeAverageFrameColor(bool abActive)

Parameters

abActive (bool) —

Returns:

void

cLux_SetDebugGameSpeed

void cLux_SetDebugGameSpeed(int alX)

Parameters

alX (int) —

Returns:

void

cLux_SetDebugInfoWindowText

void cLux_SetDebugInfoWindowText(const tString &in asText)

Parameters

asText (tString) —

Returns:

void

cLux_SetGamePaused

void cLux_SetGamePaused(bool abX,
                        bool abPauseMusic,
                        bool abPauseSounds,
                        bool abPauseAmbience)

Parameters

abX (bool) —
abPauseMusic (bool) —
abPauseSounds (bool) —
abPauseAmbience (bool) —

Returns:

void

cLux_SetGodModeActivated

void cLux_SetGodModeActivated(bool abActive)

Parameters

abActive (bool) —

Returns:

void

cLux_SetHideDebugOutputOn

void cLux_SetHideDebugOutputOn(bool abActive)

Parameters

abActive (bool) —

Returns:

void

cLux_SetHideModeEffectsActive

void cLux_SetHideModeEffectsActive(bool abX)

Parameters

abX (bool) —

Returns:

void

cLux_SetImGuiInputFocus

void cLux_SetImGuiInputFocus(cImGui@ apImGui,
                             bool abShowMouse)

Parameters

apImGui (cImGui@) —
abShowMouse (bool) —

Returns:

void

cLux_SetInteractionWhiteListActive

void cLux_SetInteractionWhiteListActive(bool abX,
                                        bool abClearList)

Parameters

abX (bool) —
abClearList (bool) —

Returns:

void

cLux_SetLookAtCallbacksActive

void cLux_SetLookAtCallbacksActive(bool abX)

Parameters

abX (bool) —

Returns:

void

cLux_SetMapPreloadPriority

void cLux_SetMapPreloadPriority(eWorldStreamPriority aPrio)

Parameters

aPrio (eWorldStreamPriority) —

Returns:

void

cLux_SetProfilerActive

void cLux_SetProfilerActive(int alMode)

Parameters

alMode (int) —

Returns:

void

cLux_SetProfilerFilter

void cLux_SetProfilerFilter(const tString &in asFilter)

Parameters

asFilter (tString) —

Returns:

void

cLux_SetProfilerPauseInterval

void cLux_SetProfilerPauseInterval(float afInterval)

Parameters

afInterval (float) —

Returns:

void

cLux_SetScriptDebugOn

void cLux_SetScriptDebugOn(bool abActive)

Parameters

abActive (bool) —

Returns:

void

cLux_SetTerrainSettings

void cLux_SetTerrainSettings(int alTextureSize,
                             int alDiffuseTexelsPerMeter,
                             int alNormalTexelsPerMeter,
                             int alSpecTexelsPerMeter)

Parameters

alTextureSize (int) —
alDiffuseTexelsPerMeter (int) —
alNormalTexelsPerMeter (int) —
alSpecTexelsPerMeter (int) —

Returns:

void

cLux_SetUnderwaterEffectsActive

void cLux_SetUnderwaterEffectsActive(bool abX,
                                     bool abUseStartAndEndEffects)

Parameters

abX (bool) —
abUseStartAndEndEffects (bool) —

Returns:

void

cLux_SetupDefaultGlobalReverb

void cLux_SetupDefaultGlobalReverb(eSoundReverbPreset aType,
                                   float afFadeTime)

Parameters

aType (eSoundReverbPreset) —
afFadeTime (float) —

Returns:

void

cLux_ShapeDamage

void cLux_ShapeDamage(iCollideShape @apShape,
                      const cMatrixf &in a_mtxTransform,
                      const cVector3f &in avOrigin,
                      float afDamage,
                      float afForce,
                      float afMaxImpulse,
                      int alStrength,
                      float afHitSpeed,
                      int aDamageType,
                      bool abCheckAgents,
                      bool abCheckPlayer,
                      bool abCheckProps,
                      bool abLethalForPlayer,
                      tID a_idSource,
                      int alInstanceId)

Parameters

@apShape (iCollideShape) —
a_mtxTransform (cMatrixf) —
avOrigin (cVector3f) —
afDamage (float) —
afForce (float) —
afMaxImpulse (float) —
alStrength (int) —
afHitSpeed (float) —
aDamageType (int) —
abCheckAgents (bool) —
abCheckPlayer (bool) —
abCheckProps (bool) —
abLethalForPlayer (bool) —
a_idSource (tID) —
alInstanceId (int) —

Returns:

void

cLux_ShowEntityInfoOn

bool cLux_ShowEntityInfoOn()

Returns:

bool—

cLux_StartMap

void cLux_StartMap(const tString &in asMapName)

Parameters

asMapName (tString) —

Returns:

void

cLux_StartNewGame

void cLux_StartNewGame()

Returns:

void

cLux_TeleportToStartPos

void cLux_TeleportToStartPos(const tString &in asStartPos)

Parameters

asStartPos (tString) —

Returns:

void

cLux_TestModeOn

bool cLux_TestModeOn()

Returns:

bool—

cLux_ToAgent

cLuxAgent@ cLux_ToAgent(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxAgent@—

cLux_ToArea

cLuxArea@ cLux_ToArea(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxArea@—

cLux_ToCritter

cLuxCritter@ cLux_ToCritter(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxCritter@—

cLux_ToLiquidArea

cLuxLiquidArea@ cLux_ToLiquidArea(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxLiquidArea@—

cLux_ToProp

cLuxProp@ cLux_ToProp(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxProp@—

cLux_ToPushableFogArea

cLuxPushableFogArea@ cLux_ToPushableFogArea(iLuxEntity @apEntity)

Parameters

@apEntity (iLuxEntity) —

Returns:

cLuxPushableFogArea@—

cLux_Translate

const tWString& cLux_Translate(const tString &in asCat,
                               const tString &in asEntry)

Parameters

asCat (tString) —
asEntry (tString) —

Returns:

const tWString&—

cLux_TranslatePlatformSpecific

const tWString& cLux_TranslatePlatformSpecific(const tString &in asCat,
                                               const tString &in asEntry)

Parameters

asCat (tString) —
asEntry (tString) —

Returns:

const tWString&—

cLux_TruncateTextFile

void cLux_TruncateTextFile(const tWString &in asPath,
                           const tString &in asPattern,
                           int alTimes)

Parameters

asPath (tWString) —
asPattern (tString) —
alTimes (int) —

Returns:

void

HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux

Contents

Summary

Function Detail

cLux_AddAIDebugMessage

cLux_AddAIDebugMessage

cLux_AddAreaType

cLux_AddCritterType

cLux_AddDebugMessage

cLux_AddDebugMessage

cLux_AddEntityToInteractionWhiteList

cLux_AddIgnoredLight

cLux_AddLiquidAreaType

cLux_AddModule

cLux_AddPropType

cLux_AddTodoMessage

cLux_AddTodoMessage

cLux_ApplyUserConfig

cLux_CacheAddMaterial

cLux_CacheAddMesh

cLux_CacheRemoveMaterial

cLux_CacheRemoveMesh

cLux_CanContinue

cLux_ChangeMap

cLux_ChangeMapDebug

cLux_CheckIsInDirectLight

cLux_CheckLineOfSight

cLux_CleanupData

cLux_ClearAllMapSaveData

cLux_ClearIgnoredLights

cLux_ClearMapSaveData

cLux_ClearPlayedVoiceLines

cLux_Continue

cLux_CreateEntityComponent_AttackDamage

cLux_CreateEntityComponent_BackboneTail

cLux_CreateEntityComponent_BarkMachine

cLux_CreateEntityComponent_CharMover

cLux_CreateEntityComponent_EdgeGlow

cLux_CreateEntityComponent_FootPlacement

cLux_CreateEntityComponent_ForceEmitter

cLux_CreateEntityComponent_HandPlacement

cLux_CreateEntityComponent_HeadTracker

cLux_CreateEntityComponent_LightSensor

cLux_CreateEntityComponent_Pathfinder

cLux_CreateEntityComponent_ProximitySensor

cLux_CreateEntityComponent_SoundListener

cLux_CreateEntityComponent_StateMachine

cLux_CreateEntityComponent_VerletAnimation

cLux_CreateHTMLImage

cLux_CreateHTMLParagraph

cLux_CreateHTMLTag

cLux_CreateScriptImGui

cLux_CreateUserComponent

cLux_DebugModeOn

cLux_DecUnderwaterEffectUserCount

cLux_DeloadMap

cLux_DisableSaving

cLux_DrawDebugText

cLux_DrawHint

cLux_DrawScreenText

cLux_DrawSetToScreen

cLux_DropPageFocus

cLux_EnableSaving

cLux_Exit

cLux_GetAchievementHandler

cLux_GetAverageBrightness

cLux_GetBodyEntity

cLux_GetClosestBody

cLux_GetClosestCharCollideBody

cLux_GetClosestCharCollider

cLux_GetClosestEntity

cLux_GetConsoleMaps

cLux_GetCurrentImGui

cLux_GetCurrentLanguage

cLux_GetCurrentMap

cLux_GetCurrentUserProfilePath

cLux_GetDebugGameSpeed

cLux_GetDefaultFont

cLux_GetDefaultGameLanguage

cLux_GetDialogHandler