Skip to content

tes3clothing⚓︎

A clothing game object.

This type inherits the following: tes3item, tes3physicalObject, tes3object, tes3baseObject.

Properties⚓︎

blocked⚓︎

The blocked state of the object.

Returns:

  • result (boolean)

boundingBox⚓︎

The bounding box for the object.

Returns:

deleted⚓︎

Read-only. The deleted state of the object.

Returns:

  • result (boolean)

disabled⚓︎

Read-only. The disabled state of the object.

Returns:

  • result (boolean)

enchantCapacity⚓︎

The object's enchantment capacity.

Returns:

  • result (number)

enchantment⚓︎

The enchantment used by the object.

Returns:

icon⚓︎

The path to the object's icon. Relative to Data Files\\icons\\.

Returns:

  • result (string)

id⚓︎

Read-only. The unique identifier for the object.

Returns:

  • result (string)

isCarriable⚓︎

Read-only. If true, the item can be carried and interacted with normally in an inventory. While this is false for certain lights, they can still sometimes appear in an inventory, but cannot be interacted with.

Returns:

  • result (boolean)

isLeftPart⚓︎

Determines if the armor is the left part of a pair.

Returns:

  • result (boolean)

isLocationMarker⚓︎

True if this object is an editor marker for a gameplay location. These include travel, intervention, prison, door, and interior north markers. Markers are invisible in-game.

Returns:

  • result (boolean)

isUsableByBeasts⚓︎

Read-only. If this property is true, beast races can wear this clothing item. This property is false for any kind of clothing that covers feet.

Returns:

  • result (boolean)

mesh⚓︎

The path to the object's mesh. Relative to Data Files\\meshes\\.

Returns:

  • result (string)

modified⚓︎

The modification state of the object since the last save.

Returns:

  • result (boolean)

name⚓︎

The player-facing name for the object.

Returns:

  • result (string)

nextInCollection⚓︎

The next object in parent collection's list.

Returns:

objectFlags⚓︎

Read-only. The raw flags of the object.

Returns:

  • result (number)

objectType⚓︎

Read-only. The type of object. Maps to values in tes3.objectType.

Returns:

owningCollection⚓︎

The collection responsible for holding this object.

Returns:

parts⚓︎

An array-style table of the tes3wearablePart data on the object.

Returns:

persistent⚓︎

The persistent flag of the object.

Returns:

  • result (boolean)

previousInCollection⚓︎

The previous object in parent collection's list.

Returns:

promptsEquipmentReevaluation⚓︎

Read-only. If true, the item should prompt equipment reevaluated when added to the actor's inventory. Thus is true for armor, clothing, and weapons.

Returns:

  • result (boolean)

scale⚓︎

The object's scale. The value range is (0, 10).

Returns:

  • result (number)

sceneCollisionRoot⚓︎

The scene graph node for this object's physics collision, if its mesh has a root collision node.

Returns:

sceneNode⚓︎

The scene graph node for this object.

Returns:

script⚓︎

The script that runs on the object.

Returns:

slot⚓︎

The slot used by the clothing object. Maps to values in tes3.clothingSlot namespace.

Returns:

slotName⚓︎

The name of the slot used by the clothing object.

Returns:

  • result (string)

sourceless⚓︎

The sourceless flag of the object.

Returns:

  • result (boolean)

sourceMod⚓︎

Read-only. The filename (including the extension) of the mod that owns this object. It has nil value if the object was anything other than loaded from an ESP or ESM file.

Returns:

  • result (string)

stolenList⚓︎

Read-only. A non-mutable list of all actors that the item has been stolen from.

Returns:

supportsActivate⚓︎

If true, the object supports activation. This includes all the items (excluding non-carriable lights), actors outside combat, activators, containers and doors.

However, the activation of such an object may still be blocked via mwscript or a Lua script.

Returns:

  • result (boolean)

supportsLuaData⚓︎

If true, references of this object can store temporary or persistent lua data.

Returns:

  • result (boolean)

value⚓︎

The value of the object. For this object type, its maximum value is 65535. Larger numbers will overflow.

Returns:

  • result (number)

weight⚓︎

The weight of the object.

Returns:

  • result (number)

Methods⚓︎

__tojson⚓︎

Serializes the object to json.

local string = myObject:__tojson()

Returns:

  • string (string)

createCopy⚓︎

Creates a copy of this object.

local newObject = myObject:createCopy({ id = ..., addToObjectList = ..., sourceless = ... })

Parameters:

  • params (table)
    • id (string): Optional. The new object's ID. If one is not provided, a randomly generated one will be used.
    • addToObjectList (boolean): Default: true. If true, the object will be added to the data handler. If this is false, the new object may not have a randomly generated ID. Do not use this without knowing the implications.
    • sourceless (boolean): Default: false. If true, the object will be made sourceless, and will not be serialized to the save game. If the object is copied outside of a save game, the object will always be sourceless.

Returns:

setupBodyParts⚓︎

Updates a body part manager for this piece of equipment, setting up all the necessary nodes for each layer.

myObject:setupBodyParts(bodyPartManager, isFemale, isFirstPerson)

Parameters: