VisionaireObject Command: getLinks - Revision history

EK at 15:32, 25 August 2023

2023-08-25T15:32:06Z

EK: EK moved page GetLinks (CMS) to VisionaireObject Command: getLinks

2023-08-25T15:17:18Z

EK moved page GetLinks (CMS) to VisionaireObject Command: getLinks

EK at 15:16, 25 August 2023

2023-08-25T15:16:55Z

David Stoffel at 15:26, 22 March 2014

2014-03-22T15:26:16Z

AFRLme at 14:50, 21 March 2014

2014-03-21T14:50:11Z

AFRLme at 17:24, 19 March 2014

2014-03-19T17:24:05Z

AFRLme at 17:21, 19 March 2014

2014-03-19T17:21:57Z

AFRLme at 17:17, 19 March 2014

2014-03-19T17:17:21Z

AFRLme at 17:16, 19 March 2014

2014-03-19T17:16:12Z

AFRLme: Created page with "
Command History

Available since ..."

2014-03-19T17:05:19Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Command History</span> <div class="mw-collapsible-content"> <div class="alt-bg">Available since ..."

New page

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

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

<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Additional Info</span>
<div class="mw-collapsible-content">
<div class="alt-bg">''!important'': The object names are case sensitive.</div>
<div>The data has to be iterated before you can access it.</div>
</div></div>

Syntax:
<syntaxhighlight>
getLinks(t_links)
</syntaxhighlight>

Example 1: using getLinks as initial function.
<syntaxhighlight>
local lang = game:getLinks(VGameLanguages) -- store all available game languages

-- * iterate the data * --
for i = 1, table.maxn(lang) do -- for i = 1 to amount of entries in lang table do...
print(lang[i]:getId().id .. ": " .. lang[i]:getName()) -- prints "language id: language name"
end
</syntaxhighlight>

Example 2: using getLinks after other functions
<syntaxhighlight>
local obj = getLink(VGameCurrentObject):getLinks(VObjectActions) -- get current item underneath the cursor & all actions associated with it...

-- * iterate the data * --
for i = 1, table.maxn(obj) do -- for i = 1 to amount of entries in obj table do...
print(i .. ": " .. obj[i]:getName()) -- prints "incremental value: action name"
end
</syntaxhighlight>

<span class="bold underline">Arguments</span>

'''t_links''': text <br/>
The name of the grouped data structure object table.

<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.

{{i18n|GetLink_(CMS)}}

@@ Line 30: / Line 30: @@
 ! Description
 |-
-| table of t_links
+| table
-| The table of VisionaireObjects linked in the field
+| The table of VisionaireObjects (t_link values) linked in the field
 |}

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+Returns a table containing multiple VisionaireObjects.
-Allows you to access, read & manipulate grouped data tables for objects, items, characters, conditions, & values etc...
+== Syntax ==
+<syntaxhighlight lang="lua">
+getLinks(field)
 </syntaxhighlight>
-Example 1: using getLinks as initial function.
+== Parameters ==
--- * iterate the data * --
+{| class="ts"
-for i = 1, table.maxn(lang) do -- for i = 1 to amount of entries in lang table do...
+|-
- print(lang[i]:getId().id .. ": " .. lang[i]:getName()) -- prints "language id: language name"
+! style="width:15%" | Parameter
-end
+! style="width:15%" | Type
-</syntaxhighlight>
+! Description
-if not obj:isEmpty() then -- if obj is not empty do...
+== Return values ==
-'''t_links''': text <br/>
+== Examples ==
-<span class="bold underline">Flags</span>
+-- Iterate the table and print the language ids and names
-none
+-- The shorthand notation offers a more convenient way to achieve the same
+for i = 1, #lang do
-<span class="bold underline">Return</span>
+  print(lang[i].id .. ": " .. lang[i].name)
+end
-'''object''' <br/>
+</syntaxhighlight>
-Returns the data from the linked objects table; or returns empty.
+{{toc}}

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

← Older revision		Revision as of 17:16, 19 March 2014
Line 60:		Line 60:
	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)}}	+	{{i18n\|GetLinks_(CMS)}}

← Older revision	Revision as of 15:17, 25 August 2023
(No difference)

@@ 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 34: / Line 34: @@
 Example 2: using getLinks after other functions
 <syntaxhighlight>
-local obj = getLink(VGameCurrentObject)
+local obj = game:getLink(VGameCurrentObject)
 if not obj:isEmpty() then -- if obj is not empty do...

@@ Line 12: / Line 12: @@
 <span class="bold">Additional Info</span>
 <div class="mw-collapsible-content">
-<div class="alt-bg">''!important'': The object names are case sensitive.</div>
+<div class="alt-bg">The data has to be iterated before you can access it.</div>
 </div></div>