TiMan: Add a sourced SOMA guide with explanations and stock-script examples.

2026-10-02T12:23:28Z

Add a sourced SOMA guide with explanations and stock-script examples.

New page

{{shortPageTitle}}
{{stub}}

This page describes SOMA’s ImageFadeFx effect.

ImageFadeFX is a post effect with separate fade, color and offset textures. SetTextures loads those three texture slots; FadeAmount computes a change speed from the target amount and fade duration, or sets the amount immediately when the duration is nonpositive.

== Typed interface ==
The methods are declared in <code>script/effects/Effects.hps</code> on <code>iScrEffect_ImageFadeFX</code>:

<syntaxhighlight lang="cpp">
void SetTextures(const tString& in asFadeTexture, const tString& in asColorTexture, const tString& in asOffsetTexture);
void SetAmount(float afAmount);
void FadeAmount(float afAmount, float afTime);
</syntaxhighlight>

== Read the texture and fade controls ==
# Trace <code>SetTextures</code> in <code>script/effects/Effect_ImageFadeFX.hps</code>: the arguments fill slots 0, 1 and 2 in fade, color and offset order. Each nonempty filename is loaded as a 2D texture. A failed load produces an error and clears that slot’s filename.
# Follow <code>SetAmount</code>: it creates or retrieves the post effect, applies the amount and texture slots, and makes the script effect active when the amount is greater than zero.
# Follow <code>FadeAmount</code>: for a positive <code>afTime</code>, the change speed is <code>abs(target - current) / afTime</code>; otherwise it calls <code>SetAmount</code> immediately.

== Still to expand ==
The texture-loading and amount controls are verified, but no shipped campaign caller was found. A complete texture set and a verified visual example are still needed.

== See also ==
* [[HPL3/SOMA/Scripting/Effects Helper|SOMA effects helpers]]

[[Category:English]]

HPL3/SOMA/Scripting/ImageFadeFx - Revision history

TiMan: Add a sourced SOMA guide with explanations and stock-script examples.