Lua API
On this page

PublicWeenieDesc

Inherits from

The PublicWeenieDesc structure defines an objects game behavior.

Fields:

AmmunitionType AmmoType

missile ammunition type

Burden number

total burden of this object

CombatUse WieldType

the type of wieldable item this is

ContainerCapacity number

number of pack slots

ContainerId number

the ID of the container holding this object

Effects IconHighlight

the type of highlight (outline) applied to the objects icon

Flags number

game data flags

Header2 number

additional game data flags

HookObjectTypes HookType

what type of dwelling hook is this

HookType HookType

the types of hooks this object may be placed on (-1 for hooks)

Icon number

icon ResourceID (minus 0x06000000)

IconOverlay number

icon overlay ResourceID (minus 0x06000000)

IconUnderlay number

icon underlay ResourceID (minus 0x06000000)

ItemsCapacity number

number of item slots

Location EquipMask

the actual equipment slots this object is currently placed in

Material MaterialType

the type of material this object is made of

MaxStackSize number

the maximum number of items possible in this stack of objects

MaxUses number

the maximum number of uses possible for this item (also maximum salvage quantity)

Monarch number

this players monarch

Name string

object name

OwnerId number

the owner of this object

PluralName string

plural object name (if not specified, use name followed by s or es)

Priority CoverageMask

the parts of the body this object protects

RadarColor number

radar dot color

RadarType number

radar type

Restrictions RestrictionDB

the access control list for this dwelling object

SpellId number

the spell cast by this object

StackSize number

the number of items in this stack of objects

TargetType ObjectType

the object categories this object may be used on

Type ObjectType

object type

UseRadius number

distance a player will walk to use an object

UsesRemaining number

the number of uses remaining for this item (also salvage quantity)

ValidLocations EquipMask

the potential equipment slots this object may be placed in

Value number

object value

WeenieClassId number

object weenie class id

WielderId number

the ID of the creature equipping this object

Workmanship number

object workmanship

Methods:

GetPropertyKeys() : string[]

Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts

Returns:string[]

ToString() : string

Returns a string that represents the current object.

Returns:string