VisionaireObject Command: getLink - Revision history

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

2023-08-11T22:45:05Z

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

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

EK at 22:44, 11 August 2023

2023-08-11T22:44:42Z

New page

Returns the VisionaireObject which is linked in a VisionaireObject field.

== Syntax ==
<syntaxhighlight lang="lua">
getLink(field)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| field
| integer
| The field which specifies a VisionaireObject link. The field type must be "t_link".
''Specify the field constant name (V + object table name in singular + field name) or the field id, see the example.''
|}

== Return values ==

{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| TVisObj
| The VisionaireObject linked in the field or an empty object if no object is linked
|}

== Examples ==

'''Example 1:''' Get the currently playable character.
<syntaxhighlight lang="lua">
-- Specify the field constant name or the field id
local curr_char = game:getLink(VGameCurrentCharacter)
local curr_char = game:getLink(468)

-- The shorthand notation offers a more convenient way to achieve the same
local curr_char = game.CurrentCharacter
</syntaxhighlight>
{{toc}}

AFRLme at 16:25, 28 September 2014

2014-09-28T16:25:24Z

← Older revision		Revision as of 17: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}}

AFRLme at 16:25, 28 September 2014

2014-09-28T16:25:00Z

New page

{| class="toccolours mw-collapsible mw-collapsed ts"
|-
! Function History
|-
| Available since v3.0
|}

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

Syntax:
<syntaxhighlight>
getLink(t_link)
</syntaxhighlight>

Example 1: using getLink as initial function.
<syntaxhighlight>
game:getLink(VGameCurrentCharacter) -- access all tables of current character
game:getLink(VGameCurrentScene) -- access all tables of current scene
</syntaxhighlight>

Example 2: using getLink after other functions
<syntaxhighlight>
game:getLink(VGameCurrentCharacter):getLink(VCharacterCurrentOutfit) -- access table of current characters active outfit
getObject("Characters[Tom]"):getLink(VCharacterCurrentOutfit) -- access active outfit table of character "Tom"
</syntaxhighlight>

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

'''t_link''': text <br/>
The name of the 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.

AFRLme at 20:53, 18 March 2014

2014-03-18T20:53:18Z

← Older revision		Revision as of 21: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:

AFRLme at 20:52, 18 March 2014

2014-03-18T20:52:58Z

← Older revision		Revision as of 21: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:

AFRLme at 20:51, 18 March 2014

2014-03-18T20:51:31Z

← Older revision		Revision as of 21:51, 18 March 2014
Line 25:		Line 25:
	<syntaxhighlight>		<syntaxhighlight>
	game:getLink(VGameCurrentCharacter):getLink(VCharacterCurrentOutfit) -- access table of current characters active outfit		game:getLink(VGameCurrentCharacter):getLink(VCharacterCurrentOutfit) -- access table of current characters active outfit
			getObject("Characters[Tom]"):getLink(VCharacterCurrentOutfit) -- access active outfit table of character "Tom"
	</syntaxhighlight>		</syntaxhighlight>

AFRLme at 20:49, 18 March 2014

2014-03-18T20:49:51Z

← Older revision		Revision as of 21:49, 18 March 2014
Line 12:		Line 12:
	Syntax:		Syntax:
	<syntaxhighlight>		<syntaxhighlight>
	getLink(~~table~~)		getLink(t_link)
	</syntaxhighlight>		</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>		<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
	~~getObject("Values[value_name]") -- get a value~~
	~~getObject("Actions[action_name]") -- get an action~~
	~~getObject("Animations[animation_name]") -- get an animation~~
	</syntaxhighlight>		</syntaxhighlight>

	Example 2: ~~Full getObject method.~~		Example 2: using getLink after other functions
	<syntaxhighlight>		<syntaxhighlight>
	~~-- * scenes * --~~		game:getLink(VGameCurrentCharacter):getLink(VCharacterCurrentOutfit) -- access table of current characters active outfit
	~~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>		</syntaxhighlight>



	<span class="bold underline">Arguments</span>		<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.

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


Line 66:		Line 44:
	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)}}		{{i18n\|GetLink_(CMS)}}

AFRLme: Created page with "
Command History

Available since ..."

2014-03-18T20:00:39Z

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 the data tables for general game objects, items, characters, conditions, & values etc...

'''''* this page is a work in progress *'''''

Syntax:
<syntaxhighlight>
getLink(table)
</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.

{{i18n|GetObject_(CMS)}}

VisionaireObject Command: getLink - Revision history

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

EK at 22:44, 11 August 2023

AFRLme at 16:25, 28 September 2014

AFRLme at 16:25, 28 September 2014

AFRLme at 20:53, 18 March 2014

AFRLme at 20:52, 18 March 2014

AFRLme at 20:51, 18 March 2014

AFRLme at 20:49, 18 March 2014

AFRLme: Created page with " Command History Available since ..."

AFRLme: Created page with "
Command History

Available since ..."