HPL3/SOMA/Scripting/Scripting Api/Map

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_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

• asName (tString) — name of billboards. May contain * as wildcards.
• avOutBillboards (cBillboard@) — reference to array that will be filled with billboards.

Returns:

• bool—array of billboards found.

Map_GetFogAreaArray

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

Creates an array of fog areas with a given name.

Parameters

• asName (tString) — name of fog areas. May contain * as wildcards.
• avOutFogAreas (cFogArea@) — reference to array that will be filled with fog areas.

Returns:

• bool—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

• asName (tString) — name of lens flares. May contain * as wildcards.
• avOutLensFlares (cLensFlare@) — reference to array that will be filled with lens flares.

Returns:

• bool—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

• asName (tString) — name of lights. May contain * as wildcards.
• avOutLights (iLight@) — reference to array that will be filled with lights.

Returns:

• bool—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

• asName (tString) — name of particle systems. May contain * as wildcards.
• avOutParticles (cParticleSystem@) — reference to array that will be filled with particle systems.

Returns:

• bool—