VisionaireObject Command: clearLink - Revision history

EK at 19:13, 11 August 2023

2023-08-11T19:13:28Z

← Older revision		Revision as of 20:13, 11 August 2023
Line 17:		Line 17:
	\|-		\|-
	\| field		\| field
	\| ~~int~~		\| integer
	\| The object field to be cleared; has to be of "t_link" type.		\| The object field to be cleared; has to be of "t_link" type.
	''Specify the field constant name (V + object table name in singular + field name) or the field id, see the example.''		''Specify the field constant name (V + object table name in singular + field name) or the field id, see the example.''

EK at 19:08, 11 August 2023

2023-08-11T19:08:21Z

← Older revision		Revision as of 20:08, 11 August 2023
Line 32:		Line 32:
	'''Example 1:''' Clear the link to the currently used item (will remove a dragged item from the cursor).		'''Example 1:''' Clear the link to the currently used item (will remove a dragged item from the cursor).
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- Specify the field constant name		-- Specify the field constant name or the field id
	game:clearLink(VGameUsedItem)		game:clearLink(VGameUsedItem)

	~~-- Or specify the field id~~
	game:clearLink(686)		game:clearLink(686)

EK at 17:52, 11 August 2023

2023-08-11T17:52:47Z

← Older revision		Revision as of 18:52, 11 August 2023
Line 40:		Line 40:
	-- Setting an empty object leads to the same result		-- Setting an empty object leads to the same result
	game:setValue(VGameUsedItem, emptyObject)		game:setValue(VGameUsedItem, emptyObject)

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

EK: Created page with "Removes a link from the VisionaireObject. == Syntax == clearLink(field) == Parameters == {| class="ts" |- ! style="width:1..."

2023-08-11T16:47:54Z

Created page with "Removes a link from the VisionaireObject. == Syntax == <syntaxhighlight lang="lua"> clearLink(field) </syntaxhighlight> == Parameters == {| class="ts" |- ! style="width:1..."

New page

Removes a link from the VisionaireObject.

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

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| field
| int
| The object field to be cleared; has to be of "t_link" type.
''Specify the field constant name (V + object table name in singular + field name) or the field id, see the example.''
|}

== Return values ==

none

== Examples ==

'''Example 1:''' Clear the link to the currently used item (will remove a dragged item from the cursor).
<syntaxhighlight lang="lua">
-- Specify the field constant name
game:clearLink(VGameUsedItem)

-- Or specify the field id
game:clearLink(686)

-- Setting an empty object leads to the same result
game:setValue(VGameUsedItem, emptyObject)
</syntaxhighlight>
{{toc}}