Skip to content

tes3soundGenerator⚓︎

A sound generator object created in the TES3 CS

This type inherits the following: tes3baseObject.

Properties⚓︎

blocked⚓︎

The blocked state of the object.

Returns:

  • result (boolean)

creature⚓︎

The base creature for this soundgen, which serves as a lookup index. Note that creatures can reference the soundgen of any other creature through the tes3creature.soundCreature property, which is generally used for variants of a creature.

When this is nil, the sound is treated as a generic fallback for this soundGen type, which is played when there is no creature match.

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)

id⚓︎

Read-only. The unique identifier for the object.

Returns:

  • result (string)

modified⚓︎

The modification state of the object since the last save.

Returns:

  • result (boolean)

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:

persistent⚓︎

The persistent flag of the object.

Returns:

  • result (boolean)

sound⚓︎

Sound object tied to this sound generator.

Returns:

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)

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)

type⚓︎

Maps to tes3.soundGenType constants.

Returns:

Methods⚓︎

__tojson⚓︎

Serializes the object to json.

local result = myObject:__tojson()

Returns:

  • result (string)