Interfaces - Revision history

EK at 10:45, 16 January 2024

2024-01-16T10:45:39Z

EK at 15:17, 20 July 2023

2023-07-20T15:17:16Z

EK at 22:14, 2 March 2023

2023-03-02T22:14:27Z

EK at 11:24, 2 March 2023

2023-03-02T11:24:08Z

EK at 11:05, 1 March 2023

2023-03-01T11:05:28Z

EK at 11:00, 1 March 2023

2023-03-01T11:00:48Z

EK at 16:48, 28 February 2023

2023-02-28T16:48:31Z

EK at 10:14, 24 February 2023

2023-02-24T10:14:46Z

EK at 17:31, 4 February 2023

2023-02-04T17:31:35Z

EK at 17:30, 4 February 2023

2023-02-04T17:30:20Z

@@ Line 63: / Line 63: @@
 * <span class="inlinecode">Show interface permanently:</span> Check this option to prevent hiding of the interface. It would be visible even during cutscenes.
 * <span class="inlinecode">Standard command:</span> One of your game commands is always set active during the game. Define one of them as the [[#Standard command|standard command]] which will become the active command whenever no other command is set.
-* <span class="inlinecode">Show action text:</span> This enables the display of [[#Action text on the interface|action text]] within the interface. You need to have a font defined (see next property) and a text area added to the interface to make it work. If you show the action text on the interface, you would usually want to disable action text display in the [[Game Properties|game properties]] to prevent duplicate action text.
+* <span class="inlinecode">Show action text:</span> This enables the display of [[#Action text on the interface|action text]] within the interface. You need to have a font defined (see next property) and a text area added to the interface to make it work. If you show the action text on the interface, you would usually want to disable action text display in the [[Game Properties#Action text|game properties]] to prevent duplicate action text.
 * <span class="inlinecode">Font:</span> Choose a font for the action text. Only applicable if "Show action text" is enabled.
 * <span class="inlinecode">Displacement:</span> Select where to display the interface. If you choose "Top", "Bottom", "Left", or "Right", the interface will be placed ''<u>next to</u> the scene'', meaning the scene has to be smaller than the game's resolution (unless it's intended to scroll); otherwise the scene will be shifted out of the screen. Use the "Absolute" option to place the interface at a certain position ''<u>on</u> the scene''. The position itself is defined in "Offset". Choose "Current cursor position" to display the interface at the current position of the cursor (like for a verb coin). Use the "Offset" setting to define the offset from the cursor position.

← Older revision		Revision as of 15:17, 20 July 2023
Line 245:		Line 245:
	==== Particle Containers ====		==== Particle Containers ====

−	You can assign a particle system to an interface button. That system will be visible as long as the respective button is visible. See the [[~~Particles~~]] page for more on how to set up particle systems.	+	You can assign a particle system to an interface button. That system will be visible as long as the respective button is visible. See the [[Particle System]] page for more on how to set up particle systems.

@@ Line 224: / Line 224: @@
 === Button components ===
-Click the <span class="inlinecode">[+]</span> icon on the "Components" tab of a button to add a component to this button. You'll get a list of available components split into four groups: "Internal Components" are directly built into the engine. The "Shaders", "Particle Containers", and "Behaviours" groups are empty by default as they only contain components you added to the project before.
+[[File:Object component.png|thumb|250px|The image shows a component added to a scene object – but it works similarly for interface buttons]]
 ==== Internal Components ====
-* <span class="inlinecode">Transform: </span> This component lets you displace, scale, and rotate the respective button. However, only images and animations attached to that button are affected, the object area is not. There is no convenient way to change these settings at runtime, although you can always transform objects/buttons through a script. If you create images and animations at the right dimensions and orientation in the first place – which is recommended – you'll probably rarely use this component.
+* <span class="inlinecode">Transform: </span> This component lets you displace, scale, and rotate the respective button. However, only images and animations attached to that button are affected, the object area is not. Note that the transform center is the top left corner of the interface, and rotation is defined in radian instead of degrees. There is no convenient way to change these settings at runtime, although you can always transform objects/buttons through a script. If you create images and animations at the right dimensions and orientation in the first place – which is recommended – you'll probably rarely use this component.
 * <span class="inlinecode">Text: </span> See the [[Text#Component text|Text]] page for more on the text component.
 * <span class="inlinecode">Movie: </span> This component lets you add movies to your interface. Unlike videos started through the [[Action_Parts#Play_video|Play video]] action part, which always take up the entire screen, component videos are added to the interface just like animations. Disabling the button will hide the video, too; enabling the button will display and restart the video (from the beginning). There is no convenient way to stop/pause/continue a video at runtime.

@@ Line 211: / Line 211: @@
 == Components ==
 === Interface components ===
@@ Line 221: / Line 224: @@
 === Button components ===
-<abbr title="to be done">tbd</abbr>
+Click the <span class="inlinecode">[+]</span> icon on the "Components" tab of a button to add a component to this button. You'll get a list of available components split into four groups: "Internal Components" are directly built into the engine. The "Shaders", "Particle Containers", and "Behaviours" groups are empty by default as they only contain components you added to the project before.
 {{toc}}

@@ Line 212: / Line 212: @@
 == Components ==
-On the "Components" tab you can add custom behaviours to your interface. Click the <span class="inlinecode">[+]</span> icon to get a list of the interface behaviours you created before and select one.
+=== Interface components ===
 Custom behaviours override the default behaviours of Visionaire, thus allowing for advanced modification and customization of the whole system. This even enables you to develop other types of games than point-and-click adventures. Behaviours are created using the [[Ilios]] scripting language.
 {{toc}}

← Older revision		Revision as of 16:48, 28 February 2023
Line 1:		Line 1:
	[[File:interface25n.png\|right\|25px\|link=]]		[[File:interface25n.png\|right\|25px\|link=]]
−	Interfaces act – as their name suggests – as the the user interface(s) of your game. They overlay scenes/objects and can be shown and hidden at any time or may even be completely invisible. Their two main functions are providing the game's commands (e. g. "Look", "Take", "Use" etc.) and serving as an inventory which holds a ~~characer~~'s items. You can use interfaces to do other things as well though; it is even possible to create puzzles on interfaces.	+	Interfaces act – as their name suggests – as the the user interface(s) of your game. They overlay scenes/objects and can be shown and hidden at any time or may even be completely invisible. Their two main functions are providing the game's commands (e. g. "Look", "Take", "Use" etc.) and serving as an inventory which holds a character's items. You can use interfaces to do other things as well though; it is even possible to create puzzles on interfaces.

@@ Line 24: / Line 24: @@
 # '''Active interfaces:''' Only active interfaces can be used in the game. An interface is active, if it is assigned to the currently playable character. If your game has multiple playable characters, all these characters may use the same interface(s) as you can assign an interface to more than one character. That does not apply to the inventory items though; these are assigned directly to a character, not to an interface.
 # '''Interface classes:''' Each interface belongs to a particular class. Only one interface per class can be active at the same time. By default, five classes are available, which will suffice in most cases – it is possible to add more classes though (see [[#Interface classes|"Interface classes"]]).
-# '''Initial assignment:''' You can assign interfaces to a character on the character's "Interfaces" tab. Only these assigned interfaces are active when starting the game. Remember that only one interface per class can be active, so it makes sense to only assign one interface per class to a character.
+# '''Initial assignment:''' You can assign interfaces to a character on the [[Characters|character's "Interfaces" tab]]. Only these assigned interfaces are active when starting the game. Remember that only one interface per class can be active, so it makes sense to only assign one interface per class to a character.
 # '''Character assignment during the game:''' Use the action part [[Action_Parts#Set_interface_of_a_character|"Set interface of a character"]] to assign an interface to a character during the game (= make it an active interface). A previously active interface of the same class will become inactive.
 # '''Active vs. shown vs. visible:''' An interface being active does not necessarily mean it's shown/visible. The type B "coin interface" in the image above, for example, is usually active so the user can use it anytime. But it gets constantly shown and hidden – "hidden" means, it is currently not displayed although still active. The same goes for an inventory which only gets displayed, if the user clicks or hovers somewhere. You control the display state via the action part [[Action_Parts#Show.2FHide_interface|"Show/Hide interface"]]. The action part [[Action_Parts#Set_interface_visibility|"Set interface visibilty"]] on the other hand only controls the opacity of an interface through a percentage value. An active interface at 0% visibility would be invisible but still displayed and thus accessible for interaction – as long as it is not hidden. On game start all active interfaces are shown at 100% visibility by default.
@@ Line 212: / Line 212: @@
 == Components ==
-tbd
+See the [[Components]] page for more on this.
 {{toc}}

@@ Line 23: / Line 23: @@
 # '''Active interfaces:''' Only active interfaces can be used in the game. An interface is active, if it is assigned to the currently playable character. If your game has multiple playable characters, all these characters may use the same interface(s) as you can assign an interface to more than one character. That does not apply to the inventory items though; these are assigned directly to a character, not to an interface.
-# '''Interface classes:''' Each interface belongs to a particular class. Only one interface per class can be active at the same time. By default, five classes are available, which will suffice in most cases – it is possible to add more classes though (see [[#Edit interface classes|"Edit interface classes"]]).
+# '''Interface classes:''' Each interface belongs to a particular class. Only one interface per class can be active at the same time. By default, five classes are available, which will suffice in most cases – it is possible to add more classes though (see [[#Interface classes|"Interface classes"]]).
 # '''Initial assignment:''' You can assign interfaces to a character on the character's "Interfaces" tab. Only these assigned interfaces are active when starting the game. Remember that only one interface per class can be active, so it makes sense to only assign one interface per class to a character.
 # '''Character assignment during the game:''' Use the action part [[Action_Parts#Set_interface_of_a_character|"Set interface of a character"]] to assign an interface to a character during the game (= make it an active interface). A previously active interface of the same class will become inactive.
@@ Line 35: / Line 35: @@
-=== Edit interface classes ===
+=== Interface classes ===
 Five interface classes are available by default: "Main interface", "Inventory", "Secondary interface", "Options interface", and "Miscellaneous". Don't care too much about their names, because they don't have any real meaning. It's just what you would usually find in an adventure game. The classes could as well be called "Class 1", "Class 2" etc. with no difference in function.

← Older revision		Revision as of 17:30, 4 February 2023
Line 1:		Line 1:
		+	[[File:interface25n.png\|right\|25px\|link=]]
	Interfaces act – as their name suggests – as the the user interface(s) of your game. They overlay scenes/objects and can be shown and hidden at any time or may even be completely invisible. Their two main functions are providing the game's commands (e. g. "Look", "Take", "Use" etc.) and serving as an inventory which holds a characer's items. You can use interfaces to do other things as well though; it is even possible to create puzzles on interfaces.		Interfaces act – as their name suggests – as the the user interface(s) of your game. They overlay scenes/objects and can be shown and hidden at any time or may even be completely invisible. Their two main functions are providing the game's commands (e. g. "Look", "Take", "Use" etc.) and serving as an inventory which holds a characer's items. You can use interfaces to do other things as well though; it is even possible to create puzzles on interfaces.