Difference between revisions of "Api.groups"

From Light Forge Wiki
Jump to: navigation, search
(Created page with " =Methods= ==getAttribute== getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer Returns the value for a specified attribute on a specified group ...")
 
(getAttribute)
Line 4: Line 4:
 
==getAttribute==
 
==getAttribute==
  
getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer
+
'''getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer'''
 +
 
  
 
Returns the value for a specified attribute on a specified group
 
Returns the value for a specified attribute on a specified group
  
 
Returns -1 if the group can't be found
 
Returns -1 if the group can't be found
 
  
 
==getName==
 
==getName==

Revision as of 18:34, 6 May 2013

Contents

Methods

getAttribute

getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer


Returns the value for a specified attribute on a specified group

Returns -1 if the group can't be found

getName

   Returns the name of the requested group
   Function getName(ByVal groupPath As String) As String

getChildCount

   Returns the number of children in a group
   Function getChildCount(ByVal groupPath As String) As Integer


setAttribute

   'sets the value of an attribute on a specified group
   Sub setAttribute(ByVal attribute As scriptingAPI.attributeTypes, ByVal value As Integer, ByVal groupPath As String)

releaseAttribute

   'release the specified attribute on a group
   Public Sub releaseAttribute(ByVal attribute As scriptingAPI.attributeTypes, ByVal groupPath As String)

releaseGroup

   'release the all attributes on a group
   Public Sub releaseGroup(ByVal attribute As scriptingAPI.attributeTypes, ByVal groupPath As String)
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox