Ingredient

Part of openmw.types

Usage:

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

Type `types`

types.Ingredient

#Ingredient functions

Type `Ingredient`

Ingredient.baseType	#Item
Ingredient.objectIsInstance(object)	Whether the object is an Ingredient.
Ingredient.record(objectOrRecordId)	Returns the read-only #IngredientRecord of a Ingredient
Ingredient.records	A read-only list of all #IngredientRecords in the world database.

Type `IngredientRecord`

IngredientRecord.effects	The effects (openmw.core#MagicEffectWithParams) of the ingredient
IngredientRecord.icon	VFS path to the icon
IngredientRecord.id	Record id
IngredientRecord.model	VFS path to the model
IngredientRecord.mwscript	MWScript on this potion (can be empty)
IngredientRecord.name	Human-readable name
IngredientRecord.value
IngredientRecord.weight

Type `types`

Field(s)

#Ingredient types.Ingredient: #Ingredient functions

Type `Ingredient`

Extends #Item

Ingredient functions

Field(s)

#Item Ingredient.baseType: #Item

Ingredient.objectIsInstance(object)

Whether the object is an Ingredient.

Parameter

openmw.core#GameObject object :

Return value

#boolean:

Ingredient.record(objectOrRecordId)

Returns the read-only #IngredientRecord of a Ingredient

Parameter

#any objectOrRecordId :

Return value

#IngredientRecord:

#list<#IngredientRecord> Ingredient.records: A read-only list of all #IngredientRecords in the world database.

Type `IngredientRecord`

Field(s)

#list<openmw.core#MagicEffectWithParams> IngredientRecord.effects: The effects (openmw.core#MagicEffectWithParams) of the ingredient

#string IngredientRecord.icon: VFS path to the icon

#string IngredientRecord.id: Record id

#string IngredientRecord.model: VFS path to the model

#string IngredientRecord.mwscript: MWScript on this potion (can be empty)

#string IngredientRecord.name: Human-readable name

#number IngredientRecord.value

#number IngredientRecord.weight

Type `Item`