(6.0.0) scribble_autotype_fade_in - JujuAdams/ScribbleOldDocs GitHub Wiki
scribble_autotype_fade_in(element, speed, smoothness, perLine, [occuranceName])
Returns: N/A (0
)
Argument | Name | Purpose |
---|---|---|
0 | element |
Text element to target. This element must have been created previously by scribble_draw() or scribble_cache() |
1 | speed |
Amount of text to reveal per tick (1 tick is usually 1 frame). This is character or lines depending on the method defined above |
2 | smoothness |
How much text is visible during the fade. Higher numbers will allow more text to be visible as it fades in |
3 | perLine |
Set to true to fade in one line at a time, otherwise text will fade in per-character |
[4] | [occuranceName] |
ID to reference a specific unique occurance of a text element. This can be a string or a number. Defaults to SCRIBBLE_DEFAULT_OCCURANCE_NAME |
The smoothness
argument offers some customisation for how text fades in. A high value will cause text to be smoothly faded in whereas a smoothness of 0
will cause text to instantly pop onto the screen. For advanced users, custom shader code can be easily combined with the smoothness
value to animate text in unique ways as it fades in.
Events (in-line scripts) will be executed as text fades in. This is a powerful tool and can be used to achieve many things, including triggering sound effects, changing character portraits, starting movement of instances, starting weather effects, giving the player items, and so on.