HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Map

From Frictional Wiki
Jump to navigation Jump to search
Info icon.png

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
bool Map_GetBillboardArray(const tString &in asName, array<cBillboard@> &inout avOutBillboards)
Creates an array of billboards with a given name
bool Map_GetDecalArray(const tString &in asName, array<cMeshEntity@> &inout avOutDecals)
Fills an array with dynamic decals with a given name
bool Map_GetFogAreaArray(const tString &in asName, array<cFogArea@> &inout avOutFogAreas)
Creates an array of fog areas with a given name
bool Map_GetLensFlareArray(const tString &in asName, array<cLensFlare@> &inout avOutLensFlares)
Creates an array of lens flares with a given name
bool Map_GetLightArray(const tString &in asName, array<iLight@> &inout avOutLights)
Creates an array of lights with a given name
bool Map_GetParticleSystemArray(const tString &in asName, array<cParticleSystem@> &inout avOutParticles)
Creates an array of particle systems with a given name

Function Detail

Map_GetBillboardArray

bool Map_GetBillboardArray(const tString &in asName,
                           cBillboard@ &inout avOutBillboards)

Creates an array of billboards with a given name.

Parameters

Returns:

  • bool—array<cBillboard@>, array of billboards found.

Map_GetDecalArray

bool Map_GetDecalArray(const tString &in asName,
                       cMeshEntity@ &inout avOutDecals)

Fills an array with dynamic decals with a given name.

Parameters

Returns:

  • bool—array<cMeshEntity@>, array of lights found.

Map_GetFogAreaArray

bool Map_GetFogAreaArray(const tString &in asName,
                         cFogArea@ &inout avOutFogAreas)

Creates an array of fog areas with a given name.

Parameters

Returns:

  • bool—array<cFogArea@>, array of fog areas found.

Map_GetLensFlareArray

bool Map_GetLensFlareArray(const tString &in asName,
                           cLensFlare@ &inout avOutLensFlares)

Creates an array of lens flares with a given name.

Parameters

Returns:

  • bool—array<cLensFlare@>, array of lens flares found.

Map_GetLightArray

bool Map_GetLightArray(const tString &in asName,
                       iLight@ &inout avOutLights)

Creates an array of lights with a given name.

Parameters

Returns:

  • bool—array<iLight@>, array of lights found.

Map_GetParticleSystemArray

bool Map_GetParticleSystemArray(const tString &in asName,
                                cParticleSystem@ &inout avOutParticles)

Creates an array of particle systems with a given name.

Parameters

Returns:

  • bool—
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/Scripting_Api/Map&oldid=6162"