SetScript

Revision as of 13:01, 24 January 2009 by imported>DuggeDank (→‎Notes)


A command for Oblivion Script Extender

Syntax:

(script:refID) reference.SetScript scriptID:ref targetObjectID:ref

Sets the specified script onto the calling object and returns any previous script.

Notes

  • Note that Oblivion doesn't have a script variable type so you must assign the script to a ref variable for this to work.
  • It seems that setting the script won't start it up. For instance, if you use player.SetScript rScript the script will be added to the player (player.GetScript will be rScript), but no blocks will run (tested GameMode, onHit, onMagicHit) and HasVariable will falsely return 0.
    • For some scripts, this isn't an issue. For instance, if you set a script to an item and then use LocalRef.AddItem Item 1 the script will run, because AddItem starts scripts.
    • In the case of the player, however, the only method to start the script is to open the console and type in player.ModAV Health 0, player.AddItem F 1 or even player with the dot player. Using the functions in a script won't start the script (even player.con HairTint 0 0 0)
    • Applying scripts directly to NPCs and creatures follow the same rules as when applying it to the player. However if you add a script to an actor without knowing the editorID beforehand RunBatchScript will not work. Use RunScriptLine instead.
  • As with all non-cloneform items, when you reload a game the script ref will be reset. If the object didn't have a script, then it won't have a script when you reload. If it had a different script, then it will have the different script once again.
    • There is an exception - when reloading a save game in the same area. For instance, if, in your save game, the player doesn't have a script, then you set a script on the player, then reload -> the script will still be on the player.

See Also