Background for Fallout 4

Form


Inheritance Tree
ScriptExtended By
ScriptExtended By
ScriptExtended By
ScriptExtended By
ScriptExtended By
ScriptExtended By
ScriptExtended By
Structs
Properties

f4se

intkslotmask30=0x1
intkslotmask31=0x2
intkslotmask32=0x4
intkslotmask33=0x8
intkslotmask34=0x10
intkslotmask35=0x20
intkslotmask36=0x40
intkslotmask37=0x80
intkslotmask38=0x100
intkslotmask39=0x200
intkslotmask40=0x400
intkslotmask41=0x800
intkslotmask42=0x1000
intkslotmask43=0x2000
intkslotmask44=0x4000
intkslotmask45=0x8000
intkslotmask46=0x10000
intkslotmask47=0x20000
intkslotmask48=0x40000
intkslotmask49=0x80000
intkslotmask50=0x100000
intkslotmask51=0x200000
intkslotmask52=0x400000
intkslotmask53=0x800000
intkslotmask54=0x1000000
intkslotmask55=0x2000000
intkslotmask56=0x4000000
intkslotmask57=0x8000000
intkslotmask58=0x10000000
intkslotmask59=0x20000000
intkslotmask60=0x40000000
intkslotmask61=0x80000000
Events
Functions
intfunctionGetFormID()Native

Returns this form's form ID.

intfunctionGetGoldValue()Native

Returns the value of this form in gold. If called on a form that doesn't have a value (like a quest), it will return -1.

boolfunctionHasKeyword(KeywordakKeyword)Native

Checks to see if the specified keyword is attached to this form.

boolfunctionHasKeywordInFormList(FormListakKeywordList)Native

Checks to see if any of the keywords in the form list is attached to this form. If the form list contains no keywords, returns false.

boolfunctionPlayerKnows()Native

Is the "Known" flag set for this form? This is used for MagicEffect and WordOfPower.

voidfunctionStartObjectProfiling()NativeDebugOnly

Starts profiling all scripts attached to this object until stopped.

voidfunctionStopObjectProfiling()NativeDebugOnly

Stops profiling all scripts attached to this object until stopped.

stringfunctionGetName()Native

Gets the name of the form, full name if possible.

voidfunctionSetName(stringname)Native

Sets the name of the form to the passed in string.

stringfunctionGetEditorID()Native

returns the editor ID of the form if possible (not all types store editor IDs at runtime)

stringfunctionGetDescription()Native

Gets the textual description of the form.

floatfunctionGetWeight()Native

Gets the weight of this form.

voidfunctionSetWeight(floatweight)Native

sets the weight of the form

voidfunctionSetGoldValue(intvalue)Native

sets the gold value of the form

Keyword[]functionGetKeywords()Native

returns all keywords of the form

boolfunctionHasWorldModel()Native

Returns whether this Form has a World Model (fast)

stringfunctionGetWorldModelPath()Native

Returns the world model path of this Form, if it has a world model

voidfunctionSetWorldModelPath(stringpath)Native
stringfunctionGetIconPath()Native

works on the path to the nif file representing the icon for the form in the inventory

voidfunctionSetIconPath(stringpath)Native
stringfunctionGetMessageIconPath()Native

works on the path to the file representing the message icon for the form

voidfunctionSetMessageIconPath(stringpath)Native

Gets the Enchantment for this form.

voidfunctionSetEnchantment(Enchantmente)Native
intfunctionGetEnchantmentValue()Native

works on the enchantment value of the associated form

voidfunctionSetEnchantmentValue(intvalue)Native
EquipSlotfunctionGetEquipType()Native

Returns the particular equipslot type

voidfunctionSetEquipType(EquipSlottype)Native
RacefunctionGetRaceForm()Native
voidfunctionSetRaceForm(RacenewRace)Native
intfunctionGetSlotMask()Native

These functions are valid for Race, Armor, and ArmorAddon
returns the slot mask for the armor.

voidfunctionSetSlotMask(intslotMask)Native

sets the slot mask for the armor

intfunctionAddSlotToMask(intslotMask)Native

adds the specified slotMask to the armor

intfunctionRemoveSlotFromMask(intslotMask)Native

removes the specified slot masks from the armor

intfunctionGetMaskForSlot(intslot)NativeGlobal

calculates the equivalent value for the properties below

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.