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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.54 by root, Tue Aug 29 14:49:28 2006 UTC vs.
Revision 1.55 by root, Tue Aug 29 17:32:19 2006 UTC

… …
105} 105}
106 106
107############################################################################# 107#############################################################################
108# "new" plug-in system 108# "new" plug-in system
109 109
110=head3 EVENTS AND OBJECT ATTACHMENTS
111
112=over 4
113
110=item $object->attach ($attachment, key => $value...) 114=item $object->attach ($attachment, key => $value...)
111 115
112=item $object->detach ($attachment) 116=item $object->detach ($attachment)
113 117
114Attach/detach a pre-registered attachment to an object. 118Attach/detach a pre-registered attachment to an object.
… …
122=item $map->attach ($attachment, key => $value...) 126=item $map->attach ($attachment, key => $value...)
123 127
124=item $map->detach ($attachment) 128=item $map->detach ($attachment)
125 129
126Attach/detach a pre-registered attachment to a map. 130Attach/detach a pre-registered attachment to a map.
131
132=item $bool = $object->attached ($name)
133
134=item $bool = $player->attached ($name)
135
136=item $bool = $map->attached ($name)
137
138Checks wether the named attachment is currently attached to the object.
127 139
128=item cf::attach_global ... 140=item cf::attach_global ...
129 141
130Attach handlers for global events. 142Attach handlers for global events.
131 143
… …
181Attach handlers to all maps. 193Attach handlers to all maps.
182 194
183=item cf:register_attachment $name, ... 195=item cf:register_attachment $name, ...
184 196
185Register an attachment by name through which objects can refer to this 197Register an attachment by name through which objects can refer to this
198attachment.
199
200=item cf:register_player_attachment $name, ...
201
202Register an attachment by name through which players can refer to this
186attachment. 203attachment.
187 204
188=item cf:register_map_attachment $name, ... 205=item cf:register_map_attachment $name, ...
189 206
190Register an attachment by name through which maps can refer to this 207Register an attachment by name through which maps can refer to this
… …
261} 278}
262 279
263sub _attach_attachment { 280sub _attach_attachment {
264 my ($obj, $name, %arg) = @_; 281 my ($obj, $name, %arg) = @_;
265 282
283 return if exists $obj->{_attachment}{$name};
284
266 my $res; 285 my $res;
267 286
268 if (my $attach = $attachment{$name}) { 287 if (my $attach = $attachment{$name}) {
269 my $registry = $obj->registry; 288 my $registry = $obj->registry;
270 289
… …
288*cf::player::attach = 307*cf::player::attach =
289*cf::map::attach = sub { 308*cf::map::attach = sub {
290 my ($obj, $name, %arg) = @_; 309 my ($obj, $name, %arg) = @_;
291 310
292 _attach_attachment $obj, $name, %arg; 311 _attach_attachment $obj, $name, %arg;
293} 312};
294 313
295# all those should be optimised 314# all those should be optimised
296*cf::object::detach = 315*cf::object::detach =
297*cf::player::detach = 316*cf::player::detach =
298*cf::map::detach = sub { 317*cf::map::detach = sub {
299 my ($obj, $name) = @_; 318 my ($obj, $name) = @_;
300 319
301 delete $obj->{_attachment}{$name}; 320 delete $obj->{_attachment}{$name};
302 reattach $obj; 321 reattach ($obj);
322};
323
324*cf::object::attached =
325*cf::player::attached =
326*cf::map::attached = sub {
327 my ($obj, $name) = @_;
328
329 exists $obj->{_attachment}{$name}
303}; 330};
304 331
305sub attach_global { 332sub attach_global {
306 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 333 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
307} 334}
… …
327 354
328sub register_attachment { 355sub register_attachment {
329 my $name = shift; 356 my $name = shift;
330 357
331 $attachment{$name} = [[KLASS_OBJECT, @_]]; 358 $attachment{$name} = [[KLASS_OBJECT, @_]];
359}
360
361sub register_player_attachment {
362 my $name = shift;
363
364 $attachment{$name} = [[KLASS_PLAYER, @_]];
332} 365}
333 366
334sub register_map_attachment { 367sub register_map_attachment {
335 my $name = shift; 368 my $name = shift;
336 369
… …
365 return 1 if $override; 398 return 1 if $override;
366 } 399 }
367 400
368 0 401 0
369} 402}
403
404=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
405
406=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407
408=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
409
410=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411
412Generate a global/object/player/map-specific event with the given arguments.
413
414This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
415removed in future versions), and there is no public API to access override
416results (if you must, access C<@cf::invoke_results> directly).
417
418=back
419
420=head2 methods valid for all pointers
421
422=over 4
423
424=item $object->valid
425
426=item $player->valid
427
428=item $map->valid
429
430Just because you have a perl object does not mean that the corresponding
431C-level object still exists. If you try to access an object that has no
432valid C counterpart anymore you get an exception at runtime. This method
433can be used to test for existence of the C object part without causing an
434exception.
435
436=back
437
438=cut
439
440*cf::object::valid =
441*cf::player::valid =
442*cf::map::valid = \&cf::_valid;
370 443
371############################################################################# 444#############################################################################
372# object support 445# object support
373 446
374sub instantiate { 447sub instantiate {

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines