HPL3/SOMA/Scripting/Scripting Api/cGui

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Jump to navigation Jump to search

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

Summary

Return Type Function and Description
cGuiGfxElement cGui_CreateGfxFilledRect(const cColor &in aColor, eGuiMaterial aMaterial)
cGuiGfxElement cGui_CreateGfxImage(const tString &in asFile, eGuiMaterial aMaterial)
cGuiGfxElement cGui_CreateGfxImage(const tString &in asFile, eGuiMaterial aMaterial, const cColor &in aColor)
cGuiGfxElement cGui_CreateGfxImageBuffer(const tString &in asFile, eGuiMaterial aMaterial, bool abCreateAnimation, const cColor &in aColor)
cGuiGfxElement cGui_CreateGfxTexture(const tString &in asFile, eGuiMaterial aMaterial, eTextureType aTextureType)
cGuiGfxElement cGui_CreateGfxTexture(const tString &in asFile, eGuiMaterial aMaterial, eTextureType aTextureType, const cColor &in aColor, bool abMipMaps)
cGuiGfxElement cGui_CreateGfxTexture(iTexture @apTexture, bool abAutoDestroyTexture, eGuiMaterial aMaterial)
cGuiGfxElement cGui_CreateGfxTexture(iTexture @apTexture, bool abAutoDestroyTexture, eGuiMaterial aMaterial, const cColor &in aColor, const cVector2f &in avStartUV, const cVector2f &in avEndUV)
cImGui cGui_CreateImGui(const tString &in asName, cGuiSet @apSet)
cGuiSet cGui_CreateSet(const tString &in asName, cGuiSkin @apSkin)
cGuiSkin cGui_CreateSkin(const tString &in asFile)
void cGui_DestroyGfx(cGuiGfxElement@ apGfx)
void cGui_DestroyImGui(cImGui@ apImGui)
void cGui_DestroySet(cGuiSet @apSet)
cGuiSet cGui_GetFocusedSet()
void cGui_GetImGuiIdFromName(const tString &in asName)
void cGui_GetImGuiStateVarString(eImGuiStateVar aVar)
cGuiSet cGui_GetSetFromName(const tString &in asName)
void cGui_SetFocus(cGuiSet@ apSet)
void cGui_SetFocusByName(const tString &in asSetName)

Function Detail

cGui_CreateGfxFilledRect

cGuiGfxElement@ cGui_CreateGfxFilledRect(const cColor &in aColor,
                                         eGuiMaterial aMaterial)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateGfxImage

cGuiGfxElement@ cGui_CreateGfxImage(const tString &in asFile,
                                    eGuiMaterial aMaterial)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateGfxImage

cGuiGfxElement@ cGui_CreateGfxImage(const tString &in asFile,
                                    eGuiMaterial aMaterial,
                                    const cColor &in aColor)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateGfxImageBuffer

cGuiGfxElement@ cGui_CreateGfxImageBuffer(const tString &in asFile,
                                          eGuiMaterial aMaterial,
                                          bool abCreateAnimation,
                                          const cColor &in aColor)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateGfxTexture

cGuiGfxElement@ cGui_CreateGfxTexture(const tString &in asFile,
                                      eGuiMaterial aMaterial,
                                      eTextureType aTextureType)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateGfxTexture

cGuiGfxElement@ cGui_CreateGfxTexture(const tString &in asFile,
                                      eGuiMaterial aMaterial,
                                      eTextureType aTextureType,
                                      const cColor &in aColor,
                                      bool abMipMaps)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateGfxTexture

cGuiGfxElement@ cGui_CreateGfxTexture(iTexture @apTexture,
                                      bool abAutoDestroyTexture,
                                      eGuiMaterial aMaterial)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateGfxTexture

cGuiGfxElement@ cGui_CreateGfxTexture(iTexture @apTexture,
                                      bool abAutoDestroyTexture,
                                      eGuiMaterial aMaterial,
                                      const cColor &in aColor,
                                      const cVector2f &in avStartUV,
                                      const cVector2f &in avEndUV)


Parameters

Returns:

  • cGuiGfxElement@

cGui_CreateImGui

cImGui@ cGui_CreateImGui(const tString &in asName,
                         cGuiSet @apSet)


Parameters

Returns:

  • cImGui@

cGui_CreateSet

cGuiSet@ cGui_CreateSet(const tString &in asName,
                        cGuiSkin @apSkin)


Parameters

Returns:

  • cGuiSet@

cGui_CreateSkin

cGuiSkin@ cGui_CreateSkin(const tString &in asFile)


Parameters

Returns:

  • cGuiSkin@

cGui_DestroyGfx

void cGui_DestroyGfx(cGuiGfxElement@ apGfx)


Parameters

Returns:

  • void

cGui_DestroyImGui

void cGui_DestroyImGui(cImGui@ apImGui)


Parameters

Returns:

  • void

cGui_DestroySet

void cGui_DestroySet(cGuiSet @apSet)


Parameters

Returns:

  • void

cGui_GetFocusedSet

cGuiSet@ cGui_GetFocusedSet()

Returns:

  • cGuiSet@

cGui_GetImGuiIdFromName

void cGui_GetImGuiIdFromName(const tString &in asName)


Parameters

Returns:

  • void

cGui_GetImGuiStateVarString

void cGui_GetImGuiStateVarString(eImGuiStateVar aVar)


Parameters

Returns:

  • void

cGui_GetSetFromName

cGuiSet@ cGui_GetSetFromName(const tString &in asName)


Parameters

Returns:

  • cGuiSet@

cGui_SetFocus

void cGui_SetFocus(cGuiSet@ apSet)


Parameters

Returns:

  • void

cGui_SetFocusByName

void cGui_SetFocusByName(const tString &in asSetName)


Parameters

Returns:

  • void