python-tutorials/tutorial1d/scripts/tutorial1.py at master · ulfryk/python-tutorials

This repository was archived by the owner on Nov 17, 2024. It is now read-only.
295 lines (233 loc) · 10.5 KB
#!/usr/bin/env python

# -*- coding: utf-8 -*-

# ####################################################################
#  Copyright (C) 2005-2013 by the FIFE team
#  http://www.fifengine.net
#  This file is part of FIFE.
#
#  FIFE is free software; you can redistribute it and/or
#  modify it under the terms of the GNU Lesser General Public
#  License as published by the Free Software Foundation; either
#  version 2.1 of the License, or (at your option) any later version.
#
#  This library is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#  Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public
#  License along with this library; if not, write to the
#  Free Software Foundation, Inc.,
#  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
# ####################################################################

import sys, os

from fife import fife

from fife.extensions import pychan

# Import the PychanApplicationBase.  This is where a lot of magic happens but
# you don't need to know the inner workings just yet.  Once you are more
# familiar with FIFE you'll understand PychanApplicationBase much more.
# PychanApplicationBase extends ApplicationBase and adds the proper code to
# initialize pychan for GUI support.
from fife.extensions.pychan import pychanbasicapplication

class QueryDialog(object):
	"""
	This class is a simple class that displays a dialog box with accept and
	decline buttons.
	
	@param acceptedfunction the function to call if the user click on accept
	@param title the title of the dialog box
	@param text the query or text that you would like the user to answer
	"""
	def __init__(self, acceptedfunction, title, text):
		self._widget = None
	
		# This loads our GUI window and saves a reference to it.  We'll need
		# it to set the text values of the title and text fields.
		self._widget = pychan.loadXML('gui/query.xml')
		
		# This searches for a child widget with the name "queryname" and
		# then sets that widgets text property.  Easy isn't it?
		# This is the title of our dialog box.
		self._queryname = self._widget.findChild(name="queryname")
		self._queryname.text = str(title, 'utf-8')

		# This searches for a child widget with the name "querytext" and
		# then sets that widgets text property.  Easy isn't it?		
		self._querytext = self._widget.findChild(name="querytext")
		self._querytext.text = str(text, 'utf-8')

		# Pychan has some handy functions to bind callbacks to certain widget
		# events.  In this case when the the 'accept' and 'decline' child 
		# widgets get clicked the acceptedfunction() or hide() functions get
		# executed.  Remember to not include the ()'s because that will run
		# the function when Python parses the line... not good!
		eventMap = {
			'accept': acceptedfunction,
			'decline': self._widget.hide,
		}
		
		# This function is what actually does the mapping of the function to
		# widget.  There is some magic behind the scenes here.
		self._widget.mapEvents(eventMap)

	def show(self):
		# Shows the window.  It's already in memory so it will be shown with the
		# correct values for the title and text.
		self._widget.show()
		
	def hide(self):
	 	# Hides the window.  Note that it's always in memory just kicking around
		# until we show it.  In some cases you might want to destroy the window
		# after you are done with it to save memory.
		self._widget.hide()


class Tutorial1MouseListener(fife.IMouseListener):
	"""
	Main game listener.  Listens for Mouse events.  You must include all
	possible event functions or you will get an exception.  These functions
	are called by the engine's event manager when the corresponding events 
	are triggered.
	"""
	def __init__(self, application):
		
		self._engine = application.engine
		self._application = application
		self._eventmanager = self._engine.getEventManager()
		
		# We must make sure to call our base class' constructor to make sure
		# the listener is setup correctly.
		fife.IMouseListener.__init__(self)
		
	def mousePressed(self, event):
		# Mouse press was consumed by a PyChan widget so lets ignore it.
		if event.isConsumedByWidgets():
			return

		# Save the click point in screen coordinates
		clickpoint = fife.ScreenPoint(event.getX(), event.getY())

		if self._application.maploaded:
			# Tell the application to move the player instance to the screen 
			# coordinate where the user clicked.
			self._application.movePlayer(clickpoint)
				
	def mouseReleased(self, event):
		pass

	def mouseMoved(self, event):
		pass
		
	def mouseEntered(self, event):
		pass
		
	def mouseExited(self, event):
		pass
		
	def mouseClicked(self, event):
		pass
	
	def mouseWheelMovedUp(self, event):
		pass	
		
	def mouseWheelMovedDown(self, event):
		pass
		
	def mouseDragged(self, event):
		pass

class Tutorial1Application(pychanbasicapplication.PychanApplicationBase):
	"""
	The main application.  It inherits 
	fife.extensions.pychan.pychanbasicapplication.PychanApplicationBase
	and implements the _pump() function which gets called every frame.
	"""
	def __init__(self, settings):
		# Call our base class's __init__ function and pass it settings.
		# This is where the FIFE engine instance gets created and configured
		# (amoungst other things).  This includes reading the settings file,
		# applying the settings to the engine, initializing PyChan (our GUI
		# manager), creating the default application listener (more info on
		# this in our later tutorials), and setting up logging.  All of
		# these things you can do on your own but we provide ApplicationBase
		# to make your life easier.
		super(Tutorial1Application,self).__init__(settings)
		
		# Save a copy of our settings.  This could be useful in the future
		# as the Setting module allows you to store your own settins as
		# well as FIFE settings.
		self._settings = settings
		
		# Initialize an instance of fife.MapLoader which is a built in map
		# loader that we provide.  We must pass it some internal FIFE objects
		# that the loader requires to properly load a map.
		self._loader = fife.MapLoader(self.engine.getModel(), 
									self.engine.getVFS(), 
									self.engine.getImageManager(), 
									self.engine.getRenderBackend())
			
		# True if we have a map loaded.  False otherwise.
		self._mapLoaded = False

		# Since we want to listen for mouse events lets save a reference to
		# the event manager and create our event listener and attach it to 
		# the manager.
		self._eventmanager = self.engine.getEventManager()
		self._mouselistener = Tutorial1MouseListener(self)
		
		# Listeners are executed in the order in which they are added.
		# Lets ensure this one gets executed first.
		self._eventmanager.addMouseListenerFront(self._mouselistener)
		
		# Add the quit botton to the top left of the screen
		# First use pychan to load the interface
		self._rootpanel = pychan.loadXML('gui/rootpanel.xml')
		
		# Map functions to the buttons on the root panel
		self._rootpanel.mapEvents({ 
			'quitButton' : self.onQuitButtonPress,
		})
		
		# Finally show the panel so it's visible to the user
		self._rootpanel.show()

		# Initialize the dialog box to ask the user if they are sure they want
		# to quit.  The dialog box doesn't get displayed until we call the 
		# show() function.  The first parameter is the function to call when
		# the user clicks the "accept" button on the dialog box.
		self._quitdialog = QueryDialog(self.quitAccepted, "Attention!", "Are you sure you wan to quit?")

	def onQuitButtonPress(self):
		"""
		This function gets called when the root panels "quit" button is pressed.
		"""
		
		# Show the quit dialog box asking the user if they want to quit.
		self._quitdialog.show()
		
	def loadMap(self, filename):
		"""
		Simple function to load and display a map file. We could of course 
		have passed in the map filename but I'll leave that up to you.
		
		@param filename The filename.
		"""
	
		self._mapfilename = filename
		
		# Check to make sure the map file is loadable (i.e. it's in the correct
		# format) and attempt to load the map.
		if self._loader.isLoadable(self._mapfilename):
			self._map = self._loader.load(self._mapfilename)
			self._mapLoaded = True

		# Save a reference to the main camera.  "camera1" must exist on the
		# map.
		self._camera = self._map.getCamera("camera1")
			
		# Save a ref to the actor layer and player on the map.  There must 
		# be a layer with an id of "actor_layer" and an instance with an id 
		# of "player" in your map file for this to work.
		self._actorlayer = self._map.getLayer("actor_layer")
		self._player = self._actorlayer.getInstance("player")

	def getLocationAt(self, screenpoint):
		"""
		Query the main camera for the Map location (on the actor layer)
		that a screen point refers to.
		
		@param screenpoint A fife.ScreenPoint
		"""
		
		# We must transform the point from screen coords to map coords then
		# create a Location object based on a the actor layer
		target_mapcoord = self._camera.toMapCoordinates(screenpoint, False)
		target_mapcoord.z = 0
		location = fife.Location(self._actorlayer)
		location.setMapCoordinates(target_mapcoord)
		return location

	def movePlayer(self, screenpoint):
		"""
		Simple function that moves the player instance to the given screenpoint.
		
		@param screenpoint A fife.ScreenPoint
		"""
		
		# You must tell the move function which action should be used for moving.
		# In this case we have the "walk" action defined for the player so we 
		# use that.  The 4.0 is how fast we want the player instance to move.
		self._player.move('walk', self.getLocationAt(screenpoint), 4.0)

	def quitAccepted(self):
		"""
		This function gets called when the user clicks "accept" on the
		quit dialog box.  It tells FIFE to exit.
		"""
		
		# The quit function is part of ApplicationBase which we inherit in this
		# class.
		self.quit()
		
		
	def _pump(self):
		"""
		This function gets called every frame.  This is where you want to
		call your main game logic code.
		"""

		# On our first frame the map will be loaded and we will grab a reference
		# to our camera, map and player instance.
		if not self._mapLoaded:
			self.loadMap("../assets/maps/tutorial1map.xml")
			
		
	def _isMapLoaded(self):
		return self._mapLoaded
		
	maploaded = property(_isMapLoaded)
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expand file tree

Search code, repositories, users, issues, pull requests...

FilesExpand file tree

tutorial1.py

Latest commit

History

tutorial1.py

File metadata and controls

Expand file tree
