zinggi / unrealscriptide

Auto-completion, Syntax Highlighting, Go to Declaration, Build and Run and more..

UnrealScript IDE Plug-in for Sublime Text 2/3

UnrealScript IDE adds many features to Sublime Text 2/3 that you'd expect from a good UnrealScript IDE.
Fully featured object-oriented auto-completion, go to declaration, syntax highlighting, build and run, snippets and some more to name a few...

Features

• Dynamic, intelligent auto-completions

  • fully object-oriented completions
  • context sensitive completions (e.g. in the defaultproperties block you only want to get variables)
  • content assist. You wont have to open the editor anymore to search for asset names.
  • parameter hints
  • display documentation when you need it
  • completions feel like the great Sublime Text 2/3 snippets

• Go to declaration and back again

  • object-oriented go to declaration (pressing it over controller.GetPlayerViewPoint(a, b) will take you to the declaration of GetPlayerViewPoint in Controller)
  • go to the declaration of the currently selected word via F10, alt + left click, right click menu, 'Goto' -> 'UnrealScript Goto Declaration' or search for it in in the command palette
  • when browsing in the declarations you can always return to your starting position by using one of the above keys when nothing is under your cursor.

• Debugger

  • UnrealScript IDE comes with UnrealDebugger integrated.
  • You can set breakpoints directly inside Sublime Text 2/3
  • more information

• Syntax highlighting

  • For .uc files and .log files

• Build system

  • to build your game use Ctrl + B, F7 or search for it in the command palette.
  • if the build contains errors, the error log will be opened, allowing you to navigate to your errors quickly.
  • if the build was successful, the game will start

• Launch Game

  • quickly open the game with your last configuration
  • you can chose which map to open
  • chose between Standalone or a Server and 2 Clients or add any other configuration you might like
  • more information

• Various useful Snippets

  • predefined Snippets for standard classes, and language features such as defaultproperties

• Add bookmarks to your comments

  • to add a bookmark write your comments like this: // ! text or /** ! text*/
  • navigate to them quickly via Ctrl + R

• More coming...

Planned

• Add support for enumerations

• Your suggestion here?

  • You can suggest features, report bugs and vote for features on this site here: UnrealScript IDE - Userecho

Installation

Very easy with Package Control right inside Sublime Text 2/3 (Package Control needs to be installed):

1. Ctrl + shift + P
2. Search for "install", hit enter
3. Search for "UnrealScriptIDE", hit enter

For a more in detail explanation visit the wiki: https://github.com/Zinggi/UnrealScriptIDE/wiki/Getting-Started

Manually (not recommended):

1. Clone or download this package
2. Put it into your Packages directory (find using 'Preferences' -> 'Browse Packages...')

please note:

UnrealScriptIDE will only work properly if you add the Src folder as a project.
To do so, goto 'Project' -> 'Add Folder To Project...' -> add the Src folder (/UDK/UDK-201*-**/Development/Src/)

Usage

Please refer to the wiki: https://github.com/Zinggi/UnrealScriptIDE/wiki

---

All credits for UnrealDebugger goes to Carlos Lopez. Huge Thanks!
All credits for various Snippets (and also for the old (now unused) Syntax highlighting file) goes to Michael Alexander. Thanks!
All credits for Syntax highlighting in UnrealScript files goes to Rokit and Eliot. Thanks!
Credits for Syntax highlighting in Log files goes to Rokit. Thanks!

If UnrealScriptIDE is helpfull to you, please consider making a donation. (Especially when you're using it commercially)
Thanks!

My auto-complete settings

Here are some relevant settings for auto-completion that I've found quite helpful:

{
	"auto_complete_with_fields": true,	//this allows auto-completion inside snippets.
	"auto_complete_triggers":	//this activates auto-completion on '.'
	[
		{
			"characters": ".",
			"selector": "source.unrealscript"
		}
	],
	"auto_complete_delay": 0,
	"auto_complete_commit_on_tab": true,	// I prefer 'tab' to 'enter'
}

---

License

UnrealScript IDE Plug-in for Sublime Text 2/3 Copyright (C) 2013 Florian Zinggeler

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

unrealscriptide's Issues

Any plans to support Sublime Text 3?

Autocompletion is not working

No matter what I do it doesn't work!
And when I add your code into my settings it tells me there's an error or something and if I put a coma at the end it doesn't show the error, I'm talking about this:
{
"auto_complete_with_fields": true, //this allows auto-completion inside snippets.
"auto_complete_triggers": //this activates auto-completion on '.' and '('
[
{
"characters": ".(",
"selector": "source.unrealscript"
}
],
"auto_complete_delay": 0,
"auto_complete_commit_on_tab": true // I prefer 'tab' to 'enter'
}

Where is the Src directory you mention?

I'm on OSX, and I am assuming you are talking about the Unreal sources from GIT not my project sources. The doc mentions some glorious folder named UDK*, however I have no such folder and there isn't a folder structure like that on the Mac as far as I can tell.

Where is this magical folder????????

Snippets and caps

All your snippets seem to complete to capitalized keywords could you have an option to complete non-capitalized keywords? For exmaple if I start with a non-capitalized letter of a keyword such as DefaultProperties could you make it complete to defaultproperties and vice versa?

GameInfo in launch config

Hello guys, how can I set my GameInfo class to work with in UnrealScriptIDE?

thanks.

'Tooltip' word causes syntax error

In my code I notice that the use of a variable named "ToolTip" would cause an error in the syntax detection and color the rest of the code as a String. Let's say, in this example, the first apostrophe would not be detected and then the semicolon and "//bar" appear to bee in a string.

ToolTip = new class'Foo';
//bar'bar

Crash on OnlineSubsystemSteamworks.uc

There seems to be a major bug when you try to open:
"Development/Src/OnlineSubsystemSteamworks/Classes/OnlineSubsystemSteamworks.uc"

Sublime just crashes.

My guess is that there is some regex in the .tmLanguage file that is stuck in an infinite loop.

Why am I pretty sure that it's the .tmLanguage file that's causing it?

Well with ST3, it tries to index the files for its new goto definition feature, but gets stuck at this file, reporting: "worker 2448 appears stuck while processing file /C/UDK/UDK-2013-02/Development/Src/OnlineSubsystemSteamworks/Classes/OnlineSubsystemSteamworks.uc, killing process"

Also there seems to be other evidence that that might be the issue:
http://www.sublimetext.com/forum/viewtopic.php?f=3&t=671

Since you know the ins and outs of this file, could you have a look at it, @EliotVU ?

How to disable auto-completion with 'tab'?

Good day. I'm having issues with tab key, which frequently autocompletes a statement, instead of inserting a \t character. I've tried disabling it in UnrealScriptIDE.sublime-settings via "auto_complete_commit_on_tab": false and "auto_complete_with_fields": false options, but without any luck.
I've also tried changing user keymap to

[
	{
		"keys": ["tab"],
		"command": "", 
		...
	}
]

But that didn't help as well. Any suggestions?

Super snippet idea

You know it would be awesome to implement a Super snippet so basically when typing this:

protected function InitializeComponent()
{
super
}

it would complete to:

protected function InitializeComponent()
{
super.InitializeComponent();
}

including parameters if available.

losmac

Script compilation fails if compiling_configurations settings only have one parameter

To repro:

Open UnrealScriptIDE.sublime-settings and modify the following:

"Standard 32bit":
[
"Win32\UDK.com",
"-unattended"
],

to:

"Standard 32bit":
[
"Win32\UDK.com"
],

When you compile this configuration you should fail with the following error:

Exception in thread Thread-8476:
Traceback (most recent call last):
File ".\threading.py", line 532, in __bootstrap_inner
File ".\UnrealBuildSystem.py", line 489, in run
IndexError: list index out of range

Looking at the Python script it appears this is happening in the print statement as it expects multiple entries in the array or so I'm guessing since I don't know Python ;)

    print "compiling with: " + self._collector.compile_settings[0] + " and " + self._collector.compile_settings[1]

If that's the case, then I would imagine the next line of code would fail as well as it references the same array/list index.

Also, I see that the Python script appends "-unattended". Why is this necessary since you could just define this in the settings file? It seems like this should be removed.

Thanks again for all the time and effort you have put into this!

-scottv

Build

After using your build tool it stopped working(although it only worked half of the time before that!)

I get this log:
/C C:\UDK\UDK-2013-02-LC\Binaries\Win32\UDK.com make -debug -unattended
everything's fine!
Traceback (most recent call last):
File ".\UnrealBuildSystem.py", line 140, in
File ".\UnrealBuildSystem.py", line 155, in handle_thread
File ".\UnrealBuildSystem.py", line 185, in show_error_panel
File ".\UnrealBuildSystem.py", line 463, in get_summery
ValueError: list.index(x): x not in list

And nothing happens after.

Also CTRL+B does nothing all, and if warnings are thrown by the compiler it won't launch map, have to click again.