VisionaireObject Command: getLink - Revision history

EK: EK moved page GetLink (CMS) to VisionaireObject Command: getLink

2023-08-11T22:45:05Z

2023-08-11T22:44:42Z

2014-11-03T23:51:17Z

Text replacement - "{{toc}}" to ""

2014-09-28T16:25:24Z

2014-09-28T16:25:00Z

2014-03-22T15:24:43Z

2014-03-18T20:53:18Z

2014-03-18T20:52:58Z

2014-03-18T20:51:31Z

2014-03-18T20:49:51Z

@@ Line 1: / Line 1: @@
-{| class="toccolours mw-collapsible mw-collapsed ts"
+Returns the VisionaireObject which is linked in a VisionaireObject field.
-Syntax:
+== Syntax ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-getLink(t_link)
+getLink(field)
 </syntaxhighlight>
-Example 1: using getLink as initial function.
+== Parameters ==
-Example 2: using getLink after other functions
+{| class="ts"
-<syntaxhighlight>
+|-
-game:getLink(VGameCurrentCharacter):getLink(VCharacterCurrentOutfit) -- access table of current characters active outfit
+! style="width:15%" | Parameter
-getObject("Characters[Tom]"):getLink(VCharacterCurrentOutfit) -- access active outfit table of character "Tom"
+! style="width:15%" | Type
-</syntaxhighlight>
+! Description
-<span class="bold underline">Arguments</span>
+== Return values ==
-'''t_link''': text <br/>
+{| class="ts"
-The name of the data structure object table.
+|-
-<span class="bold underline">Flags</span>
+== Examples ==
-none
+'''Example 1:''' Get the currently playable character.
+-- The shorthand notation offers a more convenient way to achieve the same
-<span class="bold underline">Return</span>
+local curr_char = game.CurrentCharacter
+</syntaxhighlight>
-'''object''' <br/>
+{{toc}}

← Older revision		Revision as of 23:51, 3 November 2014
Line 44:		Line 44:
	'''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.
−	~~{{toc}}~~

← Older revision		Revision as of 16:25, 28 September 2014
Line 44:		Line 44:
	'''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.
		+	{{toc}}

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

← Older revision		Revision as of 15:24, 22 March 2014
Line 43:		Line 43:
	'''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\|GetLink_(CMS)}}~~

← Older revision	Revision as of 22:45, 11 August 2023
(No difference)

← Older revision		Revision as of 20:53, 18 March 2014
Line 7:		Line 7:

	Allows you to access, read & manipulate the data tables for objects, items, characters, conditions, & values etc...		Allows you to access, read & manipulate the data tables for objects, items, characters, conditions, & values etc...
		+

	Syntax:		Syntax:

← Older revision		Revision as of 20:52, 18 March 2014
Line 6:		Line 6:


−	Allows you to access, read & manipulate the data tables for ~~general game~~ objects, items, characters, conditions, & values etc...	+	Allows you to access, read & manipulate the data tables for objects, items, characters, conditions, & values etc...
−
−	~~'''''* this page is a work in progress *'''''~~

	Syntax:		Syntax:

@@ Line 12: / Line 12: @@
 Syntax:
 <syntaxhighlight>
-getLink(table)
+getLink(t_link)
 </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.
+Example 1: using getLink as initial function.
 <syntaxhighlight>
--- This method is unsafe because it accesses all the condition/value tables associated with the project
+game:getLink(VGameCurrentCharacter) -- access all tables of current character
-getObject("Conditions[condition_name]") -- get a condition
+game:getLink(VGameCurrentScene) -- access all tables of current scene
 </syntaxhighlight>
-Example 2: Full getObject method.
+Example 2: using getLink after other functions
 <syntaxhighlight>
--- * scenes * --
+game:getLink(VGameCurrentCharacter):getLink(VCharacterCurrentOutfit) -- access table of current characters active outfit
 </syntaxhighlight>
 <span class="bold underline">Arguments</span>
-'''path''': "string" <br/>
+'''t_link''': text <br/>
-The path to the required data structure object.
+The name of the data structure object table.
@@ Line 66: / Line 44: @@
 Returns the data from the linked objects table; or returns empty.
-{{i18n|GetObject_(CMS)}}
+{{i18n|GetLink_(CMS)}}