Floating Text
Floating Text is an event in the VFX tab that displays text in the foreground of a room. This event is commonly used for lyrics or other places wherein alternatives like Show Status Sign or Show Dialogue may be less appropriate or useful. Its color, outline color, rotation, size, and position can be edited. It can't be moved.
Floating Text | |
---|---|
Tab | VFX |
Type | FloatingText |
Origin | rVersion |
Shortcut | A |
Usage
Setting | Type | Description |
---|---|---|
Text size | Text box (Number) | Text size. |
Text angle | Text box (Number) | Text angle. |
Text color | Color (Color) | Text color. |
Text outline color | Color (Color) | Text outline color. |
Text position | Text boxes (Numbers) | Text position. |
Text horizontal alignment | Selection (Enum) | Text horizontal alignment (Left, Middle, Right). |
Text vertical alignment | Selection (Enum) | Text vertical alignment (Top, Center, Bottom). |
Text position | Text boxes (Numbers) | Text position. |
Text | Text box (String) | The voice that says the phrase. |
Show Advance Text actions | Toggle (Bool) | Whether to show the Advance Text actions or not. |
Syllables will disappear | Toggle (Enum) | Whether the syllables should disappear fading out (InSine tween, unchangeable) or instantly. |
Syllable display duration | Text box (Number) | Default syllable display duration for the event and its respective Advance Text events. |
Setting | Type | Description |
---|---|---|
Syllable display duration | Text box (Number) | Custom syllable display duration for this syllable. |
To separate syllables, use "/
" (e.g. I've/ been/ wai/ting/ for/ so/ long...
).
To separate paragraphs, use "\n
" (e.g. To/ all/ my/ friends/ that/ I/ have/ lost,/\nwhile/ cros/sing/ brid/ges/ I/ have/ crossed,
).
To separate different lyrics, use \n
(a new line character). The new line counts as a "/
", meaning that it'll split syllables.
(e.g. Though
)
E/ven/ when/ it/ goes
E/ven/ when/ it/ goes
E/ven/ when/ it/ goes
E/ven/ when/ it/ goes
E/ven/ when/ it/ goes
E/ven/ when/ it/ goes
E/ven/ when/ it/ goes
E/ven/ when/ it/ goes/, it/ is/ not/ gone
To change the color of a syllable, encapsulate the text in <color=#HEXALPHA></color>
(e.g. It/ is/ get/ting/ clo/ser/ and/ clo/ser/ to/ <color=#FF0000FF>you.</color>"
). Note that this only affects the text color, and not its outline.
To use any special characters literally without affecting the functionality, put a "\
" behind the character (e.g. Our/ worries/ and\/or/ our/ fears
).
To separate a Floating Text event into its Advance Text events, click Create Advance Text actions.
Advanced
Floating Text events support RDCode variable reading, meaning they can read a variable and display its value. To use RDCode, use curly brackets ({}
), and inside a valid RDCode arithmetic expression. (e.g. Current score: {i0}
will display the current value of i0
).
Since the position of the floating text cannot be dynamically changed with the event on its own, Move Room events can be used on an empty transparent room with the text to move it.
Another way of going around this issue is not using floating text at all, as some creators instead opt for using decorations, though this removes a lot of the functionality that comes with Floating Text by default, like syllable separation, text anchoring, timed lyrics, and RDCode variable reading.
Surgery
Floating Text
{ "bar": X, "beat": X, "y": X, "type": "FloatingText", "rooms": [0], "id": 0, "text": "I've/ been/ wai/ting/ for/ so/ long...", "times": "", "color": "FFFFFFFF", "outlineColor": "000000FF", "textPosition": [50, 50], "size": 8, "angle": 0, "showChildren": true, "fadeOutRate": 3, "mode": "FadeOut", "anchor": "MiddleCenter", "narrate": true, "narrationCategory": "Subtitles" }
rooms (integer[])
Rooms to display the floating text in. Values are a list with unique integers from 0-3, or [4]
(on top).
id (integer)
ID of the Floating Text. Must be unique to all other Floating Text IDs. Keeps track of Advance Text events.
text (string)
Text to display.
times (string)
???
color (string)
Text color. Must be a valid HEX with alpha value.
outlineColor (string)
Text outline color. Must be a valid HEX with alpha value.
textPosition (number[])
X and Y position of the text. Two-item array.
size (number)
Size of the text. Must be greater than 0.
angle (number)
Angle of the text. Measured in degrees.
showChildren (bool)
Whether or not to show the Advance Text events.
fadeOutRate (number)
Default syllable display duration for the event and its respective Advance Text events in beats.
mode (enum)
Either FadeOut or HideAbruptly.
anchor (enum)
Alignment of the text, separated as VerticalHorizontal
, i.e., values: UpperLeft, UpperCenter, UpperRight, MiddleLeft, MiddleCenter, MiddleRight LowerLeft, LowerCenter, LowerRight.
narrate (bool)
Whether to narrate or not. (Accessibility)
narrationCategory (enum)
Values: Fallback, Navigation, Instruction, Notification, Dialogue, Description, Subtitles.
Advance Text
{ "bar": 1, "beat": 1, "y": 0, "type": "AdvanceText", "id": 0, "fadeOutDuration": 3 }
id (integer)
ID of its parent Floating Text.
fadeOutDuration (number)
Syllable display duration for the event in beats.
History
Trivia
- Since the floating text can't be moved dynamically, many creators often use decorations instead of this event for text.