Floating Text: Difference between revisions

Jump to navigation Jump to search

Floating Text (view source)

Revision as of 23:37, 4 January 2025

5,027 bytes added ,  Saturday at 23:37
no edit summary
(finish writing this tomorrow)
 
No edit summary
Line 8: Line 8:
}}
}}
'''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''' 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.
<!---->


== Usage ==
== Usage ==
{| class="wikitable"
|+ Properties (Floating Text)
|-
! 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.
|}
{| class="wikitable"
|+ Properties (Advance Text)
|-
! Setting  !! Type !! Description
|-
| Syllable display duration || Text box (Number) || Custom syllable display duration for this syllable.
|}
To separate '''syllables''', use "<code>/</code>" (e.g. <code>I've/ been/ wai/ting/ for/ so/ long...</code>).
To separate '''paragraphs''', use "<code>\n</code>" (e.g. <code>To/ all/ my/ friends/ that/ I/ have/ lost,/'''\n'''while/ cros/sing/ brid/ges/ I/ have/ crossed,</code>).
To separate '''different lyrics''', use <code>\n</code> (a new line character). The new line counts as a "<code>/</code>", meaning that it'll split syllables. <br>(e.g. <code>Though<br>E/ven/ when/ it/ goes<br>E/ven/ when/ it/ goes<br>E/ven/ when/ it/ goes<br>E/ven/ when/ it/ goes<br>E/ven/ when/ it/ goes<br>E/ven/ when/ it/ goes<br>E/ven/ when/ it/ goes<br>E/ven/ when/ it/ goes/, it/ is/ not/ gone</code>)
To change the '''color''' of a ''syllable'', encapsulate the text in <code><color=#HEXALPHA></color></code> (e.g. <code>It/ is/ get/ting/ clo/ser/ and/ clo/ser/ to/ <color=#FF0000FF>you.</color>"</code>). Note that this only affects the '''text''' color, and not its '''outline'''.
To use any '''special characters''' literally without affecting the functionality, put a "<code>\</code>" behind the character (e.g. <code>Our/ worries/ and'''\/'''or/ our/ fears</code>).
To separate a '''Floating Text''' event into its '''Advance Text''' events, click ''Create '''Advance Text''' actions''.


=== Advanced ===
=== Advanced ===


Advanced usage of an event would be classified as how people used this event to the fullest by breaking it or using an event combination. (e.g. Negabloom, Hom + Hue Shift etc..)
'''Floating Text''' events support [[RDCode]] variable reading, meaning they can read a variable and display its value. To use RDCode, use curly brackets (<code>{}</code>), and inside a valid RDCode arithmetic expression. (e.g. <code>Current score: {i0}</code> will display the current value of <code>i0</code>).
 
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 ==
== Surgery ==
=== Floating Text ===


<code>{ "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" }</code>
<code>{ "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" }</code>
'''rooms''' (integer[])
<br>Rooms to display the floating text in. Values are a list with unique integers from 0-3, or <code>[4]</code> (on top).
'''id''' (integer)
<br>ID of the '''Floating Text'''. Must be unique to all other '''Floating Text''' IDs. Keeps track of '''Advance Text''' events.
'''text''' (string)
<br>Text to display.
'''times''' (string)
<br>???
'''color''' (string)
<br>Text color. Must be a valid HEX with alpha value.
'''outlineColor''' (string)
<br>Text outline color. Must be a valid HEX with alpha value.
'''textPosition''' (number[])
<br>X and Y position of the text. Two-item array.
'''size''' (number)
<br>Size of the text. Must be greater than 0.
'''angle''' (number)
<br>Angle of the text. Measured in '''degrees'''.
'''showChildren''' (bool)
<br>Whether or not to show the '''Advance Text''' events.
'''fadeOutRate''' (number)
<br>Default syllable display duration for the event and its respective Advance Text events in '''beats'''.
'''mode''' (enum)
<br>Either ''FadeOut'' or ''HideAbruptly''.
'''anchor''' (enum)
<br>Alignment of the text, separated as <code>VerticalHorizontal</code>, i.e., values: ''UpperLeft'', ''UpperCenter'', ''UpperRight'', ''MiddleLeft'', ''MiddleCenter'', ''MiddleRight'' ''LowerLeft'', ''LowerCenter'', ''LowerRight''.
'''narrate''' (bool)
<br>Whether to narrate or not. (Accessibility)
'''narrationCategory''' (enum)
<br>Values: ''Fallback'', ''Navigation'', ''Instruction'', ''Notification'', ''Dialogue'', ''Description'', ''Subtitles''.
=== Advance Text ===
<code>{ "bar": 1, "beat": 1, "y": 0, "type": "AdvanceText", "id": 0, "fadeOutDuration": 3 }</code>
'''id''' (integer)
<br>ID of its parent '''Floating Text'''.
'''fadeOutDuration''' (number)
<br>Syllable display duration for the event in '''beats'''.


== History ==
== History ==
The history of the event across versions. (ex. How it changed between versions and the looks of it in its dev stages.)


== Trivia ==
== Trivia ==


Basic trivia about the event.
* Since the floating text can't be moved dynamically, many creators often use '''decorations''' instead of this event for text.


{{EventNavBox}}
{{EventNavBox}}
Retrieved from "https://wiki.rhythm.cafe/page/Special:MobileDiff/3302"

Navigation menu