Scripting - Revision history

EK at 11:54, 16 January 2024

2024-01-16T11:54:17Z

2023-10-20T10:56:55Z

2023-08-12T12:02:49Z

2023-08-10T11:16:46Z

2023-08-10T10:37:06Z

2022-10-09T20:10:16Z

2018-10-27T22:58:17Z

2015-02-18T23:27:02Z

2015-02-18T23:18:14Z

2015-01-22T13:49:40Z

@@ Line 249: / Line 249: @@
 Scripts are generally added in the "Scripts" section of the editor. Each script has to be declared a <span class="inlinecode">Definition script</span> or an <span class="inlinecode">Execution script</span> by (un)checking the option above the script editor (see image). A definition script is automatically run at game start, while an execution script has to be explicitly called.
-In your actions you can make use of scripts by using the [[Action_Parts#Call_script|Call script]] and the [[Action_Parts#Execute_a_script|Execute a script]] action parts, with the first one allowing you to select from your list of execution scripts and the second one expecting Lua code. You can use the [[Action_Parts#If_Lua_result|If Lua result]] action part to build an "if…else" query using Lua code.
+In your actions you can make use of scripts by using the [[Action_Parts#Call_script|Call script]] and the [[Action_Parts#Execute_a_script|Execute a script]] action parts, with the first one allowing you to select from your list of execution scripts and the second one expecting Lua code. You can use the [[Action_Parts#If_Lua_result|If Lua result]] action part to build an "if…else" query using Lua code. Besides that, a Lua query can also be part of a [[Conditions_and_Values#Conditions|Combined condition]].
 {{toc}}

@@ Line 244: / Line 244: @@
-== Commands ==
+== Add a script ==
-The following methods and fields are available:
+[[File:Script.png|thumb|250px|Scripts section]]
-* [[Global Commands]]
+Scripts are generally added in the "Scripts" section of the editor. Each script has to be declared a <span class="inlinecode">Definition script</span> or an <span class="inlinecode">Execution script</span> by (un)checking the option above the script editor (see image). A definition script is automatically run at game start, while an execution script has to be explicitly called.
+In your actions you can make use of scripts by using the [[Action_Parts#Call_script|Call script]] and the [[Action_Parts#Execute_a_script|Execute a script]] action parts, with the first one allowing you to select from your list of execution scripts and the second one expecting Lua code. You can use the [[Action_Parts#If_Lua_result|If Lua result]] action part to build an "if…else" query using Lua code.
 {{toc}}

@@ Line 92: / Line 92: @@
 === Common VisionaireObject fields ===
-The following fields are available for all VisionaireObjects. They are read-only:
+The following fields are available for all VisionaireObjects. They are read-only (except "name" which can be written with the "setName" method):
 * <span class="inlinecode">id:</span> The internal id of the object (integer).
 * <span class="inlinecode">name:</span> The internal name of the object as defined in the editor (string). Not to be confused with the "Name" property (with capitalized "N") which is available for some objects and contains the multi-language object name used in the game.

← Older revision		Revision as of 11:16, 10 August 2023
Line 21:		Line 21:
	Each Visionaire project is saved in a hierarchical [[Data_Structure\|data structure]]. Every instance of an object of that data structure is a "VisionaireObject" (TVisObj). All objects of the same type (e. g. scene or button) are stored in one table (called e. g. "Scenes" or "Buttons").		Each Visionaire project is saved in a hierarchical [[Data_Structure\|data structure]]. Every instance of an object of that data structure is a "VisionaireObject" (TVisObj). All objects of the same type (e. g. scene or button) are stored in one table (called e. g. "Scenes" or "Buttons").

−	The properties of an object can be accessed by defined fields for the specific table. These fields can contain single values (e. g. integers, strings) or tables of values as well as other VisionaireObjects or tables of VisionaireObjects. All objects and their fields are documented on the [[Data_Structure\|data structure]] page. The different [[#Field types\|field types]] are listed below.	+	The properties of an object can be accessed by defined fields for the specific table. These fields can contain single values (e. g. integers, strings) or tables of values as well as links to other VisionaireObjects or tables of links to VisionaireObjects. All objects and their fields are documented on the [[Data_Structure\|data structure]] page. The different [[#Field types\|field types]] are listed below.

@@ Line 145: / Line 145: @@
 === getFloat ===
 Returns a float (decimal) value.
-<syntaxhighlight>getFloat(number)</syntaxhighlight>
+<syntaxhighlight lang="lua">getFloat(number)</syntaxhighlight>
@@ Line 160: / Line 160: @@
 ==== Example(s) ====
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 getObject("Game.GameCurrentCharacter"):getFloat(VCharacterSize)
 </syntaxhighlight>

← Older revision		Revision as of 23:27, 18 February 2015
Line 139:		Line 139:

	==== Example(s) ====		==== Example(s) ====
−	<syntaxhighlight>~~local allowSkipText =~~ game:getBool(VGameAlwaysAllowSkipText)</syntaxhighlight>	+	<syntaxhighlight>
		+	print( game:getBool(VGameAlwaysAllowSkipText) ) -- print current boolean value of VGameAlwaysAllowSkipText to the log
		+	game:setValue(VGameAlwaysAllowSkipText, true) -- set VGameAlwaysAllowSkipText to true
		+	</syntaxhighlight>

@@ Line 1: / Line 1: @@
-Visionaire Studio comes with its own scripting language, which consists of, a combination of: Lua script (http://www.lua.org) and a Visionaire Object Model. The object model is used to access the Visionaire [[Data_Structure|data structure]] in a convenient way. Almost every instance in Visionaire is represented as an object (e.g. scene, character, interface, ...), all of which can be manipulated through the scripting language.
+Visionaire Studio comes with its own scripting language, which consists of, a combination of: Lua script (http://www.lua.org) and a Visionaire Object Model. The object model is used to access the Visionaire [[Data_Structure|data structure]] in a convenient way. Almost every instance in Visionaire is represented as an object (e.g. scene, character, interface, ...), all of which can be accessed / manipulated through the scripting language.
 ----
 Online documentation about the Lua scripting Language:

@@ Line 666: / Line 666: @@
 === isAnyObject ===
+Returns a boolean value of <span class="green">true</span> ''or'' <span class="red">false</span>,  depending on whether or not VisionaireObject is returned???? (not actually sure about this one - never used it before).
 Lua Syntax:
 <syntaxhighlight>isAnyObject()</syntaxhighlight>