-------------------------------------------------
Oblivion Script Definitions for Notepad++
-------------------------------------------------
by misterMcCoonie
Created: March 2009
Latest: April 2010
LatestVersion: v1.8

-------------------------------------------------
Requirements:
-------------------------------------------------
Notepad++

-------------------------------------------------
Description:
-------------------------------------------------
This mod is simply a script highlighting definitions file for Notepad++ for TES4: Oblivion scripts. There are a fair few of these on the nexus, but I couldn't find a complete one, so I made one. The definitions include the following:

-Construction Set v1.0.303 functions and their aliases
-Construction Set v1.2.404 functions and their aliases
-OBSE v18 (and all previous versions) functions and aliases
-OBSE Plugin for the Logitech G15 LCD v1.8
-Oblivion EAX v0.7 beta 2
-Pluggy v124 (no new functions in v125b)
-SoundCommands v4.0
-ALGOHOL v0.11
-Tibixe's String Function Collection (TSFC) v0.5
-Enhanced Music & Control v0.72B
-NifScript v0.9

Ideally, I'll update the definitions when the above listed items change version, but I may not know immediately when they update, so if you'd like a quicker update, PM me and let me know what's been updated.

The syntax highlighting is as follows:

-Construction Set v1.0.303 functions, aliases, if blocks, variable declarations, block types, and special variables are in blue
-Construction Set v1.2.404 functions and aliases are in light blue
-Begin/End and ;snip/;snipend blocks are in burgundy
-OBSE functions are in red
-OBSE plugin functions are in gold
-Comments are in grey
-Numbers are in orange
-Operators (including comparators, the dot, and OBSE operators) are in violet
-Text delimited by double quote marks is in green

You can create custom collapsible blocks of code by starting the block with ;snip, and ending it with ;snipend. This doesn't affect the functionality of the script in any way, just readability. I'm not the one that originally implemented this capability, I'm just carrying on the capability from definition files which are no longer updated.
For example, the following code can all be collapsed into the first line when you don't want to see the rest:

If somecondition;snip
do something...
.
.
.
EndIf;snipend

There are two versions included in the download. One is for use on white backgrounds, and the other is for black backgrounds. The white on black will only look good if you have configured Notepad++ to have a black background by default.

If there are any other OBSE plugins you'd like to see included in these definitions, please let me know.

**************************
USAGE:
**************************

Select 'Oblivion Script' from the 'Language' menu in Notepad++ to have the highlighting take effect. To have Notepad++ automatically recognize Oblivion scripts, save your scripts with a .es4 extension. You can also configure integration with Windows to open .es4 files when double clicked. I recommend saving your scripts as scriptname.txt.es4 to make Notepad++ recognize the script type, as well as remind YOU that an .es4 file is just a text format file.

-------------------------------------------------
Installation:
-------------------------------------------------
STANDARD:
*NOTE: Step 1 is different for different operating systems.
(Windows 2000/XP)
1. Unpack the archive and copy userDefineLang.xml to %SystemDrive%\Documents and Settings\%username%\Application Data\Notepad++ (where %SystemDrive% is the drive Windows is installed on, and %username% is the username of the user that is currently logged in)
(Windows Vista/7)
1. Unpack the archive and copy userDefineLang.xml to %SystemDrive%\Users\%username%\AppData\Roaming\Notepad++ (where %SystemDrive% is the drive Windows is installed on, and %username% is the username of the user that is currently logged in)
2. If a userDefineLang.xml already exists, open both with Notepad++ and copy the contents of one file into the other, so that the files are merged (do not overwrite other content)

-------------------------------------------------
Uninstallation:
-------------------------------------------------
STANDARD:
1. Delete the userDefinelang.xml file
**OR**
1. If you merged the file originally, remove the extra data from this file from your userDefineLang.xml file

-------------------------------------------------
Compatibility:
-------------------------------------------------
N/A

-------------------------------------------------
Known Bugs:
-------------------------------------------------
<none><br><br>Please send bugs/problems/issues to me, and I'll do what I can.<br><br>-------------------------------------------------<br>Version History:<br>-------------------------------------------------<br><br>1.0 - Initial release<br>1.1 - Added all the OBSE aliases I could find<br><span class="wbbtab"></span> - Added support for Enhanced Music &amp; Control OBSE plugin v0.72B<br><span class="wbbtab"></span> - IsUpper renamed to IsUpperCase, command was misdocumented in OBSE<br>1.2 - Added new functions from Pluggy v124<br><span class="wbbtab"></span> - Added new functions from OBSE v0017<br><span class="wbbtab"></span> - Added Pluggy HUD functions, which aren't documented<br><span class="wbbtab"></span> - Added all other undocumented Pluggy functions<br><span class="wbbtab"></span> - Added OnPackageEnd alias for OnPackageDone, which I missed<br><span class="wbbtab"></span> - Added SetPlayerSpell, which is undocumented on the CS Wiki<br><span class="wbbtab"></span> - Added OBSE deprecated functions, since it's conceivable you might be using an old version of OBSE<br><span class="wbbtab"></span> - Added every other OBSE function and alias that was still missing (to my knowledge)<br>1.3 - Added new functions from OBSE v0017 beta 2<br><span class="wbbtab"></span> - Added the AVString alias, which I missed last time<br><span class="wbbtab"></span> - Added the ability to create custom collapsible blocks with ;snip and ;snipend<br><span class="wbbtab"></span> - Added special global variables GameYear, GameMonth, GameDay, GameHour, TimeScale, and GameDaysPassed<br><span class="wbbtab"></span> - Added special local variables fQuestDelayTime, fTrapDamage, fTrapPushBack, fTrapMinVelocity, and bTrapContinuous<br>1.4 - Added new functions from public release of OBSE v0017<br>1.5 - Added support for NifScript v0.9<br><span class="wbbtab"></span> - Added '$'to the list of operators to reflect its use in OBSE v0017<br>1.6 - Added new functions from OBSE v0018 Beta 1<br><span class="wbbtab"></span> - Added the SetCombatStylePowerAttackFatigueModMult functions, which I somehow missed previously<br>1.7 - Added new functions from OBSE v0018 betas 2, 3, and 4<br>1.8 - Added new functions and aliases from the public release of OBSE v0018<br><span class="wbbtab"></span> - Added aliases which I missed: StringAV, OLMPOR, and GetWorldParentWorld<br><br>-------------------------------------------------<br>Future Plans:<br>-------------------------------------------------<br>-I'd like to keep this up to date for all versions of OBSE<br><br>Bug fixes and requests as usual.<br><br>-------------------------------------------------<br>Credits / Legal / Use:<br>-------------------------------------------------<br>The creators of Notepad++<br>Everyone else that wrote definition files (which prompted me to write this)<br>The modder who originally implemented the ;snip/;snipend structure<br><br>Additions:<br><none><br><br>You may use all parts of this mod freely in any of your own mods, as long as you distribute your mod for free, since this is free. Also, you might let me know when it's done (I might want to try it out :) ). A little citation would be nice, but not required.<br><br>DISCLAIMER: I am not responsible for any damages caused to person or property as a result of this mod. I test all of my mods before releasing, and rest assured I do not create mods with malicious intent.<br><br>/misterMcCoonie<br>/Oblivion Script Definitions for Notepad++</none></none>