1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
--[[
<?xml version='1.0' encoding='utf8'?>
<mission name="Mission Template (mission name goes here)">
<flags>
<unique />
</flags>
<avail>
<priority>4</priority>
<chance>5</chance>
<location>Bar</location>
</avail>
</mission>
--]]
--[[
Mission Template (mission name goes here)
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/>.
--
This is a Naev mission template.
In this document aims to provide a structure on which to build many
Naev missions and teach how to make basic missions in Naev.
For more information on Naev, please visit: http://naev.org/
Naev missions are written in the Lua programming language: http://www.lua.org/
There is documentation on Naev's Lua API at: http://api.naev.org/
You can study the source code of missions in [path_to_Naev_folder]/dat/missions/
When creating a mission with this template, please erase the
explanatory comments (such as this one) along the way, but retain the
above license header and the MISSION and DESCRIPTION fields below,
adapted to your mission.
MISSION: <NAME GOES HERE>
DESCRIPTION: <DESCRIPTION GOES HERE>
--]]
-- require statements go here. Most missions should include
-- numstring.lua, which provides the useful `numstring()` and
-- `creditstring()` functions. We use these functions to format numbers
-- as text properly in Naev. dat/missions/neutral/common.lua provides
-- the addMiscLog function, which is typically used for non-factional
-- unique missions.
require "numstring.lua"
require "missions/neutral/common.lua"
--[[
Multi-paragraph dialog strings should go here, each with an identifiable
name. You can see here that we wrap strings that are displayed to the
player with `_()`. This is a call to gettext, which enables
localization. The _() call should be used directly on the string, as
shown here, instead of on a variable, so that the script which figures
out what all the translatable text is can find it.
When writing dialog, write it like a book (in the present-tense), with
paragraphs and quotations and all that good stuff. Leave the first
paragraph unindented, and indent every subsequent paragraph by four (4)
spaces. Use quotation marks as would be standard in a book. However, do
*not* quote the player speaking; instead, paraphrase what the player
generally says, as shown below.
In most cases, you should use double-brackets for your multi-paragraph
dialog strings, as shown below.
One thing to keep in mind: the player can be any gender, so keep all
references to the player gender-neutral. If you need to use a
third-person pronoun for the player, singular "they" is the best choice.
You may notice instances of "%s" sprinkled throughout the text. These
are portions that will be filled in later by the mission via the
`string.format()` function.
--]]
ask_text = _([[As you approach the guy, he looks up in curiosity. You sit down and ask him how his day is. "Why, fine," he answers. "How are you?" You answer that you are fine as well and compliment him on his suit, which seems to make his eyes light up. "Why, thanks! It's my favorite suit! I had it custom tailored, you know.
"Actually, that reminds me! There was a special suit on %s in the %s system, the last one I need to complete my collection, but I don't have a ship. You do have a ship, don't you? So I'll tell you what, give me a ride and I'll pay you %s for it! What do you say?"]])
--[[
First you need to *create* the mission. This is *obligatory*.
You have to set the NPC and the description. These will show up at the
bar with the character that gives the mission and the character's
description.
--]]
function create ()
-- Set our mission parameters.
misplanet, missys = planet.get("Ulios")
credits = 250000
talked = false
-- Here we use the `creditstring()` function to convert our credits
-- from a number to a string. This function both applies gettext
-- correctly for variable amounts (by using the ngettext function),
-- and formats the number in a way that is appropriate for Naev (by
-- using the numstring function). You should always use this when
-- displaying a number of credits.
reward_text = creditstring(credits)
-- If we needed to claim a system, we would do that here with
-- something like the following commented out statement. However,
-- this mission won't be doing anything fancy with the system, so we
-- won't make a system claim for it.
--if not misn.claim(missys) then misn.finish(false) end
-- Give the name of the NPC and the portrait used. You can see all
-- available portraits in dat/gfx/portraits.
misn.setNPC( _("A well-dressed man"), "neutral/unique/youngbusinessman" )
misn.setDesc( _("This guy is wearing a nice suit.") )
end
--[[
This is an *obligatory* part which is run when the player approaches the
character.
Run misn.accept() here to internally "accept" the mission. This is
required; if you don't call misn.accept(), the mission is scrapped.
This is also where mission details are set.
--]]
function accept ()
-- Use different text if we've already talked to him before than if
-- this is our first time.
local text
if talked then
-- We use `string.format()` here to fill in the destination and
-- reward text. `s1:format(s2)` is a shorthand for
-- `string.format(s1, s2)`.
text = _([["Ah, it's you again! Have you changed your mind? Like I said, I just need transport to %s in the %s system, and I'll pay you %s when we get there. How's that sound?"]]):format( misplanet:name(), missys:name(), reward_text )
else
text = ask_text
talked = true
end
-- This will create the typical "Yes/No" dialogue. It returns true if
-- yes was selected.
if tk.yesno( _("My Suit Collection"),
ask_text:format( reward_text ) ) then
-- Followup text.
tk.msg( _("My Suit Collection"), _([["Fantastic! I knew you would do it! Like I said, I'll pay you as soon as we get there. No rush! Just bring me there when you're ready.]]) )
-- Accept the mission
misn.accept()
-- Mission details:
-- You should always set mission details right after accepting the
-- mission.
misn.setTitle( _("Suits Me Fine") )
misn.setReward( reward_text )
misn.setDesc( _("A well-dressed man wants you to take him to %s in the %s system so he get some sort of special suit."):format( misplanet:name(), missys:name() ) )
-- Markers indicate a target system on the map, it may not be
-- needed depending on the type of mission you're writing.
misn.markerAdd( missys, "low" )
-- The OSD shows your objectives.
local osd_desc = {}
osd_desc[1] = _("Fly to %s in the %s system"):format( misplanet:name(), missys:name() )
misn.osdCreate( _("Suits Me Fine"), osd_desc )
-- This is where we would define any other variables we need, but
-- we won't need any for this example.
-- Hooks go here. We use hooks to cause something to happen in
-- response to an event. In this case, we use a hook for when the
-- player lands on a planet.
hook.land( "land" )
else
-- Call misn.finish() to end the conversation with the NPC without
-- getting rid of him.
misn.finish()
end
end
-- This is our land hook function. Once `hook.land( "land" )` is called,
-- this function will be called any time the player lands.
function land ()
-- First check to see if we're on our target planet.
if planet.cur() == misplanet then
-- Mission accomplished! Now we do an outro dialog and reward the
-- player. Rewards are usually credits, as shown here, but
-- other rewards can also be given depending on the circumstances.
tk.msg( _([[As you arrive on %s, your passenger reacts with glee. "I must sincerely thank you, kind stranger! Now I can finally complete my suit collection, and it's all thanks to you. Here is %s, as we agreed. I hope you have safe travels!"]]):format( misplanet:name(), reward_text )
-- Reward the player. Rewards are usually credits, as shown here,
-- but other rewards can also be given depending on the
-- circumstances.
player.pay( credits )
-- Add a log entry. This should only be done for unique missions.
addMiscLog( _([[You helped transport a well-dressed man to %s so that he could buy some kind of special suit to complete his collection.]]):format( misplanet:name() ) )
-- Finish the mission. Passing the `true` argument marks the
-- mission as complete.
misn.finish( true )
end
end
|
