Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/cLux"
(Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...") |
(No difference)
|
Latest revision as of 22:49, 24 August 2020
This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete. |
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
Contents
- 1 Summary
- 2 Function Detail
- 2.1 cLux_AddAreaType
- 2.2 cLux_AddCritterType
- 2.3 cLux_AddDebugMessage
- 2.4 cLux_AddDebugMessage
- 2.5 cLux_AddEntityToInteractionWhiteList
- 2.6 cLux_AddLiquidAreaType
- 2.7 cLux_AddModule
- 2.8 cLux_AddPropType
- 2.9 cLux_AddTodoMessage
- 2.10 cLux_AddTodoMessage
- 2.11 cLux_ApplyUserConfig
- 2.12 cLux_CanContinue
- 2.13 cLux_ChangeMap
- 2.14 cLux_CheckLineOfSight
- 2.15 cLux_CleanupData
- 2.16 cLux_Continue
- 2.17 cLux_CreateEntityComponent_BackboneTail
- 2.18 cLux_CreateEntityComponent_BarkMachine
- 2.19 cLux_CreateEntityComponent_CharMover
- 2.20 cLux_CreateEntityComponent_EdgeGlow
- 2.21 cLux_CreateEntityComponent_ForceEmitter
- 2.22 cLux_CreateEntityComponent_HeadTracker
- 2.23 cLux_CreateEntityComponent_LightSensor
- 2.24 cLux_CreateEntityComponent_Pathfinder
- 2.25 cLux_CreateEntityComponent_SoundListener
- 2.26 cLux_CreateEntityComponent_StateMachine
- 2.27 cLux_CreateHTMLImage
- 2.28 cLux_CreateHTMLParagraph
- 2.29 cLux_CreateHTMLTag
- 2.30 cLux_CreateScriptImGui
- 2.31 cLux_DebugModeOn
- 2.32 cLux_DecUnderwaterEffectUserCount
- 2.33 cLux_DeloadMap
- 2.34 cLux_DrawDebugText
- 2.35 cLux_DrawHint
- 2.36 cLux_DrawScreenText
- 2.37 cLux_DrawSetToScreen
- 2.38 cLux_DropPageFocus
- 2.39 cLux_Exit
- 2.40 cLux_GetAchievementHandler
- 2.41 cLux_GetBodyEntity
- 2.42 cLux_GetClosestBody
- 2.43 cLux_GetClosestCharCollider
- 2.44 cLux_GetClosestEntity
- 2.45 cLux_GetCurrentImGui
- 2.46 cLux_GetCurrentLanguage
- 2.47 cLux_GetCurrentMap
- 2.48 cLux_GetCurrentUserProfilePath
- 2.49 cLux_GetDefaultFont
- 2.50 cLux_GetDefaultGameLanguage
- 2.51 cLux_GetDialogHandler
- 2.52 cLux_GetEffectHandler
- 2.53 cLux_GetEventDatabaseHandler
- 2.54 cLux_GetExplorationModeActive
- 2.55 cLux_GetGameConfig
- 2.56 cLux_GetGameHudImGui
- 2.57 cLux_GetGameHudSet
- 2.58 cLux_GetGameLanguageFolder
- 2.59 cLux_GetGamePaused
- 2.60 cLux_GetGameTime
- 2.61 cLux_GetGodModeActivated
- 2.62 cLux_GetGuiHandler
- 2.63 cLux_GetHelpGuiSet
- 2.64 cLux_GetHudVirtualCenterScreenSize
- 2.65 cLux_GetHudVirtualCenterScreenStartPos
- 2.66 cLux_GetHudVirtualCenterSize
- 2.67 cLux_GetHudVirtualOffset
- 2.68 cLux_GetHudVirtualSize
- 2.69 cLux_GetHudVirtualStartPos
- 2.70 cLux_GetInputFocusImGui
- 2.71 cLux_GetInputHandler
- 2.72 cLux_GetInteractionWhiteListActive
- 2.73 cLux_GetKeyConfig
- 2.74 cLux_GetLightLevelAtPos
- 2.75 cLux_GetMainMenuFile
- 2.76 cLux_GetMusicHandler
- 2.77 cLux_GetPlayer
- 2.78 cLux_GetPreloadMap
- 2.79 cLux_GetPrevInputFocusImGui
- 2.80 cLux_GetSaveConfigAtExit
- 2.81 cLux_GetSaveHandler
- 2.82 cLux_GetSoundscapeHandler
- 2.83 cLux_GetStringDuration
- 2.84 cLux_GetStringWFromDate
- 2.85 cLux_GetSupportExplorationMode
- 2.86 cLux_GetTextCatAndEntryFromString
- 2.87 cLux_GetUnderwaterEffectsActive
- 2.88 cLux_GetUserConfig
- 2.89 cLux_GetUserModuleFromID
- 2.90 cLux_GetUserModuleFromName
- 2.91 cLux_GetViewport
- 2.92 cLux_GetVoiceHandler
- 2.93 cLux_HasConfigLoadError
- 2.94 cLux_HasTranslation
- 2.95 cLux_HasUnderwaterEffectUsers
- 2.96 cLux_ID_Agent
- 2.97 cLux_ID_Area
- 2.98 cLux_ID_Beam
- 2.99 cLux_ID_Billboard
- 2.100 cLux_ID_BillboardGroup
- 2.101 cLux_ID_Body
- 2.102 cLux_ID_CharacterBody
- 2.103 cLux_ID_ClothEntity
- 2.104 cLux_ID_Critter
- 2.105 cLux_ID_Entity
- 2.106 cLux_ID_Entity3D
- 2.107 cLux_ID_ExposureArea
- 2.108 cLux_ID_FogArea
- 2.109 cLux_ID_ForceField
- 2.110 cLux_ID_GuiSetEntity
- 2.111 cLux_ID_Joint
- 2.112 cLux_ID_LensFlare
- 2.113 cLux_ID_Light
- 2.114 cLux_ID_LightMaskBox
- 2.115 cLux_ID_LiquidArea
- 2.116 cLux_ID_MeshEntity
- 2.117 cLux_ID_ParticleSystem
- 2.118 cLux_ID_Prop
- 2.119 cLux_ID_ReverbArea
- 2.120 cLux_ID_RopeEntity
- 2.121 cLux_ID_SoundEntity
- 2.122 cLux_ID_SubMeshEntity
- 2.123 cLux_IncUnderwaterEffectUserCount
- 2.124 cLux_IsChangingMap
- 2.125 cLux_IsLoadingScreenVisible
- 2.126 cLux_IsPlayGoReady
- 2.127 cLux_IsReadyToChangeMap
- 2.128 cLux_IsStreamingMap
- 2.129 cLux_LoadScreenSetBarPosAndSize
- 2.130 cLux_LoadScreenSetForceBackground
- 2.131 cLux_LoadScreenSetUseSmallIcon
- 2.132 cLux_LoadScreenShowLoadingIcon
- 2.133 cLux_MapChangeIsTransfer
- 2.134 cLux_MapIsLoaded
- 2.135 cLux_OutputTextToFile
- 2.136 cLux_ParseString
- 2.137 cLux_ParseStringIntoScreenText
- 2.138 cLux_PlayGuiSoundData
- 2.139 cLux_PlayGuiSoundDataEx
- 2.140 cLux_PreloadEntity
- 2.141 cLux_PreloadGuiGfx
- 2.142 cLux_PreloadMap
- 2.143 cLux_PreloadMaterial
- 2.144 cLux_PreloadParticleSystem
- 2.145 cLux_PreloadSound
- 2.146 cLux_PreloadWebpage
- 2.147 cLux_RegisterCollisionRadius
- 2.148 cLux_RegisterEventListenerUserModule_AgentSetActive
- 2.149 cLux_RenderBackgroundScreen
- 2.150 cLux_ResetShudderEffects
- 2.151 cLux_SaveScreenshotToFile
- 2.152 cLux_ScriptDebugOn
- 2.153 cLux_SendInputToGui
- 2.154 cLux_SetAreaOffline
- 2.155 cLux_SetDebugInfoWindowText
- 2.156 cLux_SetExplorationModeActive
- 2.157 cLux_SetGamePaused
- 2.158 cLux_SetImGuiInputFocus
- 2.159 cLux_SetInteractionWhiteListActive
- 2.160 cLux_SetMapPreloadPriority
- 2.161 cLux_SetUnderwaterEffectsActive
- 2.162 cLux_SetupDefaultGlobalReverb
- 2.163 cLux_ShapeDamage
- 2.164 cLux_ShapeDamage
- 2.165 cLux_StartMap
- 2.166 cLux_StartNewGame
- 2.167 cLux_TestModeOn
- 2.168 cLux_ToAgent
- 2.169 cLux_ToArea
- 2.170 cLux_ToCritter
- 2.171 cLux_ToLiquidArea
- 2.172 cLux_ToProp
- 2.173 cLux_Translate
- 2.174 cLux_TruncateTextFile
Summary
Function Detail
cLux_AddAreaType
cLux_AddCritterType
cLux_AddDebugMessage
void cLux_AddDebugMessage(const tString &in asText,
bool abCheckForDuplicates)
Parameters
- asText (tString) —
- abCheckForDuplicates (bool) —
Returns:
- void
cLux_AddDebugMessage
cLux_AddEntityToInteractionWhiteList
void cLux_AddEntityToInteractionWhiteList(iLuxEntity@ apEntity)
Parameters
- apEntity (iLuxEntity@) —
Returns:
- void
cLux_AddLiquidAreaType
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
cLux_AddTodoMessage
void cLux_AddTodoMessage(const tString &in asText,
bool abCheckForDuplicates)
Parameters
- asText (tString) —
- abCheckForDuplicates (bool) —
Returns:
- void
cLux_AddTodoMessage
cLux_ApplyUserConfig
bool cLux_ApplyUserConfig()
Returns:
- bool—
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)
Parameters
- asMapName (tString) —
- asStartPos (tString) —
- asTransferArea (tString) —
- asStartSound (tString) —
- asEndSound (tString) —
Returns:
- void
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_Continue
void cLux_Continue()
Returns:
- void
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_ForceEmitter
cLuxForceEmitter@ cLux_CreateEntityComponent_ForceEmitter(iLuxEntity @apEntity)
Parameters
- @apEntity (iLuxEntity) —
Returns:
- cLuxForceEmitter@—
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_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_CreateHTMLImage
cLux_CreateHTMLParagraph
tString cLux_CreateHTMLParagraph(const tString &in asContent)
Parameters
- asContent (tString) —
Returns:
- tString—
cLux_CreateHTMLTag
cLux_CreateScriptImGui
cLuxScriptImGui@ cLux_CreateScriptImGui(const tString &in asName,
bool abRegisterForDrawing,
bool abSkipResetOnRegistration = true)
Parameters
- asName (tString) —
- abRegisterForDrawing (bool) —
- abSkipResetOnRegistration (bool) —
Returns:
- cLuxScriptImGui@—
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_DrawDebugText
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
cLux_DropPageFocus
cLux_Exit
void cLux_Exit()
Returns:
- void
cLux_GetAchievementHandler
iLuxAchievementHandler@ cLux_GetAchievementHandler()
Returns:
- iLuxAchievementHandler@—
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_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_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_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_GetExplorationModeActive
bool cLux_GetExplorationModeActive()
Returns:
- bool—
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_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_GetLightLevelAtPos
cLux_GetMainMenuFile
const tString& cLux_GetMainMenuFile()
Returns:
- const tString&—
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_GetSaveConfigAtExit
bool cLux_GetSaveConfigAtExit()
Returns:
- bool—
cLux_GetSaveHandler
cLuxSaveHandler@ cLux_GetSaveHandler()
Returns:
- cLuxSaveHandler@—
cLux_GetSoundscapeHandler
cLuxSoundscapeHandler@ cLux_GetSoundscapeHandler()
Returns:
- cLuxSoundscapeHandler@—
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_GetSupportExplorationMode
bool cLux_GetSupportExplorationMode()
Returns:
- bool—
cLux_GetTextCatAndEntryFromString
cLux_GetUnderwaterEffectsActive
bool cLux_GetUnderwaterEffectsActive()
Returns:
- bool—
cLux_GetUserConfig
cConfigFile@ cLux_GetUserConfig()
Returns:
- cConfigFile@—
cLux_GetUserModuleFromID
iScrUserModule_Interface@ cLux_GetUserModuleFromID(int alID)
Parameters
- alID (int) —
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
cLux_HasTranslation
cLux_HasUnderwaterEffectUsers
bool cLux_HasUnderwaterEffectUsers()
Returns:
- bool—
cLux_ID_Agent
cLux_ID_Area
cLux_ID_Beam
cLux_ID_Billboard
cLux_ID_BillboardGroup
cLux_ID_Body
cLux_ID_CharacterBody
cLux_ID_ClothEntity
cLux_ID_Critter
cLux_ID_Entity
cLux_ID_Entity3D
cLux_ID_ExposureArea
cLux_ID_FogArea
cLux_ID_ForceField
cLux_ID_GuiSetEntity
cLux_ID_Joint
cLux_ID_LensFlare
cLux_ID_Light
cLux_ID_LightMaskBox
cLux_ID_LiquidArea
cLux_ID_MeshEntity
cLux_ID_ParticleSystem
cLux_ID_Prop
cLux_ID_ReverbArea
cLuxSoundscapeArea@ cLux_ID_ReverbArea(tID aID)
Parameters
- aID (tID) —
Returns:
- cLuxSoundscapeArea@—
cLux_ID_RopeEntity
cLux_ID_SoundEntity
cLux_ID_SubMeshEntity
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(int &out alETA)
Parameters
- alETA (int) —
Returns:
- bool—
cLux_IsReadyToChangeMap
bool cLux_IsReadyToChangeMap()
Returns:
- bool—
cLux_IsStreamingMap
bool cLux_IsStreamingMap()
Returns:
- bool—
cLux_LoadScreenSetBarPosAndSize
cLux_LoadScreenSetForceBackground
void cLux_LoadScreenSetForceBackground(bool abX)
Parameters
- abX (bool) —
Returns:
- void
cLux_LoadScreenSetUseSmallIcon
void cLux_LoadScreenSetUseSmallIcon(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
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
cLux_PreloadGuiGfx
cLux_PreloadMap
void cLux_PreloadMap(const tString &in asMapName,
eWorldStreamPriority aPrio = eWorldStreamPriority_Normal)
Parameters
- asMapName (tString) —
- aPrio (eWorldStreamPriority) —
Returns:
- void
cLux_PreloadMaterial
cLux_PreloadParticleSystem
void cLux_PreloadParticleSystem(const tString &in asFile)
Parameters
- asFile (tString) —
Returns:
- void
cLux_PreloadSound
cLux_PreloadWebpage
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_RenderBackgroundScreen
void cLux_RenderBackgroundScreen(bool abDrawFullHUD)
Parameters
- abDrawFullHUD (bool) —
Returns:
- void
cLux_ResetShudderEffects
void cLux_ResetShudderEffects(int alX)
Parameters
- alX (int) —
Returns:
- void
cLux_SaveScreenshotToFile
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_SetDebugInfoWindowText
void cLux_SetDebugInfoWindowText(const tString &in asText)
Parameters
- asText (tString) —
Returns:
- void
cLux_SetExplorationModeActive
void cLux_SetExplorationModeActive(bool abX)
Parameters
- abX (bool) —
Returns:
- void
cLux_SetGamePaused
void cLux_SetGamePaused(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_SetMapPreloadPriority
void cLux_SetMapPreloadPriority(eWorldStreamPriority aPrio)
Parameters
- aPrio (eWorldStreamPriority) —
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(int aShape,
const cMatrixf &in a_mtxTransform,
const cVector3f &in avOrigin,
float afMinDamage,
float afMaxDamage,
float afForce,
float afMaxImpulse,
int alStrength,
float afHitSpeed,
int aDamageType,
bool abCheckEnemies,
bool abCheckPlayer,
bool abCheckProps,
bool abLethalForPlayer,
const tString &in asSource)
Parameters
- aShape (int) —
- a_mtxTransform (cMatrixf) —
- avOrigin (cVector3f) —
- afMinDamage (float) —
- afMaxDamage (float) —
- afForce (float) —
- afMaxImpulse (float) —
- alStrength (int) —
- afHitSpeed (float) —
- aDamageType (int) —
- abCheckEnemies (bool) —
- abCheckPlayer (bool) —
- abCheckProps (bool) —
- abLethalForPlayer (bool) —
- asSource (tString) —
Returns:
- void
cLux_ShapeDamage
void cLux_ShapeDamage(iCollideShape@ aShape,
const cMatrixf &in a_mtxTransform,
const cVector3f &in avOrigin,
float afMinDamage,
float afMaxDamage,
float afForce,
float afMaxImpulse,
int alStrength,
float afHitSpeed,
int aDamageType,
bool abCheckEnemies,
bool abCheckPlayer,
bool abCheckProps,
bool abLethalForPlayer,
const tString &in asSource)
Parameters
- aShape (iCollideShape@) —
- a_mtxTransform (cMatrixf) —
- avOrigin (cVector3f) —
- afMinDamage (float) —
- afMaxDamage (float) —
- afForce (float) —
- afMaxImpulse (float) —
- alStrength (int) —
- afHitSpeed (float) —
- aDamageType (int) —
- abCheckEnemies (bool) —
- abCheckPlayer (bool) —
- abCheckProps (bool) —
- abLethalForPlayer (bool) —
- asSource (tString) —
Returns:
- void
cLux_StartMap
cLux_StartNewGame
void cLux_StartNewGame()
Returns:
- void
cLux_TestModeOn
bool cLux_TestModeOn()
Returns:
- bool—
cLux_ToAgent
cLuxAgent@ cLux_ToAgent(iLuxEntity @apEntity)
Parameters
- @apEntity (iLuxEntity) —
Returns:
- cLuxAgent@—
cLux_ToArea
cLux_ToCritter
cLuxCritter@ cLux_ToCritter(iLuxEntity @apEntity)
Parameters
- @apEntity (iLuxEntity) —
Returns:
- cLuxCritter@—
cLux_ToLiquidArea
cLuxLiquidArea@ cLux_ToLiquidArea(iLuxEntity @apEntity)
Parameters
- @apEntity (iLuxEntity) —
Returns:
- cLuxLiquidArea@—