annotate systems/scriptingsystem.py @ 189:4381be70e1bb tip

Fixed incompatibility with latest changes to bgrease.
author Beliar <KarstenBock@gmx.net>
date Sun, 08 Apr 2012 20:30:43 +0200
parents 2a12e2843984
children
rev   line source
12
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
1 # This program is free software: you can redistribute it and/or modify
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
2 # it under the terms of the GNU General Public License as published by
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
3 # the Free Software Foundation, either version 3 of the License, or
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
4 # (at your option) any later version.
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
5 #
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
6 # This program is distributed in the hope that it will be useful,
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
7 # but WITHOUT ANY WARRANTY; without even the implied warranty of
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
9 # GNU General Public License for more details.
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
10 #
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
11 # You should have received a copy of the GNU General Public License
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
12 # along with this program. If not, see <http://www.gnu.org/licenses/>.
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
13
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
14 from collections import deque
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
15 from copy import deepcopy
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
16
188
2a12e2843984 Removed bGrease, which is in a seperate repository, here: https://github.com/Beliaar/bGrease
Beliar <KarstenBock@gmx.net>
parents: 174
diff changeset
17 from bGrease import System
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
18
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
19 class Script(object):
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
20 """Script object"""
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
21
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
22 def __init__(self, actions, system):
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
23 """Constructor"""
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
24 assert(isinstance(actions, deque))
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
25 self.actions = actions
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
26 assert(isinstance(system, ScriptingSystem))
159
1b66e1ce226b script commands are stored in the System now instead of the the script object.
KarstenBock@gmx.net
parents: 157
diff changeset
27 self.system = system
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
28 self.reset()
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
29
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
30 def reset(self):
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
31 """Resets the state of the script"""
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
32 self.running_actions = deepcopy(self.actions)
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
33 self.running = False
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
34 self.finished = False
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
35 self.time = 0
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
36 self.wait = 0
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
37 self.cur_action = None
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
38
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
39 def update(self, time):
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
40 """Advance the script"""
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
41 if not self.running:
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
42 return
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
43 if self.cur_action and not self.cur_action.executed:
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
44 return
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
45 self.time += time
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
46 if self.wait <= self.time:
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
47 self.time = 0
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
48 try:
174
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
49 globals, locals = self.system.game_state.getGameEnvironment()
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
50 action_data = self.running_actions.popleft()
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
51 action = self.system.actions[action_data[0]]
174
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
52 action_params = eval(
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
53 action_data[1],
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
54 globals, locals
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
55 )
164
ed24962cdf5e Small fixes.
KarstenBock@gmx.net
parents: 161
diff changeset
56 if not (isinstance(action_params, list)
ed24962cdf5e Small fixes.
KarstenBock@gmx.net
parents: 161
diff changeset
57 or isinstance(action_params, tuple)):
ed24962cdf5e Small fixes.
KarstenBock@gmx.net
parents: 161
diff changeset
58 action_params = [action_params]
ed24962cdf5e Small fixes.
KarstenBock@gmx.net
parents: 161
diff changeset
59 self.cur_action = action(self.system.world, *action_params)
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
60 self.wait = action_data[2]
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
61 if len(action_data) >= 4:
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
62 vals = (
174
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
63 eval(action_data[4], globals, locals)
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
64 if len(action_data) > 4
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
65 else ()
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
66 )
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
67 command = action_data[3]
159
1b66e1ce226b script commands are stored in the System now instead of the the script object.
KarstenBock@gmx.net
parents: 157
diff changeset
68 self.system.commands[command](
1b66e1ce226b script commands are stored in the System now instead of the the script object.
KarstenBock@gmx.net
parents: 157
diff changeset
69 *vals,
1b66e1ce226b script commands are stored in the System now instead of the the script object.
KarstenBock@gmx.net
parents: 157
diff changeset
70 action=self.cur_action
1b66e1ce226b script commands are stored in the System now instead of the the script object.
KarstenBock@gmx.net
parents: 157
diff changeset
71 )
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
72 else:
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
73 self.cur_action.execute()
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
74 except IndexError:
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
75 self.finished = True
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
76 self.running = False
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
77
12
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
78
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
79 class ScriptingSystem(System):
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
80 """
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
81 System responsible for managing scripts attached to entities to define
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
82 their behavior.
9c7a96c6fe41 Refactored components and began defining basic Entities and Systems.
M. George Hansen <technopolitica@gmail.com>
parents:
diff changeset
83 """
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
84
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
85 def __init__(self, commands, actions):
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
86 """Constructor"""
159
1b66e1ce226b script commands are stored in the System now instead of the the script object.
KarstenBock@gmx.net
parents: 157
diff changeset
87 self.commands = commands
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
88 self.actions = actions
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
89 self.game_state = None
161
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
90 self.reset()
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
91
161
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
92 def reset(self):
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
93 """Resets the script and condition collections"""
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
94 self.scripts = {}
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
95 self.conditions = []
173
3abd31885f0f Added a method to the ScriptingSystem that returns the environment(locals, globals) in which scripts are run.
Beliar <KarstenBock@gmx.net>
parents: 171
diff changeset
96
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
97 def step(self, dt):
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
98 """Execute a time step for the system. Must be defined
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
99 by all system classes.
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
100
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
101 :param dt: Time since last step invocation
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
102 :type dt: float
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
103 """
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
104 for condition_data in self.conditions:
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
105 condition = condition_data[0]
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
106 script_name = condition_data[1]
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
107 if not self.scripts.has_key(script_name):
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
108 return
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
109 script = self.scripts[script_name]
174
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
110 if (eval(condition, *self.game_state.getGameEnvironment())
230d316cc43b Moved the getEnvironment method from the ScriptingSystem to the GameState and renamed it to getGameEnvironment.
Beliar
parents: 173
diff changeset
111 and not script.running):
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
112 script.running = True
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
113 for script in self.scripts.itervalues():
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
114 assert(isinstance(script, Script))
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
115 if script.finished:
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
116 script.reset()
157
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
117 elif script.running:
79d6b17b80a3 Implemented simple script system.
KarstenBock@gmx.net
parents: 65
diff changeset
118 script.update(dt)
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
119
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
120 def setScript(self, name, actions):
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
121 """Sets a script.
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
122 @param name: The name of the script
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
123 @param actions: What the script does
161
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
124 @type actions: deque or iterable
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
125 """
161
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
126 if not(isinstance(actions, deque)):
d224bbce512a Implemented loading scripts from files.
KarstenBock@gmx.net
parents: 160
diff changeset
127 actions = deque(actions)
160
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
128 self.scripts[name] = Script(actions,
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
129 self
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
130 )
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
131
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
132 def addCondition(self, condition, script_name):
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
133 """Adds a condition.
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
134 @param condition: Condition which will be evaluated
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
135 @param script_name: Name of the script that will be executed if the
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
136 condition evaluates to True.
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
137 """
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
138 self.conditions.append((condition, script_name))
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
139
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
140
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
141 def runScript(self, name):
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
142 """Runs a script with the given name
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
143 @param name: The name of the script"""
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
144 if self.scripts.has_key(name):
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
145 self.scripts[name].running = True
75c0b728ccf3 Further work on the scripting system.
KarstenBock@gmx.net
parents: 159
diff changeset
146
171
565ffdd98d68 Added math functions to the scripting system functions.
Beliar <KarstenBock@gmx.net>
parents: 164
diff changeset
147