Light

Part of openmw.types

Usage:

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

Type `types`

#Light functions

Type `Light`

Light.baseType	#Item
Light.objectIsInstance(object)	Whether the object is a Light.
Light.record(objectOrRecordId)	Returns the read-only #LightRecord of a Light
Light.records	A read-only list of all #LightRecords in the world database.

Type `LightRecord`

LightRecord.color
LightRecord.duration
LightRecord.icon	VFS path to the icon
LightRecord.id	Record id
LightRecord.isCarriable
LightRecord.model	VFS path to the model
LightRecord.mwscript	MWScript on this light (can be empty)
LightRecord.name	Human-readable name
LightRecord.radius
LightRecord.sound	VFS path to the sound
LightRecord.value
LightRecord.weight

Type `types`

Field(s)

#Light types.Light: #Light functions

Type `Item`

Type `Light`

Extends #Item

Light functions

Field(s)

#Item Light.baseType: #Item

Light.objectIsInstance(object)

Whether the object is a Light.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Light.record(objectOrRecordId)

Returns the read-only #LightRecord of a Light

Parameter

#any objectOrRecordId :

Return value

#LightRecord:

#list<#LightRecord> Light.records: A read-only list of all #LightRecords in the world database.

Type `LightRecord`

Field(s)

#number LightRecord.color

#number LightRecord.duration

#string LightRecord.icon: VFS path to the icon

#string LightRecord.id: Record id

#boolean LightRecord.isCarriable

#string LightRecord.model: VFS path to the model

#string LightRecord.mwscript: MWScript on this light (can be empty)

#string LightRecord.name: Human-readable name

#number LightRecord.radius

#string LightRecord.sound: VFS path to the sound

#number LightRecord.value

#number LightRecord.weight