Difference between revisions of "User:00zX"

jEdit is a powerful, cross platform, java based programmers text editor.

Edit Modes

jEdit uses what is called edit modes, these specify:

• Syntax highlighting rules
• Auto indent behavior
• Various other customizations for editing a certain filetype

These edit modes are easily installed an updated, they use the XML language and jEdits own document type definition for modes (xmode.dtd). More information on edit modes can be found within jEdits Help section along with a section on writing edit modes so you can customize jEdits UScript mode to your liking.

Setting jEdits Mode

By default jEdit comes with a UScript mode which can be located in the {jEdit Home Directory}\Modes this edit mode is very light weight and doesnt cover all engine versions.

Im going to recommend not using this directory if you plan to modify your edit mode or use one of the custom ones provided below, the reason for this is simpler backups when using the document directory.

On jEdits main toolbar you will find the utilities button, under that is the global options which contains the options for all edit modes. Syntax highlighting colours can be found in here also.

Wormbo's UScript jEdit Mode

My modified UScript jEdit Mode

Recommended Plugins

• Project Viewer: Usability.
• Buffer Tabs: Usability.
• Dirty Gutter: Diff.
• TaskList: TODO, NOTE, FIXME's
• Text Autocomplete: Usability - Code Completion.
• Ant Plugin: Build script for UDK with ant.
• WhiteSpace: Usability/Readability.

• Others: Code folding

Plugin Installation and Settings

jEdits Plugin Manager and Settings can be accessed through the Plugins button on the main toolbar (show picture).

To install new plugins, click on the plugin manager and you will notice a tab up the top of the new window which says install (show picture).

Navigate to this and select the checkboxes for all plugins you wish to install then hit install in the lower left of the panel.

The plugin settings can be found under the Plugins/Plugin Option button on jEdits main toolbar at the top.

Creating your first Project

In this part of the tutorial we will be creating a project using jEdit and Project Viewer.

First off I prefer to have the project viewer docked on the left hand side of jEdit, you can however put it anywhere you wish to place it.

Right click on All Projects which you should see in your project viewer, add a new group (this is a recommendation), this will help to keep all your UScript UT3/UDK etc seperate from any other projects you may wish to create. I have a group named UE3 for example, then under that group I have UT3 and UDK to house each of the projects I have for each.

Once you have your groups setup to your liking you are ready to create a project, this will require that you have a directory to scan for source files within.

Lets create a directory, as examples I'll use UT3 and UDK but you can find information on various UE games directory structures here on the wiki.

Directory Structure and creating Package Folders

Firstly you'll need to have an understanding of Unreal Engines directory structure, from there you will be able to create the required folders for packages so you can compile the *.UC files into a package file. For Unreal Script Classes (*.UC files) you will need to first make the package's folder and then the Classes folder. The following eg shows the package folders being:

UT2004 - All UT2004 source can be located under the {Drive}:\{UT2004 Dir}\System Directory so you would create a new directory containing the directory classes in there.

UT3 - For UT3 you create a folder in the {Drive}:\{User Folder}\{Documents}\My Games\Unreal Tournament 3\UTGame\Src directory also containing the directory classes.

UDK - For UDK you create a folder in the {Drive}:\UDK\{UDK-Version}\Development\Src directory.

So you should have a directory structure like:

UT2004 - {Drive}:\{UT2004}\System\{Your Package}\Classes

UT3 - {Drive}:\{User Folder}\{Documents}\My Games\Unreal Tournament 3\UTGame\Src\{Your Package}\Classes

UDK - {Drive}:\UDK\{UDK-Version}\Development\Src\{Your Package}\Classes

Right click on the group you wish to create the project within, click Add Project. This will display the create project dialogs (show Picture) Select a name and the root directory for you project, for now select {Your Package} directory. Or alternatively if you wish to use multiple package's for your project you may add the {base source directory}, you will however need to filter the imported folders so that only the ones you require for your project are displayed.

Project Viewer would now have selected the project for you, you can navigate back to all projects using the drop down box at the top of Project Viewer.

Creating your first Class

Go to file in jEdits main toolbar and select new. Copy/Paste this template unreal script class to the file, then save the file as {Your Package}\Classes\YourClass.uc

class YourClass extends Mutator;
 
function InitMutator(string Options, out string ErrorMessage)
{
	`log("I am your mutator",,'mutator');
}

You'll notice that Project Viewer doesnt automatically scan for new classes unless it has been selected to do so. Right click on your project in the Project Viewer panel and select 'Re-import files'. Make sure the Project and Classes directories are expanded and you should now see {Your Class} in there.

More on jEdit Modes

Creating a customized template an macro for creating a new class based on this template.

Customizing Project Viewer

Specialized section on setting up Project Viewer's context (Right Click) menu to contain a create class button which will create a class based on a UScript template.

You may skip to Compiling at this point.

This is basically a must have application for anyone doing UScript unless ofcoarse you opt to use other IDE's which contain their own class browsers. Personally I think UnCodeX is still the best out there and its quick with minimal overhead.

There are two versions of UnCodeX that I use, I prefer using the older 227 for anything pre-UE3 or TribesV for those I use the newer 237-beta version.

Setting Up UnCodex

Working with multiple copies of unreal engine source (for example, numerous UDK copies) can be tedious to continuously analyze all the time in UnCodex so I'll guide you through setting it up so you can have numerous shortcuts all which cache different versions of Unreal Engine. You have to be careful however, this can get confusing as to which copy is in which UnCodeX window but you can double check the title bar, which I highly recommend you do. I have been caught out a few times with this myself between UT3 and UDK sources.

As a general rule of thumb I just use the naming convention:
"Drive:\{UnCodeX}\UnCodeX.exe" -config UnCodeX-{GameName/Version}.ini

UT2004 - "Drive:\{UnCodeX227}\UnCodeX.exe" -config UnCodeX-UT2004.ini

DeusEx - "Drive:\{UnCodeX227}\UnCodeX.exe" -config UnCodeX-DeusEx.ini

UT3 - "Drive:\{UnCodeX237-beta}\UnCodeX.exe" -config UnCodeX-UT3.ini

UDK - "Drive:\{UnCodeX237-beta}\UnCodeX.exe" -config UnCodeX-UDK-2009-11-2.ini

UDK - "Drive:\{UnCodeX237-beta}\UnCodeX.exe" -config UnCodeX-UDK-2010-03.ini

Now these INI's will have to exist for this to work, so copy the default UnCodeX.ini and rename it to UnCodeX-{GameName/Version}.ini. Open this file in jEdit or notepad for editing,

[Sources]
''Add your source directories here''

UT2004 - Drive:\{UT2004}\System\

UT3 - Drive:\{User Folder}\{Documents}\My Games\Unreal Tournament 3\UTGame\Src\

[GUI.General]
StateFile=UnCodeX-{GameName-Version}.ucx

UT2004 - StateFile=UnCodeX-UT2004.ucx

DeusEx - StateFile=UnCodeX-DeusEx.ucx

UT3 - StateFile=UnCodeX-UT3.ucx

UDK - StateFile=UnCodeX-UDK-2009-11-2.ucx

UDK - StateFile=UnCodeX-UDK-2010-03.ucx

Once you have done that for your required modes you can boot the shortcut and analyze the source, now every time you boot you would be using the cache for that ini/source.

Git is a free & open source, distributed version control system. GIT
msysgit - windows

GIT command prompt

Creating a repository=

# cd hello
# ls
# git init
# git add .

Pushing a repository to GitHub

Create a repository on GitHub then...

# cd hello
# git remote add origin git@github.com:tabrez/hello.git
# git push origin master

GIT GUI

Pushing a repository to GitHub

Using Batch (Windows)

UDK - Simple Compile batch

Drive:\UDK\{UDK-Version}\Binaries\UDK.exe make -debug -intermediate -log=CompileLog.log -full
pause

UT3 - Multi-Package Compile batch

@echo Off
prompt $g
rem BASE DIRECTORIES
set UTDIR="D:\Midway\Unreal Tournament 3"
set UTCOM=%UTDIR%\Binaries\UT3.COM

rem PROJECT DETAILS
set UP1=UT_
set UP2=UT_GDP_
set K1=MDB
set K2=GameDex
set K3=Newtators
set K4=Mutatoes

rem script
set UTCONFIG=..\Config
set UTCOMSRC=..\Unpublished\CookedPC\Script
set MYCOMSRC=..\Unpublished\CookedPC\GameDex
 
@echo On
del %MYCOMSRC%\%UP1%%K1%.u
del %MYCOMSRC%\%UP1%%K2%.u
del %MYCOMSRC%\%K3%\%UP2%%K3%.u
rem del %MYCOMSRC%\%K4%\%UP2%%K4%.u
 
%UTCOM% make -debug -useunpublished -log=CompileLog.log -full
copy %UTCOMSRC%\%UP1%%K1%.u %MYCOMSRC%\%UP1%%K1%.u
copy %UTCOMSRC%\%UP1%%K2%.u %MYCOMSRC%\%UP1%%K2%.u
copy %UTCOMSRC%\%UP2%%K3%.u %MYCOMSRC%\%K3%\%UP2%%K3%.u
copy %UTCOMSRC%\%UP2%%K4%.u %MYCOMSRC%\%K4%\%UP2%%K4%.u
del %UTCOMSRC%\%UP1%%K1%.u
del %UTCOMSRC%\%UP1%%K2%.u
del %UTCOMSRC%\%UP2%%K3%.u
del %UTCOMSRC%\%UP2%%K4%.u
 
del %UTCONFIG%\%UP1%%K2%.ini
del %UTCONFIG%\%UP2%%K3%.ini
rem del %UTCONFIG%\%UP2%%K4%.ini
 
pause
prompt $p$g

NSIS

;
; GameDex-Std.nsi
; Creation Date:
; Last Updated: 22/04/2010 03:32
; Contributors: 00zX
; Attribution-Noncommercial-Share Alike 3.0 Unported
; http://creativecommons.org/licenses/by-nc-sa/3.0/
;
;--------------------------------
!define PRODUCT_MODE_STANDARD
 
!include "GameDex.nsh"
 
Function .onInit
	ReadRegStr $INSTDIR HKLM ${REG_UT} "InstallLocation"
	StrCmp $INSTDIR "" 0 NoAbort
		MessageBox MB_OK "Unreal Tournament 3 not found, Install Aborted!"
		Abort ; causes installer to quit.
	NoAbort:
FunctionEnd
 
;TODO: Detect GameDex version
!insertmacro GAMEDEX_PAK
 
!insertmacro redef GAMEDEX_PAK_NAME "Newtators"
!insertmacro GAMEDEX_PAK_SEC
 
!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN
	!insertmacro MUI_DESCRIPTION_TEXT ${GameDex} "Main GameDex Packages"
	!insertmacro MUI_DESCRIPTION_TEXT ${Newtators} "Addon Package for GameDex"
!insertmacro MUI_FUNCTION_DESCRIPTION_END
 
!define GAMEDEX_UNPAK
!insertmacro GAMEDEX_PAK
 
!insertmacro redef GAMEDEX_PAK_NAME "Newtators"
!insertmacro GAMEDEX_PAK_SEC
 
Section Uninstall
	DeleteRegKey ${PRODUCT_UNINST_ROOT_KEY} "${PRODUCT_UNINST_KEY}"
	SetAutoClose false
SectionEnd

Creating an NSIS package script

NetMode

The WorldInfo (previously LevelInfo for most Unreal Engine games pre UT3/GOW) defines the ENetMode^{(RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UDK, UT3)} enumeration.

	if(WorldInfo.NetMode != NM_DedicatedServer)
		// Code here will only be executed on Listen servers and game clients.
 
	if(WorldInfo.NetMode == NM_DedicatedServer)
		// Code here will only be executed on a server.
 
	if (WorldInfo.NetMode < NM_DedicatedServer)
		// Code here will only be executed on Listen servers and game clients.
 
	if (WorldInfo.NetMode > NM_DedicatedServer)
		// Code here will only be executed on a server or standalone client.

Replication Block

Variable Value Replication

var() float NewEquipTime;
var() float NewPutDownTime;
 
replication
{
	if(bNetDirty && (Role == ROLE_Authority) && bNetInitial)
		NewEquipTime, NewPutDownTime;
}

Repnotify and Replicated Events

This is new in Unreal Engine 3 and is not available in previous versions.

simulated event ReplicatedEvent(name VarName);	// Called when a variable with the property flag "RepNotify" is replicated
 
/** adds/removes a property from a list of properties that will always be replicated when this Actor is bNetInitial, even if the code thinks
 * the client has the same value the server already does
 * This is a workaround to the problem where an LD places an Actor in the level, changes a replicated variable away from the defaults,
 * then at runtime the variable is changed back to the default but it doesn't replicate because initial replication is based on class defaults
 * Only has an effect when called on bStatic or bNoDelete Actors
 * Only properties already in the owning class's replication block may be specified
 * @param PropToReplicate the property to add or remove to the list
 * @param bAdd true to add the property, false to remove the property
 */
native final function SetForcedInitialReplicatedProperty(Property PropToReplicate, bool bAdd);

Usage:UE3:DroppedPickup_(UT3)

Using Predefined Variables

replication
{
	// Physics
	if( (!bSkipActorPropertyReplication || bNetInitial) && bReplicateMovement
					&& ((RemoteRole == ROLE_SimulatedProxy) && (bNetInitial || bUpdateSimulatedPosition)) )
}

Actor Replication

Relevance

Role and RemoteRole

The Actor class defines the ENetRole^{(RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UDK, UT3)} enumeration and two variables, Role and RemoteRole, as follows:

if (Role == ROLE_Authority)
{
	// This is the authorative copy of this actor, it was spawned on this machine.
	// It is not a guarantee that we are on the server or in single player!
}
 
if (Role < ROLE_Authortity)
{
	// This is a non-authorative copy of this actor that was replicated
	// from the server. In other words, we must be on a client.
}

As in the replication block of Actor.uc UT3

Useful Replication Properties

const bool bNetTemporary 

Tear-off simulation in network play.

const bool bOnlyRelevantToOwner 

this actor is only relevant to its owner. If this flag is changed during play, all non-owner channels would need to be explicitly closed.

var transient bool bNetDirty 

set when any attribute is assigned a value in unrealscript, reset when the actor is replicated

var bool bAlwaysRelevant 

Always relevant for network.

var bool bReplicateInstigator 

Replicate instigator to client (used by bNetTemporary projectiles).

var bool bReplicateMovement 

if true, replicate movement/location related properties

var bool bSkipActorPropertyReplication 

if true, dont replicate actor class variables for this actor

var bool bUpdateSimulatedPosition 

if true, update velocity/location after initialization for simulated proxies

var bool bTearOff 

if true, this actor is no longer replicated to new clients, and is "torn off" (becomes a ROLE_Authority) on clients to which it was being replicated.

var bool bOnlyDirtyReplication 

if true, only replicate actor if bNetDirty is true - useful if no C++ changed attributes (such as physics) bOnlyDirtyReplication only used with bAlwaysRelevant actors

var const bool bNetInitialRotation 

Should replicate initial rotation. This property should never be changed during execution, as the client and server rely on the default value of this property always being the same.

var bool bNeverReplicateRotation 

If true, never replicate rotation

var bool bReplicateRigidBodyLocation 

replicate Location property even when in PHYS_RigidBody

var bool bKillDuringLevelTransition 

If set, actor and its components are marked as pending kill during seamless map transitions

var const bool bExchangedRoles 

whether we already exchanged Role/RemoteRole on the client, as removing then readding a streaming level causes all initialization to be performed again even though the actor may not have actually been reloaded

booleans

• (Level.NetMode == NM_Client && bNetOwner) – owner clients (special case of client where the local player is the Owner of the actor in question)

UT2004

NetUpdateFrequency is another variable useful in replication. It effectively causes an otherwise relevant (not useful when the actor is not relevant) actor to be relevant NetUpdateFrequency times per second. This is useful when the data changes frequently but you only want periodic updates. For example, PlayerReplicationInfo contains a lot of data about the client. Stuff like the various player's pings may change quite frequently, and having the client keep track of such information would be quite a network hog. But since PlayerReplicationInfo has a NetUpdateFrequency of 2, it is only updated twice a second, which is much nicer for that player's bandwidth. The list of the current NetUpdateFrequency's for all UT classes are listed below:

Actor - 100 Hz (times per second)
ZoneInfo - 4 Hz
GameReplicationInfo - 4 Hz
PlayerReplicationInfo - 2 Hz
Inventory - 8 Hz

Function replication

Like replicated variables, the replication of a function call can be tied to certain conditions. In Unreal Engine 1 and 2 this condition is specified via the replication block and typically involves comparing the actor's Role to the value ROLE_Authority, Unreal Engine 3 provides the special function modifiers client and server instead.

Client

/** Sets the clients weapon to use the replicated variables */
reliable client function SetWeapProps(UTWeapon W)
{
	W.EquipTime = NewEquipTime;
	W.PutDownTime = NewPutDownTime;
}

Server

/** Gets the times from the weapons and sets them to the replicated variables */
reliable server function GetWeapProps(UTWeapon W)
{
	NewEquipTime = W.default.EquipTime * 0.68;
	NewPutDownTime = W.default.PutDownTime * 0.70;
}