Probe

Part of openmw.types

Usage:

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

Type `types`

#Probe functions

Type `Probe`

Probe.baseType	#Item
Probe.objectIsInstance(object)	Whether the object is a Probe.
Probe.record(objectOrRecordId)	Returns the read-only #ProbeRecord of a probe
Probe.records	A read-only list of all #ProbeRecords in the world database.

Type `ProbeRecord`

ProbeRecord.icon	VFS path to the icon
ProbeRecord.id	The record ID of the probe
ProbeRecord.maxCondition	The maximum number of uses of this probe
ProbeRecord.model	VFS path to the model
ProbeRecord.mwscript	MWScript on this probe (can be empty)
ProbeRecord.name	The name of the probe
ProbeRecord.quality	The quality of the probe
ProbeRecord.value
ProbeRecord.weight

Type `types`

Field(s)

#Probe types.Probe: #Probe functions

Type `Item`

Type `Probe`

Extends #Item

Probe functions

Field(s)

#Item Probe.baseType: #Item

Probe.objectIsInstance(object)

Whether the object is a Probe.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Probe.record(objectOrRecordId)

Returns the read-only #ProbeRecord of a probe

Parameter

#any objectOrRecordId :

Return value

#ProbeRecord:

#list<#ProbeRecord> Probe.records: A read-only list of all #ProbeRecords in the world database.

Type `ProbeRecord`

Field(s)

#string ProbeRecord.icon: VFS path to the icon

#string ProbeRecord.id: The record ID of the probe

#number ProbeRecord.maxCondition: The maximum number of uses of this probe

#string ProbeRecord.model: VFS path to the model

#string ProbeRecord.mwscript: MWScript on this probe (can be empty)

#string ProbeRecord.name: The name of the probe

#number ProbeRecord.quality: The quality of the probe

#number ProbeRecord.value

#number ProbeRecord.weight