Skip to content

tes3region⚓︎

A structure that contains region information.

This type inherits the following: tes3baseObject

Properties⚓︎

blocked⚓︎

The blocked state of the object.

Returns:

  • result (boolean)

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)

name⚓︎

The region's name. It must be a string less than 32 characters long.

Returns:

  • result (string)

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)

sleepCreature⚓︎

Read-only. The region's leveled creature that can be spawned while the player is sleeping.

Returns:

sounds⚓︎

Read-only. Array-style table for the different region sounds. Each object in the table is a tes3regionSound.

Returns:

sourceless⚓︎

The soruceless 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)

supportsLuaData⚓︎

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

Returns:

  • result (boolean)

weather⚓︎

The region's current weather.

Returns:

weatherChanceAsh⚓︎

The chance the Ash weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceBlight⚓︎

The chance the Blight weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceBlizzard⚓︎

The chance the Blizzard weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceClear⚓︎

The chance the Clear weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceCloudy⚓︎

The chance the Cloudy weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceFoggy⚓︎

The chance the Foggy weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceOvercast⚓︎

The chance the Overcast weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceRain⚓︎

The chance the Rain weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChances⚓︎

Read-only. Array-style table for the different weather chances. Each object in the table is a number, between 1 - 100. The index of the table is the weather type.

Returns:

  • result (number[])

weatherChanceSnow⚓︎

The chance the Snow weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

weatherChanceThunder⚓︎

The chance the Thunder weather-type will be used. Must be an integer between 0 and 100.

Returns:

  • result (integer)

Methods⚓︎

__tojson⚓︎

Serializes the object to json.

local string = myObject:__tojson()

Returns:

  • string (string)

changeWeather⚓︎

Changes the current weather for the region to the provided weather-type parameter.

myObject:changeWeather(weatherId)

Parameters:

randomizeWeather⚓︎

Changes the weather to a random weather type.

myObject:randomizeWeather()

Parameters: