GetFOSEVersion
Alias: none
Parameters:0
Return Type: Integer
Opcode:
0x1400 (5120)
Condition Function: Yes
Introduced In: 1
Calling Convention: B
Description:
returns the installed version of FOSE
GetFOSERevision
Alias: none
Parameters:0
Return Type: Integer
Opcode:
0x1401 (5121)
Condition Function: Yes
Introduced In: 1
Calling Convention: B
Description:
returns the numbered revision of the installed version of FOSE
GetWeight
Alias:
none
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1404 (5124)
Condition Function: Yes
Introduced In: 1
Calling Convention: E
Description:
returns the weight of the sepcified base form
GetRepairList
Alias: grl
Parameters:1
item:InventoryObject
Return Type: FormList
Opcode:
0x1405 (5125)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the repair list for the inventory object
GetWeaponAmmo
Alias: GetAmmo
Parameters:1
item:InventoryObject
Return Type: BaseForm
Opcode:
0x1406 (5126)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the ammo of a weapon
GetWeaponClipRounds
Alias: GetClipSize
Parameters:1
item:InventoryObject
Return Type: Integer
Opcode:
0x1407 (5127)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the clip size for the weapon
GetAttackDamage
Alias: GetDamage
Parameters:1
item:InventoryObject
Return Type: Integer
Opcode:
0x1408 (5128)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the attack damage for the weapon
GetWeaponType
Alias: GetWeapType
Parameters:1
item:InventoryObject
Return Type: WeaponType:Integer
Opcode:
0x1409 (5129)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the weapon type
GetWeaponMinSpread
Alias: GetMinSpread
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x140a (5130)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the minimum spread of the weapon
GetWeaponSpread
Alias: GetSpread
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x140b (5131)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the spread of the weapon
GetWeaponProjectile
Alias: GetWeapProj
Parameters:1
item:InventoryObject
Return Type: BaseForm
Opcode:
0x140c (5132)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the weapon projectile info
GetWeaponSightFOV
Alias: GetSightFOV
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x140d (5133)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the zoom field of view for the weapon
GetWeaponMinRange
Alias: GetMinRange
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x140e (5134)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the min range of the weapon
GetWeaponMaxRange
Alias: GetMaxRange
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x140f (5135)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the max range of the weapon
GetWeaponAmmoUse
Alias: GetAmmoUse
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1410 (5136)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the ammo used per shot of the weapon
GetWeaponActionPoints
Alias: GetAP
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1411 (5137)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the number of action points per shot of the weapon
GetWeaponCritDamage
Alias: GetCritDam
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1412 (5138)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the critical damage of the weapon
GetWeaponCritChance
Alias: GetCritPerc
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1413 (5139)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the chance of a critical shot for the weapon
GetWeaponCritEffect
Alias: GetCritEffect
Parameters:1
item:InventoryObject
Return Type: BaseForm
Opcode:
0x1414 (5140)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the spell for the critical effect for the weapon
GetEquipType
Alias: none
Parameters:1
item:InventoryObject
Return Type: Integer
Opcode:
0x1415 (5141)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the equipment type of the inventory object
GetBaseObject
Alias: gbo
Parameters:0
Return Type: BaseForm
Opcode:
0x1416 (5142)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the base object id of the reference
GetHealth
Alias: GetBaseHealth
Parameters:1
item:GenericObject
Return Type: Integer
Opcode:
0x1417 (5143)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the base health of the object or calling reference
GetValue
Alias: GetItemValue
Parameters:1
item:InventoryObject
Return Type: Integer
Opcode:
0x1418 (5144)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the base value of the object or calling reference
GetWeaponFireRate
Alias: GetFireRate
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1419 (5145)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the fire rate of the weapon.
GetWeaponAnimAttackMult
Alias: GetAnimAttackMult
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x141a (5146)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the animation attack multiplier of the weapon.
GetWeaponRumbleLeftMotor
Alias: GetRumbleLeft
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x141b (5147)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the rumble left motor of the weapon.
GetWeaponRumbleRightMotor
Alias: GetRumbleRight
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x141c (5148)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the rumble right motor of the weapon.
GetWeaponRumbleDuration
Alias: GetRumbleDuration
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x141d (5149)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the rumble duration of the weapon.
GetWeaponRumbleWavelength
Alias: GetRumbleWavelen
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x141e (5150)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the rumble wavelegnth for the weapon.
GetWeaponAnimShotsPerSec
Alias: GetAnimShotsPerSec
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x141f (5151)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the animation shots per second of the weapon.
GetWeaponAnimReloadTime
Alias: GetAnimReloadTime
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1420 (5152)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
retuns the animation reload time for the weapon.
GetWeaponAnimJamTime
Alias: GetAnimJamTime
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1421 (5153)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the animation jam time of the weapon.
GetWeaponSkill
Alias: none
Parameters:1
item:InventoryObject
Return Type: WeaponSkill:Integer
Opcode:
0x1422 (5154)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the skill for the weapon.
GetWeaponResistType
Alias: GetWeaponResist
Parameters:1
item:InventoryObject
Return Type: ResistValue:Integer
Opcode:
0x1423 (5155)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the resist type for the weapon.
GetWeaponFireDelayMin
Alias: GetFireDelayMin
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1424 (5156)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the semi-auto min fire delay for the weapon.
GetWeaponFireDelayMax
Alias: GetFireDelayMax
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1425 (5157)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the semi-auto max fire delay for the weapon.
ListGetCount
Alias: none
Parameters:1
form list:FormList
Return
Type: Integer
Opcode: 0x1426
(5158)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
"returns the count of items in the form list"
ListGetNthForm
Alias: none
Parameters:2
form list:FormList
index:Integer
Return Type: BaseForm
Opcode:
0x1427 (5159)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the nth form in the form list
ListAddForm
Alias: none
Parameters:3
form list:FormList
form:GenericObject
index:Integer
Return Type: BaseForm
Opcode:
0x1428 (5160)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
adds the form to the list at the given index (or at the end if not
provided)
ListGetFormIndex
Alias: none
Parameters:2
form list:FormList
form:GenericObject
Return Type: Integer
Opcode:
0x1429 (5161)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the index for the specified form
ListAddReference
Alias: ListAddRef
Parameters:2
form list:FormList
index:Integer
Return Type: Integer
Opcode:
0x142a (5162)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
adds the calling reference at the given index (or at the end if not
provided)
SetWeaponClipRounds
Alias: SetClipSize
Parameters:2
path type:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x142b (5163)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon clip size
SetWeaponMinSpread
Alias: SetMinSpread
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x142c (5164)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon min spread
SetWeaponSpread
Alias: SetSpread
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x142d (5165)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon spread
SetWeaponSightFOV
Alias: SetSightFOV
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x142e (5166)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon xoom field of view
SetWeaponMinRange
Alias: SetMinRange
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x142f (5167)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon min range
SetWeaponMaxRange
Alias: SetMaxRange
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x1430 (5168)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon max range.
SetWeaponAmmoUse
Alias: SetAmmoUse
Parameters:2
path type:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x1431 (5169)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon ammo use
SetWeaponActionPoints
Alias: SetAP
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x1432 (5170)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon number of action pointer per shot
SetWeaponCritDamage
Alias: SetWeaponCritDamage
Parameters:2
path type:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x1433 (5171)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon critical hit damage.
SetWeaponCritChance
Alias: SetCritPerc
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x1434 (5172)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon critical hit chance
SetWeaponCritEffect
Alias: SetCritEffect
Parameters:2
magic item:MagicItem
item:InventoryObject
Return Type: OldCriticalEffect:BaseForm
Opcode:
0x1435 (5173)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon critical hit effect
SetWeight
Alias: none
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x1436 (5174)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weight of the object
PrintToConsole
Alias: printc
Parameters:21
format
string:String
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
Return Type: Nothing
Opcode:
0x1437 (5175)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Print formatted string to console
DebugPrint
Alias: dbprintc
Parameters:21
format
string:String
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
variable:Float
Return Type: Nothing
Opcode:
0x1438 (5176)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
prints a formatted string to the console if debug mode is enabled for
calling script
SetDebugMode
Alias: dbmode
Parameters:2
bEnableDebugMessages:Integer
modIndex:Integer
Return Type: Nothing
Opcode:
0x1439 (5177)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
toggles debug mode for all scripts belonging to a mod. When called in
the console, the mod index of the mod for which debug messages are to
be toggled can be specified by the second parameter (in decimal, not
hexadecimal, format).
IsKeyPressed
Alias: none
Parameters:1
scanCode:Integer
Return Type: Bool
Opcode:
0x143a (5178)
Condition Function: Yes
Introduced In: 1
Calling Convention: B
Description:
return if a dx scancode is down or up
TapKey
Alias: tk
Parameters:1
scanCode:Integer
Return Type: Nothing
Opcode:
0x143b (5179)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Fakes a key press for one frame
HoldKey
Alias: hk
Parameters:1
scanCode:Integer
Return Type: Nothing
Opcode:
0x143c (5180)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Fakes a key press indefinitely
ReleaseKey
Alias: rk
Parameters:1
scanCode:Integer
Return Type: FixMe
Opcode:
0x143d (5181)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Releases a key held down by HoldKey
DisableKey
Alias: dk
Parameters:1
scanCode:Integer
Return Type: Nothing
Opcode:
0x143e (5182)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Prevents a player from using a key
EnableKey
Alias: ek
Parameters:1
scanCode:Integer
Return Type: Nothing
Opcode:
0x143f (5183)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Reenables a key previously disabled with DisableKey
GetNumKeysPressed
Alias: gnkp
Parameters:0
Return Type: Integer
Opcode:
0x1440 (5184)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Returns how many keyboard keys are currently being held down
GetKeyPress
Alias: gkp
Parameters:1
index:Integer
Return
Type: scanCode:Integer
Opcode:
0x1441 (5185)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Returns the scancode of the nth key which is currently being held down
GetNumMouseButtonsPressed
Alias: gnmbp
Parameters:0
Return Type: Integer
Opcode:
0x1442 (5186)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Returns how many mouse buttons are currently being held down
GetMouseButtonPress
Alias: gmbp
Parameters:1
index:Integer
Return
Type: FixMe
Opcode: 0x1443 (5187)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
Returns the code of the nth mouse button which is currently being held
down
con_SetGameSetting
Alias: none
Parameters:2
settingName:String
newValue:String
Return Type: Nothin
Opcode:
0x1444 (5188)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description: Sets
a game setting. Does not accept variables as arguments.
con_SetINISetting
Alias: none
Parameters:2
setting:String
newValue:String
Return Type: Nothing
Opcode:
0x1445 (5189)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Setting string is of the format "SettingName:CategoryName" where
CategoryName is the header under which the setting appears in the .ini
file. Does not accept variables as arguments.
con_GetINISetting
Alias: none
Parameters:1
settingName:String
Return
Type: Nothing
Opcode: 0x1446
(5190)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Setting string is of the same format as that used by con_SetINISetting.
Does not return a value but merely prints the value to the console.
con_SetCameraFOV
Alias: none
Parameters:2
Float (Optional):Float
Float (Optional):Float
Return Type: Nothing
Opcode:
0x1447 (5191)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Change the camera's field of view (in deg): default 75
con_RefreshINI
Alias: none
Parameters:0
Return Type: Nothing
Opcode:
0x1448 (5192)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Refresh INI settings from files.
con_Save
Alias: none
Parameters:2
saveName:String
Integer
(Optional):Integer
Return Type:
Nothing
Opcode: 0x1449 (5193)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
Saves the current game with the specified filename. If the second
parameter is non-zero, generates a text file containing information
about the saved data.
con_SaveINI
Alias: none
Parameters:0
Return Type: Nothing
Opcode:
0x144a (5194)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Writes all the .ini files.
con_QuitGame
Alias: none
Parameters:0
Return Type: Nothing
Opcode:
0x144b (5195)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Exit game without going through menus.
con_LoadGame
Alias: none
Parameters:2
filename:String
Integer
(Optional):Integer
Return Type:
Nothing
Opcode: 0x144c (5196)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
Loads the savegame with the specified filename if it exists.
con_CloseAllMenus
Alias: none
Parameters:0
Return Type: Nothing
Opcode:
0x144d (5197)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Closes all open menus
GetControl
Alias: none
Parameters:1
controlCode:Integer
Return Type: scanCode:Integer
Opcode:
0x144e (5198)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Returns the key assigned to a control
GetAltControl
Alias: none
Parameters:1
controlCode:Integer
Return Type: scanCode:Integer
Opcode:
0x144f (5199)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Returns the mouse button assigned to a control
SetWeaponAmmo
Alias: SetAmmo
Parameters:2
NewAmmoInRef:MagicItem
target
item:InventoryObject
Return Type:
OldAmmo:BaseForm
Opcode: 0x1450 (5200)
Condition
Function: No
Introduced
In: 1
Calling
Convention: E
Description:
sets the ammo of the weapon
SetWeaponProjectile
Alias: SetProjectile
Parameters:2
NewProjectileInRef:MagicItem
target
item:InventoryObject
Return Type:
OldProjectile:BaseForm
Opcode: 0x1451 (5201)
Condition
Function: No
Introduced
In: 1
Calling
Convention: E
Description:
sets the projectile of the weapon
SetRepairList
Alias: none
Parameters:2
form list:FormList
target
item:InventoryObject
Return Type:
Nothing
Opcode: 0x1452 (5202)
Condition
Function: No
Introduced
In: 1
Calling
Convention: E
Description:
sets the repair list for the specified item.
GetNumericGameSetting
Alias: none
Parameters:1
settingName:String
Return
Type: IntegerOrFloat
Opcode:
0x1453 (5203)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the value of a numeric game setting
SetNumericGameSetting
Alias: none
Parameters:2
settingName:String
float:Float
Return Type: Nothing
Opcode:
0x1454 (5204)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
sets a numeric game setting. Accepts variables as arguments.
Label
Alias: none
Parameters:1
labelID:Integer
Return
Type: Nothing
Opcode:
0x1455 (5205)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Defines a labeled position in a script which subsequent calls to Goto
can use to create loops. The label must be defined before Goto is
called.
Goto
Alias:
none
Parameters:1
labelID:Integer
Return
Type: Nothing
Opcode:
0x1456 (5206)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Jump to a labeled position in the script previously defined by a call
to Label. Execution will return to the label, simulating a loop. Be
careful to provide an exit condition to avoid creating infinite loops.
CompareNames
Alias: none
Parameters:2
inv item:GenericObject
target
item:GenericObject
Return
Type: Float
Opcode: 0x1457 (5207)
Condition
Function: No
Introduced
In: 1
Calling
Convention: E
Description:
compares one name to another.
con_SetVel
Alias: none
Parameters:2
Axis:Axis
Float:Float
Return Type: Nothing
Opcode:
0x1458 (5208)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
Sets Velocity on a reference
GetEquippedObject
Alias: GetEqObj
Parameters:1
atIndex:Integer
Return Type: BaseForm
Opcode:
0x1459 (5209)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the base object of the item in the specified slot
MenuTapKey
Alias: mtk
Parameters:1
scanCode:Integer
Return Type: Nothing
Opcode:
0x145a (5210)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Fakes a key press for one frame in menu mode
MenuReleaseKey
Alias: mrk
Parameters:1
scanCode:Integer
Return Type: Nothing
Opcode:
0x145b (5211)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Releases a key held down by MenuHoldKey
MenuHoldKey
Alias: mhk
Parameters:1
scanCode:Integer
Return Type: Nothing
Opcode:
0x145c (5212)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Fakes a key press indefinately in menu mode
DisableControl
Alias: dc
Parameters:1
controlCode:Integer
Return Type: Nothing
Opcode:
0x145d (5213)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
disables the key and button bound to a control
EnableControl
Alias: ec
Parameters:1
controlCode:Integer
Return Type: Nothing
Opcode:
0x145e (5214)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
enables the key and button assigned to a control
TapControl
Alias: tc
Parameters:1
controlCode:Integer
Return Type: Nothing
Opcode:
0x145f (5215)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
taps the key or mouse button assigned to control
SetControl
Alias: none
Parameters:2
controlCode:Integer
scanCode:Integer
Return Type: Nothing
Opcode:
0x1460 (5216)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
assigns a new keycode to the specified keyboard control. Changes are
saved to the .ini when the user exits the game.
SetAltControl
Alias: none
Parameters:2
controlCode:Integer
scanCode:Integer
Return Type: Nothing
Opcode:
0x1461 (5217)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
assigns a new mouse button code to the specified mouse control. Changes
are saved to the ini when the user exits the game.
SetIsControl
Alias: none
Parameters:2
controlCode:Integer
scanCode:Integer
Return Type: Bool
Opcode:
0x1462 (5218)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Flags a key or mouse button as a control, allowing modders to define
custom controls - other scripts can then use IsControl to detect
conflicts in which two mods try to use the same key for different
actions.
IsControl
Alias: none
Parameters:1
scanCode:Integer
Return Type: Bool
Opcode:
0x1463 (5219)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns 1 if key is a game control or 2 if a custom control set by
SetIsControl.
IsKeyDisabled
Alias: none
Parameters:1
scanCode:Integer
Return Type: Bool
Opcode:
0x1464 (5220)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns 1 if the key has been disabled by a script
IsControlDisabled
Alias: none
Parameters:1
controlCode:Integer
Return Type: Bool
Opcode:
0x1465 (5221)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns 1 if the control has been disabled by a script using
DisableControl.
AddSpellNS
Alias: none
Parameters:1
spell:SpellItem
Return
Type: Nothing
Opcode: 0x1466
(5222)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
identical to AddSpell but without the UI message
GetWeaponAnimMult
Alias: GetAnimMult
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1467 (5223)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the animation multiplier for the weapon
GetWeaponReach
Alias: GetReach
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1468 (5224)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the reach of the weapon
GetWeaponIsAutomatic
Alias: GetIsAutomatic
Parameters:1
item:InventoryObject
Return Type: Bool
Opcode:
0x1469 (5225)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns 1 if the weapon is an automatic weapon
GetWeaponHandGrip
Alias: GetHandGrip
Parameters:1
item:InventoryObject
Return Type: handGrip:Integer
Opcode:
0x146a (5226)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the hand grip of the weapon
GetWeaponReloadAnim
Alias: GetReloadAnim
Parameters:1
item:InventoryObject
Return Type: reloadAnim:Integer
Opcode:
0x146b (5227)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the reload animation of the weapon
GetWeaponBaseVATSChance
Alias: GetVATSChance
Parameters:1
item:InventoryObject
Return Type: Integer
Opcode:
0x146c (5228)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the base VATS chance of the weapon
GetWeaponAttackAnimation
Alias: GetAttackAnim
Parameters:1
item:InventoryObject
Return Type: attackAnimation:Integer
Opcode:
0x146d (5229)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the attack animation of the weapon
GetWeaponNumProjectiles
Alias: GetNumProj
Parameters:1
item:InventoryObject
Return Type: Integer
Opcode:
0x146e (5230)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the number of projectiles used in a single shot by the weapon.
GetWeaponAimArc
Alias: GetAimArc
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x146f (5231)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the aim arc of the weapon.
GetWeaponLimbDamageMult
Alias: GetLimbDamageMult
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1470 (5232)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the limb damage multiplier of the weapon.
GetWeaponSightUsage
Alias: GetSightUsage
Parameters:1
item:InventoryObject
Return Type: Float
Opcode:
0x1471 (5233)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the sight usage of the weapon.
SetAttackDamage
Alias: SetDamage
Parameters:2
damage:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x1472 (5234)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the attack damage of the form
SetWeaponAnimMult
Alias: SetAnimMult
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x1473 (5235)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the animiation multiple of the weapon.
SetWeaponReach
Alias: SetReach
Parameters:2
reach:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x1474 (5236)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the reach of the weapon.
SetWeaponIsAutomatic
Alias: SetIsAutomatic
Parameters:2
isAutomatic:Bool
item:InventoryObject
Return Type: Nothing
Opcode:
0x1475 (5237)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets whether the weapon is an automatic weapon or not.
SetWeaponHandGrip
Alias: SetHandGrip
Parameters:2
handGrip:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x1476 (5238)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the hand grip of the weapon.
SetWeaponReloadAnim
Alias: SetReloadAnim
Parameters:2
reloadAnim:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x1477 (5239)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the reload animation of the weapon.
SetWeaponBaseVATSChance
Alias: SetVATSChance
Parameters:2
newVATSChance:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x1478 (5240)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the base VATS chance for the weapon.
SetWeaponAttackAnimation
Alias: SetAttackAnim
Parameters:2
attackAnimation:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x1479 (5241)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the attack animation for the weapon.
SetWeaponNumProjectiles
Alias: SetNumProj
Parameters:2
numProjectiles:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x147a (5242)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the number of projectiles the weapon fires each time it is shot.
SetWeaponAimArc
Alias: SetAimArc
Parameters:2
aimArc:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x147b (5243)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the aim arc of the weapon.
SetWeaponLimbDamageMult
Alias: SetLimbDamageMult
Parameters:2
limbDamageMult:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x147c (5244)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the limb damage multiplier for the weapon.
SetWeaponSightUsage
Alias: SetSightUsage
Parameters:2
sightUsage:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x147d (5245)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the sight usage for the weapon.
GetNumericIniSetting
Alias: none
Parameters:1
settingName:String
Return
Type: IntegerOrFloat
Opcode:
0x147e (5246)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the value of a numeric setting. Setting name is of the format
"SettingName:CategoryName" where CategoryName is the header under which
the setting appears in the .ini file.
SetNumericIniSetting
Alias: none
Parameters:2
settingName:String
newValue:Float
Return Type: Nothing
Opcode:
0x147f (5247)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
sets a numeric ini setting, using the same format for the setting name
as GetNumericIniSetting. Accepts variables as arguments.
GetModIndex
Alias: none
Parameters:1
modName:String
Return
Type: Integer
Opcode: 0x1480
(5248)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the index of the specified mod
GetNumLoadedMods
Alias: none
Parameters:0
Return Type: Integer
Opcode:
0x1481 (5249)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the number of loaded mods
GetSourceModIndex
Alias: none
Parameters:1
item:GenericObject
Return Type: Integer
Opcode:
0x1482 (5250)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the index of the mod associated with the form
IsModLoaded
Alias: none
Parameters:1
modName:String
Return
Type: Bool
Opcode: 0x1483 (5251)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
returns the whether the specified mod is loaded
GetCrosshairRef
Alias: none
Parameters:0
Return Type: Reference
Opcode:
0x1484 (5252)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the reference under the crosshair - i.e., the reference that
would be activated if the player pressed the Activate button. Will
return non-activatable items (like tables and trees) as long as they
are within activation distance. Otherwise returns zero.
SetName
Alias: none
Parameters:2
name:String
item:GenericObject
Return Type: Nothing
Opcode:
0x1485 (5253)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the name of the object.
TempCloneForm
Alias: none
Parameters:1
formToClone:GenericObject
Return Type: BaseForm
Opcode:
0x1486 (5254)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
clones the specified form and returns a new base form. This
base form will not be persisted in the save game.
IsClonedForm
Alias: IsCloned
Parameters:1
item:GenericObject
Return Type: Bool
Opcode:
0x1487 (5255)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns whether the specified form is a dynamic object or not. Dynamic
objects include those created with TempCloneForm and those generated by
the game during play. These objects always have a mod index of 0xFF.
IsScripted
Alias: none
Parameters:1
item:GenericObject
Return Type: Bool
Opcode:
0x1488 (5256)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns 1 if the object or reference has a script attached to it.
GetScript
Alias: none
Parameters:1
item:GenericObject
Return Type: BaseForm
Opcode:
0x1489 (5257)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the script of the reference or passed object.
RemoveScript
Alias: none
Parameters:1
item:GenericObject
Return Type: oldScript:BaseForm
Opcode:
0x148a (5258)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
removes the script of the reference or passed object.
SetScript
Alias: none
Parameters:2
scriptInRef:GenericObject
item:GenericObject
Return Type: oldScript:BaseForm
Opcode:
0x148b (5259)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the script of the reference or passed object.
GetObjectEffect
Alias: GetEnchantment
Parameters:1
item:InventoryObject
Return Type: BaseForm
Opcode:
0x148c (5260)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the object effect of the inventory object.
GetWeaponHasScope
Alias: none
Parameters:1
item:InventoryObject
Return Type: Bool
Opcode:
0x148d (5261)
Condition Function: Yes
Introduced In: 1
Calling Convention: E
Description:
returns whether the weapon has a scope or not.
IsControlPressed
Alias: none
Parameters:1
controlCode:Integer
Return Type: Bool
Opcode:
0x148e (5262)
Condition Function: Yes
Introduced In: 1
Calling Convention: B
Description:
returns 1 if the key or mouse button assigned to a control is pressed
ListRemoveNthForm
Alias: ListRemoveNth
Parameters:2
form list:FormList
index:Integer
Return Type: formRemoved:BaseForm
Opcode:
0x148f (5263)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
removes the nth form from the list
ListRemoveForm
Alias: none
Parameters:2
form list:FormList
form:GenericObject
Return Type: indexOfFormRemoved:Integer
Opcode:
0x1490 (5264)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
removes the specified from from the list.
GetEquippedCurrentHealth
Alias: GetEqCurHealth
Parameters:1
equipmentSlot:Integer
Return Type: Float
Opcode:
0x1491 (5265)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the current health of the object equipped in the specified slot
SetEquippedCurrentHealth
Alias: SetEqCurHealth
Parameters:2
val:Float
equipmentSlot:Integer
Return Type: Nothing
Opcode:
0x1492 (5266)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
sets the current health of the equipped object at the given slot.
GetType
Alias: GetObjectType
Parameters:1
item:GenericObject
Return Type: formType:Integer
Opcode:
0x1493 (5267)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the type of the specified base form
GetDebugMode
Alias: GetDbMode
Parameters:1
modIndex:Integer
Return
Type: Bool
Opcode: 0x1494 (5268)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
returns whether debug mode is set for the mod. If the mod index
parameter is omitted, uses the mod index of the calling script.
GetParentCell
Alias: gpc
Parameters:0
Return Type: BaseForm
Opcode:
0x1495 (5269)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the parent cell of the reference
Exp
Alias:
none
Parameters:1
float:Float
Return
Type: Float
Opcode: 0x1496 (5270)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
calculates the exponential of a value
Log10
Alias: none
Parameters:1
float:Float
Return
Type: Float
Opcode: 0x1497 (5271)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
calculates the base 10 log of a value
Floor
Alias: flr
Parameters:1
float:Float
Return
Type: Float
Opcode:
0x1498 (5272)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Returns the nearest whole number that is less than a float
Ceil
Alias:
none
Parameters:1
float:Float
Return
Type: Float
Opcode:
0x1499 (5273)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Returns the nearest whole number that is greater than a float
LeftShift
Alias: none
Parameters:2
int:Integer
int:Integer
Return Type: Integer
Opcode:
0x149a (5274)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Shifts a 32-bit integer left the specified number of bits
RightShift
Alias: none
Parameters:2
int:Integer
int:Integer
Return Type: Integer
Opcode:
0x149c (5276)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Shifts a 32-bit integer right the specified number of bits
LogicalAnd
Alias: none
Parameters:2
int:Integer
int:Integer
Return Type: Integer
Opcode:
0x149c (5276)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Performs a logical AND between two 32-bit integers.
LogicalOr
Alias: none
Parameters:2
int:Integer
int:Integer
Return Type: Integer
Opcode:
0x149d (5277)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Performs a logical OR between two 32-bit integers.
LogicalXor
Alias: none
Parameters:2
int:Integer
int:Integer
Return Type: Integer
Opcode:
0x149e (5278)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Performs a logical XOR between two 32-bit integers.
LogicalNot
Alias: none
Parameters:1
int:Integer
Return
Type: Integer
Opcode:
0x149f (5279)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
Performs a logical NOT on a 32-bit integer.
fmod
Alias:
none
Parameters:3
x:Float
n:Float
offset:Float
Return Type: Float
Opcode:
0x14a0 (5280)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the result of a floating point modulous of the passed floats
GetArmorAR
Alias: GetArmorArmorRating
Parameters:1
item:InventoryObject
Return Type: Integer
Opcode:
0x14a1 (5281)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns the armor rating of the specified armor.
IsFormValid
Alias: none
Parameters:1
refVar:variable
Return
Type: Bool
Opcode: 0x14a2 (5282)
Condition
Function: No
Introduced In: 1
Calling Convention: E
Description:
returns 1 if the object passed in the ref variable is valid. Returns 0
if the object stored in the variable is not currently loaded in memory
(for instance, a non-persistent reference) or if the variable doesn't
hold any object.
IsReference
Alias: none
Parameters:1
reference:ObjectRef
Return
Type: Bool
Opcode: 0x14a3 (5283)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
returns 1 if the passed refVar stores a reference.
IsPowerArmor
Alias: IsPA
Parameters:1
item:InventoryObject
Return Type: Bool
Opcode:
0x14a4 (5284)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
returns whether the biped form is considered power armor.
SetIsPowerArmor
Alias: SetIsPA
Parameters:2
path type:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x14a5 (5285)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets whether the armor is power armor or not.
GetOpenKey
Alias: GetKey
Parameters:0
Return Type: BaseForm
Opcode:
0x14a6 (5286)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the key associated with a lockable object
SetOpenKey
Alias: SetKey
Parameters:1
item:InventoryObject
Return
Type: Nothing
Opcode: 0x14a7
(5287)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
sets the key uesd to unlock the calling object
GetGameLoaded
Alias: none
Parameters:0
Return Type: Bool
Opcode:
0x14a8 (5288)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns 1 after a game is loaded on a per-script basis. For each script
that calls GetGameLoaded, the command will return true exactly once
each time the game is loaded and false thereafter.
GetGameRestarted
Alias: none
Parameters:0
Return Type: Bool
Opcode:
0x14a9 (5289)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns 1 when the game is restarted on a per-script basis. For each
script that calls GetGameRestarted, the commands returns true exactly
once per game session. Useful for situations in which a script must set
certain object properties or settings each time the game is started.
SetWeaponType
Alias: none
Parameters:2
weaponType:Integer
item:InventoryObject
Return Type: Nothing
Opcode:
0x14aa (5290)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the weapon type of the weapon.
SetWeaponAnimAttackMult
Alias: SetAnimAttackMult
Parameters:2
float:Float
item:InventoryObject
Return Type: Nothing
Opcode:
0x14ab (5291)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the anim attack multiplier.
GetHotkeyItem
Alias: none
Parameters:1
hotkey:Integer
Return
Type: BaseForm
Opcode: 0x14ac
(5292)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the item assigned to the specified hotkey from 1 to 8
GetTeleportCell
Alias: none
Parameters:0
Return Type: BaseForm
Opcode:
0x14ad (5293)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the cell to which the calling door reference teleports
GetLinkedDoor
Alias: none
Parameters:0
Return Type: BaseForm
Opcode:
0x14ae (5294)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the door to which the calling reference is linked
GetFirstRef
Alias: none
Parameters:3
form
type:Integer
cell
depth:Integer
include
taken refs:Bool
Return Type:
ObjectRef
Opcode: 0x14af (5295)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
returns the first reference of the specified type in the current cell
GetNextRef
Alias: none
Parameters:0
Return Type: ObjectRef
Opcode:
0x14b0 (5296)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
returns the next reference of a given type in the current cell.
GetFirstRef or GetFirstRefInCell must be called first; the formType,
cellDepth, and boolean arguments passed to
GetFirstRef/GetFirstRefInCell are used. This command should only be
used within a loop that executes within a single frame.
GetNumRefs
Alias: none
Parameters:3
form
type:Integer
cell
depth:Integer
include
taken refs:Bool
Return Type:
Integer
Opcode: 0x14b1 (5297)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
returns the number of references of a given type in the current cell
GetFirstRefInCell
Alias: none
Parameters:4
cell:Cell
form
type:Integer
cell
depth:Integer
include
taken refs:Bool
Return Type:
ObjectRef
Opcode: 0x14b2 (5298)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
returns the first reference of the specified type in the specified cell
GetNumRefsInCell
Alias: none
Parameters:4
cell:Cell
form
type:Integer
cell
depth:Integer
include
taken refs:Bool
Return Type:
Integer
Opcode: 0x14b3 (5299)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
returns the number of references of a given type in the specified cell
GetUIFloat
Alias: none
Parameters:1
traitName:String
Return
Type: Float
Opcode: 0x14b4 (5300)
Condition
Function: No
Introduced
In: 1
Calling
Convention: B
Description:
Looks up a UI trait by name and returns its numeric value. The trait
name is of the format "MenuName/ElementName/ElementName/.../TraitName"
as defined in the XML hierarchy for the desired menu, i.e.
"MessageMenu\NoGlow_Branch\MM_Title\x"
SetUIFloat
Alias: none
Parameters:2
traitName:String
newValue:Float
Return Type: Nothing
Opcode:
0x14b5 (5301)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
sets the value of a float UI trait. Trait name is of the format used by
GetUIFloat.
SetUIString
Alias: none
Parameters:2
traitName:String
newValue:String
Return Type: Nothing
Opcode:
0x14b6 (5302)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
sets the value of a string UI trait. Trait name is of the
format used by GetUIFloat.
ListReplaceNthForm
Alias: ListReplaceNth
Parameters:3
form list:FormList
replaceWith:GenericObject
formIndex:Integer
Return Type: replaced:BaseForm
Opcode:
0x14b7 (5303)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
replaces the nth form of the list with the specified form. Trait name
is of the format used by GetUIFloat.
ListReplaceForm
Alias: none
Parameters:3
form list:FormList
replaceWith:GenericObject
formToReplace:GenericObject
Return
Type: index:Integer
Opcode:
0x14b8 (5304)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
replaces the specified from with another.
GetParentWorldspace
Alias: gpw
Parameters:0
Return Type: BaseForm
Opcode:
0x14b9 (5305)
Condition Function: No
Introduced In: 1
Calling Convention: R
Description:
returns the parent worldspace of the reference
PrintActiveTile
Alias: none
Parameters:0
Return Type: Nothing
Opcode:
0x14ba (5306)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
prints name of highlighted UI component for debug purposes
SetBaseItemValue
Alias: SetValue
Parameters:2
form:InventoryObject
newValue:Integer
Return Type: Nothing
Opcode:
0x14bb (5307)
Condition Function: No
Introduced In: 1
Calling Convention: B
Description:
changes the value of the base form passed in.
SetHealth
Alias:
SetObjectHealth
Parameters:2
newHealth:Integer
form:GenericObject
Return
Type: Nothing
Opcode: 0x14bc
(5308)
Condition Function: No
Introduced In: 1
Calling Convention: E
Description:
sets the health of the specified base form
GetFOSEBeta
Alias:
none
Parameters:0
Return Type: Integer
Opcode: 0x14bd
(5309)
Condition Function: Yes
Introduced In: 1
Calling Convention: B
Description:
returns the beta number of the installed version of FOSE. A
non-beta version of FOSE will return 0.
Format
Specifiers
Some FOSE commands take a format
string
as a parameter. Format strings are actually a collection of arguments
consisting of a string followed by zero to twenty variables and/or
numbers. The string specifies how the command should use the rest of
the arguments to construct a new string. Within the format string,
percent signs are used to indicate special characters.
The format specifiers recognized by FOSE commands include all of those
recognized by vanilla Fallout script commands like MessageBox as well
as several extended specifiers:
%a - replaced by the character matching the ASCII code passed as an
integer.
%e - replaced by nothing.
Useful for passing an empty string as an argument, as the script
compiler will not accept an empty string.
%i - is
replaced by the formID of a reference or object passed in a ref variable
%k - replaced by a string representing the key associated with a
DirectInput scan code
%n -
replaced with the name of a reference or object passed in a ref variable
%p - replaced with a pronoun based on the gender of the object
parameter passed in a ref variable:
%po - objective (he,
she, it)
%pp - possessive (his, her,
its)
%ps - subjective (him, her, it)
%q - replaced with a double quote character (takes no arguments)
%r - replaced by a new-line character (takes no arguments)
%v - replaced by the name of an actor value passed as an integer actor value
code.
%x - replaced with an integer in hexadecimal format. An optional digit
from
0-9 immediately following this specifier indicates the minimum width of
the displayed value. For example, MessageEx
"%x4" 255 will display "00FF".
%{ .. %} - Conditionally omits a portion of the format string based on
a boolean value. The left bracket accepts a variable; if the value of
the variable is zero, all text up to the right bracket will be ignored,
and any parameters supplied to format specifiers within the omitted
substring will be skipped.
Additional format specifiers used by the C function printf() may work
as well. Due to the fact that integer script variables are stored as
floats, specifiers expecting integers may not display the
expected output.
Type
Codes
Form Type IDs
0: None
1: TES4
2: Group
3: GMST
4: TextureSet
5: MenuIcon
6: Global
7: Class
8: Faction
9: HeadPart
10:
Hair
11:
Eyes
12:
Race
13:
Sound
14:
AcousticSpace
15:
Skill
16:
Effect
17:
Script
18:
LandTexture
19:
Enchantment
20:
Spell
21:
Activator
22:
TalkingActivator
23:
Terminal
24:
Armor
25:
Book
26:
Clothing
27:
Container
28:
Door
29:
Ingredient
30:
Light
31:
Misc
32:
Static
33:
StaticCollection
34:
MoveableStatic
35:
PlaceableWater
36:
Grass
37:
Tree
38:
Flora
39:
Furniture
40:
Weapon
41:
Ammo
42:
NPC
43:
Creature
44:
LeveledCreature
45:
LeveledCharacter
46:
Key
47:
AlchemyItem
48:
IdleMarker
49:
Note
50:
ConstructibleObject
51:
Projectile
52:
LeveledItem
53:
Weather
54:
Climate
55:
Region
56:
NAVI
57:
Cell
58:
Reference
59:
ACHR
60:
ACRE
61:
PMIS
62:
PGRE
63:
PBEA
64:
PFLA
65:
WorldSpace
66:
Land
67:
NavMesh
68:
TLOD
69:
DIAL
70:
INFO
71:
Quest
72:
Idle
73:
Package
74:
CombatStyle
75:
LoadScreen
76:
LeveledSpell
77:
ANIO
78:
WaterForm
79:
EffectShader
80:
TOFT
81:
Explosion
82:
Debris
83:
ImageSpace
84:
ImageSpaceModifier
85:
ListForm
86:
Perk
87:
BodyPartData
88:
AddonNode
89:
ActorValueInfo
90:
RadiationStage
91:
CameraShot
92:
CameraPath
93:
VoiceType
94:
ImpactData
95:
ImpactDataSet
96:
ARMA
97:
EncounterZone
98:
Message
99:
Ragdoll
100:
DOBJ
101:
LightingTemplate
102:
SoundFile
200: Actor (for ref
walking only)
201: Inventory
Object (for ref walking only)
Weapon
Type
0:
HandToHandMelee
1:
OneHandMelee
2:
TwoHandMelee
3:
OneHandPistol
4:
OneHandPistolEnergy
5:
TwoHandRifle
6:
TwoHandAutomatic
7:
TwoHandRifleEnergy
8:
TwoHandHandle
9:
TwoHandLauncher
10:
OneHandGrenade
11: OneHandMine
12:
OneHandLunchboxMine
Equip
Type
Equipment Slot IDs
0:
head
1:
hair
2:
upper
body
3:
left
hand
4:
right
hand
5:
weapon
6:
pip boy
7:
backpack
8:
necklace
9:
headband
10:
hat
11:
eyeglasses
12:
nosering
13:
earrings
14:
mask
15:
choker
16:
mouth object
17:
body addon 1
18:
body addon 2
19:
body addon 3
Weapon Hand Grips
0:
default
1:
hand grip 1
2:
hand grip 2
3:
hand grip 3
Attack Animations
0:
default
1:
Attack 3
2:
Attack 4
3:
Attack 5
4:
Attack 6
5:
Attack 7
6:
Attack 8
7:
Attack Left
8:
Attack Loop
9:
Attack Right
10:
Attack Spin
11:
Attack Spin 2
12:
Attack Throw
13:
Attack Throw 2
14: Attack
Throw 3
15: Attack
Throw 4
16: Attack
Throw 5
17:
Place Mine
18:
Place Mine 2
Reload Animations
0:
Reload A
1:
Reload B
2: Reload C
3:
Reload D
4: Reload E
5:
Reload F
6:
Reload G
7:
Reload H
8:
Reload I
9:
Reload J
10:
Reload K
Actor Value Codes
0:
Aggression
1:
Confidence
2:
Energy
3:
Responsibility
4:
Mood
5:
Strength
6:
Perception
7:
Endurance
8:
Charisma
9:
Intelligence
10:
Agility
11:
Luck
12:
ActionPoints
13:
CarryWeight
14:
CritChance
15:
HealRate
16:
Health
17:
MeleeDamage
18:
DamageResistance
19:
PoisonResistance
20:
RadResistance
21:
SpeedMultiplier
22:
Fatigue
23:
Karma
24:
XP
25:
Head
26:
Torso
27:
LeftArm
28:
RightArm
29:
LeftLeg
30:
RightLeg
31:
Brain
32:
Barter
33:
BigGuns
34:
EnergyWeapons
35:
Explosives
36:
Lockpick
37:
Medicine
38:
MeleeWeapons
39:
Repair
40:
Science
41:
SmallGuns
42:
Sneak
43:
Speech
44:
Throwing
45:
Unarmed
46:
InventoryWeight
47:
Paralysis
48:
Invisibility
49:
Chameleon
50:
NightEye
51:
DetectLifeRange
52:
FireResistance
53:
WaterBreathing
54:
RadLevel
55:
BloodyMess
56:
UnarmedDamage
57:
Assistance
60:
EnergyResistance
61:
EMPResistance
62:
Var1Medical
72:
IgnoreCrippledLimbs
Control
Codes
0: Forward
1:
Backward
2: Left
3:
Right
4: Attack
5:
Activate
6: Block
7:
Ready Item
8: Crouch
9:
Run
10: Always Run
11:
Auto-Move
12: Jump
13:
TogglePOV
14: MenuMode
15:
Rest
16: VATS
17-24: Hotkeys 1-8
25:
Quicksave
26: Quickload
27:
Grab
DirectX Scancodes
1: Escape
2: 1
3: 2
4: 3
5: 4
6: 5
7: 6
8: 7
9: 8
10:
9
11:
0
12:
Minus
13:
Equals
14:
Backspace
15:
Tab
16:
Q
17:
W
18:
E
19:
R
20:
T
21:
Y
22:
U
23:
I
24:
O
25:
P
26:
Left Bracket
27:
Right Bracket
28:
Enter
29:
Left Control
30:
A
31:
S
32:
D
33:
F
34:
G
35:
H
36:
J
37:
K
38:
L
39:
Semicolon
40:
Apostrophe
41:
~ (Console)
42:
Left Shift
43:
Back Slash
44:
Z
45:
X
46:
C
47:
V
48:
B
49:
N
50:
M
51:
Comma
52:
Period
53:
Forward Slash
54:
Right Shift
55:
NUM*
56:
Left Alt
57:
Spacebar
58:
Caps Lock
59:
F1
60:
F2
61:
F3
62:
F4
63:
F5
64:
F6
65:
F7
66:
F8
67:
F9
68:
F10
69:
Num Lock
70:
Scroll Lock
71:
NUM7
72:
NUM8
73:
NUM9
74:
NUM-
75:
NUM4
76:
NUM5
77:
NUM6
78:
NUM+
79:
NUM1
80:
NUM2
81:
NUM3
82:
NUM0
83:
NUM.
87:
F11
88:
F12
156:
NUM Enter
157:
Right Control
181:
NUM/
184:
Right Alt
200:
Up Arrow
203:
Left Arrow
205:
Right Arrow
208:
Down Arrow
256:
Left Mouse Button
257:
Right Mouse Button
258:
Middle/Wheel Mouse Button
259:
Mouse Button 3
260:
Mouse Button 4
261:
Mouse Button 5
262:
Mouse Button 6
263:
Mouse Button 7
264:
Mouse Wheel Up
265:
Mouse Wheel Down