Change Text Position - Revision history

EK at 14:37, 28 August 2023

2023-08-28T14:37:19Z

EK at 13:54, 28 August 2023

2023-08-28T13:54:24Z

EK at 13:40, 28 August 2023

2023-08-28T13:40:06Z

EK: Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | Change text Position || Definition..."

2023-08-28T13:39:24Z

Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | Change text Position || Definition..."

New page

{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| Change text Position || Definition || Various
|}

This script sets (character or narration) text to a fixed position on screen.

== Instructions ==
Visionaire offers a [[Global_Command:_registerHookFunction|function hook]] for changing the text position. You find some examples on how to implement it below, but the script you need depends on which texts you want to handle and where you want to place them.

Add one of the scripts to the Visionaire Studio Script Editor, set the script as a definition script and change it according to your needs.

== Scripts ==
=== Basic setup ===
This basic example shows how to set up the hook function. It handles character and narrator texts.

<html><button id="button1" class="copybtn" onclick="CopyToClipboard('txt1')"></button></html>
<syntaxhighlight lang="lua" id="txt1">
-- Hook function
function txtPos(text)
-- Define the new text position
text.Position = {x = 300, y = 300}

-- Return true to tell the engine that the text position is handled by this hook function
return true
end

-- Register the hook function for the "setTextPosition" operation
registerHookFunction("setTextPosition", "txtPos")
</syntaxhighlight>

=== Distinguish by owner ===
Query the owner of the text, if you want to set the text position only for texts spoken by a certain character.

<html><button id="button1" class="copybtn" onclick="CopyToClipboard('txt2')"></button></html>
<syntaxhighlight lang="lua" id="txt2">
function txtPos(text)
-- Only handle texts spoken by the character named "hero"
if text.Owner.name == "hero" then
text.Position = {x = 300, y = 300}

return true
end

-- Return false to let the engine ignore the hook function, if the "if" query wasn't met
return false
end

registerHookFunction("setTextPosition", "txtPos")
</syntaxhighlight>

Change the query to handle all character texts or all narration texts.

<html><button id="button1" class="copybtn" onclick="CopyToClipboard('txt3')"></button></html>
<syntaxhighlight lang="lua" id="txt3">
-- Handle character texts only
if text.Owner.tableId == eCharacters then
...

-- Only handle narrator texts
if text.Owner.tableId == eGame then
...
</syntaxhighlight>

=== Scrolling scenes ===
The text position is defined in relation to the scene, not the visible screen. So if your scene is larger than the game resolution (and thus scrollable), you have to take the current scroll position into account (this code also works if your scene equals the game resolution of course, because the scroll position is always [0,0] then).

<html><button id="button1" class="copybtn" onclick="CopyToClipboard('txt4')"></button></html>
<syntaxhighlight lang="lua" id="txt4">
function txtPos(text)
if text.Owner.tableId == eCharacters then
-- Define the new text position on the screen
text.Position = {x = 300 + game.ScrollPosition.x, y = 330 + game.ScrollPosition.y}

return true
end

return false
end

registerHookFunction("setTextPosition", "txtPos")
</syntaxhighlight>

This will set the horizontal position to center. Make sure to set the text alignment to "center" in the game properties, too.

<html><button id="button1" class="copybtn" onclick="CopyToClipboard('txt5')"></button></html>
<syntaxhighlight lang="lua" id="txt5">
-- Set the text position horizontally centered
text.Position = {x = game.WindowResolution.x/2 + game.ScrollPosition.x, y = 300 + game.ScrollPosition.y}
...
</syntaxhighlight>
{{toc}}

@@ Line 72: / Line 72: @@
 === Scrolling scenes ===
-The text position is defined in relation to the scene, not the visible screen. So if your scene is larger than the game resolution (and thus scrollable), you have to take the current scroll position into account (this code also works if your scene equals the game resolution of course, because the scroll position is always [0,0] then).
+The text position is defined in relation to the scene, not to the visible screen. So if your scene is larger than the game resolution (and thus scrollable), you have to take the current scroll position into account (this code also works if your scene equals the game resolution of course, because the scroll position is always [0,0] then).
 <html><button id="button1" class="copybtn" onclick="CopyToClipboard('txt4')"></button></html>
@@ Line 79: / Line 79: @@
    if text.Owner.tableId == eCharacters then
      -- Define the new text position on the screen
-     text.Position = {x = 300 + game.ScrollPosition.x, y = 330 + game.ScrollPosition.y}
+     text.Position = {x = 300 + game.ScrollPosition.x, y = 300 + game.ScrollPosition.y}
      return true

@@ Line 18: / Line 18: @@
 == Scripts ==
 === Basic setup ===
-This basic example shows how to set up the hook function. It handles character and narrator texts.
+This basic example shows how to set up the hook function. It handles character and narration texts.
 <html><button id="button1" class="copybtn" onclick="CopyToClipboard('txt1')"></button></html>
@@ Line 65: / Line 65: @@
    ...
-   -- Only handle narrator texts
+   -- Only handle narration texts
    if text.Owner.tableId == eGame then
    ...

@@ Line 5: / Line 5: @@
 | Change text Position || Definition || Various
 |}
 This script sets (character or narration) text to a fixed position on screen.