SetDescription
Revision as of 11:28, 27 June 2015 by imported>QQuix (Added a note and 'see also')
< [[::Category:Functions|Category:Functions]]
A function added by the Oblivion Script Extender.
Syntax:
(success:bool) reference.SetDescription description:string form:ref skillLevel:short
Modifies the text of a TESDescription (e.g. book, class, skill, skill level, etc). The modified description will be used for the remainder of the game session. To modify the text displayed when achieving a new level of mastery (Apprentice, Journeyman, etc) in a skill, pass the skill as the second argument and a skill level as the third, where skill level ranges from 0 (Apprentice) to 3 (Master).
Example
SetDescription "You are like a freaking NINJA! I shall bow down and call you Master" SkillSneak 3 ; Master
Modifies the description of a skill (SkillSneak) when achieving the Master rank in it. Note the syntax of using SkillSneak (which is the skill details), not just Sneak (which is the actor value).
Notes
- For books, setting a description longer than 65535 characters crashes the game when the book is opened in game.