Frictional Game Wiki

<h1>helper_effects.hps</h1> <div class="level1"> <p> Helper functions to control effects </p> <hr /> </div> <h5>Effect_Shake_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_Shake_Start<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeInTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="sy0">,</span> <span class="kw4">const</span> cVector3f <span class="sy0">&</span>in avDirAmount<span class="sy0">=</span>cVector3f<span class="br0">(</span><span class="nu0">1</span><span class="sy0">,</span> <span class="nu0">1</span><span class="sy0">,</span> <span class="nu0">1</span><span class="br0">)</span><span class="sy0">,</span> <span class="kw4">float</span> afFrequency<span class="sy0">=</span><span class="nu0">0</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Makes the screen shake for a certain amount of time. Returns id to the current shaking. If several calls to shake has been made the largest one is used. </p> <ul> <li class="level1"> <b>afAmount</b>: The strength of the shake.</li> <li class="level1"> <b>afTime</b>: The time it shakes at full intensity (fade in and fade out are added to this).</li> <li class="level1"> <b>afFadeInTime</b>: The time before it reaches full strenght.</li> <li class="level1"> <b>afFadeOutTime</b>: The time, after afTime is up, that it will take for the shake to reach zero strength.</li> <li class="level1"> <b>avDirAmount</b>: The amount it will shake in each direction in camera space</li> <li class="level1"> <b>afFrequency</b>: Times per seconds the shake will change offset. 0=every update (ie max).</li> </ul> <hr /> </div> <h5>Effect_Shake_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Shake_FadeOut<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades out one or all shake instances. </p> <ul> <li class="level1"> <b>alID</b>: The id of the shake (returned by Effect_Shake_Start). -1 = fade out all active shakes.</li> <li class="level1"> <b>afFadeOutTime</b>: the time it takes to fade out.</li> </ul> <hr /> </div> <h5>Effect_Shake_SetSourceEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Shake_SetSourceEntity<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asSourceEntity<span class="sy0">,</span> <span class="kw4">float</span> afMinDist<span class="sy0">,</span> <span class="kw4">float</span> afMaxDist<span class="sy0">,</span> eEasing aEasingType<span class="sy0">=</span>eEasing_CubicIn<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets an entity as the source of a shake instance. The shake instance will increase in strength as the player gets closer to the entity. </p> <ul> <li class="level1"> <b>alID</b>: The id of the shake (returned by Effect_Shake_Start).</li> <li class="level1"> <b>asSourceEntity</b>: entity to be used as source.</li> <li class="level1"> <b>afMinDist</b>: distance to entity where the shake will be at its most powerful.</li> <li class="level1"> <b>afMaxDist</b>: distance where shake will have faded out completely.</li> <li class="level1"> <b>aEasingType</b>: the curve the strength of the shake will follow as you move further from the entity.</li> </ul> <hr /> </div> <h5>Effect_Shake_GetCurrentShakeAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Effect_Shake_GetCurrentShakeAmount<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Gets the current amount of shake (as in abs larges element in shake vector) </p> <hr /> </div> <h5>Effect_Shake_EnableAll</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Shake_EnableAll<span class="br0">(</span>bool abState<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_VideoDistortion_EnableAll</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_VideoDistortion_EnableAll<span class="br0">(</span>bool abState<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Fade_In</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Fade_In<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Fade_Out</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Fade_Out<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Fade_IsFading</h5> <div class="level5"> <pre class="code c++">bool Effect_Fade_IsFading<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Fade_GetAlpha</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Effect_Fade_GetAlpha<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Glow_AddEntity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Glow_AddEntity<span class="br0">(</span>iLuxEntity @apEntity<span class="sy0">,</span> <span class="kw4">float</span> afAlpha<span class="sy0">,</span> <span class="kw4">float</span> afY<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Adds a glow effect to the object to make it more visible to the player Must be called from OnPostUpdate() every frame the glow should be visible </p> <ul> <li class="level1"> <b>apEntity</b>: entity to glow</li> <li class="level1"> <b>afAlpha</b>: how much it should glow, [0, 1]</li> <li class="level1"> <b>afY</b>: The position of the the glow.</li> </ul> <hr /> </div> <h5>Effect_Bloom_SetActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Bloom_SetActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets if bloom should be active Bloom is an effect that makes bright colors glow in a halo around the object </p> <ul> <li class="level1"> <b>abX</b>: if bloom should be active</li> </ul> <hr /> </div> <h5>Effect_Bloom_FadeBrightPass</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Bloom_FadeBrightPass<span class="br0">(</span><span class="kw4">float</span> afBrightPass<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the bright pass of the bloom over time </p> <ul> <li class="level1"> <b>afBrightPass</b>: how bright a color has to be to be able to bloom, this should be a values between 0-1</li> <li class="level1"> <b>afTime</b>: time to fade</li> </ul> <hr /> </div> <h5>Effect_Bloom_FadeBloomWidth</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Bloom_FadeBloomWidth<span class="br0">(</span><span class="kw4">float</span> afBloomWidth<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the width of the bloom over time </p> <ul> <li class="level1"> <b>afBloomWidth</b>: the width in pixels of the bloom halo, works best with a value between 32-512 pixels</li> <li class="level1"> <b>afTime</b>: time to fade</li> </ul> <hr /> </div> <h5>Effect_Bloom_FadeBloomFalloff</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Bloom_FadeBloomFalloff<span class="br0">(</span><span class="kw4">float</span> afBloomFalloff<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the sharpness of the bloom over time </p> <ul> <li class="level1"> <b>afBloomFalloff</b>: how sharp the bloom should be, higher = sharper, 0.5 default</li> <li class="level1"> <b>afTime</b>: time to fade</li> </ul> <hr /> </div> <h5>Effect_Bloom_FadeBloomTint</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Bloom_FadeBloomTint<span class="br0">(</span><span class="kw4">float</span> afR<span class="sy0">,</span> <span class="kw4">float</span> afG<span class="sy0">,</span> <span class="kw4">float</span> afB<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the color of the bloom over time </p> <ul> <li class="level1"> <b>(afR</b>: the color to tint the bloom in</li> <li class="level1"> <b>afTime</b>: time to fade</li> </ul> <hr /> </div> <h5>Effect_FilmGrain_SetActive</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_FilmGrain_SetActive<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets if film grain should be active Film Grain is an effect that applies animated noise to the image to remove banding and give life to it </p> <ul> <li class="level1"> <b>abX</b>: if film grain should be active</li> </ul> <hr /> </div> <h5>Effect_FilmGrain_FadeFilmGrainIntensity</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_FilmGrain_FadeFilmGrainIntensity<span class="br0">(</span><span class="kw4">float</span> afIntensity<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the amount of noise applied to the screen over time </p> <ul> <li class="level1"> <b>afIntensity</b>: the amount of noise applied to the screen</li> <li class="level1"> <b>afTime</b>: time to fade in</li> </ul> <hr /> </div> <h5>Effect_DoF_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_DoF_Start<span class="br0">(</span><span class="kw4">float</span> afFocusStart<span class="sy0">,</span> <span class="kw4">float</span> afFocusEnd<span class="sy0">,</span> <span class="kw4">float</span> afFalloff<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts an instance of depth of field and returns the id </p> <ul> <li class="level1"> <b>afFocusStart</b>: near plane of the instance</li> <li class="level1"> <b>afFocusEnd</b>: far plane of the instance</li> <li class="level1"> <b>afFalloff</b>: how smooth the transition from sharp to blurr should be</li> <li class="level1"> <b>afTime</b>: time to fade to this value</li> </ul> <hr /> </div> <h5>Effect_DoF_FadeFocus</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_DoF_FadeFocus<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afFocusStart<span class="sy0">,</span> <span class="kw4">float</span> afFocusEnd<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade the start and end of the focus plane </p> <ul> <li class="level1"> <b>alID</b>: id of the instance</li> <li class="level1"> <b>afFocusStart</b>: near plane of the instance</li> <li class="level1"> <b>afFocusEnd</b>: far plane of the instance</li> <li class="level1"> <b>afTime</b>: time to fade to this value</li> </ul> <hr /> </div> <h5>Effect_DoF_FadeFalloff</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_DoF_FadeFalloff<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afFocusFalloff<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade the falloff of the instance </p> <ul> <li class="level1"> <b>alID</b>: id of the instance</li> <li class="level1"> <b>afFocusFalloff</b>: how smooth the transition from sharp to blurr should be</li> <li class="level1"> <b>afTime</b>: time to fade in</li> </ul> <hr /> </div> <h5>Effect_DoF_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_DoF_FadeOut<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade out the instance of depth of field, the instance is removed after fading out </p> <ul> <li class="level1"> <b>alID</b>: id of the instance</li> <li class="level1"> <b>afTime</b>: time to fade out</li> </ul> <hr /> </div> <h5>Effect_DoF_Reset</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_DoF_Reset<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_ToneMapping_UseSRGB</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ToneMapping_UseSRGB<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> If srgb gamma should be used. Default is normal pow(x, 1 / gamma) </p> <ul> <li class="level1"> <b>abX</b>: If srgb gamma correction should be used</li> </ul> <hr /> </div> <h5>Effect_ToneMapping_FadeExposure</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ToneMapping_FadeExposure<span class="br0">(</span><span class="kw4">float</span> afExposure<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the overall brightness of the image over time </p> <ul> <li class="level1"> <b>afExposure</b>: how much extra light should be let though the lens, 0 is default</li> <li class="level1"> <b>afTime</b>: time to fade in</li> </ul> <hr /> </div> <h5>Effect_ToneMapping_GetExposure</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Effect_ToneMapping_GetExposure<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get the current exposure value of the viewport </p> <p> <b>Returns</b>: , current exposure </p> <hr /> </div> <h5>Effect_ToneMapping_GetExposureBrightness</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Effect_ToneMapping_GetExposureBrightness<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get the current exposure value of the viewport </p> <p> <b>Returns</b>: , current brightness </p> <hr /> </div> <h5>Effect_ToneMapping_FadeWhiteCut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ToneMapping_FadeWhiteCut<span class="br0">(</span><span class="kw4">float</span> afWhiteCut<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the white point of the tone mapper over time Every color brighter then the white cut gets clamped to (1,1,1) </p> <ul> <li class="level1"> <b>afWhiteCut</b>: the value of the white cut, every brighter color get set to white</li> <li class="level1"> <b>afTime</b>: time to fade in</li> </ul> <hr /> </div> <h5>Effect_ToneMapping_FadeGrading</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ToneMapping_FadeGrading<span class="br0">(</span>tString asTextureName<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades in a grading texture which changes the final color of the image </p> <ul> <li class="level1"> <b>asTextureName</b>: name of the grading texture</li> <li class="level1"> <b>afTime</b>: time to fade in</li> </ul> <hr /> </div> <h5>Effect_ImageTrail_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_ImageTrail_Start<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afFadeInTime<span class="sy0">,</span> <span class="kw4">float</span> afStayTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Image trail blends the image of multiple previous frames over time, multiple instances can be active at the same time The strongest instance of image trail will be used </p> <ul> <li class="level1"> <b>afAmount</b>: how much of the previous frame should be blended, values from 0-inf, 0 = disabled</li> <li class="level1"> <b>afFadeInTime</b>: how long it should take to fade to fade in</li> <li class="level1"> <b>afStayTime</b>: how long it will stay before starting to fade out. If &lt;0, then it stays for ever.</li> <li class="level1"> <b>afFadeOutTime</b>: how long it will take to fade out</li> </ul> <p> <b>Returns</b>: the id to this image trail instance </p> <hr /> </div> <h5>Effect_ImageTrail_SetDirectAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ImageTrail_SetDirectAmount<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Image trail blends the image of multiple previous frames over time. (in case Effect_ImageTrail_Start has also been used, the strongest instance of image trail will be used </p> <ul> <li class="level1"> <b>afAmount</b>: how much of the previous frame should be blended, values from 0-inf, 0 = disabled</li> </ul> <hr /> </div> <h5>Effect_ImageTrail_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ImageTrail_FadeOut<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades out an active instance of image trail </p> <ul> <li class="level1"> <b>alID</b>: id of the trail instance, returned by _Start</li> <li class="level1"> <b>afFadeOutTime</b>: how long it will take to fade out</li> </ul> <hr /> </div> <h5>Effect_ImageTrail_Clear</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ImageTrail_Clear<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Clears all effects </p> <hr /> </div> <h5>Effect_ChromaticAberration_StartAnim</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ChromaticAberration_StartAnim<span class="br0">(</span><span class="kw4">float</span> afDuration<span class="sy0">,</span> <span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afRandomness<span class="sy0">,</span> cVector2f avDirection<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Split the image into three images depending on color and makes rotation animation. </p> <ul> <li class="level1"> <b>afDuration</b>: how long the effect should be active for, multiple instances can be active at the same time</li> <li class="level1"> <b>afAmount</b>: how far the split should go in screen space, values between 0-0.2 look good</li> <li class="level1"> <b>afRandomness</b>: the randomness of the splitting, if it should sway when splitting up and going back down, values larger than 1.0 will cause full rotation</li> <li class="level1"> <b>avDirection</b>: an additional direction that the screen should move in when splitting, 0 = random</li> </ul> <hr /> </div> <h5>Effect_ChromaticAberration_SetDirect</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ChromaticAberration_SetDirect<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afRotation<span class="sy0">,</span> <span class="kw4">float</span> afHue<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">const</span> cVector2f <span class="sy0">&</span>in avOffset<span class="sy0">=</span>cVector2f<span class="br0">(</span><span class="nu0">0</span><span class="br0">)</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Split the image into three images depending on color </p> <ul> <li class="level1"> <b>afAmount</b>: The amount of the effect (how much seperation basically). Measured in part of screen. 0 - 0.2 looks good.</li> <li class="level1"> <b>afRotation</b>: The rotation of the diffferent splits. 0 - 360</li> <li class="level1"> <b>afHue</b>: Which use to split into, there is always a 120 seperation between each split, this sets. where to make these splits. 0 - 360</li> <li class="level1"> <b>avOffset</b>: An extra offset.</li> </ul> <hr /> </div> <h5>Effect_ChromaticAberration_CreateInstance</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_ChromaticAberration_CreateInstance<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afRotation<span class="sy0">,</span> <span class="kw4">float</span> afHue<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">const</span> cVector2f <span class="sy0">&</span>in avOffset<span class="sy0">=</span>cVector2f<span class="br0">(</span><span class="nu0">0</span><span class="br0">)</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_ChromaticAberration_SetInstanceValues</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ChromaticAberration_SetInstanceValues<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afRotation<span class="sy0">,</span> <span class="kw4">float</span> afHue<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">const</span> cVector2f <span class="sy0">&</span>in avOffset<span class="sy0">=</span>cVector2f_Zero<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_ChromaticAberration_DestroyInstance</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ChromaticAberration_DestroyInstance<span class="br0">(</span><span class="kw4">int</span> alID<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Flash_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Flash_Start<span class="br0">(</span><span class="kw4">float</span> afFadeIn<span class="sy0">,</span> <span class="kw4">float</span> afWhite<span class="sy0">,</span> <span class="kw4">float</span> afFadeOut<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades exposure in and out to create a white flash effect. </p> <ul> <li class="level1"> <b>afFadeIn</b>: time to fade in.</li> <li class="level1"> <b>afWhite</b>: time to remain at the max exposure.</li> <li class="level1"> <b>afFadeOut</b>: time to fade out.</li> </ul> <hr /> </div> <h5>Effect_Screen_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_Screen_Start<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asMaterial<span class="sy0">,</span> cVector2f avPosition<span class="sy0">,</span> cVector2f avSize<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates a images that shows up on the screen, it must be faded manually Remember that these must work on both 4:3 and 16:9 aspect ratio </p> <ul> <li class="level1"> <b>asMaterial</b>: material to use</li> <li class="level1"> <b>avPosition</b>: position on the screen, values between [0,1]</li> <li class="level1"> <b>avSize</b>: size of the texture</li> </ul> <p> <b>Returns</b>: the id to this screen material </p> <hr /> </div> <h5>Effect_Screen_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_Screen_Start<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asMaterial<span class="sy0">,</span> cVector2f avPosition<span class="sy0">,</span> cVector2f avSize<span class="sy0">,</span> <span class="kw4">float</span> afTargetAlpha<span class="sy0">,</span> <span class="kw4">float</span> afFadeInTime<span class="sy0">,</span> <span class="kw4">float</span> afStayTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Creates a images that fade in and then out Remember that these must work on both 4:3 and 16:9 aspect ratio </p> <ul> <li class="level1"> <b>asMaterial</b>: material to use</li> <li class="level1"> <b>avPosition</b>: position on the screen, values between [0,1]</li> <li class="level1"> <b>avSize</b>: size of the texture</li> <li class="level1"> <b>afTargetAlpha</b>: alpha it should stop fading at</li> <li class="level1"> <b>afFadeInTime</b>: how fast it should fade in</li> <li class="level1"> <b>afStayTime</b>: how long it should stay after fading in</li> <li class="level1"> <b>afFadeOutTime</b>: how fast it should fade out again</li> </ul> <p> <b>Returns</b>: the id to this screen material </p> <hr /> </div> <h5>Effect_Screen_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Screen_FadeOut<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades out a material </p> <ul> <li class="level1"> <b>alID</b>: id of the screen material</li> <li class="level1"> <b>afFadeTime</b>: time to fade out over</li> </ul> <hr /> </div> <h5>Effect_Screen_FadeLiquidAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Screen_FadeLiquidAmount<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the liquid amount of a material, this is a variable used by the shader to determine wetness </p> <ul> <li class="level1"> <b>alID</b>: id of the screen material</li> <li class="level1"> <b>afAmount</b>: liquid amount, value between [0,1]</li> <li class="level1"> <b>afFadeTime</b>: time to fade over</li> </ul> <hr /> </div> <h5>Effect_Screen_FadeAlpha</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Screen_FadeAlpha<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afAlpha<span class="sy0">,</span> <span class="kw4">float</span> afFadeTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades the transparency of a material </p> <ul> <li class="level1"> <b>alID</b>: id of the screen material</li> <li class="level1"> <b>afAlpha</b>: transparency of the material value between [0,1]</li> <li class="level1"> <b>afFadeTime</b>: time to fade over</li> </ul> <hr /> </div> <h5>Effect_RadialBlur_SetDirect</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_RadialBlur_SetDirect<span class="br0">(</span><span class="kw4">float</span> afSize<span class="sy0">,</span> <span class="kw4">float</span> afStartDistance<span class="sy0">,</span> <span class="kw4">float</span> afAlpha<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Directly sets the values of radial blur (but will blend with any instnace that has been started) </p> <ul> <li class="level1"> <b>afSize</b>: size of the blur, screen size, looks good 0.01-0.1</li> <li class="level1"> <b>afStartDistance</b>: how far away from the center the blur should start</li> <li class="level1"> <b>afAlpha</b>: how visible the blur is</li> </ul> <hr /> </div> <h5>Effect_RadialBlur_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_RadialBlur_Start<span class="br0">(</span><span class="kw4">float</span> afSize<span class="sy0">,</span> <span class="kw4">float</span> afAlpha<span class="sy0">,</span> <span class="kw4">float</span> afStartDistance<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts a radial blur effect, will be active until </p> <ul> <li class="level1"> <b>afSize</b>: size of the blur, screen size, looks good 0.01-0.1</li> <li class="level1"> <b>afAlpha</b>: how visible the blur is</li> <li class="level1"> <b>afStartDistance</b>: how far away from the center the blur should start</li> <li class="level1"> <b>afTime</b>: time to fade in</li> </ul> <p> <b>Returns</b>: the id to this radial blur instance </p> <hr /> </div> <h5>Effect_RadialBlur_FadeSize</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_RadialBlur_FadeSize<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afSize<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes the size of the blur of this instance </p> <ul> <li class="level1"> <b>alID</b>: id to the instance to change</li> <li class="level1"> <b>afSize</b>: size of the blur</li> <li class="level1"> <b>afTime</b>: fade time of the blur</li> </ul> <hr /> </div> <h5>Effect_RadialBlur_FadeStartDistance</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_RadialBlur_FadeStartDistance<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afDistance<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes how far away from the center to start blurring </p> <ul> <li class="level1"> <b>alID</b>: id to the instance to change</li> <li class="level1"> <b>afDistance</b>: distance from center [0-1]</li> <li class="level1"> <b>afTime</b>: fade time</li> </ul> <hr /> </div> <h5>Effect_RadialBlur_FadeAlpha</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_RadialBlur_FadeAlpha<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afAlpha<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Changes how visible the instance should be </p> <ul> <li class="level1"> <b>alID</b>: id to the instance to change</li> <li class="level1"> <b>afAlpha</b>: how visible it should be [0-1]</li> <li class="level1"> <b>afTime</b>: fade time</li> </ul> <hr /> </div> <h5>Effect_RadialBlur_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_RadialBlur_FadeOut<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades out this instance and removes it. The ID is invalid after this has been called </p> <ul> <li class="level1"> <b>alID</b>: id to the instance to fade out</li> <li class="level1"> <b>afTime</b>: fade time</li> </ul> <hr /> </div> <h5>Effect_ImageFadeFX_SetAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ImageFadeFX_SetAmount<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_ImageFadeFX_FadeAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ImageFadeFX_FadeAmount<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_ImageFadeFX_SetTextures</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_ImageFadeFX_SetTextures<span class="br0">(</span><span class="kw4">const</span> tString <span class="sy0">&</span>in asFadeTexture<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asColorTexture<span class="sy0">,</span> <span class="kw4">const</span> tString <span class="sy0">&</span>in asOffsetTexture<span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_VideoDistortion_SetDirectAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_VideoDistortion_SetDirectAmount<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the amount of video distortion directly. (if there are instances in play, then the max amount will be used) </p> <ul> <li class="level1"> <b>afX</b>: The amount of the effect, 0 - 1 are valid values. (0 turns off)</li> </ul> <hr /> </div> <h5>Effect_VideoDistortion_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_VideoDistortion_Start<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeInTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="sy0">,</span> <span class="kw4">float</span> afVolume<span class="sy0">=</span><span class="nu17">1.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts the video distortion effect. If many have been started the max amount is used. Returns ID to this instnace. </p> <ul> <li class="level1"> <b>afAmount</b>: The amount of effect, 0 - 1 are valid values. (0 turns off)</li> <li class="level1"> <b>afTime</b>: The length the effect (after fade in) the effect should last. -1 means it lasts forever.</li> <li class="level1"> <b>afFadeInTime</b>: The time it takes for the effect to fade in.</li> <li class="level1"> <b>afFadeOutTime</b>: The time it takes for the effect to fade out.</li> <li class="level1"> <b>afVolume</b>: Volume of gui sound (will override previous instances. Only one sound at a time)</li> </ul> <hr /> </div> <h5>Effect_VideoDistortion_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_VideoDistortion_FadeOut<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fades out a video distortion effect instance. </p> <ul> <li class="level1"> <b>alID</b>: id to the instance to fade out. If -1, all instances will be faded.</li> <li class="level1"> <b>afFadeOutTime</b>: The time it takes for the effect to fade out.</li> </ul> <hr /> </div> <h5>Effect_VideoDistortion_SetMaxAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_VideoDistortion_SetMaxAmount<span class="br0">(</span><span class="kw4">int</span> alID<span class="sy0">,</span> <span class="kw4">float</span> afMaxAmount<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets the max amount of an instnace (basically changes the amount) </p> <ul> <li class="level1"> <b>alID</b>: id to the instance to fade out</li> <li class="level1"> <b>afMaxAmount</b>: The new max amount to be used, 0 -1 are valid values.</li> </ul> <hr /> </div> <h5>Effect_VideoDistortion_GetAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Effect_VideoDistortion_GetAmount<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get the current amount of the distortion </p> <hr /> </div> <h5>Effect_VideoDistortion_GetEffectAmount</h5> <div class="level5"> <pre class="code c++"><span class="kw4">float</span> Effect_VideoDistortion_GetEffectAmount<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Get the current effect amount of the distortion (the one that is sent to the post effect) </p> <hr /> </div> <h5>Effect_VideoDistortion_SetSoundEffectsDisabled</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_VideoDistortion_SetSoundEffectsDisabled<span class="br0">(</span>bool abX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Set if video distortion sounds should be disabled. </p> <hr /> </div> <h5>Effect_TimeGlitch_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_TimeGlitch_Start<span class="br0">(</span><span class="kw4">float</span> afTimeAdvancement<span class="sy0">,</span> <span class="kw4">float</span> afPlayFastSoundTime<span class="sy0">,</span> <span class="kw4">float</span> afShakeAmount<span class="sy0">,</span> bool abPlayEffectSound<span class="sy0">,</span> <span class="kw4">float</span> afSoundEffectVolume<span class="sy0">=</span><span class="nu17">1.0f</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Starts an effect that makes physics and visual jump forward in time. </p> <ul> <li class="level1"> <b>afTimeAdvancement</b>: The amount of time physics and visuals should advance.</li> <li class="level1"> <b>afPlayFastSoundTime</b>: How long the sounds should run sped up. (sound freq depends on the time advancement + this time)</li> <li class="level1"> <b>afShakeAmount</b>: How much the screen should shake.</li> <li class="level1"> <b>abPlayEffectSound</b>: If an effect sound should play.</li> <li class="level1"> <b>afSoundEffectVolume</b>: Volume of the sound being played.</li> </ul> <hr /> </div> <h5>Effect_Sway_FadeIn</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Sway_FadeIn<span class="br0">(</span><span class="kw4">float</span> afSize<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">,</span> <span class="kw4">float</span> afRate<span class="sy0">,</span> <span class="kw4">float</span> afAngle<span class="sy0">,</span> <span class="kw4">float</span> afInitialAmount<span class="sy0">=-</span><span class="nu17">1.0f</span><span class="sy0">,</span> <span class="kw4">float</span> afYMul<span class="sy0">=</span><span class="nu17">0.25f</span><span class="sy0">,</span> <span class="kw4">float</span> afDecay<span class="sy0">=</span><span class="nu17">0.995f</span><span class="sy0">,</span> <span class="kw4">float</span> afMoveFactor<span class="sy0">=</span><span class="nu17">0.4f</span><span class="br0">)</span> </pre><p> </p> <ul> <li class="level1"> <b>afSize</b>: max X size of sway</li> <li class="level1"> <b>afTime</b>: fade in time</li> <li class="level1"> <b>afRate</b>: how many sways per second</li> <li class="level1"> <b>afAngle</b>: sway will be around a line on XZ plane - this sets the y-axis rotation of it (degrees : 0 = along X axis)</li> <li class="level1"> <b>afInitialAmount</b>: how big is the initial sway size? (0.0f - 1.0f) If negative, has no effect.</li> <li class="level1"> <b>afYMul</b>: multiplier of afSwaySize for y</li> <li class="level1"> <b>afDecay</b>: how fast the swaying dies away (1.0f = never dies)</li> <li class="level1"> <b>afMoveFactor</b>: how much of the player's move speed to factor in</li> </ul> <hr /> </div> <h5>Effect_Sway_SetDirect</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Sway_SetDirect<span class="br0">(</span><span class="kw4">float</span> afSize<span class="sy0">,</span> <span class="kw4">float</span> afRate<span class="sy0">,</span> <span class="kw4">float</span> afAngle<span class="sy0">,</span> <span class="kw4">float</span> afInitialAmount<span class="sy0">=-</span><span class="nu17">1.0f</span><span class="sy0">,</span> <span class="kw4">float</span> afYMul<span class="sy0">=</span><span class="nu17">0.25f</span><span class="sy0">,</span> <span class="kw4">float</span> afDecay<span class="sy0">=</span><span class="nu17">0.995f</span><span class="sy0">,</span> <span class="kw4">float</span> afMoveFactor<span class="sy0">=</span><span class="nu17">0.4f</span><span class="br0">)</span> </pre><p> </p> <ul> <li class="level1"> <b>afSize</b>: max X size of sway</li> <li class="level1"> <b>afRate</b>: how many sways per second</li> <li class="level1"> <b>afAngle</b>: sway will be around a line on XZ plane - this sets the y-axis rotation of it (degrees : 0 = along X axis)</li> <li class="level1"> <b>afInitialAmount</b>: how big is the initial sway size? (0.0f - 1.0f). If negative, has no effect.</li> <li class="level1"> <b>afYMul</b>: multiplier of afSwaySize for y</li> <li class="level1"> <b>afDecay</b>: how fast the swaying dies away (1.0f = never dies)</li> <li class="level1"> <b>afMoveFactor</b>: how much of the player's move speed to factor in</li> </ul> <hr /> </div> <h5>Effect_Sway_FadeOut</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Sway_FadeOut<span class="br0">(</span><span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <ul> <li class="level1"> <b>afTime</b>: How long it takes to fade out.</li> </ul> <hr /> </div> <h5>Effect_Sway_Stop</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Sway_Stop<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Sway_GetOffset</h5> <div class="level5"> <pre class="code c++">cVector3f Effect_Sway_GetOffset<span class="br0">(</span><span class="br0">)</span> </pre><p> </p> <hr /> </div> <h5>Effect_Rumble_Start</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_Rumble_Start<span class="br0">(</span><span class="kw4">float</span> afAmount<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="sy0">,</span> <span class="kw4">float</span> afFadeInTime<span class="sy0">=</span><span class="nu0">0</span><span class="sy0">,</span> <span class="kw4">float</span> afFadeOutTime<span class="sy0">=</span><span class="nu0">0</span><span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Start a gamepad rumble </p> <hr /> </div> <h5>Effect_GamepadColor_Fade</h5> <div class="level5"> <pre class="code c++"><span class="kw4">int</span> Effect_GamepadColor_Fade<span class="br0">(</span>cColor aColor<span class="sy0">,</span> <span class="kw4">float</span> afTime<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Fade the gamepad color (the backlight of the ps4 controller) </p> <hr /> </div> <h5>Effect_Rumble_Stop</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Rumble_Stop<span class="br0">(</span><span class="kw4">int</span> alID<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops the rumble from this id </p> <hr /> </div> <h5>Effect_Rumble_SetScreenShakeMul</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_Rumble_SetScreenShakeMul<span class="br0">(</span><span class="kw4">float</span> afX<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Sets a multiplier for how much rumble should be generated from screenshake. </p> <ul> <li class="level1"> <b>afX</b>: multiplier to set. 1 is default.</li> </ul> <hr /> </div> <h5>Effect_GamepadColor_Stop</h5> <div class="level5"> <pre class="code c++"><span class="kw4">void</span> Effect_GamepadColor_Stop<span class="br0">(</span><span class="kw4">int</span> alID<span class="br0">)</span> </pre><p> </p> <p> <span class='np_break'> </span> Stops the color fade from this id </p> <hr /> </div>