» Sun Jan 11, 2015 2:45 am Previous Thread: http://www.gamesas.com/topic/1482519-beta-new-vegas-script-extender-nvse-v4
The New Vegas Script Extender, or NVSE for short, is a modder's resource that expands the scripting capabilities of Fallout: NV. It does so without modifying the executable files on disk, so there are no permanent side effects.
Website: http://nvse.silverlock.org
Download (version 4.5): /nvse_4_5.7z- compatible with runtime 1.4.0.525 and editor 1.4.0.518, plus the German "no gore" version.
Check the documentation page at the GECK Wiki :
Current Beta (NVSE 4.6 Beta 2) : https://www.dropbox....beta-2.zip?dl=0
4.5
Fixes:
GetArrayVariable return type corrected.
All String and array map modification are protected by a critical section due to concurrency issues.
Handling of {} in compiler override or let/eval expression.
You can use {} to enclose function parameters in complex expression so the parser knows which arguments are used by which function
let aVar := aFunction { parm1 parm2 } + anotherFunction { parm3 parm4 parm5 }
() are used to enclose complete expression.
let aVar := ( aFunction parm1 parm2 ) + ( anotherFunction parm3 parm4 parm5 )
EquipItem2 recognises the third parameter when used.
SetHotkeyItem should no longer interrupt the calling script when called and should work when called on an item without ExtendData.
SetHotkeyItem should properly remove the previous hotkey before setting the new one.
RemoveMeIR should work when called on an item without ExtendData.
EquipMe and UnEquipMe should work when called from the item object script.
All NVSE functions returning forms are explicitly declared as such. This should be proof read by someone 
I need to do the same for all vanilla commands.
Corrections to HealthPercent functions by jazzisparis
Fix to SetPackageLocationRadius, radius should be corrrectly set now.
Known issue:
EquipItem2 is broken in the sense that the item is equipped after EquipItem returns so which item is equipped is not detected 
So it is the same as EquipItem currently.
RunScript has been reported broken. Must be tested.
Changes:
Builtin objects preloaded are no longer reported as incomplete reads during the load of the cosave.
Rewrote type casting in IsRefInList. Hope to avoid reported CTD.
Activated showing faction rank names as part of %c in ExtractFormattedString. Should apply to all format specifiers functions.
Extract from OBSE documentation:
%c - replaced with the name of a component within another object. Takes two arguments - an object (ref) and the index of the component you want to access (short). Supported object types:
Faction - prints the male rank title of the nth rank.
NVSE already had support for AMMO (full names, short names or abreviation).
Calling GetFirstRef/GetNumRef with a cellDepth of -1 will use uGridsToLoad to calculate how many cells to scan.
TestExpr has been tested
IsPlayable is extended to weapon and ammo.
Added:
GetPerkRank:
Return actor Perk rank or -1 if the perk is not applied
[ref.]GetPerkRank [actor]
GetAltPerkRank:
Return the alternate companion Perk rank or -1 if the perk is not applied
[ref.]GetPerkRank [actor]
WARNING: those two functions can only apply to the player !
Get/SetEquipmentBipedMask:
GetEquipmentBipedMask returns which flags an armor uses.
SetEquipmentBipedMask sets which flags an armor uses.
The mask is a bitmask that should be build by using ClearBit/SetBit (see below).
The order of bit index for slots can be found in NVSE source files (GameForms.h, search for EBipedFlags).
4 = HasBackpack
8 = Medium Armor
32 = Power Armor
64 = Non playable
128 = HeavyArmor
Other bits are either unused or unknown.
GetRefs:
returns an array of references of a given type in the current cell
same syntax as GetFirstRef,
GetRefs [formType [cellDepth [includeTaken]]]
GetRefsInCell:
returns an array of references of a given type in the specified cell
same syntax as GetFirstRefInCell,
GetRefsInCell cell [formType [cellDepth [includeTaken]]]
IsPluginInstalled:
returns 1 if the specified plugin is installed, else 0
IsPluginInstalled pluginName
GetPluginVersion:
returns the version of the specified plugin, or -1 if the plugin is not installed
GetPluginVersion pluginName
Note: The plugin name is set by the plugin during registration and displayed in nvse.log, it is not the filename.
GetBaseNumFactions
Returns the count of factions of an actor baseform.
let iCount := [ref.]GetNumFactions [actor|character|creature]
GetBaseNthFaction
Returns the Nth faction of an actor baseform.
let rFaction := [ref.]GetNthFaction [actor|character|creature]
GetBaseNthRank
Returns the Nth rank of an actor baseform. Same order as GetBaseNthFaction.
let iRank := [ref.]GetNthRank [actor|character|creature]
GetNumRanks
Returns the number of ranks for a faction.
let iCount := GetNumRanks faction
A set of functions to extract embedded lists into arrays:
GetBaseSpellListSpells
GetBaseSpellListLevSpells // Tested but no data
GetBasePackages
GetBaseFactions
GetBaseRanks
GetActiveFactions
GetActiveRanks
GetFactionRankNames
GetFactionRankFemaleNames
GetRaceHairs
GetRaceEyes
GetHeadParts
GetLevCreatureRefs
GetLevCharacterRefs
GetListForms
Most rank functions require using the corresponding faction function to know which rank applies to which function (same index).
They all follow this calling logic:
let anArray_var := [ref.]GetXXX [form]
GetBasixXX and GetActiveXXX can be called on a ref (which must be an actor) or by passing an actor (or even an actorBase for GetBasixXX).
Others require passing the proper form as parameter.
GetNthDefaultForm // Not tested
Returns the form at index in the array of default forms.
The list of default form and their corresponding index can be found in GameForm.h (kDefaultObjectNames).
let rForm := GetNthDefaultForm formIndex
SetNthDefaultForm // Not tested
Sets the form at index in the array of default forms. !!There is no check that the new form is valid!!
The list of default form and their corresponding index can be found in GameForm.h (kDefaultObjectNames).
SetNthDefaultForm formIndex newForm
GetDefaultForms // Not tested
Return an array of all the default forms.
The list of default form and their corresponding index can be found in GameForm.h (kDefaultObjectNames).
let aArrayVar := GetDefaultForms
A "somewhat generic" set of functions to manipulate embedded lists of forms:
GenericAddForm: adds a form to a list of form of an object at index
let indexAddedAt := GenericAddForm whichEmbeddedList objectContainingTheEmbeddedList formToAdd index
GenericReplaceForm: change a form in a list of form of an object at index
let previousForm := GenericReplaceForm whichEmbeddedList objectContainingTheEmbeddedList replacingForm index
GenericDeleteForm: delete a form from a list of form of an object at index
let previousForm := GenericDeleteForm whichEmbeddedList objectContainingTheEmbeddedList index
GenericGetForm: returns a form from a list of form of an object at index
let currentForm := GenericGetForm whichEmbeddedList objectContainingTheEmbeddedList index
valid values for whichEmbeddedList are:
0 = Race Hair
1 = Race Eyes
5 = actor base (NPC or creature) package
6 = actor base spell
7 = actor base levelled spell
10 = NPC head part
13 = FormList form (redundant with existing functions )
index for end of list is -2
Imported from Console:
con_Inv // not tested
4.5 beta 06
Fixes:
Definition of Hairs and Eyes in TESRace.
InventoryRef functions should be fully functional now, including for the player inventory.
Plugin manager:
RegisterCommand will properly record the plugin opcodeBase.
RegisterTypeCommand will only provide an eval version when appropiate.
GetParentPlugin reports the correct answer for opcode 0.
GetModLocalData and GetAllModLocalData return types corrected.
Changes:
During reference variable evaluation, Player is replaced by PlayerRef when appropriate.
Proof of concept:
Different animations set and/or different skeleton. see TestAnim.txt in Data\nvse.
Added:
EquipItem2:
equips and runs onEquip block
[ActorRefID].EquipItemZ ObjectID:ref NoUnequipFlag:int{0, 1} HideEquipMessage:int{0, 1}
EquipMe:
equips the calling object on its owner
ref.EquipMe
UnequipMe:
unequips the calling object on its owner
ref.UnequipMe
IsEquipped:
returns 1 if the calling object is currently being worn
Currently, it must be called on an InventoryRef, though.
ref.IsEquipped
GetInvRefsForItem:
returns an array of temp refs to objects of the specified type in the calling container
(refs:Array) GetInvRefsForItem baseObject:ref
All 5 ported from OBSE.
SetHotkeyItem:
sets the item associated with a hotkey
(nothing) SetHotkeyItem whichHotkey:short item:ref
ClearHotkey:
clears the item associated with the specified hotkey.
(nothing) ClearHotkeyItem whichHotkey:short
Both ported from OBSE by Luthien Anarion.
PrintDebug or PrintD:
Version of Print that only display something if the script is in debug mode.
SetVariable:
Sets a numeric variable on a ref or a quest:
ref.SetVariable variableName variableValue
SetVariable variableName variableValue Quest
SetRefVariable:
Sets a form variable on a ref or a quest:
ref.SetRefVariable variableName anyForm
SetRefVariable variableName anyForm Quest
Get/SetStringIniSettings:
string_var GetStringIniSetting "settingGroup:settingName"
the : seems to be expected by the engine.
example: let s := GetStringIniSetting "sDPad:LANGUAGE"
SetStringIniSetting "settingGroup|settingName"
the | is coherent with the SetNumIniSettingsix
Imported from Console:
con_ShowVars (requires SetConsoleEcho 1 to be visible)
4.5 beta 05
Fixes: archive contains the actual corrections.
4.5 beta 04
Fixes:
Accounted for difference in the Reference class between Runtime and Editor.
This allows Let to use Reference.Variable without needing the compiler override.
GetRaceName should return a valid name now.
Changes:
Rewrote GetRace and GetRaceName to be more robust and accept either a ref or a baseForm as parameter.
4.5 beta 03
Fixes:
Looping through InventoryRef no longer removes existing extras when count is <=1
4.5 beta 02
Fixes:
Allows ErrorLogHook to have an integer parameter before the vfprintf format. (submitted by Queued)
EndVATScam:
Unselect any target and quit VATS mode. (ported from Queued)
4.5 beta 01
Fixes:
bad handling of $string_var name length
Changes:
User Defined Functions can have up to 15 parameters now (from 10 before).
Get/SetModelPath, GetPath functions when passed a reference, will operate on the reference's baseForm.
TESPackages identified as being safe to perma clone. Functionality still incomplete and not published. 
A few comments added or changed, or some typos corrected. Declared missing known virtual functions or found fields.
Previous changes
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta1.zip
whatsnew:
- MessageEx/MessageBoxEx
- SetNameEx
- IsClonedForm/TempCloneForm
-
GetParentCellOwner/GetOwningFactionRequiredRank/GetParentCellOwningFactionRequiredRank
-
fix loader misreporting when it can't find the editor
-
GetLocalRefIndex/BuildRef
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta2.zip
whatsnew:
- Menu*Key functions use buffered input like they should
- log
printc to IDebugLog in _DEBUG builds
- SetUIStringEx
- fix %k format
specifier
- fix DataHandler::DoAddForm (updated address then reverted it then
fixed it again)
- enable kWeapType_OneHandThrown type
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta3.zip
whatsnew:
- fix formlist params so they accept any form type
- fix
SetUIStringEx
- document new vegas parameter types
- %c format type can
print the different sub-names of ammo (0 = full name, 1 = short name, 2 =
abbreviation)
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta4.zip
whatsnew:
- full pass on all parameter types, fix lots of mistakes
- fixes
ListAddForm and other formlist things that were using ExtractArgsix
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta5.zip
whatsnew:
- Get/SetWeaponLongBursts
- SetWeaponFireRate
- long strings
should not crash the compiler any more
- overhaul dinput code
- added an
optional integer parameter to IsKeyPressed (default behavior unchanged, see
whatsnew.txt for details)
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta6.zip
whatsnew:
- access to weapon flags: Get/SetWeaponFlags1/2
- math functions
for setting individual bits (ClearBit/SetBit)
-
Get/SetActorBaseFlagsLow/High
- improve IsControlDisabled, cache now keeps
track of partially disabled keys
- ExtractArgsRaw, new internal function for
getting detailed information about passed-in arguments (not a scripting command,
only useful for C++ API stuff)
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta7.zip
whatsnew:
- fix GetCrosshairRef, other things relying on
InterfaceManager
- more helpful error message when using the updated CS
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta8.zip
whatsnew:
- fix crash when iterating over invalid form lists (generally a
sign that a mod needs to be updated, but crashing is bad)
- support for
editor 1.4.0.518
This patch was released at a slightly awkward time, so some mods relying on
the very strange behavior of the mouse functions may need to be updated.
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta9.zip
whatsnew:
- document new method of getting to NiNode
- fix
IsControlDisabled, tilde/escape
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta10.7z
whatsnew:
- support for German "no gore" runtime
- optionally hook
internal game error log
- fix crash in GetHotkeyItem,
SetWeaponRequiredSkill
- Get/SetEquippedWeaponModFlags
-
Get/SetWeaponItemModEffect/Value1/Value2
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta11.7z
whatsnew:
- fixed Get/SetWeaponItemModValue2
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_2_beta12.7z
whatsnew:
- made weapon mod indexing the same across all functions (1-based
instead of 0-based for backwards compatibility)
data-cke-saved-href="http://nvse.silverlock.org/beta/nvse_3_beta1.7z
whatsnew:
3 beta 02:
Added isNogore to NVSEinterface
Fixed
GetFactionRank (Report the exact rank and not 1 after SetFactionRank)
3 alpha 01:
New functions:
HasOwnership
checks
wether an NPC owns a reference or has the required faction rank to own said
reference
IsOwned
checks wether a reference is owned by
an NPC or that said NPC as the required faction rank to own the
reference
SetOwningFactionRequiredRank
set the owning
faction required
reference
GetDialogueSubject
Get the
subject reference in a converation. That is the reference who STARTED the
conversation, (subject of Hello/Greatings
topic)
GetDialogueTarget
Get the target reference in a
conversation. That is the reference who ANSWERS the conversation, (target
of Hello/Greatings topic)
GetDialogueSpeaker
Get the
current speaker in a conversation. That is the current subject in a
topic.
note: GetCurentPackageTarget does not provide
the other member of a conversation
reliably.
SetPackageLocationReference
Change
the target reference of a
package.
GetAgeClass
Classify the age of
the standard races: -1 undefined. 0 is Child, 1 is default, 2 is Old, 3 is
OldAged.
RemoveMeIR,
removes an inventory reference from its
container, optionally transferring it to a different container, in much the same
way as the vanilla RemoveMe command. The inventory reference becomes invalid
once this command is called and should no longer be used.
CopyIR
copies an inventory reference to the specified
container. The calling object needn't be in a container and remains valid after
the command is called. If the calling object is equipped, the copy will not be
equipped.
CreateTempRef
creates a
temporary reference to the specified form. This reference does not exist in the
gameworld or in a container, and remains valid for only one frame. It is mostly
useful for creating a stack of one or more items to be added to a container with
CopyIR
GetFirstRefForItem,
returns the first entry in an array
of temp refs to objects of the specified type in the calling container
GetNextRefForItem
returns the next entry in the array of
temp refs to objects of the specified type in the calling container
AddItemOwnership
Specifies the ownership info while
adding an
item
AddItemHealthPercentOwner
Specifies
both the ownership info and the health while adding an
item
"Token" functions: A token is an Item that can
only be present once in inventory, and must allow Health and Ownership. Most
likely created from an Armor with no biped slot so it can't be
equipped.
GetTokenValue, GetTV
Get the value of a
token
SetTokenValue, SetTV
Add or modify
the value of a token
GetTokenRef,
GetTR
Get the referenece of a
token
SetTokenRef, SetTR
Add or modify
the reference of a token
SetTokenValueAndRef,
SetTVR
Add or modify both the value and the reference of a
token
GetPaired
Detects if ref and actor
cross references each other (through item ownership). Usage for thinks like is
familly member, is partner of where there maybe multiple instances (n n
links)
GetRespawn
Checks the respawn
flag on Actor
SetRespawn
Sets the respawn flag on actor.
Effective on standard NPC, unreliable on
LevelledCharacters
GetPermanent
Checks the permanent
flag on Reference
SetPermanet
Sets the permanent flag on
Reference. Effective on standard NPC, unreliable on LevelledCharacters
GetBaseForm
Find the actual baseForm of a Levelled
form
IsRefInList
Checks whether a ref, its baseform or its
leveled baseForm is in a FormList
Changed
functions
TempCloneForm
IsClonedForm
Both
accept any Form as the source, rather than just 3D object to allow for cloning
of packages for example.
ListGetFormIndex
Eval version
of the function created
2 beta 14
- PluginApi extended to support:
* condition functions
in plugins.
* function alternate name in plugins using
DEFINE_COMMAND_ALT_PLUGIN.
* NVSECommandTableInterface (like OBSE).
2 beta 13
- PluginApi extended to support Messaging Interface (like OBSE).
Implemented messages are GameLoad and GameSave.
4.2 beta 04
Fixes:
GetUserTime properly returns an array now.
ListClear should try to do something now.
Pelinor's corrections to InventoryRef.
Changes:
Open/Close braces checks are added in the NVSE parser so that any extraneous closing brace will terminate the sub expression.
This way, said extraneous brace, and the rest of the line, will be then parsed by the GECK parser.
This should allow mixing NVSE expressions and standard expressions in the same source line.
(Please report any non override script that fails to compile once converted to the compiler override)
Provide a map file for runtime.
Port of (Set)IsPlayable from OBSE
IsPlayable returns wether an armor is usable by the player.
[ref.]IsPlayable [item:BipedModel]
SetIsPlayable Sets wether an armor is usable by the player.
[ref.]SetIsPlayable int:doSet [item:BipedModel]
GetEquipmentSlotsMask returns which slots an armor uses.
[ref.]GetEquipmentSlotsMask [item:BipedModel]
SetEquipmentSlotsMask sets which slots an armor uses.
The mask is a bitmask that should be build by using ClearBit/SetBit.
The order of bit index for slots can be found in the GECK (order in the list) or in NVSE source files (GameForms.h, search for EPartBit).
The first bit is at index 0
[ref.]SetEquipmentSlotsMask int:Bitmask [item:BipedModel]
SetConsoleEcho toggles wether the engine print to the console, required by con_SQV
Returns the current state
GetConsoleEcho checks wether the engine print to the console, uses no parameters.
con_SQV imports the console command ShowQuestVars, requires ConsoleEcho turned on, as in:
let oldEcho := SetConsoleEcho 1
con_SQV quest
SetConsoleEcho oldEcho
GetScopeModelPath returns the model path of the scope of a weapon
SetScopeModelPath sets the model path of the scope of a weapon
4.2 beta 3:
Port Heap management from SKSE originally by Sheson.
Set "DefaultHeapInitialAllocMB" in the "Memory" section of nvse_config.ini
Vanilla value is 200, hardcoded max value is <500. 400 has been reported functional, 500 induced CTD.
No ScrapHeap as there is'nt a single allocation but at least 6 with varrying sizes.
IsPlayerSwimming workaround IsSwimming returning false for the player
GetTFC returns wether or not Fly Camera is active
Port of the Algohol OBSE plugin by emtim:
V3Length returns length of given vector3
V3Normalize returns normalized vector3
V3Crossproduct returns crossproduct of two vectors
QFromEuler converts euler angles to quaternion. optional flag indicates if the angles came from an actor
QFromAxisAngle converts axis-angle rotation to quaternion
QNormalize returns normalized quaternion
QMultQuatQuat multiplies two quaternions
QMultQuatVector3 multiplies vector3 by quaternion
QInterpolate interpolates between two quaternions
QToEuler converts quaternion to euler angles. optional flag indicates the output will be used for rotating an actor
Cleanup default NVSE.log for release build.
Added logLevel management to nvse.ini.
Value logLevel in RELEASE or DEBUG section. Valid values are 0 (FatalError) to 5 (Debug), anything greater will be treated as 5.
Fixes:
RemoveScript, tests for unassigned pointer now.
Label/Goto return addresses assigned by script refID. So the same label can be used in a script and a user defined function.
Corrected the number of subprocedure called when setting a string_var. Applies to BipedPathFuncs and GetPath funcs
Corrected handling of $: Vanilla functions should recognise the $ parameter and the result should not be truncated to the variable nae size any more.
ianpatt's Windows 8 compatibility fix for steam_loader.
Update3D avoids the player due to camera issues.
Miscellanous:
Some comments and/or member renaming following save decoding or unfinished functions.
nvse_plugin_example updated.
4.2 beta 2
GetRace returns the race of an NPC
GetRaceName returns the name of the race of an NPC
con_SCOF imports the console command SCOF
PickOneOf returns a random item in the FormList that is present in the NPC inventory.
Version 3 of the messaging interface, providing alternate Delete/rename save event with the file name rather than the file path:
kMessage_DeleteGameName, // version of the messages sent with a save file name instead of a save file path.
kMessage_RenameGameName,
kMessage_RenameNewGameName,
Rename(s) will remain untested until someone knows how to rename a save in game
4.1b1 and earlier:
4.1 beta 01 mostly ports OBSE plugin events/strings/arrays/user functions/expressions and the relevant serialization
I tried to keep function names identical to OBSE, so I can refer directly to the OBSE online documentation. http://obse.silverlock.org/obse_command_doc.html
added variables to nvse_settings.ini to help control debugging without recompiling.
ported support for serialization/messages/strings/arrays... to the pluginAPI
messages available:
ExitGame exit to windows from main menu or in-game menu
ExitToMainMenu exit to main menu from in-game menu
LoadGame Dispatched immediately before plugin serialization callbacks invoked, after savegame has been read by Fallout
// dataLen: length of file path, data: char* file path of .fos savegame file
// Receipt of this message does not *guarantee* the serialization callback will be invoked
// as there may be no .nvse file associated with the savegame
SaveGame as above
Precompile EDITOR: Dispatched when the user attempts to save a script in the script editor.
// NVSE first does its pre-compile checks; if these pass the message is dispatched before
// the vanilla compiler does its own checks.
// data: ScriptBuffer* to the buffer representing the script under compilation
PreLoadGame dispatched immediately before savegame is read by Fallout
// dataLen: length of file path, data: char* file path of .ess savegame file
ExitGame_Console exit game using 'qqq' console command
PostLoadGame dispatched after an attempt to load a saved game has finished (the game's LoadGame() routine
//has returned). You will probably want to handle this event if your plugin uses a Preload callback
//as there is a chance that after that callback is invoked the game will encounter an error
//while loading the saved game (eg. corrupted save) which may require you to reset some of your
//plugin state.
//data: bool, true if game successfully loaded, false otherwise */
PostPostLoad sent right after kMessage_PostLoad to facilitate the correct dispatching/registering of messages/listeners
// plugins may register as listeners during the first callback while deferring dispatches until the next
RuntimeScriptError dispatched when an NVSE script error is encountered during runtime/
// data: char* errorMessageText
DeleteGame sent right before deleting the .nvse cosave and the .fos save.
// dataLen: length of file path, data: char* file path of .fos savegame file
RenameGame sent right before renaming the .nvse cosave and the .fos save.
// dataLen: length of old file path, data: char* old file path of .fos savegame file
// you are expected to save the data and wait for kMessage_RenameNewGame
RenameNewGame sent right after RenameGame.
// dataLen: length of new file path, data: char* new file path of .fos savegame file
NewGame sent right before iterating through plugins newGame.
// dataLen: 0, data: NULL
Some NPC functions:
SetEyes sets an NPCs eyes
[ref.]SetEyes eye:form [NPC:npc]
GetEyes gets an NPCs eyes
[ref.]GetEyes [NPC:npc]
SetHair sets an NPCs hair
[ref.]SetHair hair:form [NPC:npc]
GetHair gets an NPCs hair
[ref.]GetHair [NPC:npc]
GetHairLength sets an NPC hairLength (apparently unused, but still [:smile:] )
[ref.]GetHairLength [NPC:npc]
SetHairLength sets an NPC hairLength (apparently unused, but still [:smile:] )
[ref.]SetHairLength hairLength:float [NPC:npc]
GetHairColor gets an NPCs hair color (code: 1=Red, 2=Green, 3=Blue, other=color)
[ref.]GetHairColor hairColorCode:int [NPC:npc]
SetHairColor sets an NPCs hair color (color as RGB bytes)
[ref.]SetHairColor hairColor:int
GetNPCWeight gets an NPCs weight
[ref.]GetNPCWeight [NPC:npc]
SetNPCWeight sets an NPCs weight (no idea if that has any effect [:smile:] , the code seems to igore it for NPC (using height instead) but it is used for the PC)
[ref.]SetNPCWeight weight:float [NPC:npc]
GetNPCHeight gets an NPCs height
[ref.]GetNPCHeight [NPC:npc]
SetNPCHeight sets an NPCs height
[ref.]SetNPCHeight weight:float [NPC:npc]
To see the effect of any of those functions, you should call Update3D (But NOT on the player at the moment)
Update3D
patched ModFactionRank same issue as SetFactionRank, exact rank was not taken into account if modified on the reference.
some scripts functions from OBSE:
GetVariable looks up the value of a variable by name. If called on a reference, the ref must be scriptable, but not necessary a quest.
[ref.]GetVariable variableName:string [QUEST:quest]
HasVariable returns true if the script has a variable with the specified name
[ref.]HasVariable variableName:string [QUEST:quest]
GetRefVariable looks up the value of a ref variable by name
[ref.]GetRefVariable variableName:string [QUEST:quest]
GetArrayVariable looks up an array variable by name on the calling object or specified quest
[ref.]GetArrayVariable variableName:string [QUEST:quest]
CompareScripts returns true if the compiled scripts are identical
CompareScripts script:formID script:formID
ResetAllVariables sets all variables in a script to zero, unless called on a reference, apply to the calling script.
[ref.]ResetAllVariables
GetNumExplicitRefs returns the number of literal references in a script
GetNumExplicitRefs script:formID
GetNthExplicitRef returns the nth literal reference in a script
GetNthExplicitRef script:formID
RunScript
GetCurrentScript
GetCallingScript
OBSE expressions, see http://obse.silverlock.org/obse_command_doc.html#OBSE_Expressions
Let
eval
While
Loop
ForEach
Continue
Break
ToString (and $)
Print
testexpr (did I test that one ? Can't remember [:smile:] )
TypeOf
GetUserTime
GetModLocalData (verified ?)
SetModLocalData
OBSE user-defined functions, see http://obse.silverlock.org/obse_command_doc.html#User_Defined_Functions
Call
Function
SetFunctionValue
OBSE Array variables, see http://obse.silverlock.org/obse_command_doc.html#Array_Variables
ar_Construct
ar_Size
ar_Dump
ar_DumpID
ar_Erase
ar_Sort
ar_CustomSort (to be verified, had to wait for user functions and then forgot)
ar_SortAlpha
ar_Find
ar_First
ar_Last
ar_Next
ar_Prev
ar_Keys
ar_HasKey
ar_BadStringIndex
ar_BadNumericIndex
ar_Copy
ar_DeepCopy
ar_Null
ar_Resize
ar_Insert
ar_InsertRange
ar_Append
ar_List
ar_Map
ar_Range
OBSE String variables, see http://obse.silverlock.org/obse_command_doc.html#String_Variables
sv_Destruct
sv_Construct
sv_Set
sv_Compare
sv_Length
sv_Erase
sv_SubString
sv_ToNumeric
sv_Insert
sv_Count
sv_Find
sv_Replace
sv_GetChar
sv_Split
sv_Percentify
sv_ToUpper
sv_ToLower
IsLetter
IsDigit
IsPrintable
IsPunctuation
IsUpperCase
CharToAscii
ToUpper
ToLower
AsciiToChar
NumToHex
ToNumber
GetNthModName
GetName
GetKeyName
GetFormIDString
GetRawFormIDString
GetFalloutDirectory
ActorValueToString
ActorValueToStringC
GetModelPath
GetIconPath
GetBipedModelPath
GetBipedIconPath
GetTexturePath
SetModelPathEX
SetIconPathEX
SetBipedIconPathEX
SetBipedModelPathEX
SetTexturePath
GetNthFactionRankName
SetNthFactionRankNameEX
GetStringGameSetting
SetStringGameSettingEX
3 beta 05 again some package functions.
SetPackageTargetReference sets package target to the calling reference
[ref.]SetPackageTarget package:form [target:ref]
SetPackageTargetCount sets package target count or distance (alias is SetPackageTargetDistance)
SetPackageTargetCount package:form count:int
GetPackageTargetCount gets package target count or distance (alias is GetPackageTargetDistance)
GetPackageTargetCount package:form
SetPackageLocationRadius sets package start location radius
SetPackageLocationRadius package:form radius:float
GetPackageLocationRadius gets package start location radius
GetPackageLocationRadius package:form
3 beta 04 complements SetOpenKey
ClearOpenKey clears the key used to unlock the calling object (shows the lock has broken until unlocked).
ref.ClearOpenKey
3 beta 03 more package functions mainly.
SetOpenKey sets the key used to unlock the calling object
ref.SetOpenKey Key:formID
GetCurrentPackage gets the current package from an actor
[ref.]GetCurrentPackage [actor:ref]
GetPackageLocation gets package start location
GetPackageLocation package:form
The following, while called on a reference, runs on the reference baseForm
GetPackageCount gets the count of packages from an actor base form
[ref.]GetPackageCount [actor:ref]
GetNthPackage gets the Nth package from an actor base form (O is the package with the highest priority)
[ref.]GetNthPackage packageIndex:int [actor:ref]
SetNthPackage sets and returns the Nth package to an actor base form
[ref.]SetNthPackage package:form packageIndex:int [actor:ref]
AddPackageAt adds the Nth package to an actor base form : 0 at top, -1 at end, returns index
[ref.]AddPackageAt package:form packageIndex:int [actor:ref]
RemovePackageAt removes and returns the Nth package from an actor base form: -1 at end
[ref.]RemovePackageAt packageIndex:int [actor:ref]
RemoveAllPackages removes all packages from an actor base form, returns count removed
[ref.]RemoveAllPackages [actor:ref]
