path.Archi Class Reference

List of all members.

Public Member Functions
def	__init__
def	get_src_file
def	get_content_file
def	get_xml_file
def	list_files
def	get_src_dir
def	get_content_dir
def	get_xml_dir
Public Attributes
	main_directory

---

Detailed Description

This class manages the arhitecture of the project.
It allows the user to travel in the file system of the game, to get
the XML files and others (PNG, configuration files...)
Moreover, it should be cross-platform compliant

---

Member Function Documentation

def path.Archi.get_content_dir	(		self,
			dir_path
	)

Gets the given dir_path with respect to the content folder.

def path.Archi.get_content_file	(		self,
			file_path,
			mode = 'r',
			opened = False
	)

Gets the path of the content files directory. content files are
basically all graphical files, and a description of the common world

def path.Archi.get_src_dir	(		self,
			dir_path
	)

Gets the given dir_path with respect to the src folder.

def path.Archi.get_src_file	(		self,
			file_path,
			mode = 'r',
			opened = False
	)

Gets the path of the src directory.
At least used by the src scripts.

def path.Archi.get_xml_dir	(		self,
			dir_path
	)

Gets the given dir_path with respect to the xml folder.

def path.Archi.get_xml_file	(		self,
			file_path,
			mode = 'r',
			opened = False
	)

Gets the path of a xml file describing a world, a scenario, or a
campaign.

def path.Archi.list_files	(		self,
			dir_path
	)

List all the files present in the dir_path, if it is a dir.
Else raise a FileNotFoundError.

---

The documentation for this class was generated from the following file:

• src/path.py