ObjName (CMS) - Revision history

AFRLme at 16:34, 23 August 2022

2022-08-23T16:34:23Z

AFRLme at 16:32, 23 August 2022

2022-08-23T16:32:50Z

AFRLme at 16:32, 23 August 2022

2022-08-23T16:32:19Z

AFRLme at 16:31, 23 August 2022

2022-08-23T16:31:59Z

AFRLme at 12:30, 22 October 2017

2017-10-22T12:30:18Z

AFRLme at 12:28, 22 October 2017

2017-10-22T12:28:27Z

AFRLme at 12:28, 22 October 2017

2017-10-22T12:28:15Z

AFRLme: Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | objName(obj) || Definition || Sebas..."

2017-10-22T12:26:21Z

Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By |- | objName(obj) || Definition || Sebas..."

New page

{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left" | By
|-
| objName(obj) || Definition || Sebastian
|}

This small function allows you to return the action text name of the specified object; returns name based on current active language.

== Instructions ==
1. Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
2. To use this function you should create an ''execute a script'' action containing...
<syntaxhighlight>
objName(game.CurrentScene.SceneObjects["example"]) -- return name of a specified object
</syntaxhighlight>
''or...''
<syntaxhighlight>
objName(game.CurrentObject) -- return name of object currently underneath the cursor
</syntaxhighlight>

== Main Script ==
<syntaxhighlight>
-- * returns the objects, buttons or characters name * --
function objName(obj)
local table = obj:getId().tableId
if table == eObjects then
return obj:getTextStr(VObjectName)
elseif table == eCharacters then
return obj:getTextStr(VCharacterName)
elseif table == eButtons then
return obj:getTextStr(VButtonName)
end
end
</syntaxhighlight>

== Syntax Breakdown ==
{| class="ts" style="width:100%"
|-
! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
|-
| obj || "string" ''or'' link || This should be a "string" or link value containing the object you want to return the name for. The object can be a scene object, a character, an item, an interface button, etc.
|}

@@ Line 39: / Line 39: @@
 function objName(obj)
    local t = obj:getId().tableId -- store table ID belonging to the linked visOBJ
-   if table == eObjects then -- check if scene object or item
+  -- + --
      return obj:getTextStr(VObjectName) -- return object/item name
-   elseif table == eCharacters then  -- check if character
+   elseif t == eCharacters then -- check if character
      return obj:getTextStr(VCharacterName) -- return character name
-   elseif table == eButtons then -- check if interface button
+   elseif t == eButtons then -- check if interface button
      return obj:getTextStr(VButtonName) -- return interface button name
    end

@@ Line 6: / Line 6: @@
 |}
-This small function allows you to return the action text name of the specified Visionaire Studio Object (visOBJ).
+This small function allows you to quickly return the action text name of the linked Visionaire Studio Object (visOBJ).
 <hr>
 {| class="ts"

@@ Line 6: / Line 6: @@
 |}
-This small function allows you to return the action text name of the specified Visionaire Studio Object (visOBJ), which could be a scene object, a character, or an interface button.
+This small function allows you to return the action text name of the specified Visionaire Studio Object (visOBJ).
 <hr>
 {| class="ts"

@@ Line 39: / Line 39: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
 |-
-| obj || link || This should be a link to the object you want to return the name for. The object can be a scene object, a character, an item or an interface button, etc.
+| obj || link || This should be a link to the object you want to return the name for. The object can be a scene object, a character, an item or an interface button.
 |}{{toc}}

@@ Line 40: / Line 40: @@
 |-
 | obj || link || This should be a link to the object you want to return the name for. The object can be a scene object, a character, an item or an interface button, etc.
-|}
+|}{{toc}}

@@ Line 6: / Line 6: @@
 |}
-This small function allows you to return the action text name of the specified object; returns name based on current active language.
+This small function allows you to return the action text name of the specified Visionaire Studio Object (visOBJ), which could be a scene object, a character, or an interface button.
 == Instructions ==
 . Add the [[#Main_Script|main script]] to the Visionaire Studio Script Editor & set the script as a definition script.<br/>
-. To use this function you should create an ''execute a script'' action containing...
+a. Usage Example #1: return name belonging to a scene object belonging to the current scene.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-objName(game.CurrentScene.SceneObjects["example"]) -- return name of a specified object
+objName(game.CurrentScene.SceneObjects["object_name"])
 </syntaxhighlight>
-''or...''
+d. Usage Example #4: return name belonging to an interface button.
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-objName(game.CurrentObject) -- return name of object currently underneath the cursor
+objName(Interfaces["interface_name"].Buttons["button_name"])
 </syntaxhighlight>
 == Main Script ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
 function objName(obj)
-   local table = obj:getId().tableId
+   local t = obj:getId().tableId -- store table ID belonging to the linked visOBJ
-   if table == eObjects then
+   if table == eObjects then -- check if scene object or item
-     return obj:getTextStr(VObjectName)
+     return obj:getTextStr(VObjectName) -- return object/item name
-   elseif table == eCharacters then
+   elseif table == eCharacters then  -- check if character
-     return obj:getTextStr(VCharacterName)
+     return obj:getTextStr(VCharacterName) -- return character name
-   elseif table == eButtons then
+   elseif table == eButtons then -- check if interface button
-     return obj:getTextStr(VButtonName)
+     return obj:getTextStr(VButtonName) -- return interface button name
    end
 end
 </syntaxhighlight>
 == Syntax Breakdown ==
@@ Line 39: / Line 55: @@
 ! style="text-align:left" | Name !! style="text-align:left" | Type !! style="text-align:left;width:80%" | Description
 |-
-| obj || link || This should be a link to the object you want to return the name for. The object can be a scene object, a character, an item or an interface button.
+| obj || link || This should be a link to the visOBJ you want to return the name for. The object can be a scene object, a character, an item, or an interface button.
 |}{{toc}}