| … | |
… | |
| 4 | |
4 | |
| 5 | =head1 DESCRIPTION |
5 | =head1 DESCRIPTION |
| 6 | |
6 | |
| 7 | NPC dialogue support module. |
7 | NPC dialogue support module. |
| 8 | |
8 | |
|
|
9 | =over 4 |
|
|
10 | |
| 9 | =cut |
11 | =cut |
| 10 | |
12 | |
| 11 | package NPC_Dialogue; |
13 | package NPC_Dialogue; |
| 12 | |
14 | |
| 13 | use strict; |
15 | use common::sense; |
| 14 | |
|
|
| 15 | sub has_dialogue($) { |
|
|
| 16 | my ($ob) = @_; |
|
|
| 17 | |
|
|
| 18 | $ob->msg =~ /^\@match /; |
|
|
| 19 | } |
|
|
| 20 | |
16 | |
| 21 | sub parse_message($) { |
17 | sub parse_message($) { |
| 22 | map [split /\n/, $_, 2], |
18 | map [split /\n/, $_, 2], |
| 23 | grep length, |
19 | grep length, |
| 24 | split /^\@match /m, |
20 | split /^\@match /m, |
| … | |
… | |
| 26 | } |
22 | } |
| 27 | |
23 | |
| 28 | sub new { |
24 | sub new { |
| 29 | my ($class, %arg) = @_; |
25 | my ($class, %arg) = @_; |
| 30 | |
26 | |
|
|
27 | $arg{ob} = $arg{pl}->ob; |
|
|
28 | |
| 31 | my $self = bless { |
29 | my $self = bless { |
| 32 | %arg, |
30 | %arg, |
| 33 | }, $class; |
31 | }, $class; |
| 34 | |
32 | |
| 35 | $self->{match} ||= [parse_message $self->{npc}->msg]; |
33 | $self->{match} ||= [parse_message $self->{npc}->msg]; |
| … | |
… | |
| 83 | =over 4 |
81 | =over 4 |
| 84 | |
82 | |
| 85 | =item $who - The cf::object::player object that initiated the dialogue. |
83 | =item $who - The cf::object::player object that initiated the dialogue. |
| 86 | |
84 | |
| 87 | =item $npc - The NPC (or magic_ear etc.) object that is being talked to. |
85 | =item $npc - The NPC (or magic_ear etc.) object that is being talked to. |
|
|
86 | |
|
|
87 | =item $map - The map the NPC (not the player) is on. |
| 88 | |
88 | |
| 89 | =item $msg - The actual message as passed to this method. |
89 | =item $msg - The actual message as passed to this method. |
| 90 | |
90 | |
| 91 | =item $match - An arrayref with previous results from C<@parse>. |
91 | =item $match - An arrayref with previous results from C<@parse>. |
| 92 | |
92 | |
| … | |
… | |
| 98 | |
98 | |
| 99 | =item $flag - A hashref that stores flags associated with the player and |
99 | =item $flag - A hashref that stores flags associated with the player and |
| 100 | can be seen by all NPCs (so better name your flags uniquely). This is |
100 | can be seen by all NPCs (so better name your flags uniquely). This is |
| 101 | useful for storing e.g. quest information. See C<@setflag> and C<@ifflag>. |
101 | useful for storing e.g. quest information. See C<@setflag> and C<@ifflag>. |
| 102 | |
102 | |
|
|
103 | =item $find - see @find, below. |
|
|
104 | |
| 103 | =back |
105 | =back |
| 104 | |
106 | |
| 105 | The environment is that standard "map scripting environment", which is |
107 | The environment is that standard "map scripting environment", which is |
| 106 | limited in the type of constructs allowed (no loops, for example). |
108 | limited in the type of constructs allowed (no loops, for example). |
| 107 | |
109 | |
|
|
110 | Here is a example: |
|
|
111 | |
|
|
112 | =over 4 |
|
|
113 | |
|
|
114 | =item B<matching for an item name> |
|
|
115 | |
|
|
116 | @match hi |
|
|
117 | @cond grep $_->name =~ /royalty/, $who->inv |
|
|
118 | You got royalties there! Wanna have! |
|
|
119 | |
|
|
120 | You may want to change the C<name> method there to something like C<title>, |
|
|
121 | C<slaying> or any other method that is allowed to be called on a |
|
|
122 | C<cf::object> here. |
|
|
123 | |
|
|
124 | =item B<matching for an item name and removing the matched item> |
|
|
125 | |
|
|
126 | @match found earhorn |
|
|
127 | @cond grep $_->slaying =~ /Gramp's walking stick/, $who->inv |
|
|
128 | @eval my @g = grep { $_->slaying =~ /Gramp's walking stick/ } $who->inv; $g[0]->decrease; |
|
|
129 | Thanks for the earhorn! |
|
|
130 | |
|
|
131 | This example is a bit more complex. The C<@eval> statement will search |
|
|
132 | the players inventory for the same term as the C<@cond> and then |
|
|
133 | decreases the number of objects used there. |
|
|
134 | |
|
|
135 | (See also the map: C<scorn/houses/cornerbrook.map> for an example how this is |
|
|
136 | used in the real world :-) |
|
|
137 | |
|
|
138 | =back |
|
|
139 | |
| 108 | =item @eval perl |
140 | =item @eval perl |
| 109 | |
141 | |
| 110 | Like C<@cond>, but proceed regardless of the outcome. |
142 | Like C<@cond>, but proceed regardless of the outcome. |
| 111 | |
143 | |
| 112 | =item @msg perl |
144 | =item @msg perl |
| 113 | |
145 | |
| 114 | Like C<@cond>, but the return value will be stringified and prepended to |
146 | Like C<@cond>, but the return value will be stringified and prepended to |
| 115 | the message. |
147 | the reply message. |
|
|
148 | |
|
|
149 | =item @check match expression |
|
|
150 | |
|
|
151 | Executes a match expression (see |
|
|
152 | http://pod.tst.eu/http://cvs.schmorp.de/deliantra/server/lib/cf/match.pm) |
|
|
153 | to see if it matches. |
|
|
154 | |
|
|
155 | C<self> is the npc object, C<object>, C<source> and C<originator> are the |
|
|
156 | player communicating with the NPC. |
|
|
157 | |
|
|
158 | If the check fails, the match is skipped. |
|
|
159 | |
|
|
160 | =item @find match expression |
|
|
161 | |
|
|
162 | Like C<@check> in that it executes a match expression, but instead of |
|
|
163 | failing, it gathers all objects into an array and provides a reference to |
|
|
164 | the array in the C<$find> variable. |
|
|
165 | |
|
|
166 | When you want to skip the match when no objects have been found, combine |
|
|
167 | C<@find> with C<@cond>: |
|
|
168 | |
|
|
169 | @match see my spellbook |
|
|
170 | @find type=SPELLBOOK in inv |
|
|
171 | @cond @$find |
|
|
172 | It looks dirty. |
|
|
173 | @match see my spellbook |
|
|
174 | I can't see any, where do you have it? |
| 116 | |
175 | |
| 117 | =item @setstate state value |
176 | =item @setstate state value |
| 118 | |
177 | |
| 119 | Sets the named state C<state> to the given C<value>. State values are |
178 | Sets the named state C<state> to the given C<value>. State values are |
| 120 | associated with a specific player-NPC pair, so each NPC has its own state |
179 | associated with a specific player-NPC pair, so each NPC has its own state |
| … | |
… | |
| 125 | See C<@ifstate> for an example. |
184 | See C<@ifstate> for an example. |
| 126 | |
185 | |
| 127 | =item @ifstate state value |
186 | =item @ifstate state value |
| 128 | |
187 | |
| 129 | Requires that the named C<state> has the given C<value>, otherwise this |
188 | Requires that the named C<state> has the given C<value>, otherwise this |
| 130 | topic is skipped. For more complex comparisons, see C<@cond> with |
189 | topic is skipped. For more complex comparisons, see C<@cond> with |
| 131 | C<$state>. Example: |
190 | C<$state>. Example: |
| 132 | |
191 | |
| 133 | @match quest |
192 | @match quest |
| 134 | @setstate question quest |
193 | @setstate question quest |
| 135 | Do you really want to help find the magic amulet of Beeblebrox? |
194 | Do you really want to help find the magic amulet of Beeblebrox? |
| … | |
… | |
| 143 | associated with a specific player and can be seen by all NPCs. with |
202 | associated with a specific player and can be seen by all NPCs. with |
| 144 | respect to a particular player, which makes them suitable to store quest |
203 | respect to a particular player, which makes them suitable to store quest |
| 145 | markers and other information (e.g. reputation/alignment). Flags are |
204 | markers and other information (e.g. reputation/alignment). Flags are |
| 146 | persistent over the lifetime of a player, so be careful :) |
205 | persistent over the lifetime of a player, so be careful :) |
| 147 | |
206 | |
|
|
207 | Perversely enough, using C<@setfflag> without a C<value> clears the flag |
|
|
208 | as if it was never set, so always provide a flag value (e.g. C<1>) when |
|
|
209 | you want to set the flag. |
|
|
210 | |
| 148 | See C<@ifflag> for an example. |
211 | See C<@ifflag> for an example. |
| 149 | |
212 | |
| 150 | =item @ifflag flag value |
213 | =item @ifflag flag value |
| 151 | |
214 | |
| 152 | Requires that the named C<flag> has the given C<value>, otherwise this |
215 | Requires that the named C<flag> has the given C<value>, otherwise this |
| 153 | topic is skipped. For more complex comparisons, see C<@cond> with |
216 | topic is skipped. For more complex comparisons, see C<@cond> with |
| 154 | C<$flag>. Example: |
217 | C<$flag>. |
|
|
218 | |
|
|
219 | If no C<value> is given, then the ifflag succeeds when the flag is true. |
|
|
220 | |
|
|
221 | Example: |
| 155 | |
222 | |
| 156 | @match I want to do the quest! |
223 | @match I want to do the quest! |
| 157 | @setflag kings_quest 1 |
224 | @setflag kings_quest 1 |
| 158 | Then seek out Bumblebee in Navar, he will tell you... |
225 | Then seek out Bumblebee in Navar, he will tell you... |
| 159 | @match I did the quest |
226 | @match I did the quest |
| … | |
… | |
| 164 | |
231 | |
| 165 | @match hi |
232 | @match hi |
| 166 | @ifflag kings_quest |
233 | @ifflag kings_quest |
| 167 | Hi, I was told you want to do the kings quest? |
234 | Hi, I was told you want to do the kings quest? |
| 168 | |
235 | |
| 169 | =item @trigger connected-id |
236 | =item @trigger connected-id [state] |
| 170 | |
237 | |
| 171 | Trigger all objects with the given connected-id. The trigger is stateful |
238 | Trigger all objects with the given connected-id. |
| 172 | and retains state per connected-id. |
239 | |
|
|
240 | When the state argument is omitted the trigger is stateful and retains an |
|
|
241 | internal state per connected-id. There is a limitation to the use of this: The |
|
|
242 | state won't be changed when the connection is triggered by other triggers. So |
|
|
243 | be careful when triggering the connection from other objects. |
|
|
244 | |
|
|
245 | When a state argument is given it should be a positive integer. Any value |
|
|
246 | C<!= 0> will 'push' the connection (in general, you should specify C<1> |
|
|
247 | for this) and C<0> will 'release' the connection. This is useful for |
|
|
248 | example when you want to let an NPC control a door. |
|
|
249 | |
|
|
250 | Trigger all objects with the given connected-id by 'releasing' the connection. |
|
|
251 | |
|
|
252 | =item @playersound face-name |
|
|
253 | |
|
|
254 | Plays the given sound face (either an alias or sound file path) so that |
|
|
255 | only the player talking to the npc can hear it. |
|
|
256 | |
|
|
257 | =item @npcsound face-name |
|
|
258 | |
|
|
259 | Plays the given sound face (either an alias or sound file path) as if |
|
|
260 | the npc had made that sound, i.e. it will be located at the npc and all |
|
|
261 | players near enough can hear it. |
| 173 | |
262 | |
| 174 | =item @addtopic topic |
263 | =item @addtopic topic |
| 175 | |
264 | |
| 176 | Adds the given topic names (separated by C<|>) to the list of topics |
265 | Adds the given topic names (separated by C<|>) to the list of topics |
| 177 | returned. |
266 | returned. |
| … | |
… | |
| 186 | my $lcmsg = lc $msg; |
275 | my $lcmsg = lc $msg; |
| 187 | |
276 | |
| 188 | topic: |
277 | topic: |
| 189 | for my $match (@{ $self->{match} }) { |
278 | for my $match (@{ $self->{match} }) { |
| 190 | for (split /\|/, $match->[0]) { |
279 | for (split /\|/, $match->[0]) { |
| 191 | if ($_ eq "*" || $lcmsg eq lc) { |
280 | if ($_ eq "*" || $lcmsg =~ /\b\Q$_\E\b/i) { |
| 192 | my $reply = $match->[1]; |
281 | my $reply = $match->[1]; |
| 193 | my @kw; |
282 | my @kw; |
| 194 | |
283 | |
| 195 | my @replies; |
284 | my @replies; |
| 196 | my @match; # @match/@parse command results |
285 | my @match; # @match/@parse command results |
| 197 | |
286 | |
| 198 | my $state = $self->{npc}{$self->{ob}->name}{dialog_state} ||= {}; |
287 | my $state = $self->{npc}{$self->{ob}->name}{dialog_state} ||= {}; |
| 199 | my $flag = $self->{ob}{dialog_flag} ||= {}; |
288 | my $flag = $self->{ob}{dialog_flag} ||= {}; |
|
|
289 | |
|
|
290 | my @find; |
| 200 | |
291 | |
| 201 | my %vars = ( |
292 | my %vars = ( |
| 202 | who => $self->{ob}, |
293 | who => $self->{ob}, |
| 203 | npc => $self->{npc}, |
294 | npc => $self->{npc}, |
|
|
295 | map => $self->{npc}->map, |
| 204 | state => $state, |
296 | state => $state, |
| 205 | flag => $flag, |
297 | flag => $flag, |
| 206 | msg => $msg, |
298 | msg => $msg, |
| 207 | match => \@match, |
299 | match => \@match, |
|
|
300 | find => \@find, |
| 208 | ); |
301 | ); |
| 209 | |
302 | |
| 210 | local $self->{ob}{record_replies} = \@replies; |
303 | local $self->{ob}{record_replies} = \@replies; |
| 211 | |
304 | |
| 212 | # now execute @-commands (which can result in a no-match) |
305 | # now execute @-commands (which can result in a no-match) |
| … | |
… | |
| 219 | or next topic; |
312 | or next topic; |
| 220 | |
313 | |
| 221 | } elsif ($cmd eq "comment") { |
314 | } elsif ($cmd eq "comment") { |
| 222 | # nop |
315 | # nop |
| 223 | |
316 | |
|
|
317 | } elsif ($cmd eq "playersound") { |
|
|
318 | $self->{ob}->contr->play_sound (cf::sound::find $args); |
|
|
319 | |
|
|
320 | } elsif ($cmd eq "npcsound") { |
|
|
321 | $self->{npc}->play_sound (cf::sound::find $args); |
|
|
322 | |
| 224 | } elsif ($cmd eq "cond") { |
323 | } elsif ($cmd eq "cond") { |
| 225 | cf::safe_eval $args, %vars |
324 | cf::safe_eval $args, %vars |
| 226 | or next topic; |
325 | or next topic; |
| 227 | |
326 | |
| 228 | } elsif ($cmd eq "eval") { |
327 | } elsif ($cmd eq "eval") { |
| 229 | cf::safe_eval $args, %vars; |
328 | cf::safe_eval $args, %vars; |
| 230 | warn "\@eval evaluation error: $@\n" if $@; |
329 | warn "\@eval evaluation error: $@\n" if $@; |
| 231 | |
330 | |
|
|
331 | } elsif ($cmd eq "check") { |
|
|
332 | eval { |
|
|
333 | cf::match::match $args, $self->{ob}, $self->{npc}, $self->{ob} |
|
|
334 | or next topic; |
|
|
335 | }; |
|
|
336 | warn "\@check evaluation error: $@\n" if $@; |
|
|
337 | |
|
|
338 | } elsif ($cmd eq "find") { |
|
|
339 | @find = eval { |
|
|
340 | cf::match::match $args, $self->{ob}, $self->{npc}, $self->{ob} |
|
|
341 | }; |
|
|
342 | warn "\@find evaluation error: $@\n" if $@; |
|
|
343 | |
| 232 | } elsif ($cmd eq "msg") { |
344 | } elsif ($cmd eq "msg") { |
| 233 | push @replies, [$self->{npc}, (scalar cf::safe_eval $args, %vars)]; |
345 | push @replies, [$self->{npc}, (scalar cf::safe_eval $args, %vars)]; |
| 234 | |
346 | |
| 235 | } elsif ($cmd eq "setflag") { |
347 | } elsif ($cmd eq "setflag") { |
| 236 | my ($name, $value) = split /\s+/, $args, 2; |
348 | my ($name, $value) = split /\s+/, $args, 2; |
| 237 | $value ? $flag->{$name} = $value |
349 | defined $value ? $flag->{$name} = $value |
| 238 | : delete $flag->{$name}; |
350 | : delete $flag->{$name}; |
| 239 | |
351 | |
| 240 | } elsif ($cmd eq "setstate") { |
352 | } elsif ($cmd eq "setstate") { |
| 241 | my ($name, $value) = split /\s+/, $args, 2; |
353 | my ($name, $value) = split /\s+/, $args, 2; |
| 242 | $value ? $state->{$name} = $value |
354 | defined $value ? $state->{$name} = $value |
| 243 | : delete $state->{$name}; |
355 | : delete $state->{$name}; |
| 244 | |
356 | |
| 245 | } elsif ($cmd eq "ifflag") { |
357 | } elsif ($cmd eq "ifflag") { |
| 246 | my ($name, $value) = split /\s+/, $args, 2; |
358 | my ($name, $value) = split /\s+/, $args, 2; |
| 247 | $flag->{$name} eq $value |
359 | defined $value ? $flag->{$name} eq $value |
|
|
360 | : $flag->{$name} |
| 248 | or next topic; |
361 | or next topic; |
| 249 | |
362 | |
| 250 | } elsif ($cmd eq "ifstate") { |
363 | } elsif ($cmd eq "ifstate") { |
| 251 | my ($name, $value) = split /\s+/, $args, 2; |
364 | my ($name, $value) = split /\s+/, $args, 2; |
| 252 | $state->{$name} eq $value |
365 | defined $value ? $state->{$name} eq $value |
|
|
366 | : $state->{$name} |
| 253 | or next topic; |
367 | or next topic; |
| 254 | |
368 | |
| 255 | } elsif ($cmd eq "trigger") { |
369 | } elsif ($cmd eq "trigger") { |
|
|
370 | my ($con, $state) = split /\s+/, $args, 2; |
|
|
371 | |
|
|
372 | if (defined $state) { |
|
|
373 | $self->{npc}->map->trigger ($con, $state, $self->{npc}, $self->{ob}); |
|
|
374 | } else { |
| 256 | my $rvalue = \$self->{npc}{dialog_trigger}{$args*1}; |
375 | my $rvalue = \$self->{npc}{dialog_trigger}{$con+0}; |
| 257 | $self->{npc}->map->trigger ($args, $$rvalue = !$$rvalue); |
376 | $self->{npc}->map->trigger ($con, $$rvalue = !$$rvalue, $self->{npc}, $self->{ob}); |
|
|
377 | } |
| 258 | |
378 | |
| 259 | } elsif ($cmd eq "addtopic") { |
379 | } elsif ($cmd eq "addtopic") { |
| 260 | push @kw, split /\|/, $args; |
380 | push @kw, split /\|/, $args; |
| 261 | $self->{add_topic}->(split /\s*\|\s*/, $args) if $self->{add_topic}; |
381 | $self->{add_topic}->(split /\s*\|\s*/, $args) if $self->{add_topic}; |
| 262 | |
382 | |
| … | |
… | |
| 269 | } |
389 | } |
| 270 | } |
390 | } |
| 271 | |
391 | |
| 272 | delete $self->{npc}{$self->{ob}->name}{dialog_state} unless %$state; |
392 | delete $self->{npc}{$self->{ob}->name}{dialog_state} unless %$state; |
| 273 | delete $self->{ob}{dialog_flag} unless %$flag; |
393 | delete $self->{ob}{dialog_flag} unless %$flag; |
| 274 | |
|
|
| 275 | # combine lines into paragraphs |
|
|
| 276 | $reply =~ s/(?<=\S)\n(?=\w)/ /g; |
|
|
| 277 | $reply =~ s/\n\n/\n/g; |
|
|
| 278 | |
394 | |
| 279 | # ignores flags and npc from replies |
395 | # ignores flags and npc from replies |
| 280 | $reply = join "\n", (map $_->[1], @replies), $reply; |
396 | $reply = join "\n", (map $_->[1], @replies), $reply; |
| 281 | |
397 | |
| 282 | # now mark up all matching keywords |
398 | # now mark up all matching keywords |
| … | |
… | |
| 287 | last; |
403 | last; |
| 288 | } |
404 | } |
| 289 | } |
405 | } |
| 290 | } |
406 | } |
| 291 | |
407 | |
|
|
408 | $self->{npc}->use_trigger ($self->{ob}) |
|
|
409 | if $self->{npc}->type == cf::MAGIC_EAR; |
|
|
410 | |
| 292 | return wantarray ? ($reply, @kw) : $reply; |
411 | return wantarray ? ($reply, @kw) : $reply; |
| 293 | } |
412 | } |
| 294 | } |
413 | } |
| 295 | } |
414 | } |
| 296 | |
415 | |
