HPL3/SOMA/Scripting/Scripting Api/IrradianceSet

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
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
void IrradianceSet_FadeIn(const tString &in asSet, float afTime)
Fades in the specified set on all probes belonging to it
void IrradianceSet_FadeInSingleProbe(const tString &in asProbe, const tString &in asSet, float afTime)
Fades in the specified set on a specific probe

Function Detail

IrradianceSet_FadeIn

void IrradianceSet_FadeIn(const tString &in asSet,
                          float afTime)

Fades in the specified set on all probes belonging to it. This also fades out the currently active set for these probes.

Parameters

  • asSet (tString) — set to fade in.
  • afTime (float) — how long it should take until the fade is done.

Returns:

  • void

IrradianceSet_FadeInSingleProbe

void IrradianceSet_FadeInSingleProbe(const tString &in asProbe,
                                     const tString &in asSet,
                                     float afTime)

Fades in the specified set on a specific probe. This also fades out the currently active set for these probes.

Parameters

  • asProbe (tString) — the probe to fade in the set on. Wildcards (*) supported.
  • asSet (tString) — set to fade in.
  • afTime (float) — how long it should take until the fade is done.

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/IrradianceSet&oldid=5032"