NexusWiki - User contributions [en]

Beginner's Guide

2011-10-02T22:47:53Z

Mularac: /* ' Nexus:TJI Scope of variables ' */

===='''''Nexus:TJI Scripting Structure'''''====

This article, written by Arparso, was created with the aim of explaining how the scripting language of the game should be formatted and how it works.

[[Nexus:TJI Scripting Structure]]

====='''Nexus:TJI Scope of variables'''=====

This articles explains how the scope of variables work and how you can properly take advantage of it.

[[Nexus:TJI Scope of variables]]

----

===='''''Nexus:TJI Basic File Structure'''''====

Before you can create your mod, it'd be a good idea to create the required file structure for it to run. This little guide will show you how to set up the bare requirements your mod would like.

[[Nexus:TJI Basic File Structure]]

----

===='''''Nexus:TJI Creating Solar systems'''''====

As the title suggests, the link below will take you to a guide that'll tell you almost all you need to know about creating you're own custom star systems for the game.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Creating Solar systems]]

----

===='''''Nexus:TJI Basic mission-making walkthrough'''''====

A rather small guide written to help you create your first mission. It's accompanied with a demo mission, to illustrate this process.
Mission and guide written by Mularac.

[[Mission_Making_Tutorial|Mission-making Tutorial]]

[[Demo_mission|Demo mission]]

----

===='''''Nexus:TJI Basics Tutorial'''''====

As we have the rest of the basics guide up here, it's time to add what is probably quite an important bit... how to do this stuff!
Follow the link below to go to the Mision Making tutorial.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Mission Making]]

Beginner's Guide

2011-10-02T22:47:33Z

Mularac: /* 'Nexus:TJI Scope of variables' */

===='''''Nexus:TJI Scripting Structure'''''====

This article, written by Arparso, was created with the aim of explaining how the scripting language of the game should be formatted and how it works.

[[Nexus:TJI Scripting Structure]]

====='''' Nexus:TJI Scope of variables ''''=====

This articles explains how the scope of variables work and how you can properly take advantage of it.

[[Nexus:TJI Scope of variables]]

----

===='''''Nexus:TJI Basic File Structure'''''====

Before you can create your mod, it'd be a good idea to create the required file structure for it to run. This little guide will show you how to set up the bare requirements your mod would like.

[[Nexus:TJI Basic File Structure]]

----

===='''''Nexus:TJI Creating Solar systems'''''====

As the title suggests, the link below will take you to a guide that'll tell you almost all you need to know about creating you're own custom star systems for the game.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Creating Solar systems]]

----

===='''''Nexus:TJI Basic mission-making walkthrough'''''====

A rather small guide written to help you create your first mission. It's accompanied with a demo mission, to illustrate this process.
Mission and guide written by Mularac.

[[Mission_Making_Tutorial|Mission-making Tutorial]]

[[Demo_mission|Demo mission]]

----

===='''''Nexus:TJI Basics Tutorial'''''====

As we have the rest of the basics guide up here, it's time to add what is probably quite an important bit... how to do this stuff!
Follow the link below to go to the Mision Making tutorial.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Mission Making]]

Beginner's Guide

2011-10-02T22:47:20Z

Mularac: /* Nexus:TJI Scope of variables */

===='''''Nexus:TJI Scripting Structure'''''====

This article, written by Arparso, was created with the aim of explaining how the scripting language of the game should be formatted and how it works.

[[Nexus:TJI Scripting Structure]]

=====''''Nexus:TJI Scope of variables''''=====

This articles explains how the scope of variables work and how you can properly take advantage of it.

[[Nexus:TJI Scope of variables]]

----

===='''''Nexus:TJI Basic File Structure'''''====

Before you can create your mod, it'd be a good idea to create the required file structure for it to run. This little guide will show you how to set up the bare requirements your mod would like.

[[Nexus:TJI Basic File Structure]]

----

===='''''Nexus:TJI Creating Solar systems'''''====

As the title suggests, the link below will take you to a guide that'll tell you almost all you need to know about creating you're own custom star systems for the game.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Creating Solar systems]]

----

===='''''Nexus:TJI Basic mission-making walkthrough'''''====

A rather small guide written to help you create your first mission. It's accompanied with a demo mission, to illustrate this process.
Mission and guide written by Mularac.

[[Mission_Making_Tutorial|Mission-making Tutorial]]

[[Demo_mission|Demo mission]]

----

===='''''Nexus:TJI Basics Tutorial'''''====

As we have the rest of the basics guide up here, it's time to add what is probably quite an important bit... how to do this stuff!
Follow the link below to go to the Mision Making tutorial.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Mission Making]]

Nexus:TJI Scope of variables

2011-10-02T22:46:47Z

Mularac: Created page with "==''' Scope of Variables '''== ===''' Introduction to variables '''=== A variable is an expression in a programming language that allows you to store information. Different l..."

==''' Scope of Variables '''==

===''' Introduction to variables '''===

A variable is an expression in a programming language that allows you to store information. Different languages have different methods and implementations for this (some don't even have them).

In nexus, variables are weakly typed. What does that mean, you may ask yourself?
Well, it means that variables can store anything. The "how" is unknown to us, it could be dynamically typed like python or just not typed at all, like smalltak where they're just pointers.
But that's not what's important. What is important, though, is that one variable can store anything, like numbers, objects, lists, etc.

So a variable you were using for, let's say, store a ship object

<pre>
ship := GetSceneObj("My Ship");
</pre>

can be then used to store something else, like a string. (although that's a horrible style of coding)

<pre>
ship := "Hello World";
</pre>

If you have had experience in other languages, you'll notice than in Black Ruler you don't have to declare the variables anywhere, you just invoke them. The name of the variable can be anything and it won't matter, except for the scope of said variable.

===''' Scope of Variables '''===

The "scope" of a variable means from where in the script that variable can be accessed.

====''' "e." variables '''====

These variables are vital to any code, and you'll probrably be using them a lot, so pay attention. They mark the lowest scope of all, and can only be reached from within the block they were first invoked, and when that block's finished executing they will disappear.

Examples:

a)
<pre>
rule event DoSomething
:action
e.string:="Hello World";
Debug(e.string);
LocalEvent(DoSomethingElse);
:end
END

Rule event DoSomethingElse
:action
debug(e.string);
:end
END
</pre>

in this case, in the debug screen it'll appear written "Hello World" and below it "0", as the two "e.string" variables are not the same.

b)

<pre>
Rule event DoSomething
:action
e.string:="Hello World";
Delay(0,1,
Debug(e.string);
,0);
:end
END
</pre>

What would it appear on the debug screen? The answer is "0". We don't exactly know how, but the delay command generates a new block where all the variables present in that block are independant from the block they where called from.

c)
<pre>
rule event DoSomething
:action
e.string:="Hello World";
Debug(e.string);
LocalEvent(DoSomethingElse, e.string:="Hello again");
:end
END

Rule event DoSomethingElse
:action
debug(e.string);
:end
END
</pre>

In this case, however, the debug screen will show "Hello world" and below it "Hello again". Why? because the string "Hello again" was passed as an argument to the DoSomethingElse rule and stored in that rule's "e.string" variable.

====''' "p." variables '''====

Those variables access the variables stored in the previous event. This always means the directly previous valid E. variables.
It's used mainly, if not always, to pass parametres from one event to an other or from an event to a delay function.

Example:
a) Going back to the variables of the rule the delay function is called

<pre>
Rule event DoSomething
:action
e.string:="Hello World";
Delay(0,1,
Debug(e.string);
,e.string:=p.string);
:end
END
</pre>

This time in the debug screen it'll appear"Hello World", because the delay's "e.string" variable was declared with the content of the "DoSomething" rule's "e.string" variable (note that the name doesn't have to be the same, but it's good practice to keep it that way).

b)
<pre>
rule event DoSomething
:action
e.string:="Hello World";
Debug(e.string);
LocalEvent(DoSomethingElse, e.string:=p.string);
:end
END

Rule event DoSomethingElse
:action
debug(e.string);
:end
END
</pre>

Same as above. The "DoSomethingElse" Rule's e.string variable was declared with the "DoSomething" rule "e.string"'s content.
Note that ALWAYS when passing arguments with functions like "LocalEvent", "MEvent", "ChangeState", "Delay", etc, you have to use the p prefix to access the variables of the rule this functions were called from, and that p prefix is only used to access the ones with the E prefix.

====''' variables withouth a prefix '''====

Those variables are what we could call "semi-global". Their scope extends within the machine they were first declared, so the contents of that variable can be accessed and changed from any rule in any state of that machine, and it can, of course, be passed as an argument to an other state in an other machine (in the form of a E. variable or any other).
You're probably feeling excited about this type of variables, as you don't have to deal with passing parametres and e. or p. variables and all that. Well, don't. Global or semi-global variables are a bad deal in any programming language, and you must avoid them whenever it's possible, because they can break your code if you're not cautius or at least make it unreadable by someone on the outside, as keeping track of those variables in a complex code is a pain.

====''' "M." variables '''====

In all sense and purpose, these are global variables. Their scope extends towards the entire mission, meaning that any rule being executed in your mission can access it and change it.
Same recommendation as before: Be careful with it. My recommendation is that use them only for declaring mission "constants" (like ships) or in the worst case some very specific boolean flag, nothing more.

====''' "S." variables '''====

These variables only make sense inside a selection, like the Execlist or SelectEx command. They only live through one iteration of said commands, so declaring them out of the blue doesn't make a lot of sense.

What's important about them, though, is that in those selections the selected object can accessed via the "s.this" variable you all head about. And as any s. variable it will change at the end of the cicle's iteration.

Beginner's Guide

2011-10-02T22:37:52Z

Mularac:

===='''''Nexus:TJI Scripting Structure'''''====

This article, written by Arparso, was created with the aim of explaining how the scripting language of the game should be formatted and how it works.

[[Nexus:TJI Scripting Structure]]

====='''''Nexus:TJI Scope of variables'''''=====

This articles explains how the scope of variables work and how you can properly take advantage of it.

[[Nexus:TJI Scope of variables]]

----

===='''''Nexus:TJI Basic File Structure'''''====

Before you can create your mod, it'd be a good idea to create the required file structure for it to run. This little guide will show you how to set up the bare requirements your mod would like.

[[Nexus:TJI Basic File Structure]]

----

===='''''Nexus:TJI Creating Solar systems'''''====

As the title suggests, the link below will take you to a guide that'll tell you almost all you need to know about creating you're own custom star systems for the game.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Creating Solar systems]]

----

===='''''Nexus:TJI Basic mission-making walkthrough'''''====

A rather small guide written to help you create your first mission. It's accompanied with a demo mission, to illustrate this process.
Mission and guide written by Mularac.

[[Mission_Making_Tutorial|Mission-making Tutorial]]

[[Demo_mission|Demo mission]]

----

===='''''Nexus:TJI Basics Tutorial'''''====

As we have the rest of the basics guide up here, it's time to add what is probably quite an important bit... how to do this stuff!
Follow the link below to go to the Mision Making tutorial.

Written by Jusas.

Edited by The Old Dragon.

[[Nexus:TJI Mission Making]]

AddItem

2010-02-23T02:18:55Z

Mularac: Fixed this entry as it had been changed by a spammer....

'''AddItem'''(list, item);
Adds an object to the list. ’list’ is the identifier of the selection.

AddItem

2010-02-23T02:18:10Z

Mularac:

''AddItem''(list, item);
Adds an object to the list. ’list’ is the identifier of the selection.

Beginner's Guide

2010-02-23T02:07:30Z

Mularac: Added my tutorial and the demo mission I wrote

Mission Making Tutorial

2010-02-22T21:15:11Z

Mularac: Created page with '='''''NEXUS TJI mission-making'''''= As you probably know by now, thanks to Arparso's great tuturial about Nexus's scripting structure, that ev...'

='''''NEXUS TJI mission-making'''''=

As you probably know by now, thanks to Arparso's great tuturial about [[Nexus:TJI_Scripting_Structure|Nexus's scripting structure]], that every mission in this game is divided in MACHINES, STATES, and Rules. But that only deals with one part of the mission, the "body" of it, in a way.
In order to ilustrate this concepts I will be pasteing here a [[Demo_mission|Demo mission]] I've made with this article in mind.

==''The main parts of the mission''==
Here area a collection of the main parts a mission is divided into

===The heading===
----

Each mission starts, of course, with the basics of the mission: it's identity number, it's name, and where it'll take place (note that you can't change locations in a single mission):
<pre>
NUMBER <num>
name "<the name of the mission>"
DefLocation "<name of the location>"
</pre>
The "name of the location" is a "navpoint" created with the Solar System editor, one you can find in the "universe\systems\" folder.
Unlike the number, the name of the mission doesn't have to be unique, you can put anything in there, even the same title that some other mission, as long as the numbering is not the same (well... that's not enteryle true... if you place a letter istead of a number, the game will treat it as a mission number "0" and it will never give you a conflict, even if you label two or more missions as "NUMBER A").
Following that is a list of the current objective numbers, in this fashion:
<pre>
OBJECTIVE
1
2
...
END
</pre>
Finally, as an example, here's the [[Demo_mission#Heading|Demo mission's heading]] (note that everything after "//" and between "/* - */" is interpretated by the game as a comment):
<pre>
MISSION 1 //mission number
Name "Demo Mission" //name of the mission
DefLocation "NAV_CHAKRIS_IV" //the location where the mission will take place

OBJECTIVES //in here we place the number of objectives that will be includid in the mission
1
2
3
END
</pre>
===The SceneInit Rule===
----

This is a very special rule, critical to any mission, and that is for the fact that this rule takes place '''before''' the mission starts. In this rule you can do pretty much anything you want, but there are a few things mandatory to do here.

*The radious of the mission, in meters, as defined by the [[SetSceneRadius]](<num>); command.
*The setting of the variables associated to each of the ships that will appear on the mission (though critical for most missions, it's not mandatory), defined by the command <name of the variable> := [[GetSceneObj]]("<name of the ship>");

This rule is special also because it's the first link to any of the Machines you've written for this mission, in here you call the Machines (or Machines) you want your mission to start with.
Unlike any other Rule, this one doesn't go inside a State, it only goes beneath the "RULES" block, as all the Machines in your mission do.
Here's the [[Demo_mission#SceneInit|SceneInit]] rule of the [[Demo_mission|Demo mission]], as well as the start of the "RULES" block:
<pre>
RULES

RULE event sceneInit
:action
SetSceneRadius(100000); //this is, as the name suggests it, the radious in meters of the scene.

GuiSelect(0); //this is required to start a cinematic scene

SetRelation(#race_player, #race_spacetech, 2);
SetRelation(#race_player, #race_gorg, 2);
SetRelation(#race_gorg, #race_player, 2);
SetRelation(#race_spacetech, #race_player, 2);
SetRelation(#race_player, #race_Human_E, 1); //the relations between the races that will appear in
//the game. the "race_player" is the playable race,
//and the number mean what sort of relationship they
//share with other races, more info on that is
//located on the modding manual

sp := GetSceneObj("Mayflower");
bs := GetSceneObj("Hawkeye"); //in here we define the "Scene Objects", the ships and other
//interactive obects

drone := GetSceneObj("Nightingale");

gorg1 := GetSceneObj("Feral");
gorg2 := GetSceneObj("Darkclaw");

Disappear(drone);
Disappear(gorg1);
Disappear(gorg2); //we disappear the ships that are bound to appear via ip drive

Playmusic(1); //in here we set the number of the music track (as defined in the
//mod_sound.ini file, in the universe\engine\ folder

GetMachine("Director"):ChangeState(IntroMovie, 0);
GetMachine("Objectives"):ChangeState(monitor,0); // with these commands we "call" the machines
//that would define the game, and their given
// state

FadeScreen(1, 0, 0); //we "fade" the screen, make it black
:end
END
</pre>

===The body of the mission===
---
The sintax of this part has already been brilliantly explainied by Arparso in his [[Nexus:TJI_Scripting_Structure|Tutorial]], so I will only offer some advices here. Always use different states when there's a remarkable change in the mission (arrival of ships, discovery of stuff, etc), and try to keep your mission as tidy as possible. Machines can run simultaneosly, so having a lot of them is never a good idea. Try to divide them into clear, diferencied tasks (one of the AI, one or two for the actual mission, etc).
So, here's the body of the [[Demo_mission|Demo mission]]: [[Demo_mission#body|body]]
Also, don't forget that once you've finished with all your machines, included all the files that you wanted to include (to include a file you have to do this: "#include "<name of the file" ", and it would be like you wrote the content of that file in the mission file, so keep a close watch on the mission sintaxis of included files!) you have to '''END''' the mission. Just add a finall ''END'' on the bottom, after the last included file and just above the ''ENTITIES'' section.

===The ''ENTITIES'' section===
---
Here's defined the settings of each of the mission's ships, like name, class, race, location, heading, etc, in this fashion:
<pre>
SHIP
<content>
END
</pre>
Whereas the content may be:

*Name "<name of the ship>"

*Race #<race of the ship>

*ShipType #<ship type of the ship, as defined in the SHIPTYPE part of the tacticstypes.ini>
or
*Class #<class of the ship, as defined in the SHIPCLASS part of the tacticstypes.ini>

*Position <x y z coordinates of the ship>

*Orientation <pitch heading and bank of the ship>

*Devices #<dev 1> #<dev 2> ... #<dev n> ; Note that this is optional, every device you place here will be added to the ship, so ''BE CAREFUL'' with it.

You may also add NPC's here to the mission's ships:
<pre>
NPC
<content>
END
</pre>
with the content being:

*Name "<name>"
*ID <num> The id is the way to link this NPC to each dialog
*Face <num> If this line is not provided, then the game will use the ID number as face number
* Rank <num 1-10>
* Medals #<medal 1> ... #<medal n> ;
* CrewLevel <num> The level of the crew
* Skill 1 <num> The skill of this npc in the Military area
* Skill 2 <num> idem but in the engineering area
* Skill 3 <num> idem but in the scientific area
* XP <num> The experience of this npc.

That pretty much covers it. Here's [[Demo_mission#Entities|Demo mission's ENTITIES]] area:

<pre>
ENTITIES

SHIP
Name "Hawkeye"
Race #race_Player
ShipType #styp_ep6_Siege_Battleship
Position -1000 838 -8966
Orientation 0 0 0

NPC
Name "Johan Mastropiero"

ID 1
Face 20
Rank 3
Medals ;
CrewLevel 1
Skill 1 0
Skill 2 0
Skill 3 0
XP 0
END
END

SHIP
Name "Nightingale"
Race #race_SpaceTech
ShipType #styp_Frigate
Position 2441.14 -8877.7 2618.99
Orientation 180 0 0
END

SHIP
Name "Mayflower"
Race #race_Human_E
ShipType #styp_Supportship
Position -12843.8 -1399.87 -5833.99
Orientation 0 0 0

NPC
Name "James Carson"

ID 2
Face 26
Rank 2
Medals ;
CrewLevel 1
Skill 1 0
Skill 2 0
Skill 3 0
XP 0
END
END

SHIP
Name "Feral"
TechCat 31 20
TechPointsScanned 0
Race #race_Gorg
ShipType #styp_ep6_gorg_escortcruiser
Position -5890.52 -22.7949 7108.39
Orientation -92.7069 -36.0036 47.6695
END

SHIP
Name "Darkclaw"
TechCat 31 30
TechPointsScanned 0
Race #race_Gorg
ShipType #styp_ep3_gorg_heavy_battleship
Position -5892.08 769.904 6509.39
Orientation -92.7069 -36.0036 47.6695
END

END
</pre>

==''Auxiliary parts of a mission''==
---
I'll now move to explain two other files linked to every mission. Although they're not critical to a mission, they're adviced to be included, as they're the files that contain the dialogs and objectives.

===Dialogs===
---
The dialogs of each mission go into a file (any file, as long as it is a .ini file. Moreover, two or more mission's dialogs could go into one or more files, although that's not encouraged. Best to keep things nice and tidy) in the \universe\texts\dialogs\ folder.
The dialog syntaxis is as follows:
<pre>
Dialog
<content>
END
</pre>
with the content being:

*name <identifier number of the dialog, the one that links the dialog to the mission>
*Layout <where it's located on the screen, see the manual>
*NPC <id number of the npc saying this>
*distort <num ranging from -1 to 3> it's the level of interference in a dialog (with -1 being none whatsoever)
*ExpireEvent <event to occur when the dialog ends (in the same state where the dialog was called, of course)>
Here is the text build of each dialog:
<pre>
text
{
<language (0 for english, 2 for spanish, 1 for hungarian...)> "<content>"
}
</pre>
Here are the dialogs corresponding to the [[Demo_mission|Demo mission]]: [[Demo_mission#Dialogs|Dialogs]]

in case of being this a dialog with a choice system built-in, a few thigs are added:

*ChooseTime <num in seconds> the ammount of time the dialog stays on the air by itself

and the text build will look something like this:
<pre>
text
{
<language1> "<text in language 1>"
<language2> "<in language 2>"
.........
}
options
{
<language1> "<1° choice in language 1>"
<language2> "<in language 2>"

.........
}
<event generated by choice 1>
{
<language1> "<2° choice in language 1>"
<language2> "<in language 2>"

.........
}
<event generated by choice 2>

............

{
<language1> "<n° choice in language 1>"
<language2> "<in language 2>"

.........
}
<event generated by choice n>
END
</pre>
unfortunately, there aren't any dialogs with such choices in the [[Demo_mission|Demo mission]], but I can provid you with an example, taken from my mission "Consequences" available in the Stargate Mod: War Begins PB4, 5, 6 and 7 (at the time this article was written):

<pre>
DIALOG
name dialog_consequences_c2_4
Layout 6
ExpireEvent TimerFail
NPC 9
distort -1
text
{
0 "They aren't respondind sir, and they are charging weapons. What do we do sir? Fight or flee?"
}
options
{
0 "We fight. All hands to battle stations!"
}
Fight

{
0 "We came here to fight the replicators, no the Lucians. Major, get us out of here."
}
Flee

END //we end the choices
END
</pre>

===Objectives===
---
The Objectives of a mission go into any file (in pretty much the same way that the dialogs) in the \universe\texts\mod_texts\ or in the \universe\texts\texts\ folders. Each dialog is linked to a mission with the mission's number, in this fashion:
<pre>
TEXT "objective_<num of mission>_<numv of objective>"
<language> "<text in that language>"
END
</pre>
And that's pretty much it. The [[Demo_mission|Demo Mission's]] objectives are located [[Demo_mission#Objectives|here]]

Demo mission

2010-02-22T20:27:06Z

Mularac:

==Heading==
<pre>
MISSION 1 //mission number
Name "Demo Mission" //name of the mission
DefLocation "NAV_CHAKRIS_IV" //the location where the mission will take place

OBJECTIVES //in here we place the number of objectives that will be includid in the mission
1
2
3
END
</pre>
==SceneInit==
<pre>
RULES

RULE event sceneInit
:action
SetSceneRadius(100000); //this is, as the name suggests it, the radious in meters of the scene.

GuiSelect(0); //this is required to start a cinematic scene

SetRelation(#race_player, #race_spacetech, 2);
SetRelation(#race_player, #race_gorg, 2);
SetRelation(#race_gorg, #race_player, 2);
SetRelation(#race_spacetech, #race_player, 2);
SetRelation(#race_player, #race_Human_E, 1); //the relations between the races that will appear in
//the game. the "race_player" is the playable race,
//and the number mean what sort of relationship they
//share with other races, more info on that is
//located on the modding manual

sp := GetSceneObj("Mayflower");
bs := GetSceneObj("Hawkeye"); //in here we define the "Scene Objects", the ships and other
//interactive obects

drone := GetSceneObj("Nightingale");

gorg1 := GetSceneObj("Feral");
gorg2 := GetSceneObj("Darkclaw");

Disappear(drone);
Disappear(gorg1);
Disappear(gorg2); //we disappear the ships that are bound to appear via ip drive

Playmusic(1); //in here we set the number of the music track (as defined in the
//mod_sound.ini file, in the universe\engine\ folder

GetMachine("Director"):ChangeState(IntroMovie, 0);
GetMachine("Objectives"):ChangeState(monitor,0); // with these commands we "call" the machines
//that would define the game, and their given
// state

FadeScreen(1, 0, 0); //we "fade" the screen, make it black
:end
END
</pre>
==Body==
<pre>
MACHINE "Director"

STATE IntroMovie

RULE event In
:action
Delay(0,1,
FadeScreen(0, 2, StartMission);
//we "unfade" the screen, and as defined by the command, when the fading finishes the "StartMission" event will be fired
SelectDevices(1, m.bs, s.this:devtype=#weap_miss3);
//we select the missile batterie
Execlist(1, LoadWeapon(s.this, -100));
//we unload the weapon. Don't worry, I'll explain the execlist command later along the way.
,0);
:end
END

Rule event StartMission
:action
CamMoveAndTurn(m.bs, 2000, m.drone, 4, 10); //we move the camera to see the
// "drone" ship from the perspective of
//the "bs" ship (more info in the manual).
Title(0,0,0,"Demo Mission"); //we play a title (obviously)
Delay(0,10,
Guiselect(3); //we wait 10 seconds (the ammount of time that will take the
//camera to stop moving) to stop the simple cinematic
Dialog("demo_1",0,0); //we bring upon the 1° string of dialogs, when one of
//them finishes (or is interrupted by the player) the
//following will appear.
Dialog("demo_2",0,0);
Dialog("demo_3",0,0);
,0);
:end
END

Rule event SecObj //this event is fired when the last dialog expires, and is called via the "ExpireEvent"
//command, as you can see the demo.ini file in the \texts\dialogs\ folder
:action
Title(0,0,0,"objective_1_2"); //we display the second objective
MissionObjective(2, #OBJECTIVE_UNCOMPLETED); //and we make it so it appears on the
//"objectives" screen
SetArea(1, m.sp, 5000);
Timer(Arrival, 10, 0); //this event fires a localevent with a given delay, for more
//info, check the "timer" command
:end
END

Rule event AreaEntered
condition e.ship=m.bs&e.area=1 //this is an other special rule, it's fired when a ship enters a
//given area. E.ship, the ship and e.area the area.
:action
Engines:=GetFreeSel(); //we start a list with this command
SelectDevices(Engines, m.bs, InSet(s.this, 52) | InSet(s.this, 53) | InSet(s.this, 54));
//in here we select all the devices that fall under the 52 and 53 "sets" (normal and secondary engines).
//Check the tacticstypes.ini for more info.
Execlist(Engines, EnableDevice(s.this,0));

AddItem(1, m.bs);
AddItem(1, m.sp);
traffic1 := StartTraffic(1, 2); //we start some "traffic", small ships that will
//travel from one ship to the other.

Delay(0,40, /*we wait some time for the ships to finish some travels*/
Execlist(Engines, EnableDevice(s.this,1)); //and we let our ship move again
SelectDevices(1, m.bs, s.this:devtype=#weap_miss3);
Execlist(1, LoadWeapon(s.this, 13)); //we load the weapon
EndTraffic(traffic1); //we end the traffic
MissionObjective(2, #OBJECTIVE_COMPLETED); //and we tell the player that the
//objective has completed
,0);
:end
END

Rule event Arrival
:action
LongRangeArrive(m.drone); //with this command we make the ship appears using it's
//ip drives
:end
END

Rule event RunAway //this is also a special event, is only fired when a ship leaves the scene using the ip
//drives.
condition e.ship=m.bs // we check if the player decides to leave the scene
:action
if(MissionObjective(2) = #OBJECTIVE_UNCOMPLETED, MissionObjective(2, #OBJECTIVE_FAILED));
if(MissionObjective(1) = #OBJECTIVE_UNCOMPLETED, MissionObjective(2, #OBJECTIVE_FAILED));
//we check wether these objectives have been completed or not, and if not, then we mark them as failed
Delay(0,5, uQuitMission(0),0);
:end
END

Rule event LongRangeArrived
condition e.ship=m.drone
/* this is a special rule, and it is only fired when a ship appears by means of an ip drive. In this rule the variable "e.ship"
refers to the ship that appeared, so with the "condition" line we check that it matches the "drone" from our scene obj */
:action
MakeFullyknown(e.ship); //with this command we detect the ship
FreezeReconState(e.ship,1); //and with this other command we make sure it stays that
//way.
SelectDevices(1, m.drone, 1); //with this rule we efectibly select all the devices of
//a given ship, "m.drone"
Execlist(1, EnableDevice(s.this,0));

/* for those familiar with basic programing, the execlist command works a bit like a "for" thing, where the objects to be replaced
are the items of the list placed in that rule, (in this case, the "1", all the devices of the "m.drone" ship, and then replace
"s.this" with each item until it reaches the very end, like a for rule.
And for the ones that don't know what a for rule is... well... look it up :P nah, kidding. What I did here was run every item from
the list "1" with a "EnableDevice" rule (again, look what that means in the modding manual) */

Title(0,0,0,"objective_1_1"); //we display the first objective
MissionObjective(1, #OBJECTIVE_UNCOMPLETED); //and we make it so it appears on the
//"objectives" screen
:end
END

Rule event Fataldamaged
condition e.ship=m.drone //like the longrangearrived rule, this is also a special one, that will
//only be fired when a ship is wrecked (not destroyed). E.ship is the wrecked ship.
:action
MissionObjective(1, #OBJECTIVE_COMPLETED); //with this we show that the objective
//has been, of course, completed.
Delay(0,10,
Dialog("demo_4",0,0);
LongRangeArrive(m.gorg1);
LongRangeArrive(m.gorg2); //I know this is a cliche... but what
//the hell. When the practice drone is done for, I
//make two gorg ships appear from hyperspace.
,0);
:end
END

Rule event LongRangeArrived
condition e.ship:race=#race_gorg //with this we place a condition that the incoming ship must
//belong to the gorg race to be valid for the rule
:action
MakeFullyknown(m.gorg1); //with this command we detect the ship
FreezeReconState(m.gorg1,1); //and with this other command we make sure it stays
//that way.

MakeFullyknown(m.gorg2); //with this command we detect the ship
FreezeReconState(m.gorg2,1); //and with this other command we make sure it stays
//that way.
ChangeState(Next,0); //we change the state. Note that from every machine only one
//state can run at a time, so everything that was in this
//state will effectibly stop working.
:end
END

END //state IntroMovie

State Next
Rule event in
:action
if(MissionObjective(2) = #OBJECTIVE_UNCOMPLETED, MissionObjective(2, #OBJECTIVE_FAILED));
//which means that if you didn't accomplish the second objective by now, then your time is over amigo, now you have other priorities.

SelectShips(1, s.this:race=#race_gorg); //we select every ship that belongs to the
//gorg race
Execlist(1, s.this:tMoveTo(m.bs, 2, 0)); //and using the execlist rule (the one that
//was like a "for", remember?) to move them against our ship.

Dialog("demo_5",0,0);
:end
END

Rule event Flee //an other event that is called by a dialog ending. again, check the demo.ini file for
//more details.
:action
MissionObjective(3, #OBJECTIVE_UNCOMPLETED);
Title(0,0,0,"objective_1_3"); //same as before.

SelectDevices(1, m.sp, s.this:devtype=#supp_longrange); //in this time we select
//only the devices (or device) matching an specific criteria, that it must
//belong to the devicetype #supp_longrange, the ip drive.
Execlist(1, ActivateDevice(s.this,1)); //and we activate the device. Simple.
:end
END

Rule event RunAway
condition e.ship=m.bs //we check that leaving ship is our own
:action
if(MissionObjective(3) = #OBJECTIVE_UNCOMPLETED, MissionObjective(2, #OBJECTIVE_FAILED));
//as before, if you didn't complete the objective, then you failed it.
Delay(0,10, uQuitMission(1),0); //and finally we quit to a "you've won!" screen
:end
END

Rule event Fataldamaged
condition e.ship:race=#race_gorg
:action
SelectShips(1, s.this:race=#race_gorg); //we select all the gorg ships and we place
//inside one list, labeled as "1" (note that using a number is not mandatory)

If(AllNumOf(1) = 0, ChangeState(mission_won,0)); //and we check the number of
//elements of that list, and if
//that is number is 0 it means that the
//list is empty, thus, no more gorg ships.
:end
END

Rule event Fataldamaged
condition e.ship=m.bs //well, this means that this event will be fired only if our ship suffered
//terminal damage, and thus, you've lost the mission
:action
Delay(0,10, uQuitMission(0),0);
:end
END
END //state next

State Mission_won
rule event in
:action
MissionObjective(3, #OBJECTIVE_COMPLETED);
Delay(0,10, uQuitMission(1),0); //and we finish the mission.
:end
END
END //state mission_won
END //Machine "Director"

Machine "Objectives"

State Monitor

Rule event in
:action
//in here we set the common, starting parameters of the mission, like the initial
//objectives
MissionObjective(1, #OBJECTIVE_HIDDEN);
MissionObjective(2, #OBJECTIVE_HIDDEN);
MissionObjective(3, #OBJECTIVE_HIDDEN);

SetObjectivePrimary(1,1);
SetObjectivePrimary(2,0);
SetObjectivePrimary(3,0); //in here we set wether an objective is or not primary

:end
END
END //Monitor
END
END
</pre>

==Entities==
<pre>
ENTITIES

SHIP
Name "Hawkeye"
Race #race_Player
ShipType #styp_ep6_Siege_Battleship
Position -1000 838 -8966
Orientation 0 0 0

NPC
Name "Johan Mastropiero"

ID 1
Face 20
Rank 3
Medals ;
CrewLevel 1
Skill 1 0
Skill 2 0
Skill 3 0
XP 0
END
END

SHIP
Name "Nightingale"
Race #race_SpaceTech
ShipType #styp_Frigate
Position 2441.14 -8877.7 2618.99
Orientation 180 0 0
END

SHIP
Name "Mayflower"
Race #race_Human_E
ShipType #styp_Supportship
Position -12843.8 -1399.87 -5833.99
Orientation 0 0 0

NPC
Name "James Carson"

ID 2
Face 26
Rank 2
Medals ;
CrewLevel 1
Skill 1 0
Skill 2 0
Skill 3 0
XP 0
END
END

SHIP
Name "Feral"
TechCat 31 20
TechPointsScanned 0
Race #race_Gorg
ShipType #styp_ep6_gorg_escortcruiser
Position -5890.52 -22.7949 7108.39
Orientation -92.7069 -36.0036 47.6695
END

SHIP
Name "Darkclaw"
TechCat 31 30
TechPointsScanned 0
Race #race_Gorg
ShipType #styp_ep3_gorg_heavy_battleship
Position -5892.08 769.904 6509.39
Orientation -92.7069 -36.0036 47.6695
END

END
</pre>

==Dialogs==
Read [[Mission_Making_Tutorial#Dialogs|this]] before copying these lines into a file!

<pre>
Dialog
name demo_1
Layout 4
NPC 2
distort -1
text
{
0 "Ok, captain, the target drone should be arriving in a few seconds. Is everything ready?"
}
END

Dialog
name demo_2
Layout 4
NPC 1
distort -1
text
{
0 "Well, everything but the fact that the extremely comptent fellows at the station forgot to load up our torpedoes."
}
END

Dialog
name demo_3
Layout 4
NPC 2
ExpireEvent SecObj
distort -1
text
{
0 "Well, why am I not surprised... head over to the Mayflower, if you want. They should be able to help you with that."
}
END

Dialog
name demo_4
Layout 4
NPC 2
distort -1
text
{
0 "Damn... we have Gorg ships incoming!"
}
END

Dialog
name demo_5
Layout 4
NPC 2
ExpireEvent Flee
distort -1
text
{
0 "Captain, we're pulling the Mayflower away. There's no need to fight here, fight or flee, your call"
}
END
</pre>

==Objectives==
Also, read [[Mission_Making_Tutorial#Objectives|this]] before copying these lines into a file!
<pre>
TEXT "objective_1_1"
0 "Destroy the drone"
END

TEXT "objective_1_2"
0 "Approach the support ship to have your missile bank filled up"
END

TEXT "objective_1_3"
0 "Destroy the Gorg ships"
END
</pre>

Demo mission

2010-02-22T20:22:24Z

Mularac: Created page with '==Heading== <pre> MISSION 1 //mission number Name "Demo Mission" //name of the mission DefLocation "NAV_CHAKRIS_IV" //the location where the mission will take place OBJECTIVES...'