Editing WildStar:API types

__NOWYSIWYG__{{\|uiapitype}}

This is the main WildStar API 'value type' reference. The [[\UI API]] uses rather complex values using Lua native types for some of its parameters and return values. Rather than re-explain them every time they're used. This reference provides list of 'distinct' Lua based data types used in WildStar. See also [[\API events]].

== Reference ==
<onlyinclude><div class="ApiList"><!-- do not remove this line
-->
=== Simple types ===
:{{\|id|API TYPE|nil}} - the Lua 'nil' type. a type, or variable state, which has no value
:{{\|id|API TYPE|boolean}} - a Lua 'boolean' type, which holds Lua 'false' or 'true' values     
:{{\|id|API TYPE|number}} - a regular Lua number, which for WS is a 'double' size floating point number
:{{\|id|API TYPE|string}} - a regular Lua string, always 1 byte per char. WS utf-8 encodes non-ASCII chars
:{{\|id|API TYPE|function}} - a regular Lua function, which any variable can reference.
:{{\|id|API TYPE|table}} - a regular Lua table, which any variable can reference.
:{{\|id|API TYPE|userdata}} - a regular Lua userdata, which any variable can reference.

=== Complex types ===
:{{\|id|API TYPE|bagId}} - Numbers representing bags you carry, bank bags, bank window, etc
:{{\|id|API TYPE|itemString}} - A structured string holds item data, like Created by, itemId, ...
:{{\|id|API TYPE|itemLink}} - A string that is clickable if shown in-game, contains an itemString.
:{{\|id|API TYPE|itemType}} - String classification of an item, ["Armor", "Consumable", ...]
:{{\|id|API TYPE|unitId}} - An identifier that specifies a unit or unit type ["target", "party1", ...]
:{{\|id|API TYPE|auctionItem}} - A structured table containing information about a particular item on the Auction House, [BuyoutPrice, CurrentBid, etc]

=== Data types ===
:{{\|id|API TYPE|Unit}} [userdata] - target-able unit data. prefixed unit, unitPlayer, unitTarget
:{{\|id|API TYPE|Money}} [userdata] - currency data
:{{\|id|API TYPE|Quest}} [userdata] - quest data
:{{\|id|API TYPE|Item}} [userdata] - Item data
:{{\|id|API TYPE|Ability}} [userdata] - Player Ability Information

=== Module types ===
:{{\|id|API TYPE|Addon}} - actual AddOn instance type. see [[\UI AddOn]].
:{{\|id|API TYPE|Package}} - actual library AddOn instance type. see [[\UI AddOn]].
</div></onlyinclude><!-- do not remove this line -->

== See also ==
* [[\API events]]