1 | #! perl |
1 | # |
|
|
2 | # This file is part of Deliantra, the Roguelike Realtime MMORPG. |
|
|
3 | # |
|
|
4 | # Copyright (©) 2017,2018 Marc Alexander Lehmann / the Deliantra team |
|
|
5 | # Copyright (©) 2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
|
|
6 | # |
|
|
7 | # Deliantra is free software: you can redistribute it and/or modify it under |
|
|
8 | # the terms of the Affero GNU General Public License as published by the |
|
|
9 | # Free Software Foundation, either version 3 of the License, or (at your |
|
|
10 | # option) any later version. |
|
|
11 | # |
|
|
12 | # This program is distributed in the hope that it will be useful, |
|
|
13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
15 | # GNU General Public License for more details. |
|
|
16 | # |
|
|
17 | # You should have received a copy of the Affero GNU General Public License |
|
|
18 | # and the GNU General Public License along with this program. If not, see |
|
|
19 | # <http://www.gnu.org/licenses/>. |
|
|
20 | # |
|
|
21 | # The authors can be reached via e-mail to <support@deliantra.net> |
|
|
22 | # |
2 | |
23 | |
3 | # this implements the mapscript connectable |
24 | =head1 NAME |
4 | |
25 | |
5 | package safe::mapscript; |
26 | cf::mapscript |
6 | |
27 | |
7 | use strict qw(subs vars); |
28 | =head1 DESCRIPTION |
8 | |
29 | |
|
|
30 | This module implements the mapscript object. |
|
|
31 | |
|
|
32 | Map scripts are perl snippets that get executed whenever any connected |
|
|
33 | element is triggered (e.g. a check inv, a lever etc.) |
|
|
34 | |
|
|
35 | =head1 ENVIRONMENT |
|
|
36 | |
|
|
37 | The map scripts are compiled and executed into a namespace with the |
|
|
38 | following symbols available: |
|
|
39 | |
|
|
40 | =over 4 |
|
|
41 | |
|
|
42 | =cut |
|
|
43 | |
|
|
44 | package cf::mapscript::eval; |
|
|
45 | |
|
|
46 | use common::sense; |
|
|
47 | |
|
|
48 | =item $self |
|
|
49 | |
|
|
50 | The mapscript object itself. |
|
|
51 | |
|
|
52 | =item $state |
|
|
53 | |
|
|
54 | The state value (0 means release, <>0 means push/trigger/enable) that |
|
|
55 | triggered the map script. |
|
|
56 | |
|
|
57 | =item $activator |
|
|
58 | |
|
|
59 | The object that was triggered (the lever, check inv element, npc etc.). |
|
|
60 | |
|
|
61 | =item $originator |
|
|
62 | |
|
|
63 | The object that triggered the activator, usually (but not always) the |
|
|
64 | player who stepped on a check inv, pulled a lever etc. Can be C<undef>. |
|
|
65 | |
|
|
66 | =cut |
|
|
67 | |
9 | our ($self, $state, $activator, $originator); |
68 | use vars qw($self $state $activator $originator); |
|
|
69 | |
|
|
70 | =item @obs = find $id_or_object |
|
|
71 | |
|
|
72 | Finds all objects with the given I<connected> C<$id>. If an object |
|
|
73 | reference is passed, it will be returned unchanged. |
|
|
74 | |
|
|
75 | =cut |
10 | |
76 | |
11 | sub find($) { |
77 | sub find($) { |
12 | ref $_[0] ? $_[0] |
78 | ref $_[0] ? $_[0] |
13 | : $self->map->find_link ($_[0]) |
79 | : $self->map->find_link ($_[0]) |
14 | } |
80 | } |
15 | |
81 | |
16 | sub get($) { |
82 | =item trigger $id_or_object[, $state] |
17 | (&find)[0]->value |
83 | |
18 | } |
84 | Triggers the linked chain with the given I<connected> id, or the connected |
|
|
85 | chain associated with the given object (if an object reference is passed), |
|
|
86 | and passes the given state (or C<1>, if missing) to it. |
|
|
87 | |
|
|
88 | =cut |
19 | |
89 | |
20 | sub trigger($;$) { |
90 | sub trigger($;$) { |
21 | $self->map->trigger ($_[0], $#_ ? $_[1] : 1, $self); |
91 | $self->map->trigger ($_[0], $#_ ? $_[1] : 1, $self); |
22 | } |
92 | } |
23 | |
93 | |
|
|
94 | =item timer $id_or_object, $seconds |
|
|
95 | |
|
|
96 | Starts the timer on the given mapscript object (usually, C<$id_or_object> is |
|
|
97 | C<$self>). When the timer expires on the mapscript object, it will trigger |
|
|
98 | the script with C<$activator == $self> and C<$originator == undef>. |
|
|
99 | |
|
|
100 | =cut |
|
|
101 | |
24 | sub timer($$) { |
102 | sub timer($$) { |
25 | my $ob = (&find)[0]; |
103 | my $ob = (&find)[0]; |
26 | $ob->speed_left ($_[1] / -cf::TICK); |
104 | $ob->speed_left (-$_[1] / cf::TICK); |
27 | $ob->set_speed (1); |
105 | $ob->set_speed (1); |
28 | } |
106 | } |
29 | |
107 | |
30 | package cf::mapscript; |
108 | package cf::mapscript; |
31 | |
109 | |
32 | use strict qw(subs vars); |
110 | use common::sense; |
|
|
111 | |
|
|
112 | *{"main::safe::cf::mapscript::eval::"} = \%{"main::cf::mapscript::eval::"}; |
33 | |
113 | |
34 | our %CACHE; |
114 | our %CACHE; |
35 | |
115 | |
36 | sub activate($$$) { |
116 | sub activate($$$) { |
|
|
117 | package cf::mapscript::eval; |
|
|
118 | |
37 | ($self, $state, $activator, $originator) = @_; |
119 | ($self, $state, $activator, $originator) = @_; |
38 | |
120 | |
39 | ( |
121 | ( |
40 | $CACHE{$self->msg} ||= cf::safe_eval |
122 | $CACHE{$self->msg} ||= cf::safe_eval |
41 | "package mapscript; sub {\n" |
123 | "package cf::mapscript::eval; sub {\n" |
42 | . "#line 1 '" . ($self->debug_desc) . "'\n" |
124 | . "#line 1 '" . ($self->debug_desc) . "'\n" |
43 | . $self->msg |
125 | . $self->msg |
44 | . "\n}" |
126 | . "\n}" |
45 | or sub { } |
127 | or sub { } |
46 | )->(); |
128 | )->(); |
47 | } |
129 | } |
48 | |
130 | |
|
|
131 | =back |
|
|
132 | |
|
|
133 | =head1 EXAMPLE |
|
|
134 | |
|
|
135 | Have a look at F<scorn/anthonty/portgate.map> for a nontrivial example. |
|
|
136 | |
|
|
137 | =cut |
|
|
138 | |
49 | 1; |
139 | 1; |