HPL3/Amnesia: Rebirth/Scripting/cLuxGuiHandler

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cLuxGuiHandler has no public fields.

Functions

Return Type	Function And Description
void	AttachCameraTextureToEntity(const tString &in asName, iLuxEntity@ apEnt)
void	CreateCameraTexture(const tString &in asName, const cVector2l &in avSize, uint alFrameRate, float afFOV, float afNearPlane, float afFarPlane)
void	DestroyCameraTexture(const tString &in asName)
bool	GetGameHudInputFocus()
void	SetCameraTextureBackgroundTransparent(const tString &in asName, bool abX)
void	SetCameraTextureMatrix(const tString &in asName, const cMatrixf &in a_mtxCamera)
void	SetCameraTextureSettings(const tString &in asName, float afFOV, float afNearPlane, float afFarPlane)
void	SetGameHudInputFocus(bool abX)

Details

AttachCameraTextureToEntity

void AttachCameraTextureToEntity(const tString &in asName,
                                 iLuxEntity@ apEnt)

Parameters

• asName (tString) —
• apEnt (iLuxEntity@) —

Returns:

• void

CreateCameraTexture

void CreateCameraTexture(const tString &in asName,
                         const cVector2l &in avSize,
                         uint alFrameRate,
                         float afFOV,
                         float afNearPlane,
                         float afFarPlane)

Parameters

• asName (tString) —
• avSize (cVector2l) —
• alFrameRate (uint) —
• afFOV (float) —
• afNearPlane (float) —
• afFarPlane (float) —

Returns:

• void

DestroyCameraTexture

void DestroyCameraTexture(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

GetGameHudInputFocus

bool GetGameHudInputFocus()

Returns:

• bool—

SetCameraTextureBackgroundTransparent

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

Parameters

• asName (tString) —
• abX (bool) —

Returns:

• void

SetCameraTextureMatrix

void SetCameraTextureMatrix(const tString &in asName,
                            const cMatrixf &in a_mtxCamera)

Parameters

• asName (tString) —
• a_mtxCamera (cMatrixf) —

Returns:

• void

SetCameraTextureSettings

void SetCameraTextureSettings(const tString &in asName,
                              float afFOV,
                              float afNearPlane,
                              float afFarPlane)

Parameters

• asName (tString) —
• afFOV (float) —
• afNearPlane (float) —
• afFarPlane (float) —

Returns:

• void

SetGameHudInputFocus

void SetGameHudInputFocus(bool abX)

Parameters

• abX (bool) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iScrGuiHandler Interface ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)

See all references...