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