HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cResources

From Frictional Wiki
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
bool cResources_AddLanguageFile(const tString &in asFilePath, bool abAddResourceDirs)
bool cResources_AddResourceDir(const tWString &in asDir, bool abAddSubDirectories, const tString &in asMask)
void cResources_ClearResourceDirs()
void cResources_ClearTranslations()
iFontData cResources_CreateFontData(const tString &in asName)
iGpuShader cResources_CreateGpuShader(const tString &in asName, int alType, cPrepParserVarContainer @apVarCont)
iGpuShader cResources_CreateGpuShader(const tString &in asName, int alType)
cFrameSubImage cResources_CreateImage(const tString &in asName)
cMaterial cResources_CreateMaterial(const tString &in asName)
cMesh cResources_CreateMesh(const tString &in asName)
iSoundData cResources_CreateSoundData(const tString &in asName, bool abStream, bool abLooping, bool ab3, bool abNonBlockingLoad)
cSoundEntityData cResources_CreateSoundEntityData(const tString &in asName)
iTexture cResources_CreateTexture1D(const tString &in asName, bool abUseMipMaps)
iTexture cResources_CreateTexture2D(const tString &in asName, bool abUseMipMaps)
iTexture cResources_CreateTexture3D(const tString &in asName, bool abUseMipMaps)
iTexture cResources_CreateTextureCubeMap(const tString &in asName, bool abUseMipMaps)
iVideoStream cResources_CreateVideo(const tString &in asName)
void cResources_DestroyFontData(iFontData @apData)
void cResources_DestroyGpuShader(iGpuShader @apShader)
void cResources_DestroyImage(cFrameSubImage @apData)
void cResources_DestroyMaterial(cMaterial @apMaterial)
void cResources_DestroyMesh(cMesh@ apMesh)
void cResources_DestroySoundData(iSoundData@ apData)
void cResources_DestroySoundEntityData(cSoundEntityData @apData)
void cResources_DestroyTexture(iTexture @apTexture)
void cResources_DestroyUnusedParticleSystems(int alMaxToKeep)
void cResources_DestroyUnusedSoundData(int alMaxToKeep)
void cResources_DestroyVideo(iVideoStream @apVideo)
void cResources_DestroyXmlDocument(iXmlDocument@ apDoc)
tString cResources_GetMaterialPhysicsName(const tString &in asName)
float cResources_GetMaterialTextureAnisotropy()
int cResources_GetMaterialTextureFilter()
int cResources_GetMaterialTextureSizeDownScaleLevel()
bool cResources_LoadResourceDirsFile(const tString &in asFile)
iXmlDocument cResources_LoadXmlDocument(const tString &in asFile)
void cResources_PreloadParticleSystem(const tString &in asDataName)
void cResources_PreloadSoundEntityData(const tString &in asName, bool abNonBlockingLoad)
void cResources_SetMaterialTextureAnisotropy(float afX)
void cResources_SetMaterialTextureFilter(int alFilter)
void cResources_SetMaterialTextureSizeDownScaleLevel(int alLevel)
tWString cResources_Translate(const tString &in asCat, const tString &in asName)

Function Detail

cResources_AddLanguageFile

bool cResources_AddLanguageFile(const tString &in asFilePath,
                                bool abAddResourceDirs)


Parameters

  • asFilePath (tString) —
  • abAddResourceDirs (bool) —

Returns:

  • bool

cResources_AddResourceDir

bool cResources_AddResourceDir(const tWString &in asDir,
                               bool abAddSubDirectories,
                               const tString &in asMask)


Parameters

Returns:

  • bool

cResources_ClearResourceDirs

void cResources_ClearResourceDirs()

Returns:

  • void

cResources_ClearTranslations

void cResources_ClearTranslations()

Returns:

  • void

cResources_CreateFontData

iFontData@ cResources_CreateFontData(const tString &in asName)


Parameters

Returns:

  • iFontData@

cResources_CreateGpuShader

iGpuShader@ cResources_CreateGpuShader(const tString &in asName,
                                       int alType,
                                       cPrepParserVarContainer @apVarCont)


Parameters

Returns:

  • iGpuShader@

cResources_CreateGpuShader

iGpuShader@ cResources_CreateGpuShader(const tString &in asName,
                                       int alType)


Parameters

  • asName (tString) —
  • alType (int) —

Returns:

  • iGpuShader@

cResources_CreateImage

cFrameSubImage@ cResources_CreateImage(const tString &in asName)


Parameters

Returns:

  • cFrameSubImage@

cResources_CreateMaterial

cMaterial@ cResources_CreateMaterial(const tString &in asName)


Parameters

Returns:

  • cMaterial@

cResources_CreateMesh

cMesh@ cResources_CreateMesh(const tString &in asName)


Parameters

Returns:

  • cMesh@

cResources_CreateSoundData

iSoundData@ cResources_CreateSoundData(const tString &in asName,
                                       bool abStream,
                                       bool abLooping,
                                       bool ab3,
                                       bool abNonBlockingLoad)


Parameters

  • asName (tString) —
  • abStream (bool) —
  • abLooping (bool) —
  • ab3 (bool) —
  • abNonBlockingLoad (bool) —

Returns:

  • iSoundData@

cResources_CreateSoundEntityData

cSoundEntityData@ cResources_CreateSoundEntityData(const tString &in asName)


Parameters

Returns:

  • cSoundEntityData@

cResources_CreateTexture1D

iTexture@ cResources_CreateTexture1D(const tString &in asName,
                                     bool abUseMipMaps)


Parameters

  • asName (tString) —
  • abUseMipMaps (bool) —

Returns:

  • iTexture@

cResources_CreateTexture2D

iTexture@ cResources_CreateTexture2D(const tString &in asName,
                                     bool abUseMipMaps)


Parameters

  • asName (tString) —
  • abUseMipMaps (bool) —

Returns:

  • iTexture@

cResources_CreateTexture3D

iTexture@ cResources_CreateTexture3D(const tString &in asName,
                                     bool abUseMipMaps)


Parameters

  • asName (tString) —
  • abUseMipMaps (bool) —

Returns:

  • iTexture@

cResources_CreateTextureCubeMap

iTexture@ cResources_CreateTextureCubeMap(const tString &in asName,
                                          bool abUseMipMaps)


Parameters

  • asName (tString) —
  • abUseMipMaps (bool) —

Returns:

  • iTexture@

cResources_CreateVideo

iVideoStream@ cResources_CreateVideo(const tString &in asName)


Parameters

Returns:

  • iVideoStream@

cResources_DestroyFontData

void cResources_DestroyFontData(iFontData @apData)


Parameters

Returns:

  • void

cResources_DestroyGpuShader

void cResources_DestroyGpuShader(iGpuShader @apShader)


Parameters

Returns:

  • void

cResources_DestroyImage

void cResources_DestroyImage(cFrameSubImage @apData)


Parameters

Returns:

  • void

cResources_DestroyMaterial

void cResources_DestroyMaterial(cMaterial @apMaterial)


Parameters

Returns:

  • void

cResources_DestroyMesh

void cResources_DestroyMesh(cMesh@ apMesh)


Parameters

Returns:

  • void

cResources_DestroySoundData

void cResources_DestroySoundData(iSoundData@ apData)


Parameters

Returns:

  • void

cResources_DestroySoundEntityData

void cResources_DestroySoundEntityData(cSoundEntityData @apData)


Parameters

Returns:

  • void

cResources_DestroyTexture

void cResources_DestroyTexture(iTexture @apTexture)


Parameters

Returns:

  • void

cResources_DestroyUnusedParticleSystems

void cResources_DestroyUnusedParticleSystems(int alMaxToKeep)


Parameters

  • alMaxToKeep (int) —

Returns:

  • void

cResources_DestroyUnusedSoundData

void cResources_DestroyUnusedSoundData(int alMaxToKeep)


Parameters

  • alMaxToKeep (int) —

Returns:

  • void

cResources_DestroyVideo

void cResources_DestroyVideo(iVideoStream @apVideo)


Parameters

Returns:

  • void

cResources_DestroyXmlDocument

void cResources_DestroyXmlDocument(iXmlDocument@ apDoc)


Parameters

Returns:

  • void

cResources_GetMaterialPhysicsName

tString cResources_GetMaterialPhysicsName(const tString &in asName)


Parameters

Returns:

  • tString

cResources_GetMaterialTextureAnisotropy

float cResources_GetMaterialTextureAnisotropy()

Returns:

  • float

cResources_GetMaterialTextureFilter

int cResources_GetMaterialTextureFilter()

Returns:

  • int

cResources_GetMaterialTextureSizeDownScaleLevel

int cResources_GetMaterialTextureSizeDownScaleLevel()

Returns:

  • int

cResources_LoadResourceDirsFile

bool cResources_LoadResourceDirsFile(const tString &in asFile)


Parameters

Returns:

  • bool

cResources_LoadXmlDocument

iXmlDocument@ cResources_LoadXmlDocument(const tString &in asFile)


Parameters

Returns:

  • iXmlDocument@

cResources_PreloadParticleSystem

void cResources_PreloadParticleSystem(const tString &in asDataName)


Parameters

Returns:

  • void

cResources_PreloadSoundEntityData

void cResources_PreloadSoundEntityData(const tString &in asName,
                                       bool abNonBlockingLoad)


Parameters

  • asName (tString) —
  • abNonBlockingLoad (bool) —

Returns:

  • void

cResources_SetMaterialTextureAnisotropy

void cResources_SetMaterialTextureAnisotropy(float afX)


Parameters

  • afX (float) —

Returns:

  • void

cResources_SetMaterialTextureFilter

void cResources_SetMaterialTextureFilter(int alFilter)


Parameters

  • alFilter (int) —

Returns:

  • void

cResources_SetMaterialTextureSizeDownScaleLevel

void cResources_SetMaterialTextureSizeDownScaleLevel(int alLevel)


Parameters

  • alLevel (int) —

Returns:

  • void

cResources_Translate

const tWString& cResources_Translate(const tString &in asCat,
                                     const tString &in asName)


Parameters

Returns:

  • const tWString&