Argo Bubbles - Revision history

EK at 11:43, 13 February 2024

2024-02-13T11:43:42Z

EK at 12:38, 5 January 2024

2024-01-05T12:38:15Z

Show changes

EK at 12:16, 5 January 2024

2024-01-05T12:16:34Z

EK at 11:12, 5 January 2024

2024-01-05T11:12:51Z

EK at 11:03, 5 January 2024

2024-01-05T11:03:58Z

EK at 21:26, 4 January 2024

2024-01-04T21:26:29Z

EK at 09:24, 28 August 2023

2023-08-28T09:24:17Z

EK at 17:01, 5 August 2023

2023-08-05T17:01:49Z

EK at 11:30, 9 May 2023

2023-05-09T11:30:19Z

EK at 12:31, 7 May 2023

2023-05-07T12:31:45Z

@@ Line 100: / Line 100: @@
-<syntaxhighlight lang="lua" id="txt">
+<syntaxhighlight lang="lua">
 -- Example
 local custom_styles = {

@@ Line 25: / Line 25: @@
 . Create the bubble graphics and add them to your project folder or any subfolder. Basic graphics are included in the demo project which can be downloaded from the [[#Resources|resources section]].
-. Adjust the settings at the top of the script (between "DEFINE YOUR SETTINGS HERE" and "USUALLY NO NEED TO CHANGE ANYTHING BELOW THIS LINE").
+. Adjust the [[#Settings|settings]] at the top of the script (between "DEFINE YOUR SETTINGS HERE" and "USUALLY NO NEED TO CHANGE ANYTHING BELOW THIS LINE").
 == Description ==
-The script is extensively commented, giving you all the information you need to make use of its features. If anything is unclear, you may find the answer in this description.
+The script is extensively commented, giving you all the information you need to make use of its features. A [[#Settings|detailed description of the settings]] can be found on this page.
@@ Line 51: / Line 51: @@
-==== Bubble style ====
+==== Default bubble style ====
 * <span class="inlinecode">align_h:</span> The horizontal alignment of the bubble in relation to the character. Possible values are (center|left|right|char_facing). The "char_facing" value results in a left/right aligned bubble, respectively, depending on the character's facing direction.
@@ Line 90: / Line 90: @@
-=== Work with multiple speech bubble styles ===
+==== Custom bubble styles ====
-A main feature of the "Argo Bubbles" script is the ability to define as many bubble styles as you like. You could have a different bubble color/design for each character, for example. Or depending on where a NPC stands, that character might need a different positioning of the bubble than the default one. You can even define multiple styles for the same character and switch between them during the game. The default bubble style is defined in the "default_style" variable.
+A main feature of the "Argo Bubbles" script is the ability to define multiple bubble styles. You could have a different bubble color/design for each character, for example. Or depending on where an NPC stands, that character might need a different positioning of the bubble than the default one. You can even define multiple styles for the same character and switch between them during the game.
-If you would like to add more styles:
+The default bubble style is defined in the "default_style" table. If you would like to add more styles:
 * If a character is meant to use only a single style throughout the game (either the default style or a custom one), you don't have to do anything else.
 * If you want the character to switch styles during the game, add a Visionaire value called "argo_bubble" to the character. By changing that value you can select the style to be active. A value of 0 selects the default style. A value of 1 selects the first custom style defined for that character, a value of 2 the second custom style for that character etc. You can define as many custom styles per character as you like - just add them to the "custom_styles" table.

← Older revision		Revision as of 11:12, 5 January 2024
Line 108:		Line 108:

	== Tutorial ==		== Tutorial ==
−	For a deeper understanding of how the speech bubbles are created and how they replace the text displayed by Visionaire, please have a look at the tutorial; it is included [[#Resources\|in the .zip file]]. You <u>don't</u> have to read it, if you just want to use the script in your project. <span class="red">Be aware that the tutorial was created for script version 2.1.2. The basic idea is still the same, but the code has changed a lot since then.</span>	+	For a deeper understanding of how the speech bubbles are created and how they replace the text displayed by Visionaire, please have a look at the tutorial; it is included [[#Resources\|in the .zip file]]. You <u>don't</u> have to read it, if you just want to use the script in your project.
		+
		+	<span class="red">Be aware that the tutorial was created for script version 2.1.2. The basic idea is still the same, but the code has changed a lot since then.</span>

@@ Line 23: / Line 23: @@
 . Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor and set the script as a definition script.
-. Create the bubble graphics and add them to your project folder or any subfolder.
+. Create the bubble graphics and add them to your project folder or any subfolder. Basic graphics are included in the demo project which can be downloaded from the [[#Resources|resources section]].
 . Adjust the settings at the top of the script (between "DEFINE YOUR SETTINGS HERE" and "USUALLY NO NEED TO CHANGE ANYTHING BELOW THIS LINE").
@@ Line 35: / Line 35: @@
 === How the Argo Bubbles are created ===
-* Display of the regular character text is prevented. The text is stored internally to get integrated in the speech bubble. The font used in the bubble will stay the same though - it is the regular font defined in the editor for a specific character. Choose a font for the character that fits your speech bubble design.
+* Display of the regular character text is prevented. The text is stored internally to get integrated in the speech bubble. The font used in the bubble will stay the same though - it is the regular font defined in the editor for a specific character. Choose a font for the character that fits your speech bubble design. Any [[Text#Text_formatting|text formatting]] or [[Text#Text_effects|text effects]] are preserved.
 * The main bubble graphic is cut into nine pieces which are individually stretched and then reassembled to match the calculated size of the bubble (see the graphic below). This "ninerect" technique ensures that the corners don't get distorted, but leads to limitations to what the speech bubbles can look like. It is not possible with this script to have elliptical or fancy-shaped bubbles. They need to be more or less rectangular.
 * You usually want to have a pointer attached to the bubble, pointing at the character who is currently speaking. Depending on your alignment settings and on the direction the character is facing, the script selects one of up to four pointer graphics you can provide and places it accordingly. Pointers are optional though.
@@ Line 96: / Line 96: @@
 If you would like to add more styles:
-* Add custom bubble styles to the "custom_styles" table. You can override all properties of the default style. Undefined properties will fallback to default.
+* Add custom bubble styles to the "custom_styles" table. You can override all properties of the default style. Undefined properties will fallback to the default values.
 * Each custom bubble style is defined for a specific character. Add the name of the character as an additional "char" property.
 * If a character is meant to use only a single style throughout the game (either the default style or a custom one), you don't have to do anything else.
@@ Line 108: / Line 108: @@
 == Tutorial ==
-For a deeper understanding of how the speech bubbles are created and how they replace the text displayed by Visionaire, please have a look at the tutorial (it is included in the .zip file). You <u>don't</u> have to read it, if you just want to use the script in your project. Be aware that the tutorial was created for script version 2.1.2. The basic idea is still the same, but the code has changed a lot since then.
+For a deeper understanding of how the speech bubbles are created and how they replace the text displayed by Visionaire, please have a look at the tutorial; it is included [[#Resources|in the .zip file]]. You <u>don't</u> have to read it, if you just want to use the script in your project. <span class="red">Be aware that the tutorial was created for script version 2.1.2. The basic idea is still the same, but the code has changed a lot since then.</span>

@@ Line 7: / Line 7: @@
 This script allows you to turn texts spoken by characters into speech bubbles.
 <hr>
 {| class="toccolours mw-collapsible mw-collapsed ts qntoggle"
@@ Line 125: / Line 123: @@
                   (with contributions by Mulewa and some lines of code
                   taken from the Visionaire Shader Toolkit by Simon Scheckel)
-Version:         2.2.1
+Version:         2.2.2
-Date:            2023-06-03
+Date:            2024-01-04
-Requirements:    Visionaire Studio 5.1.9.2 or higher
+Requirements:    Visionaire Studio 5.3 or higher
 License:         MIT License (details at the bottom of the script)
 Based on:        Advanced Speechbubble Script [v1.1] (10/13/2018), written by Sebastian/TURBOMODUS (with permission)
@@ Line 265: / Line 263: @@
 function ab_on_text_started(text)
    -- add your functions here
 end
@@ Line 314: / Line 313: @@
 -- New mode: create bubbles in "textRender" function
 function show_argo_bubble(text)
-   if text.Owner:getId().tableId == eCharacters then
+   if text.Owner.tableId == eCharacters then
      -- Add current character text to the bubbles table, if not already there (and bubbles not killed early)
-     if bubbles[text:getId().id] == nil and killed[text:getId().id] == nil then
+     if bubbles[text.id] == nil and killed[text.id] == nil then
-       bubbles[text:getId().id] = {
+       bubbles[text.id] = {
          Text = text.CurrentText,
-         Owner = text.Owner:getName(),
+         Owner = text.Owner.name,
-         Background = text.Background
+         Background = text.Background,
+       }
      end
@@ Line 336: / Line 336: @@
 function show_argo_bubble_classic(text)
    if classic_mode then
-     if text.Owner:getId().tableId == eCharacters then
+     if text.Owner.tableId == eCharacters then
        -- Add current character text to the bubbles table
-       bubbles[text:getId().id] = {
+       bubbles[text.id] = {
          Text = text.CurrentText,
-         Owner = text.Owner:getName(),
+         Owner = text.Owner.name,
          Background = text.Background
+       }
@@ Line 359: / Line 359: @@
 function destroy_argo_bubble(text)
    -- Remove current text from bubbles table
-   bubbles[text:getId().id] = nil
+   bubbles[text.id] = nil
    -- Call external functions that use the "textStopped" event handler
@@ Line 548: / Line 548: @@
    end
-   -- Draw the text line by line
+   -- Draw the text object
-   for k, line in ipairs(text_and_bubble_dims.lines) do
+   local text_pos = {x = 0, y = text_box_pos_y}
-     local tempdim = graphics.fontDimension(line)
+  local alignment = 2
-     local text_pos = {x = 0, y = 0}
-    if bubble_style.text_align_h == "left" then
+  graphics.drawTextObject(val.Object, text_pos.x, text_pos.y, alignment)
 end
@@ Line 853: / Line 847: @@
 MIT License
-Copyright 2023 The Argonauts
+Copyright 2024 The Argonauts
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
@@ Line 870: / Line 864: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Description
 |-
-| [[media:argo_bubbles_2.2.1.zip|argo_bubbles_2.2.1.zip]] || A working example of the script in action. ''Visionaire Studio 5.1.9.2+'' required to run the included .ved file(s).
+| [[media:argo_bubbles_2.2.2.zip|argo_bubbles_2.2.2.zip]] || A working example of the script in action. ''Visionaire Studio 5.3+'' required to run the included .ved file(s).
 |}{{toc}}

@@ Line 118: / Line 118: @@
 Argo Bubbles
 ------------
-Speech bubble script for Visionaire Studio 5.
+This script turns character texts into speech bubbles. It allows defining differently styled bubbles for each character, or even different speech bubble styles for the same character to switch between during the game.
 Authors:         The Argonauts
-                  with contributions by Mulewa
+                  (with contributions by Mulewa and some lines of code
-                 and some lines of code taken from the Visionaire Shader Toolkit by Simon Scheckel
+                 taken from the Visionaire Shader Toolkit by Simon Scheckel)
-Version:         2.2.0
+Version:         2.2.1
-Date:            2023-05-07
+Date:            2023-06-03
-Play our games:  https://the-argonauts.itch.io/
+Requirements:    Visionaire Studio 5.1.9.2 or higher
-based on (with permission):
+Argonauts games: https://the-argonauts.itch.io/
 ]]
@@ Line 276: / Line 263: @@
 function ab_on_text_started(text)
    -- add your functions here
 end
@@ Line 322: / Line 308: @@
 local bubbles = {}
 -- New mode: create bubbles in "textRender" function
 function show_argo_bubble(text)
    if text.Owner:getId().tableId == eCharacters then
-     -- Add current character text to the bubbles table, if not already there
+     -- Add current character text to the bubbles table, if not already there (and bubbles not killed early)
-     if bubbles[text:getId().id] == nil then
+     if bubbles[text:getId().id] == nil and killed[text:getId().id] == nil then
        bubbles[text:getId().id] = {
          Text = text.CurrentText,
@@ Line 382: / Line 369: @@
 -- Call this function to immediately destroy all bubbles
 function kill_argo_bubbles()
    bubbles = {}
 end
@@ Line 849: / Line 844: @@
 graphics.addDrawFunc("bubble_below_interface()", 0)
 graphics.addDrawFunc("bubble_above_interface()", 1)
 </syntaxhighlight>
@@ Line 857: / Line 868: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Description
 |-
-| [[media:argo_bubbles_2.2.0.zip|argo_bubbles_2.2.0.zip]] || A working example of the script in action. ''Visionaire Studio 5.1.9.2+'' required to run the included .ved file(s).
+| [[media:argo_bubbles_2.2.1.zip|argo_bubbles_2.2.1.zip]] || A working example of the script in action. ''Visionaire Studio 5.1.9.2+'' required to run the included .ved file(s).
 |}{{toc}}

← Older revision		Revision as of 11:30, 9 May 2023
Line 100:		Line 100:
	* If a character is meant to use only a single style throughout the game (either the default style or a custom one), you don't have to do anything else.		* If a character is meant to use only a single style throughout the game (either the default style or a custom one), you don't have to do anything else.
	* If you want the character to switch styles during the game, add a Visionaire value called "argo_bubble" to the character. By changing that value you can select the style to be active. A value of 0 selects the default style. A value of 1 selects the first custom style defined for that character, a value of 2 the second custom style for that character etc. You can define as many custom styles per character as you like - just add them to the "custom_styles" table.		* If you want the character to switch styles during the game, add a Visionaire value called "argo_bubble" to the character. By changing that value you can select the style to be active. A value of 0 selects the default style. A value of 1 selects the first custom style defined for that character, a value of 2 the second custom style for that character etc. You can define as many custom styles per character as you like - just add them to the "custom_styles" table.
		+
		+
		+	=== Kill the bubbles ===
		+
		+	Call the <code>kill_argo_bubbles()</code> function to immediately remove all current bubbles from the screen. You'll need this, for example, if the user can open the menu by pressing a key, because it would be possible to do that while a character is talking and thus a speech bubble is visible. By calling the kill function you prevent the bubble from appearing on the menu as well. A scene change does not automatically hide a bubble.

@@ Line 64: / Line 64: @@
 * <span class="inlinecode">text_align_v:</span> The vertical text alignment inside the bubble. Possible values are (center|top|bottom).  This option has a visible effect only if the bubble has a fixed height.
 * <span class="inlinecode">padding:</span> The distance between the text block and the outer edge of the bubble, defined in a table {"top", "right", "bottom", "left"}.
-* <span class="inlinecode">fixed_width:</span> The fixed width of the bubble. Set the value to 0 to not set a fixed width.
+* <span class="inlinecode">fixed_width:</span> The fixed width of the bubble. Set the value to 0 to not set a fixed width. Be aware that the width of the bubble does currently not affect line breaks.
 * <span class="inlinecode">fixed_height:</span> The fixed height of the bubble. Set the value to 0 to not set a fixed height.
 * <span class="inlinecode">fixed_pos:</span> A fixed position on the screen to show the bubble at, defined in a table {"x", "y"}. That position will serve as the root point of the position calculation (it substitutes the character's position), so it depends on your alignment settings where the bubble will be placed. Don't set "align_h" to "char_facing" when using the fixed position, because the bubble position would change depending on the character's facing direction.