EK at 14:41, 31 August 2023

2023-08-31T14:41:32Z

EK: Created page with "Returns the path to a media file, linked in a VisionaireObject field. == Syntax == getPath(field) == Parameters == {| clas..."

2023-08-11T19:39:15Z

Created page with "Returns the path to a media file, linked in a VisionaireObject field. == Syntax == <syntaxhighlight lang="lua"> getPath(field) </syntaxhighlight> == Parameters == {| clas..."

New page

Returns the path to a media file, linked in a VisionaireObject field.

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

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| field
| integer
| The field which specifies a path. The field type must be "t_path".
''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
|-
| string
| The file path stored in the field.
|}

== Examples ==

'''Example 1:''' Get the file path to a scene's background music.
<syntaxhighlight lang="lua">
-- Specify the field constant name or the field id
local bg_file = getObject("Scenes[kitchen]"):getPath(VSceneBackgroundMusic)
local bg_file = getObject("Scenes[kitchen]"):getPath(132)

-- The shorthand notation offers a more convenient way to achieve the same
local bg_file = Scenes["kitchen"].BackgroundMusic
</syntaxhighlight>
{{toc}}

@@ Line 31: / Line 31: @@
 |-
 | string
-| The file path stored in the field.
+| The file path stored in the field. The path will be returned in unix format ("/" for directories) and relative to the .ved file.
 |}

VisionaireObject Command: getPath - Revision history

EK at 14:41, 31 August 2023

EK: Created page with "Returns the path to a media file, linked in a VisionaireObject field. == Syntax == getPath(field) == Parameters == {| clas..."