ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/ext/NPC_Dialogue.pm
(Generate patch)

Comparing deliantra/server/ext/NPC_Dialogue.pm (file contents):
Revision 1.2 by elmex, Thu Jan 4 15:20:11 2007 UTC vs.
Revision 1.17 by root, Mon Oct 26 02:55:07 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines