getOwners: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Added version.)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=getOwners
|name=getOwners
|version=1.3b48
|description=Returns a string list containing the names of the owners of the [[Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter.  
|description=Returns a string list containing the names of the owners of the [[Current Token|Current Token]]. The type of the value returned depends on the delimiter parameter.  
* If the delimiter is not specified then a [[String List|string list]] is returned with the default value of {{code|","}} is used.
* If the delimiter is not specified then a [[String List|string list]] is returned with the default value of {{code|","}} is used.
Line 8: Line 9:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: names = getOwners()]
getOwners()
[h: names = getOwners(delim)]
</source>
<source lang="mtmacro" line>
getOwners(delim)
</source>
</source>
{{code|delim}} is the delimiter used to separate the values in the  [[String List|string list]] which defaults to {{code|",""}} if not specified.
{{code|delim}} is the delimiter used to separate the values in the  [[String List|string list]] which defaults to {{code|",""}} if not specified.

Revision as of 12:15, 10 March 2009

getOwners() Function

Introduced in version 1.3b48
Returns a string list containing the names of the owners of the Current Token. The type of the value returned depends on the delimiter parameter.
  • If the delimiter is not specified then a string list is returned with the default value of "," is used.
  • If the delimiter json then a json array is returned.
  • Otherwise a string list is returned with the delimiter passed in.

Usage

getOwners()
getOwners(delim)

delim is the delimiter used to separate the values in the string list which defaults to ","" if not specified.

Example

To display the owners of the current token use.
[h: names = getOwners()]
[foreach(name, names, "<br>"): name]

See Also

Version Changes

  • 1.3b49 - Added json delimiter option.