Global Command: getObject - Revision history

EK at 18:43, 11 August 2023

2023-08-11T18:43:44Z

EK at 11:55, 19 May 2023

2023-05-19T11:55:37Z

EK at 11:43, 19 May 2023

2023-05-19T11:43:51Z

EK: Created page with "Get a Visionaire object. ''Note that in most cases it is no longer necessary to make use of this function, because Visionaire objects can now be accessed directly (since Visi..."

2023-05-03T21:29:08Z

Created page with "Get a Visionaire object. ''Note that in most cases it is no longer necessary to make use of this function, because Visionaire objects can now be accessed directly (since Visi..."

New page

Get a Visionaire object.

''Note that in most cases it is no longer necessary to make use of this function, because Visionaire objects can now be accessed directly (since Visionaire Studio version 5.0).''

== Syntax ==
<syntaxhighlight lang="lua">
getObject(path_or_tuple [, logWarning])
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| path_or_tuple
| string
| Path to a Visionaire Object. The path has to start with a table name, followed by the object name in square brackets ([...]). The "game" table does not have object names. Optionally a field name (field type must either be "t_link" or "t_links") can follow after a dot. For "t_links" fields you must specify an object name in square brackets ([...]). Alternatively, you can pass in a tuple with the table id and the object id, e. g. "(0,3)".
|-
| logWarning
| boolean
| If true a warning will be printed to the log file if the object could not be found. The default value is true.
|}

== Return values ==

{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| TVisObj
| The Visionaire object or an empty object if no object was found.
|}

== Examples ==

'''Example 1:''' Access a condition just by its name (name must be unique throughout the project).
<syntaxhighlight lang="lua">
local doorCond = getObject("Conditions[door_open?]")

-- Note that the same can be achieved easier with the "shorthand" notation
local doorCond = Conditions["door_open?"]
</syntaxhighlight>

'''Example 2:''' Access a condition of a specific object.
<syntaxhighlight lang="lua">
local doorCond = getObject("Scenes[office].SceneConditions[door_open?]")

-- Note that the same can be achieved easier with the "shorthand" notation
local doorCond = Scenes["office"].Conditions["door_open?"]
</syntaxhighlight>
{{toc}}

← Older revision		Revision as of 18:43, 11 August 2023
Line 1:		Line 1:
	Get a Visionaire object.		Get a Visionaire object.

−	''Note that in most cases it is no longer necessary to make use of this function, because Visionaire objects can now be accessed directly (~~since Visionaire Studio version 5.0~~).''	+	''Note that in most cases it is no longer necessary to make use of this function, because Visionaire objects can now be accessed directly ("shorthand notation").''
		+
		+	{\| class="ts"
		+	\|-
		+	\| style="width:15%" \| Related functions
		+	\| [[VisionaireObject Command: getObject\|TVisObj:getObject]]
		+	\|}

@@ Line 51: / Line 51: @@
-'''Example 2:''' Access a condition of a specific object.
+'''Example 2:''' Access a condition of a specific object by passing the full path.
 <syntaxhighlight lang="lua">
 local doorCond = getObject("Scenes[office].SceneObjects[door].ObjectConditions[door_open?]")
@@ Line 57: / Line 57: @@
 -- Note that the same can be achieved easier with the "shorthand" notation
 local doorCond = Scenes["office"].Objects["door"].Conditions["door_open?"]
 </syntaxhighlight>
 {{toc}}