annotate behaviours/npc.py @ 48:1bdadb768bcf

Added approach functionality to the BaseBehaviour
author KarstenBock@gmx.net
date Thu, 08 Sep 2011 14:20:31 +0200
parents dd9bd93ec81c
children 8b1ad2d342d8
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 random import randrange
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
17
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
18 from fife import fife
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
19
34
12071706020f Fixed error in setting the initial state of the NPC behaviour
KarstenBock@gmx.net
parents: 33
diff changeset
20 import base
12071706020f Fixed error in setting the initial state of the NPC behaviour
KarstenBock@gmx.net
parents: 33
diff changeset
21 from base import BaseBehaviour
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
22
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
23 class NPCBehaviour(BaseBehaviour):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
24 """This is a basic NPC behaviour"""
46
bf506f739322 Removed layer as attribute of BaseBehaviour and added it as a parameter to the attachToLayer method.
KarstenBock@gmx.net
parents: 34
diff changeset
25 def __init__(self, parent=None):
bf506f739322 Removed layer as attribute of BaseBehaviour and added it as a parameter to the attachToLayer method.
KarstenBock@gmx.net
parents: 34
diff changeset
26 super(NPCBehaviour, self).__init__()
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
27
33
77dfe4a917b5 Set default value of layer parameter of BaseBehaviour to None
KarstenBock@gmx.net
parents: 32
diff changeset
28 self.parent = parent
34
12071706020f Fixed error in setting the initial state of the NPC behaviour
KarstenBock@gmx.net
parents: 33
diff changeset
29 self.state = base._AGENT_STATE_NONE
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
30 self.pc = None
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
31 self.target_loc = None
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
32 self.nextAction = None
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
33
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
34 # hard code these for now
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
35 self.distRange = (2, 4)
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
36 # these are parameters to lower the rate of wandering
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
37 # wander rate is the number of "IDLEs" before a wander step
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
38 # this could be set for individual NPCs at load time
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
39 # or thrown out altogether.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
40 self.wanderCounter = 0
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
41 self.wanderRate = 9
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
42
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
43 def getTargetLocation(self):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
44 """@rtype: fife.Location
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
45 @return: NPC's position"""
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
46 x = self.getX()
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
47 y = self.getY()
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
48 if self.state == base._AGENT_STATE_WANDER:
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
49 """ Random Target Location """
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
50 l = [0, 0]
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
51 for i in range(len(l)):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
52 sign = randrange(0, 2)
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
53 dist = randrange(self.distRange[0], self.distRange[1])
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
54 if sign == 0:
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
55 dist *= -1
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
56 l[i] = dist
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
57 x += l[0]
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
58 y += l[1]
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
59 # Random walk is
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
60 # rl = randint(-1, 1);ud = randint(-1, 1);x += rl;y += ud
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
61 l = fife.Location(self.agent.getLocation())
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
62 l.setLayerCoordinates(fife.ModelCoordinate(x, y))
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
63 return l
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
64
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
65 def onInstanceActionFinished(self, instance, action):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
66 """What the NPC does when it has finished an action.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
67 Called by the engine and required for InstanceActionListeners.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
68 @type instance: fife.Instance
48
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 47
diff changeset
69 @param instance: self.agent
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
70 @type action: ???
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
71 @param action: ???
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
72 @return: None"""
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
73 if self.state == base._AGENT_STATE_WANDER:
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
74 self.target_loc = self.getTargetLocation()
48
1bdadb768bcf Added approach functionality to the BaseBehaviour
KarstenBock@gmx.net
parents: 47
diff changeset
75 BaseBehaviour.onInstanceActionFinished(self, instance, action)
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
76
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
77
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
78 def idle(self):
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
79 """Controls the NPC when it is idling. Different actions
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
80 based on the NPC's state.
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
81 @return: None"""
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
82 if self.state == base._AGENT_STATE_NONE:
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
83 self.state = base._AGENT_STATE_IDLE
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
84 self.agent.act('stand', self.agent.getFacingLocation())
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
85 elif self.state == base._AGENT_STATE_IDLE:
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
86 if self.wanderCounter > self.wanderRate:
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
87 self.wanderCounter = 0
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
88 self.state = base._AGENT_STATE_WANDER
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
89 else:
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
90 self.wanderCounter += 1
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
91 self.state = base._AGENT_STATE_NONE
30
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
92
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
93 self.target_loc = self.getTargetLocation()
ec5a55266f6a Moved behaviours from objects/actors.py to files seperate files inside a behaviours directory.
KarstenBock@gmx.net
parents:
diff changeset
94 self.agent.act('stand', self.agent.getFacingLocation())
47
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
95 elif self.state == base._AGENT_STATE_WANDER:
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
96 self.wander(self.target_loc)
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
97 self.state = base._AGENT_STATE_NONE
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
98 elif self.state == base._AGENT_STATE_TALK:
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
99 self.agent.act('stand', self.pc.getLocation())
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
100
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
101 def wander(self, location):
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
102 """Nice slow movement for random walking.
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
103 @type location: fife.Location
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
104 @param location: Where the NPC will walk to.
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
105 @return: None"""
dd9bd93ec81c Fixed NPC behaviour. NPCs are wandering around again.
KarstenBock@gmx.net
parents: 46
diff changeset
106 self.agent.move('walk', location, self.speed - 1)