Clothing

Part of openmw.types

Usage:

local Clothing = require('openmw.types').Clothing

Type types

types.Clothing

#Clothing functions

Type Clothing

Clothing.TYPE

#ClothingTYPE

Clothing.baseType

#Item

Clothing.createRecordDraft(clothing)

Creates a #ClothingRecord without adding it to the world database.

Clothing.objectIsInstance(object)

Whether the object is a Clothing.

Clothing.record(objectOrRecordId)

Returns the read-only #ClothingRecord of a Clothing

Clothing.records

A read-only list of all #ClothingRecords in the world database.

Type ClothingRecord

ClothingRecord.enchant

The enchantment ID of this clothing (can be empty)

ClothingRecord.enchantCapacity
ClothingRecord.icon

VFS path to the icon

ClothingRecord.id

Record id

ClothingRecord.model

VFS path to the model

ClothingRecord.mwscript

MWScript on this clothing (can be empty)

ClothingRecord.name

Name of the clothing

ClothingRecord.type

See Clothing.TYPE

ClothingRecord.value
ClothingRecord.weight

Type ClothingTYPE

ClothingTYPE.Amulet
ClothingTYPE.Belt
ClothingTYPE.LGlove
ClothingTYPE.Pants
ClothingTYPE.RGlove
ClothingTYPE.Ring
ClothingTYPE.Robe
ClothingTYPE.Shirt
ClothingTYPE.Shoes
ClothingTYPE.Skirt

Type types

Field(s)

#Clothing types.Clothing

#Clothing functions

Type Clothing

Extends #Item

Clothing functions

Field(s)

#ClothingTYPE Clothing.TYPE

#ClothingTYPE

#Item Clothing.baseType

#Item

Clothing.createRecordDraft(clothing)

Creates a #ClothingRecord without adding it to the world database.

Use openmw_world#world.createRecord to add the record to the world.

Parameter

  • #ClothingRecord clothing : A Lua table with the fields of a ClothingRecord.

Return value

#ClothingRecord: A strongly typed clothing record.

Clothing.objectIsInstance(object)

Whether the object is a Clothing.

Parameter

Return value

#boolean:

Clothing.record(objectOrRecordId)

Returns the read-only #ClothingRecord of a Clothing

Parameter

  • #any objectOrRecordId :

Return value

#ClothingRecord:

#list<#ClothingRecord> Clothing.records

A read-only list of all #ClothingRecords in the world database.

Type ClothingRecord

Field(s)

#string ClothingRecord.enchant

The enchantment ID of this clothing (can be empty)

#number ClothingRecord.enchantCapacity
#string ClothingRecord.icon

VFS path to the icon

#string ClothingRecord.id

Record id

#string ClothingRecord.model

VFS path to the model

#string ClothingRecord.mwscript

MWScript on this clothing (can be empty)

#string ClothingRecord.name

Name of the clothing

#number ClothingRecord.type

See Clothing.TYPE

#number ClothingRecord.value
#number ClothingRecord.weight

Type ClothingTYPE

Clothing.TYPE

Field(s)

#number ClothingTYPE.Amulet
#number ClothingTYPE.Belt
#number ClothingTYPE.LGlove
#number ClothingTYPE.Pants
#number ClothingTYPE.RGlove
#number ClothingTYPE.Ring
#number ClothingTYPE.Robe
#number ClothingTYPE.Shirt
#number ClothingTYPE.Shoes
#number ClothingTYPE.Skirt

Type Item