annotate behaviours/base.py @ 48:1bdadb768bcf

Added approach functionality to the BaseBehaviour
author KarstenBock@gmx.net
date Thu, 08 Sep 2011 14:20:31 +0200
parents bf506f739322
children b4a525456c99
rev   line source
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
1 # This file is part of PARPG.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
2
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
3 # PARPG is free software: you can redistribute it and/or modify
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
4 # it under the terms of the GNU General Public License as published by
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
5 # the Free Software Foundation, either version 3 of the License, or
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
6 # (at your option) any later version.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
7
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
8 # PARPG is distributed in the hope that it will be useful,
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
11 # GNU General Public License for more details.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
12
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
13 # You should have received a copy of the GNU General Public License
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
14 # along with PARPG. If not, see <http://www.gnu.org/licenses/>.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
15
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
16 from fife import fife
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
17
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
18 _AGENT_STATE_NONE, _AGENT_STATE_IDLE, _AGENT_STATE_APPROACH, _AGENT_STATE_RUN, _AGENT_STATE_WANDER, _AGENT_STATE_TALK = xrange(6)
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
19
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
20 class BaseBehaviour (fife.InstanceActionListener):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
21 """Fife agent listener"""
46
bf506f739322 Removed layer as attribute of BaseBehaviour and added it as a parameter to the attachToLayer method.
KarstenBock@gmx.net
parents: 44
diff changeset
22 def __init__(self):
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
23 fife.InstanceActionListener.__init__(self)
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
24 self.agent = None
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
25 self.state = None
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
26 self.speed = 0
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
27 self.idle_counter = 1
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
28
46
bf506f739322 Removed layer as attribute of BaseBehaviour and added it as a parameter to the attachToLayer method.
KarstenBock@gmx.net
parents: 44
diff changeset
29 def attachToLayer(self, agent_ID, layer):
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
30 """Attaches to a certain layer
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
31 @type agent_ID: String
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
32 @param agent_ID: ID of the layer to attach to.
46
bf506f739322 Removed layer as attribute of BaseBehaviour and added it as a parameter to the attachToLayer method.
KarstenBock@gmx.net
parents: 44
diff changeset
33 @type layer: Fife layer
bf506f739322 Removed layer as attribute of BaseBehaviour and added it as a parameter to the attachToLayer method.
KarstenBock@gmx.net
parents: 44
diff changeset
34 @param layer: Layer of the agent to attach the behaviour to
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
35 @return: None"""
46
bf506f739322 Removed layer as attribute of BaseBehaviour and added it as a parameter to the attachToLayer method.
KarstenBock@gmx.net
parents: 44
diff changeset
36 self.agent = layer.getInstance(agent_ID)
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
37 self.agent.addActionListener(self)
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
38 self.state = _AGENT_STATE_NONE
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
39
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
40 def getX(self):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
41 """Get the NPC's x position on the map.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
42 @rtype: integer"
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
43 @return: the x coordinate of the NPC's location"""
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
44 return self.agent.getLocation().getLayerCoordinates().x
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
45
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
46 def getY(self):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
47 """Get the NPC's y position on the map.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
48 @rtype: integer
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
49 @return: the y coordinate of the NPC's location"""
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
50 return self.agent.getLocation().getLayerCoordinates().y
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
51
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
52 def onNewMap(self, layer):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
53 """Sets the agent onto the new layer."""
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
54 if self.agent is not None:
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
55 self.agent.removeActionListener(self)
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
56
44
98f26f7636d8 Changes to make PARPG "runable" with grease. (With the correct modified assets)
KarstenBock@gmx.net
parents: 33
diff changeset
57 self.agent = layer.getInstance(self.parent.fifeagent.identifier)
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
58 self.agent.addActionListener(self)
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
59 self.state = _AGENT_STATE_NONE
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
60 self.idle_counter = 1
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
61
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
62 def idle(self):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
63 """@return: None"""
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
64 self.state = _AGENT_STATE_IDLE
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
65 self.agent.act('stand', self.agent.getFacingLocation())
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
66
48
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
67 def approach(self, location, action=None):
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
68 """Approaches a location and then perform an action (if set).
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
69 @type loc: fife.Location
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
70 @param loc: the location to approach
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
71 @type action: Action
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
72 @param action: The action to schedule for execution after the approach.
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
73 @return: None"""
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
74 self.state = _AGENT_STATE_APPROACH
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
75 self.nextAction = action
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
76 boxLocation = tuple([int(float(i)) for i in location])
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
77 l = fife.Location(self.agent.getLocation())
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
78 l.setLayerCoordinates(fife.ModelCoordinate(*boxLocation))
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
79 self.agent.move('run', l, self.speed + 1)
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
80
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
81 def onInstanceActionFinished(self, instance, action):
48
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
82 """@type instance: ???
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
83 @param instance: ???
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
84 @type action: ???
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
85 @param action: ???
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
86 @return: None"""
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
87 # First we reset the next behavior
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
88 act = self.nextAction
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
89 self.nextAction = None
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
90 self.idle()
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
91
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
92 if act:
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
93 act.execute()
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
94
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
95 if(action.getId() != 'stand'):
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
96 self.idle_counter = 1
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
97 else:
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 46
diff changeset
98 self.idle_counter += 1