[RELz] Script Syntax Highlighter for Notepad++ : Fallout 3

» Sat May 28, 2011 9:48 am

http://www.fallout3nexus.com/downloads/file.php?id=10322

http://www.fallout3nexus.com/downloads/images/10322-1-1260438684.png

I've had a Fallout 3 syntax highlighter for Notepad++ lying around my hard drive for nearly a year now, being slowly updated as I use it. An old version has been available for some time via my user page on the GECK Wiki, but I figured it was about time I did a proper release for it so I've uploaded it to Fallout 3 Nexus.

NTRODUCTION:

This Fallout 3 Script Syntax Highlighter for Notepad++ allows you to write and edit scripts for Fallout 3 more easily in Notepad++ by applying syntax highlighting to make them easier to read, as well as making Begin/End blocks and blocks of conditional statements collapsible.

Files with the extension of *.fo3 (for example, "MyScript.fo3") will automatically be highlighted appropriately by Notepad++ when opened. You can change this or add new file extensions in Notepad++'s User-Defined Language dialogue box.

Functions from the GECK v1.1.0.36 and FOSE v1.2 are included in this syntax highlighter.

REQUIREMENTS:

In order to use this syntax highlighter, you must use Notepad++ to edit your scripts. You can download the latest version of Notepad++ from the Notepad++ website:
- http://sourceforge.net/projects/notepad-plus/files/

If you find this syntax highlighter not to your taste, there is an alternate syntax highlighter for Notepad++ available, created by reinhart_menken, available on Fallout 3 Nexus:
- http://www.fallout3nexus.com/downloads/file.php?id=2472

INSTALL:

To install this Fallout 3 Script Syntax Highlighter for Notepad++, you must locate the directory in which Notepad++'s configuration files are located, and place the UserDefineLang.xml file that you've downloaded in that directory. The fastest way to find this directory is to open up Windows' command line interface (use the "cmd" command in the Run box) and type the following:

cd %APPDATA%\Notepad

Press enter, and the appropriate directory will be displayed to the left of the command prompt.

If there is already a UserDefineLang.xml file here, then you'll need to copy the information (except for the tags) from this UserDefineLang.xml file into the already existing one.

UNINSTALL:

To uninstall this Fallout 3 Script Syntax Highlighter for Notepad++, simply delete the UserDefineLang.xml file that you placed in the configuration directory when installing.

If, when installing, you had to manually copy the data from one UserDefineLang.xml file into another, you'll want to open up the file and delete just that data, rather than the file itself.

CHANGE LOG:

v1.0 - Initial release

v1.1 - Fixed typo - "SetUIFloatSetUIString" to "SetUIFloat SetUIString"

v1.2 - Fixed typos - "CrtitChance" to "CritChance", "SetPCToddle" to "SetPCToddler" and "GetMinRangeGetWeaponMaxRange" to "GetMinRange GetWeaponMaxRange". Added new functions from the GECK v1.5.0.19

v1.3 - Added functions from FOSE v1.2 (26 in total)

PERMISSION:

Please don't upload this Fallout 3 Script Syntax Highlighter for Notepad++ anywhere without asking my permission. However, feel free to use it to make your own syntax highlighter without asking my permission.

If you wish to use keyword lists or anything else that you find in this Fallout 3 Script Syntax Highlighter for Notepad++, feel free to do so without asking my permission.

Feel free to use this readme as a template to make your own.

CREDITS:

Thanks to the FOSE team for FOSE
Thanks to Bethesda Games Studios for Fallout 3 and for the GECK
Thanks to Drayk_Cannon for contacting me about the missing functions and typos fixed in v1.2
This syntax highlighter was made by Mark Hanna, a.k.a. Cipscis

CONTACT DETAILS:

If you find any mistakes (there are probably some typos still in there) please let me know so I can fix them
You can contact me via PM on the Bethesda Games Studios Forums as Cipscis
You can contact me via PM on the Nexus Forums as Cipscis
You can email me at http://mailto:mark@cipscis.com

If anyone has any suggestions (or finds any mistakes) please let me know! I've slowly been getting rid of typos over the year but I haven't used every function so there may be a couple left in the more obscure functions.

Cipscis

EDIT:

Updated to v1.1

Cipscis

EDIT:

Updated to v1.2

Cipscis

EDIT:

Updated to v1.3

Cipscis

» Sat May 28, 2011 5:25 pm

Another masterpiece, I'm sure, Cipscis. I'm downloading and trying it out right now. :goodjob:

» Sat May 28, 2011 4:00 pm

I'm gonna try this tonight, I Live in Notepad++.

Thank you!

Miax

» Sat May 28, 2011 2:58 am

Cool, just what I need as I work on my http://www.gamesas.com/bgsforums/index.php?showtopic=1061050.

Thank you!

» Sat May 28, 2011 5:23 pm

Thank You Thank You Thank You

I've had a heck of a time trying to write scripts and this would be most helpful. (I once used the command "event.change" in GECK script!)

so again Thank you.

» Sat May 28, 2011 6:38 am

Thanks everyone for your kind words, I hope you find it useful. I've just spotted and fixed a typo affecting FOSE's http://fose.silverlock.org/fose_command_doc.html#SetUIFloat and http://fose.silverlock.org/fose_command_doc.html#SetUIString functions, so I've updated the syntax highlighter to v1.1

Cipscis

» Sat May 28, 2011 4:23 pm

Thanks to Drayk_Cannon for pointing out several typos and missing functions from the GECK v1.5.0.19 to me, I've now updated the syntax highlighter to v1.2:

- Fixed typos - "CrtitChance" to "CritChance", "SetPCToddle" to "SetPCToddler" and "GetMinRangeGetWeaponMaxRange" to "GetMinRange GetWeaponMaxRange"
- Added new functions from the GECK v1.5.0.19

Cipscis

» Sat May 28, 2011 6:26 am

Would it be possible to update this to include all the functions from FOSE v1.2? I know that not all are documented though.

» Sat May 28, 2011 10:04 am

Would it be possible to update this to include all the functions from FOSE v1.2? I know that not all are documented though.

If you have Vista, you can go to folder options and set it to show hidden files. Then you can edit this file and add them: C:\Users\YourUserName\AppData\Roaming\Notepad++\userDefineLang.xml

I found a list of new commands yesterday from a post:

Here are some not overly great docs for the commands added since the last documentation update (since 1.1)float form.GetCurrentHealth() - returns the health of formvoid SetCurrentHealth(float health, ref form) - sets the health of a formfloat Rand(float min, float max) - returns a random value between min and maxint form.GetNumItems() - returns the number of items in a containerref form.GetInventoryObject(int idx) - returns the type of the specified item in the containerint form.GetRefCount() - returns the number of items in a stackvoid form.SetRefCount(int count) - sets the number of items in a stackfloat Pow(float a, float B) - returns a ^ b (b does not need to be an integer)int form.IsQuestItem(ref obj = NULL) - returns if form (or obj if present) is a quest itemvoid form.SetQuestItem(int arg, ref obj) - sets if form/obj is a quest itemint form.IsOffLimits(ref actor) - returns if the specified door is off-limits to the actor (note: apparently not 100% reliable for the player yet)ref form.GetParentCellOwner() - returns a ref to form's parent cellref form.GetOwner() - returns a ref to form's ownerint form.GetOwningFactionRequiredRank() - returns the rank someone must be of the owning faction to be considered an owner of formint form.GetOwningFactionRequiredRank() - returns the rank someone must be of the owning faction to be considered an owner of form's parent cellref GetCurrentQuest() - returns the current questref GetCurrentObjective() - returns the current objectiveint GetQuestObjectiveCount(ref quest) - returns the number of objectives for the specified questref GetNthQuestObjective(ref quest, int idx) - returns the specified objective of the specified questvoid SetCurrentQuest(ref quest) - sets the player's current questint form.IsPersistent() - returns if form is persistentint form.SetEyes(ref eyes, ref target = NULL) - sets the eyes of form (or target if specified)int form.SetHair(ref hair, ref target = NULL) - sets the hair of form (or target ir specified)int form.SetHairLength(float length, ref target = NULL) - sets the hair length of form (or target if specified)ref form.GetEyes(ref target = NULL) - gets the eyes of form (or target if specified)ref form.GetHair(ref target = NULL) - gets the hair of form (or target if specified)float form.GetHairLength(ref target = NULL) - gets the hair length of form (or target if specified)

» Sat May 28, 2011 5:41 am

I've just updated the syntax highlighter to include the functions that RickerHK listed in his post. "GetOwningFactionRequiredRank" is doubled up there, although there are two different descriptions, so I think one FOSE v1.2 function is missing from the highlighter because I don't know what it's called.

Cipscis