Usage

Usage

Auto-Completion

Start typing in a .uc file and auto-completion should automatically try to help you.

Some relevant settings for auto-completion can be found here: configure

Sometimes the auto-completions are messed up or not correct. If this happens save your file and try again. If that doesn't work, rebuild the cache.

NOTE: If you delete a class file or add a .uc file to the src folder with another application, you need to rebuild your cache file.
This can be done using 'Tools' -> 'UnrealScript IDE: Rebuild Cache' or ctrl + shift + p -> search for 'rebuild cache' -> hit enter.
If you modify a class file inside another application, you need to open and save the file with Sublime Text 2 to register the changes.

Goto declaration

If you want to go to the declaration of the currently selected word (or the word that is located under your cursor) use either F10, Alt + LMB, right click menu, via 'Goto' -> 'UnrealScript Goto Declaration' or search it in the command palette.

UnrealScript IDE will remember from where you started browsing. If you want to come back to where you started, use one of the above again, when nothing is selected or the cursor is at the beginning of the line.

While browsing you can either go deeper by pressing F10 or 'UnrealScript Goto Declaration', or go deeper and set a new starting location to return to, with Alt + LMB or the right click menu

Build system

Use Ctrl + B, F7 or search in the command palette to build your game.

Build and Run
You can use Ctrl + Shift + B or Shift + F7 to use build and run. This will start your game with your last used configuration.

Build configuration
If you press Ctrl + Alt + B or Alt + F7 You see a screen with different build options to choose from. Per default you have: 32bit, 64bit, Debug 32bit and Debug 64bit.
You can edit and add your own configuration in the settings. If you build in debug, it will automatically install UnrealDebugger

Launch Game

By default, there are two launch configurations already provided.
A configuration to start a standalone game and one to start a server and two clients.

You can add your own and modify existing ones by opening a map and then choosing: 'Manage Configurations' or by modifying the settings

A complete overview of all available startup settings can be found here
DO NOT USE: editor, server, 127.0.0.1, yourmap.udk
For example, use "-ResX=1920 -ResY=1080 -fullscreen" for full-screen and HD
or use "-log" to display the log.

Debugger

UnrealDebugger will now be automatically installed when you build your game in debug mode. If you had another debugger (such as NFringe) installed before, it will preserve the shared dll (DebuggerInterface.dll).
You can uninstall UnrealDebugger through the command palette (ctrl+shift+p) by searching for "UnrealScriptIDE: Uninstall UnrealDebugger". This will restore the dll of your old debugger.

To use the Debugger, start your game with a debug configuration. Debug configurations will only show up if you built the game in debug mode before.

You can set breakpoints directly inside Sublime Text 2 by either using the right click menu or with the shortcut ctrl+. to toggle a breakpoint or ctrl+shift+. to deactivate a breakpoint.

You can get a list of all your breakpoints by using ctrl+shift+p -> "Manage Breakpoints" -> enter
From there you can navigate to each breakpoint, deactivate all at once, activate all or remove all
This can also be used as a bookmark manager, but of course Sublime already has that ;)

Settings

You can have a look and an explanation of each available setting under:

'Preferences' -> 'Package Settings' -> 'UnrealScriptIDE' -> 'Settings - Default'

Do not modify this file! (It wouldn't really hurt if you modify this file, but when UnrealScript IDE is updated (happens automatically), you would lose your changes)

Instead change the settings under:

'Preferences' -> 'Package Settings' -> 'UnrealScriptIDE' -> 'Settings - User'

e.g like this:

{
	"startup_configurations":
	{
		"One Server and Two Clients":
		[
			"SERVER: -ConsolePosX=600 -ConsolePosY=600",
			"CLIENT: -log -resx=800 -resy=600 -ConsolePosX=0 -ConsolePosY=600 -posx=0 -posy=0",
			"CLIENT: -log -resx=800 -resy=600 -ConsolePosX=1250 -ConsolePosY=600 -posx=1200 -posy=0"
		],
		"Standalone":
		[
			"CLIENT: -log -ResX=1280 -ResY=720 -nomoviestartup -ConsolePosX=0 -ConsolePosY=720 -posx=0 -posy=0"
		],
		"Standalone Fullscreen":
		[
			"CLIENT: -log -ResX=1920 -ResY=1080 -fullscreen -nomoviestartup"
		]
	}
}