GetObject (CMS) - Revision history

EK: Redirected page to Global Command: getObject

2023-05-19T11:56:08Z

Redirected page to Global Command: getObject

AFRLme at 18:58, 31 August 2014

2014-08-31T18:58:27Z

David Stoffel at 15:22, 22 March 2014

2014-03-22T15:22:11Z

AFRLme at 14:49, 21 March 2014

2014-03-21T14:49:15Z

AFRLme at 18:16, 21 February 2014

2014-02-21T18:16:51Z

AFRLme at 18:12, 21 February 2014

2014-02-21T18:12:49Z

AFRLme at 17:24, 21 February 2014

2014-02-21T17:24:07Z

AFRLme at 17:17, 21 February 2014

2014-02-21T17:17:59Z

AFRLme at 17:17, 21 February 2014

2014-02-21T17:17:05Z

AFRLme at 17:10, 21 February 2014

2014-02-21T17:10:20Z

← Older revision		Revision as of 11:56, 19 May 2023
Line 1:		Line 1:
−	~~{\| class="toccolours mw-collapsible mw-collapsed ex"~~	+	#REDIRECT [[Global Command: getObject]]
−	~~! Function history~~
−	\|-
−	~~\| Available since v3.0~~
−	\|}
−
−	~~Allows you to access, read & manipulate the data tables for the linked object, item, character, condition, & value etc...~~
−
−	~~{\| class="toccolours mw-collapsible mw-collapsed ex"~~
−	~~! Additional Info~~
−	\|-
−	~~\| ''!important'': The object names are case sensitive.~~
−	\|}
−
−
−	~~Syntax:~~
−	~~<syntaxhighlight>~~
−	~~getObject("path[object, error]")~~
−	~~</syntaxhighlight>~~
−
−
−	~~Example 1: Quick getObject method; you must take care when using this method, that your project does not contain multiple objects with the same name.~~
−	~~<syntaxhighlight>~~
−	~~-- This method is unsafe because it accesses all the condition/value tables associated with the project~~
−	~~getObject("Conditions~~[~~condition_name]") -- get a condition~~
−	~~getObject("Values~~[~~value_name]") -- get a value~~
−	~~getObject("Actions[action_name]") -- get an action~~
−	~~getObject("Animations[animation_name]") -- get an animation~~
−	~~</syntaxhighlight>~~
−
−	~~Example 2~~: ~~Full getObject method.~~
−	~~<syntaxhighlight>~~
−	~~-- * scenes * --~~
−	~~getObject("Scenes[scene_name].SceneConditions[condition_name]") -- get condition linked to a scene~~
−	~~getObject("Scenes[scene_name].SceneObjects[object_name].ObjectConditions[condition_name]") -- get condition linked to a scene object~~
−	~~getObject("Scenes[scene_name].SceneValues[value_name]") -- get value linked to a scene~~
−	~~getObject("Scenes[scene_name].SceneObjects[object_name].ObjectValues[value_name]") -- get value linked to a scene object~~
−	~~getObject("Scenes[scene_name].SceneActions[action_name]") --~~
−	~~getObject("scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]") -- get animation linked to a scene object~~
−	~~-- * characters * --~~
−	~~getObject("Characters[character_name].CharacterConditions[condition_name]") -- get condition linked to a character~~
−	~~getObject("Characters[character_name].CharacterValues[value_name]") -- get value linked to a character~~
−	getObject~~("Characters[character_name~~]~~.CharacterActions[action_name~~]~~") -- get action linked to a character~~
−	~~getObject("Characters[character_name].CharacterOutfits[outfit_name].OutfitCharacterAnimations[animation_name]") -- get animation linked to a character~~
−	~~-- etc...~~
−	~~</syntaxhighlight>~~
−
−
−
−	~~<span class="bold underline">Arguments</span>~~
−
−	~~'''path''': "string" <br/>~~
−	~~The path to the required data structure object.~~
−
−	~~'''object''': text<br/>~~
−	~~Name of the object, character, condition etc; the name is case sensitive.~~
−
−	~~'''error''': bool (true/false) <br/>~~
−	~~If <span class="green">''true''</span> a warning will be printed to the log, if the linked object can not be found; it is set to <span class="green">true</span>, by default.~~
−
−
−	~~<span class="bold underline">Flags</span>~~
−
−	~~none~~
−
−
−	~~<span class="bold underline">Return</span>~~
−
−	~~'''object''' <br/>~~
−	~~Returns the data from the linked objects table; or returns empty.~~

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+{| class="toccolours mw-collapsible mw-collapsed ex"
-<span class="bold">Function History</span>
+! Function history
-<div class="mw-collapsible-content">
+|-
-<div class="alt-bg">Available since v3.0</div>
+| Available since v3.0
-</div></div>
+|}
 Allows you to access, read & manipulate the data tables for the linked object, item, character, condition, & value etc...
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+{| class="toccolours mw-collapsible mw-collapsed ex"
-<span class="bold">Additional Info</span>
+! Additional Info
-<div class="mw-collapsible-content">
+|-
-<div>''!important'': The object names are case sensitive.</div>
+| ''!important'': The object names are case sensitive.
-</div></div>
+|}

← Older revision		Revision as of 15:22, 22 March 2014
Line 70:		Line 70:
	'''object''' <br/>		'''object''' <br/>
	Returns the data from the linked objects table; or returns empty.		Returns the data from the linked objects table; or returns empty.
−
−	~~{{i18n\|GetObject_(CMS)}}~~

@@ Line 1: / Line 1: @@
 <div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<span class="bold">Command History</span>
+<span class="bold">Function History</span>
 <div class="mw-collapsible-content">
 <div class="alt-bg">Available since v3.0</div>

@@ Line 51: / Line 51: @@
 <span class="bold underline">Arguments</span>
-'''Path''': "string" <br/>
+'''path''': "string" <br/>
 The path to the required data structure object.
-'''Object''': text<br/>
+'''object''': text<br/>
 Name of the object, character, condition etc; the name is case sensitive.

@@ Line 17: / Line 17: @@
 Syntax:
 <syntaxhighlight>
-getObject("path[object]")
+getObject("path[object, error]")
 </syntaxhighlight>
@@ Line 55: / Line 55: @@
 '''Object''': text<br/>
-name of the object, character, condition etc; the name is case sensitive.
+Name of the object, character, condition etc; the name is case sensitive.
@@ Line 66: / Line 69: @@
 '''object''' <br/>
-Returns the data from the linked objects table.
+Returns the data from the linked objects table; or returns empty.
 {{i18n|GetObject_(CMS)}}

← Older revision		Revision as of 17:24, 21 February 2014
Line 6:		Line 6:


−	Allows you to ~~<span class="red">~~access~~</span>~~, read & manipulate the data tables for the linked object, item, character, condition, & value etc...	+	Allows you to access, read & manipulate the data tables for the linked object, item, character, condition, & value etc...

	<div class="toccolours mw-collapsible mw-collapsed tbl-ds">		<div class="toccolours mw-collapsible mw-collapsed tbl-ds">

← Older revision		Revision as of 17:17, 21 February 2014
Line 6:		Line 6:


−	Allows you to access, read & manipulate the data tables for the linked object, item, character, condition, & value etc...	+	Allows you to <span class="red">access</span>, read & manipulate the data tables for the linked object, item, character, condition, & value etc...

	<div class="toccolours mw-collapsible mw-collapsed tbl-ds">		<div class="toccolours mw-collapsible mw-collapsed tbl-ds">

@@ Line 40: / Line 40: @@
 getObject("scenes[scene_name].SceneObjects[object_name].ObjectAnimations[animation_name]") -- get animation linked to a scene object
 -- * characters * --
 </syntaxhighlight>
@@ Line 60: / Line 65: @@
 <span class="bold underline">Return</span>
-none
+'''object''' <br/>
 {{i18n|GetObject_(CMS)}}