|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
| ▼Nactor | |
| ▼Naquamentus | |
| CAquamentus | This class represents the Aquamentus Boss |
| ▼Nboomerang | |
| CBoomerang | Boomerang Weapon Class The class holding the creation, behaviour, and collision effects of the player's boomerang weapon |
| ▼Nboss | |
| CBoss | Superclass for representing a Boss |
| ▼Nenemy | |
| CEnemy | Superclass for representing an Enemy |
| ▼Nfireball | |
| CFireball | This class represents the Fireball object |
| ▼Nhealthbar | |
| CHealth_Bar | This class represents the HealthBar for the user controlled player character |
| ▼Nitem | |
| CItem | Consumable Item Class This class is used for the creation of a random consumable item, spawned once an enemy has been defeated on their last position before despawn |
| ▼Nkeese | |
| CKeese | This class represents the Keese enemy |
| ▼Nplayer | |
| CPlayer | Player Class A pygame sprite subclass for defining the creation of the game's playable character, as well as its interactions with both the user and other entities within the game |
| ▼Nrupee | |
| CRupee_Bar | This class represents the RupeeBar object |
| ▼Nspritesheet | |
| CSpriteSheet | This class represents the SpriteSheet object, allowing sprites to be loaded and processed |
| ▼Nstalfos | |
| CStalfos | This class represents the Stalfos enemy |
| ▼Nsword | |
| CSword | Player Sword Class Class for the creation and deletion of the sword sprite object, made when the player attacks |
| ▼Ncollision | |
| ▼Ndoor | |
| CDoor | Dungeon Door Class This class is used to place a door on one of four places of a dungeon room, to allow the player to walk through and traverse to other rooms within the dungeon |
| ▼Nlevel | |
| CLevel | Dungeon level background class Creates the background of a dungeon, can be modified in the future to change colour based on sprite sheet and new arg |
| ▼Nlevelmanager | |
| CLevelManager | Dungeon Level Creation Class Class used as a master constructor for every dungeon levels, getting pre-written data and loading it when the game starts and when a transition occurs |
| ▼Nwall | |
| CWall | This class represents the Wall class for collision for objects in the environment |
1.8.13
================================================
FILE: Doc/Design/MIS/html/aquamentus_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Aquamentus Boss More...
Classes | |
| class | actor.aquamentus.Aquamentus |
| This class represents the Aquamentus Boss. More... | |
Functions | |
| def | actor.aquamentus.populateSprites () |
| Creates the sprite list for Aquamentus. More... | |
Variables | |
| string | actor.aquamentus.SPRITE_MAP = 'src/actor/sprites/aquamentus.png' |
Aquamentus Boss
| def actor.aquamentus.populateSprites | ( | ) |
Creates the sprite list for Aquamentus.
Iterates through a sprite sheet to pull images for the sprite array
1.8.13
================================================
FILE: Doc/Design/MIS/html/boomerang_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Boomerang Weapon More...
Classes | |
| class | actor.boomerang.Boomerang |
| Boomerang Weapon Class The class holding the creation, behaviour, and collision effects of the player's boomerang weapon. More... | |
Functions | |
| def | actor.boomerang.populateSprites () |
| Creates the sprite list for Boomerang. More... | |
| def | actor.boomerang.stuncoeffient (x) |
| Finds the coeffient for the stun value Uses a quadradic equation with the frame counter to find the coefficent. More... | |
Variables | |
| string | actor.boomerang.SPRITE_MAP = 'src/actor/sprites/boomerang.png' |
Boomerang Weapon
| def actor.boomerang.populateSprites | ( | ) |
Creates the sprite list for Boomerang.
Iterates through a sprite sheet to pull images for the sprite array
| def actor.boomerang.stuncoeffient | ( | x | ) |
Finds the coeffient for the stun value Uses a quadradic equation with the frame counter to find the coefficent.
| x | The current frame of the boomerang |
1.8.13
================================================
FILE: Doc/Design/MIS/html/boss_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Boss Template More...
Classes | |
| class | actor.boss.Boss |
| Superclass for representing a Boss. More... | |
Boss Template
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1aquamentus_1_1_aquamentus-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.aquamentus.Aquamentus, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1aquamentus_1_1_aquamentus.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the Aquamentus Boss. More...
Public Member Functions | |
| def | __init__ (self, x, y) |
| Constructor for Aquamentus. More... | |
| def | checkState (self) |
| Evaluates the state of the Aquamentus. More... | |
| def | swapDirection (self) |
| Swaps Aquamentus' direction. More... | |
| def | attack (self) |
| Allows for Aquamentus to attack. More... | |
| def | bossLogic (self) |
| Controls Aquamentus logic. More... | |
 Public Member Functions inherited from actor.boss.Boss | |
| def | __init__ (self, x, y) |
| Constructor for Boss. More... | |
| def | checkState (self) |
| Empty function for evaluating Boss state. | |
| def | move (self) |
| Moves the Boss. More... | |
| def | bossLogic (self) |
| Empty function for logic of Boss. | |
| def | update (self) |
| Update loop for a Boss. More... | |
| def | hit (self, dir) |
| Hit dectetion for Boss. More... | |
Public Attributes | |
| isAttacking | |
| Represents wether or not the boss is attacking. | |
| attackStartFrame | |
| Represents the frame that the boss starts an attack. | |
| fireballs | |
| Represents the boss' fireballs. | |
| xSpeed | |
| Aquamentus' set x speed. | |
| maxHP | |
| Aquamentus' max health. | |
| HP | |
| Aquamentus' current health. | |
| dmg | |
| Aquamentus' damage. | |
| image | |
| Sprite image. | |
| sprites | |
| Array of sprites. | |
| obj | |
| Collision list. | |
| spriteIndex | |
| Index for the array of sprites. | |
| hitCount | |
| Integer value representing the buffer for the number of hits for Aquamentus after being hit by player character. More... | |
| isHit | |
| Represents the current state if Aquamentus has collided with player character attack. More... | |
| oldx | |
| This represents the previous x-location of Aquamentus in movement/stationary state. More... | |
| oldy | |
| This represents the previous y-location of Aquamentus in movement/stationary state. More... | |
| Public Attributes inherited from actor.boss.Boss | |
| image | |
| Boss Pygame surface. | |
| rect | |
| Rectanlge that represents boss. | |
| id | |
| X postion of the boss. More... | |
| isHit | |
| Wether the boss is hit or not. | |
| stuncount | |
| The amount of stun frames the boss has remaining. | |
| maxHP | |
| Boss' max health. | |
| HP | |
| Boss' current health. | |
| dmg | |
| Boss' damage. | |
| hitCount | |
| Boss' hit count. | |
| xSpeed | |
| Boss' speed in the x direction. | |
| ySpeed | |
| Boss' speed in the y direction. | |
| frameCounter | |
| Total number of frames the boss has been alive for. | |
This class represents the Aquamentus Boss.
| def actor.aquamentus.Aquamentus.__init__ | ( | self, | |
| x, | |||
| y | |||
| ) |
Constructor for Aquamentus.
Constructor takes two parameters, the x and y coordinates
| x | X coordinate of the starting postion of the Aquamentus |
| y | Y coordinate of the starting postion of the Aquamentus |
| def actor.aquamentus.Aquamentus.attack | ( | self | ) |
Allows for Aquamentus to attack.
Spawns fireballs at Aquamenuts' mouth and sets their move speed
| def actor.aquamentus.Aquamentus.bossLogic | ( | self | ) |
Controls Aquamentus logic.
Uses the states to control the Aquamentus
| def actor.aquamentus.Aquamentus.checkState | ( | self | ) |
Evaluates the state of the Aquamentus.
Evalautes if Aquamentus can stop, if it is in iframes, if it collides with something, and if it has died
| def actor.aquamentus.Aquamentus.swapDirection | ( | self | ) |
Swaps Aquamentus' direction.
Multiplies the speed in the x direction by -1
| actor.aquamentus.Aquamentus.hitCount |
Integer value representing the buffer for the number of hits for Aquamentus after being hit by player character.
| actor.aquamentus.Aquamentus.isHit |
Represents the current state if Aquamentus has collided with player character attack.
| actor.aquamentus.Aquamentus.oldx |
This represents the previous x-location of Aquamentus in movement/stationary state.
| actor.aquamentus.Aquamentus.oldy |
This represents the previous y-location of Aquamentus in movement/stationary state.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1boomerang_1_1_boomerang-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.boomerang.Boomerang, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1boomerang_1_1_boomerang.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Boomerang Weapon Class The class holding the creation, behaviour, and collision effects of the player's boomerang weapon. More...
Public Member Functions | |
| def | __init__ (self, x, y, direction, obj, player) |
| Boomerang constructor A sprite subclass constructor that takes an x and y position (the players), a direction for the boomerang's trajectory, a list of collidable objects, as well as the player object (to add to the collision list) More... | |
| def | moveupdate (self) |
| Boomerang position updating function, updating position based on changing trajectory speed. | |
| def | collisionupdate (self) |
| Boomerang collision updating function, constantly checking for collisions and acting accordingly. | |
| def | spriteupdate (self) |
| Updates the boomerang sprite every 10 frames. | |
| def | update (self) |
| Boomerang updating function, repeatedly running moveupdate and collisionupdate. | |
| def | collision (self) |
| Default collision function to satisfy other class collision calls to this object. | |
Public Attributes | |
| image | |
| Boomerang sprite image. | |
| rect | |
| Position of boomerang. | |
| dir | |
| Initial travel direction of boomerang. | |
| speed | |
| Boomerang initial update speed. | |
| obj | |
| List of objects the boomerang could collide with. | |
| killable | |
| Boolean to tell when the boomerang should be deleted. | |
| sprites | |
| List of sprites for boomerang. | |
| spriteIndex | |
| Index of the current sprite. | |
| frameCounter | |
| Total number of frames boomerang is onscreen. | |
Boomerang Weapon Class The class holding the creation, behaviour, and collision effects of the player's boomerang weapon.
| def actor.boomerang.Boomerang.__init__ | ( | self, | |
| x, | |||
| y, | |||
| direction, | |||
| obj, | |||
| player | |||
| ) |
Boomerang constructor A sprite subclass constructor that takes an x and y position (the players), a direction for the boomerang's trajectory, a list of collidable objects, as well as the player object (to add to the collision list)
| x | X coordinate of boomerang spawn |
| y | Y coordinate of boomerang spawn |
| direction | Direction of boomerang path |
| obj | List of objects to check for collision with the boomerang |
| player | Player object to also check collision for |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1boss_1_1_boss-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.boss.Boss, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1boss_1_1_boss.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Superclass for representing a Boss. More...
Public Member Functions | |
| def | __init__ (self, x, y) |
| Constructor for Boss. More... | |
| def | checkState (self) |
| Empty function for evaluating Boss state. | |
| def | move (self) |
| Moves the Boss. More... | |
| def | bossLogic (self) |
| Empty function for logic of Boss. | |
| def | update (self) |
| Update loop for a Boss. More... | |
| def | hit (self, dir) |
| Hit dectetion for Boss. More... | |
Public Attributes | |
| image | |
| Boss Pygame surface. | |
| rect | |
| Rectanlge that represents boss. | |
| id | |
| X postion of the boss. More... | |
| isHit | |
| Wether the boss is hit or not. | |
| stuncount | |
| The amount of stun frames the boss has remaining. | |
| maxHP | |
| Boss' max health. | |
| HP | |
| Boss' current health. | |
| dmg | |
| Boss' damage. | |
| hitCount | |
| Boss' hit count. | |
| xSpeed | |
| Boss' speed in the x direction. | |
| ySpeed | |
| Boss' speed in the y direction. | |
| frameCounter | |
| Total number of frames the boss has been alive for. | |
Superclass for representing a Boss.
| def actor.boss.Boss.__init__ | ( | self, | |
| x, | |||
| y | |||
| ) |
| def actor.boss.Boss.hit | ( | self, | |
| dir | |||
| ) |
Hit dectetion for Boss.
Handles health and iframes
| def actor.boss.Boss.move | ( | self | ) |
| def actor.boss.Boss.update | ( | self | ) |
| actor.boss.Boss.id |
X postion of the boss.
Y postion of the boss Boss ID
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1enemy_1_1_enemy-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.enemy.Enemy, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1enemy_1_1_enemy.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Superclass for representing an Enemy. More...
Public Member Functions | |
| def | __init__ (self, x, y) |
| Constructor for Enemy. More... | |
| def | checkState (self) |
| Empty function for evaluating Enemy state. | |
| def | move (self) |
| Moves the Enemy. More... | |
| def | enemyLogic (self) |
| Empty function for logic of Enemy. | |
| def | update (self) |
| Update loop for a Enemy. More... | |
| def | hit (self, direc) |
| Hit dectetion for Enemy. More... | |
Public Attributes | |
| image | |
| Enemy Pygame surface. | |
| rect | |
| Rectanlge that represents enemy. | |
| id | |
| Enemy x postion. More... | |
| isHit | |
| Wether the enemy is hit. | |
| stuncount | |
| Remaining stun frames. | |
| maxHP | |
| Enemy max health. | |
| HP | |
| Enemy current health. | |
| dmg | |
| Enemy damage. | |
| hitCount | |
| This represents the buffer for the number of hits for the Enemy after being hit by player character. More... | |
| hitdir | |
| Represents the direction Enemy is hit in by player character attack. More... | |
| xSpeed | |
| Enemy speed in the x direction. | |
| ySpeed | |
| Enemy speed in the y direction. | |
| frameCounter | |
| Total number of frames the enemy has been alive. | |
Superclass for representing an Enemy.
| def actor.enemy.Enemy.__init__ | ( | self, | |
| x, | |||
| y | |||
| ) |
| def actor.enemy.Enemy.hit | ( | self, | |
| direc | |||
| ) |
Hit dectetion for Enemy.
Handles health, iframes and knockback direction
| direc | Direction of the knockback |
| def actor.enemy.Enemy.move | ( | self | ) |
| def actor.enemy.Enemy.update | ( | self | ) |
| actor.enemy.Enemy.hitCount |
This represents the buffer for the number of hits for the Enemy after being hit by player character.
| actor.enemy.Enemy.hitdir |
Represents the direction Enemy is hit in by player character attack.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1fireball_1_1_fireball-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.fireball.Fireball, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1fireball_1_1_fireball.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the Fireball object. More...
Public Member Functions | |
| def | __init__ (self, x, y, xSpeed, ySpeed) |
| Constructor for Fireball. More... | |
| def | start (self, x, y, xs, ys) |
| Starts the Fireball's movement. More... | |
| def | end (self) |
| Ends the Fireball's movement. More... | |
| def | hit (self, dir) |
| Empty function for being hit by player. More... | |
| def | checkState (self) |
| Evaluates the state of the Fireball. More... | |
| def | move (self) |
| Moves the Fireball. More... | |
| def | logic (self) |
| Updates the Fireball sprite. More... | |
| def | update (self) |
| Updates the Fireball every frame More... | |
Public Attributes | |
| image | |
| Fireball surface. More... | |
| rect | |
| Rectangle that represents the fireball. | |
| id | |
| Fireball x postion. More... | |
| isHit | |
| Wether the fireball is hit. | |
| dmg | |
| Fireball damage. | |
| hitCount | |
| Fireball hit frames. | |
| xSpeed | |
| Fireball speed in the x direction. | |
| ySpeed | |
| Fireball speed in the y direction. | |
| frameCounter | |
| Total number of frames fireball is alive. | |
| sprites | |
| obj | |
| Fireball collision list. | |
| spriteIndex | |
| Sprite list index. | |
This class represents the Fireball object.
| def actor.fireball.Fireball.__init__ | ( | self, | |
| x, | |||
| y, | |||
| xSpeed, | |||
| ySpeed | |||
| ) |
Constructor for Fireball.
Constructor takes four parameters, the x and y coordinates and the x and y speeds
| def actor.fireball.Fireball.checkState | ( | self | ) |
Evaluates the state of the Fireball.
Checks for collision with walls, doors, and players
| def actor.fireball.Fireball.end | ( | self | ) |
| def actor.fireball.Fireball.hit | ( | self, | |
| dir | |||
| ) |
Empty function for being hit by player.
Needs to exist for when player sword collides with Fireball
| def actor.fireball.Fireball.logic | ( | self | ) |
Updates the Fireball sprite.
Swaps between the 2 sprites every 15 frames
| def actor.fireball.Fireball.move | ( | self | ) |
| def actor.fireball.Fireball.start | ( | self, | |
| x, | |||
| y, | |||
| xs, | |||
| ys | |||
| ) |
| def actor.fireball.Fireball.update | ( | self | ) |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1healthbar_1_1_health___bar-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.healthbar.Health_Bar, including all inherited members.
| __init__(self, x, y) | actor.healthbar.Health_Bar | |
| h_sprite_sheet | actor.healthbar.Health_Bar | |
| health(self, i) | actor.healthbar.Health_Bar | |
| image | actor.healthbar.Health_Bar | |
| rect | actor.healthbar.Health_Bar |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1healthbar_1_1_health___bar.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the HealthBar for the user controlled player character. More...
Public Member Functions | |
| def | __init__ (self, x, y) |
| Constructor HealthBar class. More... | |
| def | health (self, i) |
| Method to update the current sprite image for the healthbar. More... | |
Public Attributes | |
| image | |
| This represents the sprite image for the Health_Bar object. More... | |
| h_sprite_sheet | |
| This represents the spritesheet for the image for the Health_Bar object, containing all sprites associated with the health bar. More... | |
| rect | |
| This represents rectangle for position for the sprite image of the Health_Bar object. More... | |
This class represents the HealthBar for the user controlled player character.
The HealthBar class uses the base class for visible game objects from Pygame library.
| def actor.healthbar.Health_Bar.__init__ | ( | self, | |
| x, | |||
| y | |||
| ) |
Constructor HealthBar class.
Constructor for class initializes the x and y location of the HealthBar object.
| x | this represents the x-coordinate at which the HealthBar object will be drawn. |
| y | this represents the y-coordinate at which the HealthBar object will be drawn. |
| def actor.healthbar.Health_Bar.health | ( | self, | |
| i | |||
| ) |
Method to update the current sprite image for the healthbar.
This method will allow the HealthBar to update as soon as the player character is damaged/receives health.
| i | value represening the number of heart sprites to render to screen. |
| actor.healthbar.Health_Bar.h_sprite_sheet |
This represents the spritesheet for the image for the Health_Bar object, containing all sprites associated with the health bar.
| actor.healthbar.Health_Bar.image |
This represents the sprite image for the Health_Bar object.
| actor.healthbar.Health_Bar.rect |
This represents rectangle for position for the sprite image of the Health_Bar object.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1item_1_1_item-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.item.Item, including all inherited members.
| __init__(self, x, y, typ) | actor.item.Item | |
| collision(self, p) | actor.item.Item | |
| id | actor.item.Item | |
| image | actor.item.Item | |
| itemsprite | actor.item.Item | |
| rect | actor.item.Item | |
| type | actor.item.Item |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1item_1_1_item.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Consumable Item Class This class is used for the creation of a random consumable item, spawned once an enemy has been defeated on their last position before despawn. More...
Public Member Functions | |
| def | __init__ (self, x, y, typ) |
| Item constructor A sprite subclass constructor which takes a pair of x-y coordinates, commonly those of the killed enemy, and an item type, in the form of a randomly generated integer from 0 to the # of possible items. More... | |
| def | collision (self, p) |
| Collision handler for the player and the consumable item, depending on the item's type. More... | |
Public Attributes | |
| image | |
| Item sprite image. | |
| itemsprite | |
| List of possible item sprite images. | |
| rect | |
| Item x and y position. | |
| id | |
| Collision ID (how other items tell what this item is) | |
| type | |
| Integer value to determine what kind of item this is (rupee, heart, etc) | |
Consumable Item Class This class is used for the creation of a random consumable item, spawned once an enemy has been defeated on their last position before despawn.
| def actor.item.Item.__init__ | ( | self, | |
| x, | |||
| y, | |||
| typ | |||
| ) |
Item constructor A sprite subclass constructor which takes a pair of x-y coordinates, commonly those of the killed enemy, and an item type, in the form of a randomly generated integer from 0 to the # of possible items.
| x | X coordinate of the spawned item |
| y | Y coordinate of the spawned item |
| typ | Integer value to specify the type of consumable item |
| def actor.item.Item.collision | ( | self, | |
| p | |||
| ) |
Collision handler for the player and the consumable item, depending on the item's type.
| p | Player object |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1keese_1_1_keese-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.keese.Keese, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1keese_1_1_keese.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the Keese enemy. More...
Public Member Functions | |
| def | __init__ (self, x, y) |
| Constructor for Keese. More... | |
| def | genRestLength (self) |
| Sets the Keese rest length. More... | |
| def | genTravelPoint (self) |
| Creates a new travel point for Keese. More... | |
| def | switchSprite (self) |
| Iterates through the sprite list. More... | |
| def | stop (self) |
| Stops the Keese. More... | |
| def | setMoveSpeed (self) |
| Sets the Keese x and y movement speed. More... | |
| def | checkState (self) |
| Evaluates the state of the Keese. More... | |
| def | enemyLogic (self) |
| Controls Keese logic. More... | |
| Public Member Functions inherited from actor.enemy.Enemy | |
| def | __init__ (self, x, y) |
| Constructor for Enemy. More... | |
| def | checkState (self) |
| Empty function for evaluating Enemy state. | |
| def | move (self) |
| Moves the Enemy. More... | |
| def | enemyLogic (self) |
| Empty function for logic of Enemy. | |
| def | update (self) |
| Update loop for a Enemy. More... | |
| def | hit (self, direc) |
| Hit dectetion for Enemy. More... | |
Public Attributes | |
| isMoving | |
| Whether the Keese is moving. | |
| canStop | |
| Whether the Keese can stop. | |
| isResting | |
| Whether the Keees is resting. | |
| travelPoint | |
| Point the Keese is traveling to. | |
| restTime | |
| The amount of frames the Keese will rest for. | |
| restStartFrame | |
| The frame the Keese starts resting. | |
| flyStartFrame | |
| The frame the Keese starts flying on. | |
| spriteIndex | |
| The sprite list index. | |
| maxHP | |
| Keese max health. | |
| HP | |
| Keese current health. | |
| dmg | |
| Keese damage. | |
| image | |
| Keese current sprite. More... | |
| sprites | |
| Keese sprite list. | |
| xSpeed | |
| The current x-directional speed for Keese in movement/stationary state. More... | |
| ySpeed | |
| The current y-directional speed for Keese in movement/stationary state. More... | |
| hitCount | |
| Integer value representing the buffer for the number of hits for Keese after being hit by player character. More... | |
| isHit | |
| Represents the current state if Keese has collided with player character attack. More... | |
| Public Attributes inherited from actor.enemy.Enemy | |
| image | |
| Enemy Pygame surface. | |
| rect | |
| Rectanlge that represents enemy. | |
| id | |
| Enemy x postion. More... | |
| isHit | |
| Wether the enemy is hit. | |
| stuncount | |
| Remaining stun frames. | |
| maxHP | |
| Enemy max health. | |
| HP | |
| Enemy current health. | |
| dmg | |
| Enemy damage. | |
| hitCount | |
| This represents the buffer for the number of hits for the Enemy after being hit by player character. More... | |
| hitdir | |
| Represents the direction Enemy is hit in by player character attack. More... | |
| xSpeed | |
| Enemy speed in the x direction. | |
| ySpeed | |
| Enemy speed in the y direction. | |
| frameCounter | |
| Total number of frames the enemy has been alive. | |
This class represents the Keese enemy.
| def actor.keese.Keese.__init__ | ( | self, | |
| x, | |||
| y | |||
| ) |
| def actor.keese.Keese.checkState | ( | self | ) |
| def actor.keese.Keese.genRestLength | ( | self | ) |
Sets the Keese rest length.
Generates a random number between [1,2] inclusive as the rest time between movements and sets the rest start frame to the current frame
| def actor.keese.Keese.genTravelPoint | ( | self | ) |
Creates a new travel point for Keese.
Generate a random point to move to between 0 an the width - 30 of the screen for the x coordinate and between 0 and the height - 30 of the screen for the y coordinate
| def actor.keese.Keese.setMoveSpeed | ( | self | ) |
Sets the Keese x and y movement speed.
Compares the two lengths of travel (x and y) and sets the speed in which ever direction is longer to the max speed and the other to a scalar multiple of the max speed based on the ratio of the two lengths
| def actor.keese.Keese.stop | ( | self | ) |
| def actor.keese.Keese.switchSprite | ( | self | ) |
Iterates through the sprite list.
Swaps between the two sprites that are avalible for the keese
| actor.keese.Keese.hitCount |
Integer value representing the buffer for the number of hits for Keese after being hit by player character.
| actor.keese.Keese.isHit |
Represents the current state if Keese has collided with player character attack.
| actor.keese.Keese.xSpeed |
The current x-directional speed for Keese in movement/stationary state.
| actor.keese.Keese.ySpeed |
The current y-directional speed for Keese in movement/stationary state.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1player_1_1_player-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.player.Player, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1player_1_1_player.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Player Class A pygame sprite subclass for defining the creation of the game's playable character, as well as its interactions with both the user and other entities within the game. More...
Public Member Functions | |
| def | __init__ (self, x, y, hud) |
| Player constructor The constructor for the player object, used within the initialization of the game. More... | |
| def | movechar (self) |
| Function to move the player in a specified direction. | |
| def | move (self, d, b) |
| Function to store which movement buttons are being pressed and let go of by the user. More... | |
| def | attack (self) |
| Function to react to the user pressing the attack button, putting the player into an attack animation and spawning a sword for the duration. | |
| def | useitem (self) |
| Function to react to the user pressing the use item button, putting the player into an attack animation and spawning a boomerang for the duration. | |
| def | moveupdate (self) |
| UPDATE LOOP FUNCTIONS. More... | |
| def | attackupdate (self) |
| Update function for attack and boomerang conditions, as well as handing user collision with enemies (damage taken) Checks sword collision on enemies, and checks the timeout on both the sword and boomerang attack animations, telling the player when they can move again. More... | |
| def | collisionupdate (self) |
| Update function to check collisions between the player and any specified collidable objects, and call their respective collision events. | |
| def | update (self) |
| Player master update function, running all update functions, repeated in main file loop. | |
Public Attributes | |
| image | |
| Player sprite image. | |
| id | |
| Collision ID (To tell other objects what this object is) | |
| leveltrans | |
| Boolean value to tell the game when the player has left the room, and a room transition is needed. | |
| rect | |
| Player x and y position. | |
| walkLeft | |
| Animation sprites for player walking left. | |
| walkRight | |
| Animation sprites for player walking right. | |
| walkUp | |
| Animation sprites for player walking up. | |
| walkDown | |
| Animation sprites for player walking down. | |
| attacksprite | |
| Animation sprites for player attacking. | |
| obj | |
| List of objects that the player can collide with. | |
| hbar | |
| Health bar corresponding to the player's health. | |
| rbar | |
| Rupee bar corresponding to the player's rupy count. | |
| kbar | |
| Key bar corresponding to the player's key count. | |
| totalhp | |
| Player's maximum HP amount. | |
| hp | |
| Player's current HP amount (starts at max) | |
| rupes | |
| Player's rupee counter. | |
| keys | |
| Player's key counter. | |
| collision | |
| Whether the player is currently colliding with anything. | |
| collidbuy | |
| Whether the player has collided with the shop object. | |
| doorcount | |
| How long the player needs to walk into a locked door to use a key and unlock it (Prevents touching and unlocking doors by accident) | |
| spawning | |
| Checks whether the player has just entered a room. | |
| spawncount | |
| Number of frames before the user can take control of the player when they enter a room. | |
| moveable | |
| Boolean allowing and stoping the player from moving. | |
| attackbool | |
| Boolean to tell whether the player is attacking or not. | |
| attackcount | |
| Attack counter, to control how long the attack lasts. | |
| attacksword | |
| Holder for a sword object when attacking. More... | |
| item | |
| Holder for a boomerang object when using item. | |
| itembool | |
| Boolean to tell whether the player is using their boomerang or not. | |
| oldx | |
| Player's x value one frame ago. | |
| oldy | |
| Player's y value one frame ago. | |
| dirbool | |
| Boolean array to tell which directional buttons are pressed or not (starting left going clockwise, dirbool[0] is left, dirbool[1] is up, etc) | |
| dir | |
| Current direction the player is facing. More... | |
| hit | |
| Boolean on whether the player was recently hit. | |
| hitcount | |
| How long a hit counts for on the player (how long until self.hit turns off) | |
| speed | |
| Per-frame unit speed of player. | |
| debug | |
| Whether debug mode is on/off. | |
| hasWon | |
| Has the player won or not. | |
Player Class A pygame sprite subclass for defining the creation of the game's playable character, as well as its interactions with both the user and other entities within the game.
| def actor.player.Player.__init__ | ( | self, | |
| x, | |||
| y, | |||
| hud | |||
| ) |
Player constructor The constructor for the player object, used within the initialization of the game.
The only arguments passed are an initial x and y position, as well as heads-up-display (HUD) elements.
| x | Initial player x coordinate |
| y | Initial player y coordinate |
| hud | Array of HUD elements which act directly with the user's tracked values (health bar, rupy/key count) |
| def actor.player.Player.attackupdate | ( | self | ) |
Update function for attack and boomerang conditions, as well as handing user collision with enemies (damage taken) Checks sword collision on enemies, and checks the timeout on both the sword and boomerang attack animations, telling the player when they can move again.
Also updates the player and reacts accordingly to recieving damage.
| def actor.player.Player.move | ( | self, | |
| d, | |||
| b | |||
| ) |
Function to store which movement buttons are being pressed and let go of by the user.
| d | Direction related to the button pressed (integer value from 0 to 3, starting from the left and going clockwise) |
| b | Boolean value on whether the button is pressed or not |
| def actor.player.Player.moveupdate | ( | self | ) |
UPDATE LOOP FUNCTIONS.
Update function for player movement and according sprite animation
| actor.player.Player.attacksword |
Holder for a sword object when attacking.
Sprite function to delete a sprite object and all relations of the object in the project.
| actor.player.Player.dir |
Current direction the player is facing.
Render Appropriate Sprites According to movement.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1rupee_1_1_rupee___bar-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.rupee.Rupee_Bar, including all inherited members.
| __init__(self, x, y) | actor.rupee.Rupee_Bar | |
| image | actor.rupee.Rupee_Bar | |
| rect | actor.rupee.Rupee_Bar |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1rupee_1_1_rupee___bar.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the RupeeBar object. More...
Public Member Functions | |
| def | __init__ (self, x, y) |
| Constructor for the RupeeBar object. More... | |
Public Attributes | |
| image | |
| This represents the sprite image of the Rupee_Bar object. More... | |
| rect | |
| This represents rectangle for collision and position for the sprite image of the Rupee_Bar object. More... | |
This class represents the RupeeBar object.
The Rupee class uses the Pygame library and SpriteSheet module to create an image for the
| def actor.rupee.Rupee_Bar.__init__ | ( | self, | |
| x, | |||
| y | |||
| ) |
Constructor for the RupeeBar object.
Constructor for class initializes the x and y location of the RupeeBar object.
| x | this represents the x-coordinate at which the RupeeBar object will be drawn. |
| y | this represents the y-coordinate at which the RupeehBar object will be drawn. |
| actor.rupee.Rupee_Bar.image |
This represents the sprite image of the Rupee_Bar object.
| actor.rupee.Rupee_Bar.rect |
This represents rectangle for collision and position for the sprite image of the Rupee_Bar object.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1spritesheet_1_1_sprite_sheet-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.spritesheet.SpriteSheet, including all inherited members.
| __init__(self, file_name) | actor.spritesheet.SpriteSheet | |
| get_image(self, x, y, width, height) | actor.spritesheet.SpriteSheet | |
| get_imageNT(self, x, y, width, height) | actor.spritesheet.SpriteSheet | |
| sprite_sheet | actor.spritesheet.SpriteSheet |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1spritesheet_1_1_sprite_sheet.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the SpriteSheet object, allowing sprites to be loaded and processed. More...
Public Member Functions | |
| def | __init__ (self, file_name) |
| Constructor for the SpriteSheet class. More... | |
| def | get_image (self, x, y, width, height) |
| Accessor to return an image splice from the loaded SpriteSheet. More... | |
| def | get_imageNT (self, x, y, width, height) |
| Accessor to return an image splice from the loaded SpriteSheet, WITHOUT removing the image background. More... | |
Public Attributes | |
| sprite_sheet | |
| This represents the current spritesheet loaded from the specific file_name path. More... | |
This class represents the SpriteSheet object, allowing sprites to be loaded and processed.
The SpriteSheet class uses the Pygame library to load images and change the transperancy on those images.
| def actor.spritesheet.SpriteSheet.__init__ | ( | self, | |
| file_name | |||
| ) |
Constructor for the SpriteSheet class.
This constructor initializes an image file using the Pygame library.
| file_name | This is the string representing the path to the image file. |
| def actor.spritesheet.SpriteSheet.get_image | ( | self, | |
| x, | |||
| y, | |||
| width, | |||
| height | |||
| ) |
Accessor to return an image splice from the loaded SpriteSheet.
This accessor returns an image splice based on the x,y location and the height and width of the image.
| x | The x-coordinate for starting point of the splice on the SpriteSheet. |
| y | The y-coordinate for starting point of the splice on the SpriteSheet. |
| width | The width of the splice on the SpriteSheet. |
| height | The height of the splice on the SpriteSheet. |
| def actor.spritesheet.SpriteSheet.get_imageNT | ( | self, | |
| x, | |||
| y, | |||
| width, | |||
| height | |||
| ) |
Accessor to return an image splice from the loaded SpriteSheet, WITHOUT removing the image background.
This accessor returns an image splice based on the x,y location and the height and width of the image.
| x | The x-coordinate for starting point of the splice on the SpriteSheet. |
| y | The y-coordinate for starting point of the splice on the SpriteSheet. |
| width | The width of the splice on the SpriteSheet. |
| height | The height of the splice on the SpriteSheet. |
| actor.spritesheet.SpriteSheet.sprite_sheet |
This represents the current spritesheet loaded from the specific file_name path.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1stalfos_1_1_stalfos-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.stalfos.Stalfos, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1stalfos_1_1_stalfos.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the Stalfos enemy. More...
Public Member Functions | |
| def | __init__ (self, x, y) |
| Constructor for Stalfos. More... | |
| def | checkState (self) |
| Evaluates the state of the Stalfos. More... | |
| def | enemyLogic (self) |
| Controls Stalfos logic. More... | |
| def | genTravelPath (self) |
| Creates a new travel point for Stalfos. More... | |
| def | setWalkSpeed (self) |
| Sets the walk speed of the Stalfos. More... | |
| def | stop (self) |
| Stops the Stalfos. More... | |
| Public Member Functions inherited from actor.enemy.Enemy | |
| def | __init__ (self, x, y) |
| Constructor for Enemy. More... | |
| def | checkState (self) |
| Empty function for evaluating Enemy state. | |
| def | move (self) |
| Moves the Enemy. More... | |
| def | enemyLogic (self) |
| Empty function for logic of Enemy. | |
| def | update (self) |
| Update loop for a Enemy. More... | |
| def | hit (self, direc) |
| Hit dectetion for Enemy. More... | |
Public Attributes | |
| isMoving | |
| Call superclass constructor. More... | |
| previousDirection | |
| Movement integer value for previous direction of movement for Stalfos state. More... | |
| direction | |
| Movement integer value for current direction of movement for Stalfos state. More... | |
| walkFrames | |
| Integer representing the frames walked by Staflos in movement state. More... | |
| walkStartFrame | |
| Integer value for movement frame for Stalfos during movement state. More... | |
| oldx | |
| This represents the previous x-location of Stalfos in movement/stationary state. More... | |
| oldy | |
| This represents the previous y-location of Stalfos in movement/stationary state. More... | |
| obj | |
| This represents the list of objects Stalfos can collide with, in movement/stationary state. More... | |
| maxHP | |
| The integer value setting the Stalfos health to maximum health. More... | |
| HP | |
| The integer value representing Current Stalfos health. More... | |
| dmg | |
| The integer value representing the current damage value that the Stalfos object has received from player character. More... | |
| image | |
| Spritesheet for the acessing of the Stalfos sprite image. More... | |
| sprites | |
| Creates a list of sprites list for Stalfos. More... | |
| spriteIndex | |
| Represents the integer value for the current index in the sprite list for Stalfos. More... | |
| hitdir | |
| Represents the integer value (0,1,2,3) direction Stalfos is hit in by player character attack. More... | |
| hitCount | |
| Integer value representing the buffer for the number of hits for the Enemy after being hit by player character. More... | |
| isHit | |
| Represents the current state if Stalfos has collided with player character attack. More... | |
| xSpeed | |
| The current x-directional speed for Stalfos in movement/stationary state. More... | |
| ySpeed | |
| The current y-directional speed for Stalfos in movement/stationary state. More... | |
| Public Attributes inherited from actor.enemy.Enemy | |
| image | |
| Enemy Pygame surface. | |
| rect | |
| Rectanlge that represents enemy. | |
| id | |
| Enemy x postion. More... | |
| isHit | |
| Wether the enemy is hit. | |
| stuncount | |
| Remaining stun frames. | |
| maxHP | |
| Enemy max health. | |
| HP | |
| Enemy current health. | |
| dmg | |
| Enemy damage. | |
| hitCount | |
| This represents the buffer for the number of hits for the Enemy after being hit by player character. More... | |
| hitdir | |
| Represents the direction Enemy is hit in by player character attack. More... | |
| xSpeed | |
| Enemy speed in the x direction. | |
| ySpeed | |
| Enemy speed in the y direction. | |
| frameCounter | |
| Total number of frames the enemy has been alive. | |
This class represents the Stalfos enemy.
| def actor.stalfos.Stalfos.__init__ | ( | self, | |
| x, | |||
| y | |||
| ) |
Constructor for Stalfos.
Constructor takes two parameters, the x and y coordinates
| x | X coordinate of the starting postion of the Keese |
| y | Y coordinate of the starting postion of the Keese |
| def actor.stalfos.Stalfos.checkState | ( | self | ) |
| def actor.stalfos.Stalfos.enemyLogic | ( | self | ) |
| def actor.stalfos.Stalfos.genTravelPath | ( | self | ) |
Creates a new travel point for Stalfos.
Generates a direction to walk and the distance to move
| def actor.stalfos.Stalfos.setWalkSpeed | ( | self | ) |
Sets the walk speed of the Stalfos.
Sets speed based on the direction
| def actor.stalfos.Stalfos.stop | ( | self | ) |
| actor.stalfos.Stalfos.direction |
Movement integer value for current direction of movement for Stalfos state.
| actor.stalfos.Stalfos.dmg |
The integer value representing the current damage value that the Stalfos object has received from player character.
| actor.stalfos.Stalfos.hitCount |
Integer value representing the buffer for the number of hits for the Enemy after being hit by player character.
| actor.stalfos.Stalfos.hitdir |
Represents the integer value (0,1,2,3) direction Stalfos is hit in by player character attack.
| actor.stalfos.Stalfos.HP |
The integer value representing Current Stalfos health.
| actor.stalfos.Stalfos.image |
| actor.stalfos.Stalfos.isHit |
Represents the current state if Stalfos has collided with player character attack.
| actor.stalfos.Stalfos.isMoving |
Call superclass constructor.
Check for movement.
Boolean values for keeping track of the Stalfos state.
| actor.stalfos.Stalfos.maxHP |
The integer value setting the Stalfos health to maximum health.
| actor.stalfos.Stalfos.obj |
This represents the list of objects Stalfos can collide with, in movement/stationary state.
| actor.stalfos.Stalfos.oldx |
This represents the previous x-location of Stalfos in movement/stationary state.
| actor.stalfos.Stalfos.oldy |
This represents the previous y-location of Stalfos in movement/stationary state.
| actor.stalfos.Stalfos.previousDirection |
Movement integer value for previous direction of movement for Stalfos state.
| actor.stalfos.Stalfos.spriteIndex |
Represents the integer value for the current index in the sprite list for Stalfos.
| actor.stalfos.Stalfos.sprites |
Creates a list of sprites list for Stalfos.
| actor.stalfos.Stalfos.walkFrames |
Integer representing the frames walked by Staflos in movement state.
| actor.stalfos.Stalfos.walkStartFrame |
Integer value for movement frame for Stalfos during movement state.
| actor.stalfos.Stalfos.xSpeed |
The current x-directional speed for Stalfos in movement/stationary state.
| actor.stalfos.Stalfos.ySpeed |
The current y-directional speed for Stalfos in movement/stationary state.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1sword_1_1_sword-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for actor.sword.Sword, including all inherited members.
| __init__(self, x, y, direction) | actor.sword.Sword | |
| image | actor.sword.Sword | |
| rect | actor.sword.Sword | |
| sprite | actor.sword.Sword |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classactor_1_1sword_1_1_sword.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Player Sword Class Class for the creation and deletion of the sword sprite object, made when the player attacks. More...
Public Member Functions | |
| def | __init__ (self, x, y, direction) |
| Sword constructor, taking an x and y coordinate, and the direction for the sword to be pointing (player direction) More... | |
Public Attributes | |
| sprite | |
| Array of all possible sword directions (following usual directional standards, 0-3, starting at left going clockwise) | |
| image | |
| Sprite image of the sword. More... | |
| rect | |
| X and Y position of the sword. | |
Player Sword Class Class for the creation and deletion of the sword sprite object, made when the player attacks.
| def actor.sword.Sword.__init__ | ( | self, | |
| x, | |||
| y, | |||
| direction | |||
| ) |
| actor.sword.Sword.image |
Sprite image of the sword.
Below is for testing self.image = pygame.Surface([26, 14]) self.image.fill((200, 0, 0))
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1door_1_1_door-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for collision.door.Door, including all inherited members.
| __init__(self, direction, state) | collision.door.Door | |
| collision(self, i) | collision.door.Door | |
| dir (defined in collision.door.Door) | collision.door.Door | |
| dungeon_sheet (defined in collision.door.Door) | collision.door.Door | |
| id | collision.door.Door | |
| image | collision.door.Door | |
| openDoor(self) | collision.door.Door | |
| rect | collision.door.Door | |
| state | collision.door.Door |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1door_1_1_door.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Dungeon Door Class This class is used to place a door on one of four places of a dungeon room, to allow the player to walk through and traverse to other rooms within the dungeon. More...
Public Member Functions | |
| def | __init__ (self, direction, state) |
| Door constructor, making a door on the specified side of the dungeon. More... | |
| def | collision (self, i) |
| This method checks for collision with the Door object and other sprite object. More... | |
| def | openDoor (self) |
| Function to set a door state and sprite to open Changes a blocked door (state 1/2) to an open door (state 0), changing collision attributes and sprites respectively. | |
Public Attributes | |
| dungeon_sheet | |
| state | |
| DOOR STATE 0 = open 1 = blocked (objective door) 2 = locked (key door) State of the door, integer value on whether the door is open(0), blocked by an objective(1), or locked(2) (blocked = eg. More... | |
| dir | |
| image | |
| Sprite image of the door. | |
| rect | |
| X and y coordinates of the image. | |
| id | |
| Collision ID (to help other objects identify what they are colliding with and how to react) | |
Dungeon Door Class This class is used to place a door on one of four places of a dungeon room, to allow the player to walk through and traverse to other rooms within the dungeon.
| def collision.door.Door.__init__ | ( | self, | |
| direction, | |||
| state | |||
| ) |
Door constructor, making a door on the specified side of the dungeon.
| direction | Integer value of the wall the door will be on (direction from centre of room) |
| def collision.door.Door.collision | ( | self, | |
| i | |||
| ) |
This method checks for collision with the Door object and other sprite object.
The collision will be checked with the Door and other sprite object as the object collides with the wall.
| i | This is the sprite object that is passed into the method, and checks if the object is colliding with the Door object, reseting the sprite objects location accordingly. |
| collision.door.Door.state |
DOOR STATE 0 = open 1 = blocked (objective door) 2 = locked (key door) State of the door, integer value on whether the door is open(0), blocked by an objective(1), or locked(2) (blocked = eg.
kill all enemies in room to open)
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1level_1_1_level-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for collision.level.Level, including all inherited members.
| __init__(self) | collision.level.Level | |
| image | collision.level.Level | |
| rect | collision.level.Level |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1level_1_1_level.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Dungeon level background class Creates the background of a dungeon, can be modified in the future to change colour based on sprite sheet and new arg. More...
Public Member Functions | |
| def | __init__ (self) |
| Background initializer Initialize a background to constantly be printed as game background. | |
Public Attributes | |
| image | |
| Level background sprite image. | |
| rect | |
| Background x and y coordinates (adjusted for the HUD display) | |
Dungeon level background class Creates the background of a dungeon, can be modified in the future to change colour based on sprite sheet and new arg.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1levelmanager_1_1_level_manager-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for collision.levelmanager.LevelManager, including all inherited members.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1levelmanager_1_1_level_manager.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Dungeon Level Creation Class Class used as a master constructor for every dungeon levels, getting pre-written data and loading it when the game starts and when a transition occurs. More...
Public Member Functions | |
| def | __init__ (self, spritelist, collidlist, updatelist) |
| Dungeon Level Master Initializer The class initializer, taking empty lists, each for letting the make() function define what objects need to be drawn/collidable/updatable. More... | |
| def | make (self, x, y) |
| Dungeon Level Constructor The main function to load a given index of data from leveldata.py, and load it into the game environment. More... | |
| def | transition (self, xchange, ychange) |
| Dungeon level transition function, used to go to an adjacent level, clear all current data, and load new room data. More... | |
| def | open (self) |
| Function to open all blocked doors in the current dungeon room (usually used when all enemies defeated, locked doors stay locked) | |
| def | endroom (self) |
| Function to store current data, open all blocked doors, and possibly spawn a key/prize when all enemies defeated When all enemies in a room are killed, this function is called, changing the enemy array in leveldata.py for the current level to an empty array (so enemies don't reload once you enter again), running the self.open() function to open all blocked doors, and if the roomID is a predetermined key/rupy room, spawn a key/rupy in the middle of the room. | |
| def | clear (self) |
| Clears the levelmanager's update lists Empty all sprite lists for the game (spritelist, collisionlist, and updatelist), usually used in transition from one room to another. | |
Public Attributes | |
| sl | |
| List of objects to be printed (ie player, not invisible walls) | |
| cl | |
| List of objects that can be collided with (ie keese, not level background) | |
| ul | |
| List of objects that need to be constantly updated (ie player, not walls/static objects) | |
| x | |
| X-Coordinate of the level in leveldata's Room ID array (RID[y][x]) | |
| y | |
| Y-Coordinate of the level in leveldata's Room ID array (RID[y][x]) | |
| level | |
| Level background. | |
| RID | |
| Misc room spawnings (ie shop room) | |
| enarray | |
| boss | |
| doors | |
| killed | |
Static Public Attributes | |
| list | keyset = [3, 7, 17] |
| list | rupeset = [1, 16, 12] |
| LD = None | |
| List of all rooms to load (to be altered) | |
Dungeon Level Creation Class Class used as a master constructor for every dungeon levels, getting pre-written data and loading it when the game starts and when a transition occurs.
| def collision.levelmanager.LevelManager.__init__ | ( | self, | |
| spritelist, | |||
| collidlist, | |||
| updatelist | |||
| ) |
Dungeon Level Master Initializer The class initializer, taking empty lists, each for letting the make() function define what objects need to be drawn/collidable/updatable.
| spritelist | List of objects for the game to print (usually empty pygame.sprite.Group) |
| collidlist | List of objects which have a collision interaction with the player (usually empty pygame.sprite.Group) |
| updatelist | List of objects which need to be regularly updated (usually empty pygame.sprite.Group) |
| def collision.levelmanager.LevelManager.make | ( | self, | |
| x, | |||
| y | |||
| ) |
Dungeon Level Constructor The main function to load a given index of data from leveldata.py, and load it into the game environment.
| i | Index of the room to be created |
| def collision.levelmanager.LevelManager.transition | ( | self, | |
| xchange, | |||
| ychange | |||
| ) |
Dungeon level transition function, used to go to an adjacent level, clear all current data, and load new room data.
| j | Value to add to the current index to get to new room |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1wall_1_1_wall-members.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This is the complete list of members for collision.wall.Wall, including all inherited members.
| __init__(self, x, y, w, h, sprite) | collision.wall.Wall | |
| collision(self, i) | collision.wall.Wall | |
| id | collision.wall.Wall | |
| image | collision.wall.Wall | |
| rect | collision.wall.Wall |
1.8.13
================================================
FILE: Doc/Design/MIS/html/classcollision_1_1wall_1_1_wall.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
This class represents the Wall class for collision for objects in the environment. More...
Public Member Functions | |
| def | __init__ (self, x, y, w, h, sprite) |
| Constructor for the Wall class. More... | |
| def | collision (self, i) |
| This method checks for collision with the Wall object and other sprite object. More... | |
Public Attributes | |
| image | |
| This represents the sprite image for Wall object. More... | |
| rect | |
| This represents rectangle for position for the sprite image of the Wall object. More... | |
| id | |
| This represents the ID for the Wall object, ised for collision in main.py. More... | |
This class represents the Wall class for collision for objects in the environment.
The Wall class uses the base class for visible game objects from Pygame library.
| def collision.wall.Wall.__init__ | ( | self, | |
| x, | |||
| y, | |||
| w, | |||
| h, | |||
| sprite | |||
| ) |
Constructor for the Wall class.
Constructor for Wall class initializes a Wall object based on the x/y location and the width/height of the wall, and the sprite the collision for the wall will be created upon.
| x | This represents the integer value for the x-location for the Wall object to be created. |
| y | This represents the integer value for the y-location for the Wall object to be created. |
| w | This represents the integer value for the width of the Wall object when created. |
| h | This represents the integer value for the height of the Wall object when created. |
| sprite | This represents the sprite that the collison for a Wall will be present upon at all times. |
| def collision.wall.Wall.collision | ( | self, | |
| i | |||
| ) |
This method checks for collision with the Wall object and other sprite object.
The collision will be checked with the Wall and other sprite object as the object collides with the wall.
| i | This is the sprite object that is passed into the method, and checks if the object is colliding with the Wall object, reseting the sprite objects location accordingly. |
| collision.wall.Wall.id |
This represents the ID for the Wall object, ised for collision in main.py.
| collision.wall.Wall.image |
This represents the sprite image for Wall object.
| collision.wall.Wall.rect |
This represents rectangle for position for the sprite image of the Wall object.
1.8.13
================================================
FILE: Doc/Design/MIS/html/classes.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
|
|
| LevelManager (collision.levelmanager) | Stalfos (actor.stalfos) | |||
| Sword (actor.sword) | ||||||
| Aquamentus (actor.aquamentus) | Enemy (actor.enemy) | Item (actor.item) |
| ||||
|
|
| Player (actor.player) | ||||
| Wall (collision.wall) | ||||||
| Boomerang (actor.boomerang) | Fireball (actor.fireball) | Keese (actor.keese) | |||||
| Boss (actor.boss) |
|
| Rupee_Bar (actor.rupee) | ||||
|
| ||||||
| Health_Bar (actor.healthbar) | Level (collision.level) | ||||||
| Door (collision.door) | SpriteSheet (actor.spritesheet) | ||||||
1.8.13
================================================
FILE: Doc/Design/MIS/html/colour_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Colour Constants More...
Variables | |
| tuple | config.colour.WHITE = (255, 255, 255) |
| Defines the colour white. | |
Colour Constants
1.8.13
================================================
FILE: Doc/Design/MIS/html/constants_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Actor Constants More...
Variables | |
| tuple | actor.constants.BLACK = (0,0,0) |
| Defines the colour black. | |
| tuple | actor.constants.WHITE = (255, 255, 255) |
| Defines the colour white. | |
| tuple | actor.constants.PURPLE = (255, 50, 255) |
| Defines the colour purple. | |
| tuple | actor.constants.RED = (255, 50, 50) |
| Defines the colour red. | |
| tuple | actor.constants.BLUE = (0,0,255) |
| Defines the color blue. | |
| int | actor.constants.PLAYER_WIDTH = 15 |
| Defines the player's width. | |
| int | actor.constants.PLAYER_HEIGHT = 15 |
| Defines the player's height. | |
| int | actor.constants.PLAYER_SPEED = 2 |
| Defines the player's speed. | |
| int | actor.constants.PLAYER_MAX_HP = 3 |
| Defines the player's max hp. | |
| int | actor.constants.PLAYER_DOORCOUNT = 20 |
| Defines how many frames the player collides with a locked door before a key is used. | |
| int | actor.constants.PLAYER_SPAWNCOUNT = 8 |
| Defines how long the player is uncontrollable for when entering a new room (movement to walk out of door) | |
| int | actor.constants.HIT_SPEED = 12 |
| Defines the speed of the knock back applied per frame. | |
| int | actor.constants.HIT_TIME = 5 |
| Defines the number of frames hit speed is applied for. | |
| int | actor.constants.HIT_IFRAME = 30 |
| Defines the number of iframes. | |
| int | actor.constants.ATK_WIDTH = 15 |
| Defines the width of the attack hitbox. | |
| int | actor.constants.ATK_HEIGHT = 15 |
| Defines the height of the attack hitbox. | |
| int | actor.constants.ATK_LENGTH = 10 |
| Defines the number of frames the hit stays out for. | |
| int | actor.constants.ATK_BUFFER = 20 |
| Defines the number of frames before the next attack can start. | |
| int | actor.constants.BOOM_SPEED = 9 |
| Defines the bommerang speed. | |
| float | actor.constants.BOOM_RETURN = 0.3 |
| Defines the acceleration in the opposite direction of the bommerang's travel path. | |
| int | actor.constants.GLOBAL_FRAME_BUFFER = 12 |
| Coordinate Divisor that determines range in which next sprite should render. | |
| int | actor.constants.KEESE_MAX_HP = 1 |
| Defines the keese's max hp. | |
| float | actor.constants.KEESE_DMG = 0.5 |
| Defines the keese's damage. | |
| int | actor.constants.KEESE_MAX_SPEED = 2 |
| Defines the keese's max speed. | |
| int | actor.constants.KEESE_MIN_SPEED = 1 |
| Defines the keese's min speed. | |
| int | actor.constants.ACCEPTABLE_RADIUS = 20 |
| Defines the keese's minimum magnitude from its determined travel point before stopping. | |
| int | actor.constants.KEESE_MAGNITUDE_MIN = 200 |
| Defines the keese's minimum magnitude for selecting its next travel point. | |
| int | actor.constants.STALFOS_MAX_HP = 2 |
| Defines the stalfos' max hp. | |
| int | actor.constants.STALFOS_DMG = 1 |
| Defines the stalfos' damage. | |
| int | actor.constants.STALFOS_SPEED = 1 |
| Defines the stalfos' speed. | |
| int | actor.constants.STALFOS_HIT_SPEED = 10 |
| Defines the stalfos' speed during knockback. | |
| int | actor.constants.ENEMY_STUNCOUNT = 35 |
| Length of frames an enemy will be stunned for when hit by a boomerang. | |
| int | actor.constants.AQUAMENTUS_MAX_HP = 5 |
| Defines the aquamentus' max hp. | |
| int | actor.constants.AQUAMENTUS_DMG = 2 |
| Defines the aquamentus' damage. | |
| int | actor.constants.AQUAMENTUS_SPEED = 1 |
| Defines the aquamentus' speed. | |
| int | actor.constants.FIREBALL_DMG = 1 |
| Defines the fireballs damage. | |
Actor Constants
1.8.13
================================================
FILE: Doc/Design/MIS/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/dir_7bdefc09624a65e4879833850a61ce04.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Files | |
| file | door.py |
| Dungeon Door | |
| file | level.py |
| Dungeon Background | |
| file | levelmanager.py |
| Dungeon Level Master Creator | |
| file | wall.py |
| Wall Class | |
1.8.13
================================================
FILE: Doc/Design/MIS/html/dir_7e83d1792d529f4aa7126ac7e0b3b699.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/dir_8b3787363fadf95d9e54890e1424c9de.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Files | |
| file | aquamentus.py |
| Aquamentus Boss | |
| file | boomerang.py |
| Boomerang Weapon | |
| file | boss.py |
| Boss Template | |
| file | constants.py |
| Actor Constants | |
| file | enemy.py |
| Enemy Template | |
| file | fireball.py |
| Fireball object | |
| file | healthbar.py |
| HealthBar Class | |
| file | item.py |
| Consumable Items | |
| file | keese.py |
| Keese Enemy | |
| file | player.py |
| Playable Characer | |
| file | rupee.py |
| Rupee_Bar Class | |
| file | spritesheet.py |
| SpriteSheet Class | |
| file | stalfos.py |
| Stalfos Enemy | |
| file | sword.py |
| Player Sword | |
1.8.13
================================================
FILE: Doc/Design/MIS/html/door_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Dungeon Door More...
Classes | |
| class | collision.door.Door |
| Dungeon Door Class This class is used to place a door on one of four places of a dungeon room, to allow the player to walk through and traverse to other rooms within the dungeon. More... | |
Dungeon Door
1.8.13
================================================
FILE: Doc/Design/MIS/html/doxygen.css
================================================
/* The standard CSS for doxygen 1.8.13 */
body, table, div, p, dl {
font: 400 14px/22px Roboto,sans-serif;
}
p.reference, p.definition {
font: 400 14px/22px Roboto,sans-serif;
}
/* @group Heading Levels */
h1.groupheader {
font-size: 150%;
}
.title {
font: 400 14px/28px Roboto,sans-serif;
font-size: 150%;
font-weight: bold;
margin: 10px 2px;
}
h2.groupheader {
border-bottom: 1px solid #879ECB;
color: #354C7B;
font-size: 150%;
font-weight: normal;
margin-top: 1.75em;
padding-top: 8px;
padding-bottom: 4px;
width: 100%;
}
h3.groupheader {
font-size: 100%;
}
h1, h2, h3, h4, h5, h6 {
-webkit-transition: text-shadow 0.5s linear;
-moz-transition: text-shadow 0.5s linear;
-ms-transition: text-shadow 0.5s linear;
-o-transition: text-shadow 0.5s linear;
transition: text-shadow 0.5s linear;
margin-right: 15px;
}
h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
text-shadow: 0 0 15px cyan;
}
dt {
font-weight: bold;
}
div.multicol {
-moz-column-gap: 1em;
-webkit-column-gap: 1em;
-moz-column-count: 3;
-webkit-column-count: 3;
}
p.startli, p.startdd {
margin-top: 2px;
}
p.starttd {
margin-top: 0px;
}
p.endli {
margin-bottom: 0px;
}
p.enddd {
margin-bottom: 4px;
}
p.endtd {
margin-bottom: 2px;
}
/* @end */
caption {
font-weight: bold;
}
span.legend {
font-size: 70%;
text-align: center;
}
h3.version {
font-size: 90%;
text-align: center;
}
div.qindex, div.navtab{
background-color: #EBEFF6;
border: 1px solid #A3B4D7;
text-align: center;
}
div.qindex, div.navpath {
width: 100%;
line-height: 140%;
}
div.navtab {
margin-right: 15px;
}
/* @group Link Styling */
a {
color: #3D578C;
font-weight: normal;
text-decoration: none;
}
.contents a:visited {
color: #4665A2;
}
a:hover {
text-decoration: underline;
}
a.qindex {
font-weight: bold;
}
a.qindexHL {
font-weight: bold;
background-color: #9CAFD4;
color: #ffffff;
border: 1px double #869DCA;
}
.contents a.qindexHL:visited {
color: #ffffff;
}
a.el {
font-weight: bold;
}
a.elRef {
}
a.code, a.code:visited, a.line, a.line:visited {
color: #4665A2;
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
color: #4665A2;
}
/* @end */
dl.el {
margin-left: -1cm;
}
pre.fragment {
border: 1px solid #C4CFE5;
background-color: #FBFCFD;
padding: 4px 6px;
margin: 4px 8px 4px 2px;
overflow: auto;
word-wrap: break-word;
font-size: 9pt;
line-height: 125%;
font-family: monospace, fixed;
font-size: 105%;
}
div.fragment {
padding: 0px;
margin: 4px 8px 4px 2px;
background-color: #FBFCFD;
border: 1px solid #C4CFE5;
}
div.line {
font-family: monospace, fixed;
font-size: 13px;
min-height: 13px;
line-height: 1.0;
text-wrap: unrestricted;
white-space: -moz-pre-wrap; /* Moz */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
white-space: pre-wrap; /* CSS3 */
word-wrap: break-word; /* IE 5.5+ */
text-indent: -53px;
padding-left: 53px;
padding-bottom: 0px;
margin: 0px;
-webkit-transition-property: background-color, box-shadow;
-webkit-transition-duration: 0.5s;
-moz-transition-property: background-color, box-shadow;
-moz-transition-duration: 0.5s;
-ms-transition-property: background-color, box-shadow;
-ms-transition-duration: 0.5s;
-o-transition-property: background-color, box-shadow;
-o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
div.line:after {
content:"\000A";
white-space: pre;
}
div.line.glow {
background-color: cyan;
box-shadow: 0 0 10px cyan;
}
span.lineno {
padding-right: 4px;
text-align: right;
border-right: 2px solid #0F0;
background-color: #E8E8E8;
white-space: pre;
}
span.lineno a {
background-color: #D8D8D8;
}
span.lineno a:hover {
background-color: #C8C8C8;
}
.lineno {
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
div.ah, span.ah {
background-color: black;
font-weight: bold;
color: #ffffff;
margin-bottom: 3px;
margin-top: 3px;
padding: 0.2em;
border: solid thin #333;
border-radius: 0.5em;
-webkit-border-radius: .5em;
-moz-border-radius: .5em;
box-shadow: 2px 2px 3px #999;
-webkit-box-shadow: 2px 2px 3px #999;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%);
}
div.classindex ul {
list-style: none;
padding-left: 0;
}
div.classindex span.ai {
display: inline-block;
}
div.groupHeader {
margin-left: 16px;
margin-top: 12px;
font-weight: bold;
}
div.groupText {
margin-left: 16px;
font-style: italic;
}
body {
background-color: white;
color: black;
margin: 0;
}
div.contents {
margin-top: 10px;
margin-left: 12px;
margin-right: 8px;
}
td.indexkey {
background-color: #EBEFF6;
font-weight: bold;
border: 1px solid #C4CFE5;
margin: 2px 0px 2px 0;
padding: 2px 10px;
white-space: nowrap;
vertical-align: top;
}
td.indexvalue {
background-color: #EBEFF6;
border: 1px solid #C4CFE5;
padding: 2px 10px;
margin: 2px 0px;
}
tr.memlist {
background-color: #EEF1F7;
}
p.formulaDsp {
text-align: center;
}
img.formulaDsp {
}
img.formulaInl {
vertical-align: middle;
}
div.center {
text-align: center;
margin-top: 0px;
margin-bottom: 0px;
padding: 0px;
}
div.center img {
border: 0px;
}
address.footer {
text-align: right;
padding-right: 12px;
}
img.footer {
border: 0px;
vertical-align: middle;
}
/* @group Code Colorization */
span.keyword {
color: #008000
}
span.keywordtype {
color: #604020
}
span.keywordflow {
color: #e08000
}
span.comment {
color: #800000
}
span.preprocessor {
color: #806020
}
span.stringliteral {
color: #002080
}
span.charliteral {
color: #008080
}
span.vhdldigit {
color: #ff00ff
}
span.vhdlchar {
color: #000000
}
span.vhdlkeyword {
color: #700070
}
span.vhdllogic {
color: #ff0000
}
blockquote {
background-color: #F7F8FB;
border-left: 2px solid #9CAFD4;
margin: 0 24px 0 4px;
padding: 0 12px 0 16px;
}
/* @end */
/*
.search {
color: #003399;
font-weight: bold;
}
form.search {
margin-bottom: 0px;
margin-top: 0px;
}
input.search {
font-size: 75%;
color: #000080;
font-weight: normal;
background-color: #e8eef2;
}
*/
td.tiny {
font-size: 75%;
}
.dirtab {
padding: 4px;
border-collapse: collapse;
border: 1px solid #A3B4D7;
}
th.dirtab {
background: #EBEFF6;
font-weight: bold;
}
hr {
height: 0px;
border: none;
border-top: 1px solid #4A6AAA;
}
hr.footer {
height: 1px;
}
/* @group Member Descriptions */
table.memberdecls {
border-spacing: 0px;
padding: 0px;
}
.memberdecls td, .fieldtable tr {
-webkit-transition-property: background-color, box-shadow;
-webkit-transition-duration: 0.5s;
-moz-transition-property: background-color, box-shadow;
-moz-transition-duration: 0.5s;
-ms-transition-property: background-color, box-shadow;
-ms-transition-duration: 0.5s;
-o-transition-property: background-color, box-shadow;
-o-transition-duration: 0.5s;
transition-property: background-color, box-shadow;
transition-duration: 0.5s;
}
.memberdecls td.glow, .fieldtable tr.glow {
background-color: cyan;
box-shadow: 0 0 15px cyan;
}
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
background-color: #F9FAFC;
border: none;
margin: 4px;
padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
padding: 0px 8px 4px 8px;
color: #555;
}
.memSeparator {
border-bottom: 1px solid #DEE4F0;
line-height: 1px;
margin: 0px;
padding: 0px;
}
.memItemLeft, .memTemplItemLeft {
white-space: nowrap;
}
.memItemRight {
width: 100%;
}
.memTemplParams {
color: #4665A2;
white-space: nowrap;
font-size: 80%;
}
/* @end */
/* @group Member Details */
/* Styles for detailed member documentation */
.memtitle {
padding: 8px;
border-top: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
border-top-right-radius: 4px;
border-top-left-radius: 4px;
margin-bottom: -1px;
background-image: url('nav_f.png');
background-repeat: repeat-x;
background-color: #E2E8F2;
line-height: 1.25;
font-weight: 300;
float:left;
}
.permalink
{
font-size: 65%;
display: inline-block;
vertical-align: middle;
}
.memtemplate {
font-size: 80%;
color: #4665A2;
font-weight: normal;
margin-left: 9px;
}
.memnav {
background-color: #EBEFF6;
border: 1px solid #A3B4D7;
text-align: center;
margin: 2px;
margin-right: 15px;
padding: 2px;
}
.mempage {
width: 100%;
}
.memitem {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
-webkit-transition: box-shadow 0.5s linear;
-moz-transition: box-shadow 0.5s linear;
-ms-transition: box-shadow 0.5s linear;
-o-transition: box-shadow 0.5s linear;
transition: box-shadow 0.5s linear;
display: table !important;
width: 100%;
}
.memitem.glow {
box-shadow: 0 0 15px cyan;
}
.memname {
font-weight: 400;
margin-left: 6px;
}
.memname td {
vertical-align: bottom;
}
.memproto, dl.reflist dt {
border-top: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
padding: 6px 0px 6px 0px;
color: #253555;
font-weight: bold;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
background-color: #DFE5F1;
/* opera specific markup */
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
border-top-right-radius: 4px;
/* firefox specific markup */
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
-moz-border-radius-topright: 4px;
/* webkit specific markup */
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-webkit-border-top-right-radius: 4px;
}
.overload {
font-family: "courier new",courier,monospace;
font-size: 65%;
}
.memdoc, dl.reflist dd {
border-bottom: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
padding: 6px 10px 2px 10px;
background-color: #FBFCFD;
border-top-width: 0;
background-image:url('nav_g.png');
background-repeat:repeat-x;
background-color: #FFFFFF;
/* opera specific markup */
border-bottom-left-radius: 4px;
border-bottom-right-radius: 4px;
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
/* firefox specific markup */
-moz-border-radius-bottomleft: 4px;
-moz-border-radius-bottomright: 4px;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
/* webkit specific markup */
-webkit-border-bottom-left-radius: 4px;
-webkit-border-bottom-right-radius: 4px;
-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
}
dl.reflist dt {
padding: 5px;
}
dl.reflist dd {
margin: 0px 0px 10px 0px;
padding: 5px;
}
.paramkey {
text-align: right;
}
.paramtype {
white-space: nowrap;
}
.paramname {
color: #602020;
white-space: nowrap;
}
.paramname em {
font-style: normal;
}
.paramname code {
line-height: 14px;
}
.params, .retval, .exception, .tparams {
margin-left: 0px;
padding-left: 0px;
}
.params .paramname, .retval .paramname {
font-weight: bold;
vertical-align: top;
}
.params .paramtype {
font-style: italic;
vertical-align: top;
}
.params .paramdir {
font-family: "courier new",courier,monospace;
vertical-align: top;
}
table.mlabels {
border-spacing: 0px;
}
td.mlabels-left {
width: 100%;
padding: 0px;
}
td.mlabels-right {
vertical-align: bottom;
padding: 0px;
white-space: nowrap;
}
span.mlabels {
margin-left: 8px;
}
span.mlabel {
background-color: #728DC1;
border-top:1px solid #5373B4;
border-left:1px solid #5373B4;
border-right:1px solid #C4CFE5;
border-bottom:1px solid #C4CFE5;
text-shadow: none;
color: white;
margin-right: 4px;
padding: 2px 3px;
border-radius: 3px;
font-size: 7pt;
white-space: nowrap;
vertical-align: middle;
}
/* @end */
/* these are for tree view inside a (index) page */
div.directory {
margin: 10px 0px;
border-top: 1px solid #9CAFD4;
border-bottom: 1px solid #9CAFD4;
width: 100%;
}
.directory table {
border-collapse:collapse;
}
.directory td {
margin: 0px;
padding: 0px;
vertical-align: top;
}
.directory td.entry {
white-space: nowrap;
padding-right: 6px;
padding-top: 3px;
}
.directory td.entry a {
outline:none;
}
.directory td.entry a img {
border: none;
}
.directory td.desc {
width: 100%;
padding-left: 6px;
padding-right: 6px;
padding-top: 3px;
border-left: 1px solid rgba(0,0,0,0.05);
}
.directory tr.even {
padding-left: 6px;
background-color: #F7F8FB;
}
.directory img {
vertical-align: -30%;
}
.directory .levels {
white-space: nowrap;
width: 100%;
text-align: right;
font-size: 9pt;
}
.directory .levels span {
cursor: pointer;
padding-left: 2px;
padding-right: 2px;
color: #3D578C;
}
.arrow {
color: #9CAFD4;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
cursor: pointer;
font-size: 80%;
display: inline-block;
width: 16px;
height: 22px;
}
.icon {
font-family: Arial, Helvetica;
font-weight: bold;
font-size: 12px;
height: 14px;
width: 16px;
display: inline-block;
background-color: #728DC1;
color: white;
text-align: center;
border-radius: 4px;
margin-left: 2px;
margin-right: 2px;
}
.icona {
width: 24px;
height: 22px;
display: inline-block;
}
.iconfopen {
width: 24px;
height: 18px;
margin-bottom: 4px;
background-image:url('folderopen.png');
background-position: 0px -4px;
background-repeat: repeat-y;
vertical-align:top;
display: inline-block;
}
.iconfclosed {
width: 24px;
height: 18px;
margin-bottom: 4px;
background-image:url('folderclosed.png');
background-position: 0px -4px;
background-repeat: repeat-y;
vertical-align:top;
display: inline-block;
}
.icondoc {
width: 24px;
height: 18px;
margin-bottom: 4px;
background-image:url('doc.png');
background-position: 0px -4px;
background-repeat: repeat-y;
vertical-align:top;
display: inline-block;
}
table.directory {
font: 400 14px Roboto,sans-serif;
}
/* @end */
div.dynheader {
margin-top: 8px;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
address {
font-style: normal;
color: #2A3D61;
}
table.doxtable caption {
caption-side: top;
}
table.doxtable {
border-collapse:collapse;
margin-top: 4px;
margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
border: 1px solid #2D4068;
padding: 3px 7px 2px;
}
table.doxtable th {
background-color: #374F7F;
color: #FFFFFF;
font-size: 110%;
padding-bottom: 4px;
padding-top: 5px;
}
table.fieldtable {
/*width: 100%;*/
margin-bottom: 10px;
border: 1px solid #A8B8D9;
border-spacing: 0px;
-moz-border-radius: 4px;
-webkit-border-radius: 4px;
border-radius: 4px;
-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
-webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
}
.fieldtable td, .fieldtable th {
padding: 3px 7px 2px;
}
.fieldtable td.fieldtype, .fieldtable td.fieldname {
white-space: nowrap;
border-right: 1px solid #A8B8D9;
border-bottom: 1px solid #A8B8D9;
vertical-align: top;
}
.fieldtable td.fieldname {
padding-top: 3px;
}
.fieldtable td.fielddoc {
border-bottom: 1px solid #A8B8D9;
/*width: 100%;*/
}
.fieldtable td.fielddoc p:first-child {
margin-top: 0px;
}
.fieldtable td.fielddoc p:last-child {
margin-bottom: 2px;
}
.fieldtable tr:last-child td {
border-bottom: none;
}
.fieldtable th {
background-image:url('nav_f.png');
background-repeat:repeat-x;
background-color: #E2E8F2;
font-size: 90%;
color: #253555;
padding-bottom: 4px;
padding-top: 5px;
text-align:left;
font-weight: 400;
-moz-border-radius-topleft: 4px;
-moz-border-radius-topright: 4px;
-webkit-border-top-left-radius: 4px;
-webkit-border-top-right-radius: 4px;
border-top-left-radius: 4px;
border-top-right-radius: 4px;
border-bottom: 1px solid #A8B8D9;
}
.tabsearch {
top: 0px;
left: 10px;
height: 36px;
background-image: url('tab_b.png');
z-index: 101;
overflow: hidden;
font-size: 13px;
}
.navpath ul
{
font-size: 11px;
background-image:url('tab_b.png');
background-repeat:repeat-x;
background-position: 0 -5px;
height:30px;
line-height:30px;
color:#8AA0CC;
border:solid 1px #C2CDE4;
overflow:hidden;
margin:0px;
padding:0px;
}
.navpath li
{
list-style-type:none;
float:left;
padding-left:10px;
padding-right:15px;
background-image:url('bc_s.png');
background-repeat:no-repeat;
background-position:right;
color:#364D7C;
}
.navpath li.navelem a
{
height:32px;
display:block;
text-decoration: none;
outline: none;
color: #283A5D;
font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
text-decoration: none;
}
.navpath li.navelem a:hover
{
color:#6884BD;
}
.navpath li.footer
{
list-style-type:none;
float:right;
padding-left:10px;
padding-right:15px;
background-image:none;
background-repeat:no-repeat;
background-position:right;
color:#364D7C;
font-size: 8pt;
}
div.summary
{
float: right;
font-size: 8pt;
padding-right: 5px;
width: 50%;
text-align: right;
}
div.summary a
{
white-space: nowrap;
}
table.classindex
{
margin: 10px;
white-space: nowrap;
margin-left: 3%;
margin-right: 3%;
width: 94%;
border: 0;
border-spacing: 0;
padding: 0;
}
div.ingroups
{
font-size: 8pt;
width: 50%;
text-align: left;
}
div.ingroups a
{
white-space: nowrap;
}
div.header
{
background-image:url('nav_h.png');
background-repeat:repeat-x;
background-color: #F9FAFC;
margin: 0px;
border-bottom: 1px solid #C4CFE5;
}
div.headertitle
{
padding: 5px 5px 5px 10px;
}
dl
{
padding: 0 0 0 10px;
}
/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
dl.section
{
margin-left: 0px;
padding-left: 0px;
}
dl.note
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #D0C000;
}
dl.warning, dl.attention
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #FF0000;
}
dl.pre, dl.post, dl.invariant
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #00D000;
}
dl.deprecated
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #505050;
}
dl.todo
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #00C0E0;
}
dl.test
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #3030E0;
}
dl.bug
{
margin-left:-7px;
padding-left: 3px;
border-left:4px solid;
border-color: #C08050;
}
dl.section dd {
margin-bottom: 6px;
}
#projectlogo
{
text-align: center;
vertical-align: bottom;
border-collapse: separate;
}
#projectlogo img
{
border: 0px none;
}
#projectalign
{
vertical-align: middle;
}
#projectname
{
font: 300% Tahoma, Arial,sans-serif;
margin: 0px;
padding: 2px 0px;
}
#projectbrief
{
font: 120% Tahoma, Arial,sans-serif;
margin: 0px;
padding: 0px;
}
#projectnumber
{
font: 50% Tahoma, Arial,sans-serif;
margin: 0px;
padding: 0px;
}
#titlearea
{
padding: 0px;
margin: 0px;
width: 100%;
border-bottom: 1px solid #5373B4;
}
.image
{
text-align: center;
}
.dotgraph
{
text-align: center;
}
.mscgraph
{
text-align: center;
}
.plantumlgraph
{
text-align: center;
}
.diagraph
{
text-align: center;
}
.caption
{
font-weight: bold;
}
div.zoom
{
border: 1px solid #90A5CE;
}
dl.citelist {
margin-bottom:50px;
}
dl.citelist dt {
color:#334975;
float:left;
font-weight:bold;
margin-right:10px;
padding:5px;
}
dl.citelist dd {
margin:2px 0;
padding:5px 0;
}
div.toc {
padding: 14px 25px;
background-color: #F4F6FA;
border: 1px solid #D8DFEE;
border-radius: 7px 7px 7px 7px;
float: right;
height: auto;
margin: 0 8px 10px 10px;
width: 200px;
}
div.toc li {
background: url("bdwn.png") no-repeat scroll 0 5px transparent;
font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
margin-top: 5px;
padding-left: 10px;
padding-top: 2px;
}
div.toc h3 {
font: bold 12px/1.2 Arial,FreeSans,sans-serif;
color: #4665A2;
border-bottom: 0 none;
margin: 0;
}
div.toc ul {
list-style: none outside none;
border: medium none;
padding: 0px;
}
div.toc li.level1 {
margin-left: 0px;
}
div.toc li.level2 {
margin-left: 15px;
}
div.toc li.level3 {
margin-left: 30px;
}
div.toc li.level4 {
margin-left: 45px;
}
.inherit_header {
font-weight: bold;
color: gray;
cursor: pointer;
-webkit-touch-callout: none;
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
.inherit_header td {
padding: 6px 0px 2px 5px;
}
.inherit {
display: none;
}
tr.heading h2 {
margin-top: 12px;
margin-bottom: 4px;
}
/* tooltip related style info */
.ttc {
position: absolute;
display: none;
}
#powerTip {
cursor: default;
white-space: nowrap;
background-color: white;
border: 1px solid gray;
border-radius: 4px 4px 4px 4px;
box-shadow: 1px 1px 7px gray;
display: none;
font-size: smaller;
max-width: 80%;
opacity: 0.9;
padding: 1ex 1em 1em;
position: absolute;
z-index: 2147483647;
}
#powerTip div.ttdoc {
color: grey;
font-style: italic;
}
#powerTip div.ttname a {
font-weight: bold;
}
#powerTip div.ttname {
font-weight: bold;
}
#powerTip div.ttdeci {
color: #006318;
}
#powerTip div {
margin: 0px;
padding: 0px;
font: 12px/16px Roboto,sans-serif;
}
#powerTip:before, #powerTip:after {
content: "";
position: absolute;
margin: 0px;
}
#powerTip.n:after, #powerTip.n:before,
#powerTip.s:after, #powerTip.s:before,
#powerTip.w:after, #powerTip.w:before,
#powerTip.e:after, #powerTip.e:before,
#powerTip.ne:after, #powerTip.ne:before,
#powerTip.se:after, #powerTip.se:before,
#powerTip.nw:after, #powerTip.nw:before,
#powerTip.sw:after, #powerTip.sw:before {
border: solid transparent;
content: " ";
height: 0;
width: 0;
position: absolute;
}
#powerTip.n:after, #powerTip.s:after,
#powerTip.w:after, #powerTip.e:after,
#powerTip.nw:after, #powerTip.ne:after,
#powerTip.sw:after, #powerTip.se:after {
border-color: rgba(255, 255, 255, 0);
}
#powerTip.n:before, #powerTip.s:before,
#powerTip.w:before, #powerTip.e:before,
#powerTip.nw:before, #powerTip.ne:before,
#powerTip.sw:before, #powerTip.se:before {
border-color: rgba(128, 128, 128, 0);
}
#powerTip.n:after, #powerTip.n:before,
#powerTip.ne:after, #powerTip.ne:before,
#powerTip.nw:after, #powerTip.nw:before {
top: 100%;
}
#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
border-top-color: #ffffff;
border-width: 10px;
margin: 0px -10px;
}
#powerTip.n:before {
border-top-color: #808080;
border-width: 11px;
margin: 0px -11px;
}
#powerTip.n:after, #powerTip.n:before {
left: 50%;
}
#powerTip.nw:after, #powerTip.nw:before {
right: 14px;
}
#powerTip.ne:after, #powerTip.ne:before {
left: 14px;
}
#powerTip.s:after, #powerTip.s:before,
#powerTip.se:after, #powerTip.se:before,
#powerTip.sw:after, #powerTip.sw:before {
bottom: 100%;
}
#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
border-bottom-color: #ffffff;
border-width: 10px;
margin: 0px -10px;
}
#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
border-bottom-color: #808080;
border-width: 11px;
margin: 0px -11px;
}
#powerTip.s:after, #powerTip.s:before {
left: 50%;
}
#powerTip.sw:after, #powerTip.sw:before {
right: 14px;
}
#powerTip.se:after, #powerTip.se:before {
left: 14px;
}
#powerTip.e:after, #powerTip.e:before {
left: 100%;
}
#powerTip.e:after {
border-left-color: #ffffff;
border-width: 10px;
top: 50%;
margin-top: -10px;
}
#powerTip.e:before {
border-left-color: #808080;
border-width: 11px;
top: 50%;
margin-top: -11px;
}
#powerTip.w:after, #powerTip.w:before {
right: 100%;
}
#powerTip.w:after {
border-right-color: #ffffff;
border-width: 10px;
top: 50%;
margin-top: -10px;
}
#powerTip.w:before {
border-right-color: #808080;
border-width: 11px;
top: 50%;
margin-top: -11px;
}
@media print
{
#top { display: none; }
#side-nav { display: none; }
#nav-path { display: none; }
body { overflow:visible; }
h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
.summary { display: none; }
.memitem { page-break-inside: avoid; }
#doc-content
{
margin-left:0 !important;
height:auto !important;
width:auto !important;
overflow:inherit;
display:inline;
}
}
/* @group Markdown */
/*
table.markdownTable {
border-collapse:collapse;
margin-top: 4px;
margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
border: 1px solid #2D4068;
padding: 3px 7px 2px;
}
table.markdownTableHead tr {
}
table.markdownTableBodyLeft td, table.markdownTable th {
border: 1px solid #2D4068;
padding: 3px 7px 2px;
}
th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone {
background-color: #374F7F;
color: #FFFFFF;
font-size: 110%;
padding-bottom: 4px;
padding-top: 5px;
}
th.markdownTableHeadLeft {
text-align: left
}
th.markdownTableHeadRight {
text-align: right
}
th.markdownTableHeadCenter {
text-align: center
}
*/
table.markdownTable {
border-collapse:collapse;
margin-top: 4px;
margin-bottom: 4px;
}
table.markdownTable td, table.markdownTable th {
border: 1px solid #2D4068;
padding: 3px 7px 2px;
}
table.markdownTable tr {
}
th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone {
background-color: #374F7F;
color: #FFFFFF;
font-size: 110%;
padding-bottom: 4px;
padding-top: 5px;
}
th.markdownTableHeadLeft, td.markdownTableBodyLeft {
text-align: left
}
th.markdownTableHeadRight, td.markdownTableBodyRight {
text-align: right
}
th.markdownTableHeadCenter, td.markdownTableBodyCenter {
text-align: center
}
/* @end */
================================================
FILE: Doc/Design/MIS/html/dynsections.js
================================================
function toggleVisibility(linkObj)
{
var base = $(linkObj).attr('id');
var summary = $('#'+base+'-summary');
var content = $('#'+base+'-content');
var trigger = $('#'+base+'-trigger');
var src=$(trigger).attr('src');
if (content.is(':visible')===true) {
content.hide();
summary.show();
$(linkObj).addClass('closed').removeClass('opened');
$(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
} else {
content.show();
summary.hide();
$(linkObj).removeClass('closed').addClass('opened');
$(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
}
return false;
}
function updateStripes()
{
$('table.directory tr').
removeClass('even').filter(':visible:even').addClass('even');
}
function toggleLevel(level)
{
$('table.directory tr').each(function() {
var l = this.id.split('_').length-1;
var i = $('#img'+this.id.substring(3));
var a = $('#arr'+this.id.substring(3));
if (l|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Enemy Template More...
Classes | |
| class | actor.enemy.Enemy |
| Superclass for representing an Enemy. More... | |
Enemy Template
1.8.13
================================================
FILE: Doc/Design/MIS/html/files.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
| ▼ src | |
| ▼ actor | |
| aquamentus.py | Aquamentus Boss |
| boomerang.py | Boomerang Weapon |
| boss.py | Boss Template |
| constants.py | Actor Constants |
| enemy.py | Enemy Template |
| fireball.py | Fireball object |
| healthbar.py | HealthBar Class |
| item.py | Consumable Items |
| keese.py | Keese Enemy |
| player.py | Playable Characer |
| rupee.py | Rupee_Bar Class |
| spritesheet.py | SpriteSheet Class |
| stalfos.py | Stalfos Enemy |
| sword.py | Player Sword |
| ▼ collision | |
| door.py | Dungeon Door |
| level.py | Dungeon Background |
| levelmanager.py | Dungeon Level Master Creator |
| wall.py | Wall Class |
| ▼ config | |
| colour.py | Colour Constants |
| window.py | Window Constants |
1.8.13
================================================
FILE: Doc/Design/MIS/html/fireball_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Fireball object More...
Classes | |
| class | actor.fireball.Fireball |
| This class represents the Fireball object. More... | |
Functions | |
| def | actor.fireball.populateSprites () |
| Creates the sprite list for Fireball. More... | |
Variables | |
| string | actor.fireball.SPRITE_MAP = 'src/actor/sprites/fireball.png' |
Fireball object
| def actor.fireball.populateSprites | ( | ) |
Creates the sprite list for Fireball.
Iterates through a sprite sheet to pull images for the sprite array
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_a.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_b.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_c.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_d.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_e.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_f.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_func.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_g.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_h.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_i.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_k.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_l.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_m.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_o.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_p.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_r.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_s.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_t.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_u.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_vars.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_w.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_x.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/functions_y.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/healthbar_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
HealthBar Class More...
Classes | |
| class | actor.healthbar.Health_Bar |
| This class represents the HealthBar for the user controlled player character. More... | |
HealthBar Class
1.8.13
================================================
FILE: Doc/Design/MIS/html/hierarchy.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
| Ccollision.levelmanager.LevelManager | Dungeon Level Creation Class Class used as a master constructor for every dungeon levels, getting pre-written data and loading it when the game starts and when a transition occurs |
| ▼Cobject | |
| Cactor.spritesheet.SpriteSheet | This class represents the SpriteSheet object, allowing sprites to be loaded and processed |
| ▼CSprite | |
| Cactor.boomerang.Boomerang | Boomerang Weapon Class The class holding the creation, behaviour, and collision effects of the player's boomerang weapon |
| ▼Cactor.boss.Boss | Superclass for representing a Boss |
| Cactor.aquamentus.Aquamentus | This class represents the Aquamentus Boss |
| ▼Cactor.enemy.Enemy | Superclass for representing an Enemy |
| Cactor.keese.Keese | This class represents the Keese enemy |
| Cactor.stalfos.Stalfos | This class represents the Stalfos enemy |
| Cactor.fireball.Fireball | This class represents the Fireball object |
| Cactor.healthbar.Health_Bar | This class represents the HealthBar for the user controlled player character |
| Cactor.item.Item | Consumable Item Class This class is used for the creation of a random consumable item, spawned once an enemy has been defeated on their last position before despawn |
| Cactor.player.Player | Player Class A pygame sprite subclass for defining the creation of the game's playable character, as well as its interactions with both the user and other entities within the game |
| Cactor.rupee.Rupee_Bar | This class represents the RupeeBar object |
| Cactor.sword.Sword | Player Sword Class Class for the creation and deletion of the sword sprite object, made when the player attacks |
| Ccollision.door.Door | Dungeon Door Class This class is used to place a door on one of four places of a dungeon room, to allow the player to walk through and traverse to other rooms within the dungeon |
| Ccollision.level.Level | Dungeon level background class Creates the background of a dungeon, can be modified in the future to change colour based on sprite sheet and new arg |
| Ccollision.wall.Wall | This class represents the Wall class for collision for objects in the environment |
1.8.13
================================================
FILE: Doc/Design/MIS/html/index.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
1.8.13
================================================
FILE: Doc/Design/MIS/html/item_8py.html
================================================
|
The Legend of Python, Modular Interface Specification
Revison 2.2 12/5/2018
ThisProject'spurposeistore-designanopen-sourceversionofTheLegendofZelda
|
Consumable Items More...
Classes | |
| class | actor.item.Item |
| Consumable Item Class This class is used for the creation of a random consumable item, spawned once an enemy has been defeated on their last position before despawn. More... | |
Consumable Items
1.8.13
================================================
FILE: Doc/Design/MIS/html/jquery.js
================================================
/*!
* jQuery JavaScript Library v1.7.1
* http://jquery.com/
*
* Copyright 2011, John Resig
* Dual licensed under the MIT or GPL Version 2 licenses.
* http://jquery.org/license
*
* Includes Sizzle.js
* http://sizzlejs.com/
* Copyright 2011, The Dojo Foundation
* Released under the MIT, BSD, and GPL Licenses.
*
* Date: Mon Nov 21 21:11:03 2011 -0500
*/
(function(bb,L){var av=bb.document,bu=bb.navigator,bl=bb.location;var b=(function(){var bF=function(b0,b1){return new bF.fn.init(b0,b1,bD)},bU=bb.jQuery,bH=bb.$,bD,bY=/^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,bM=/\S/,bI=/^\s+/,bE=/\s+$/,bA=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,bN=/^[\],:{}\s]*$/,bW=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,bP=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,bJ=/(?:^|:|,)(?:\s*\[)+/g,by=/(webkit)[ \/]([\w.]+)/,bR=/(opera)(?:.*version)?[ \/]([\w.]+)/,bQ=/(msie) ([\w.]+)/,bS=/(mozilla)(?:.*? rv:([\w.]+))?/,bB=/-([a-z]|[0-9])/ig,bZ=/^-ms-/,bT=function(b0,b1){return(b1+"").toUpperCase()},bX=bu.userAgent,bV,bC,e,bL=Object.prototype.toString,bG=Object.prototype.hasOwnProperty,bz=Array.prototype.push,bK=Array.prototype.slice,bO=String.prototype.trim,bv=Array.prototype.indexOf,bx={};bF.fn=bF.prototype={constructor:bF,init:function(b0,b4,b3){var b2,b5,b1,b6;if(!b0){return this}if(b0.nodeType){this.context=this[0]=b0;this.length=1;return this}if(b0==="body"&&!b4&&av.body){this.context=av;this[0]=av.body;this.selector=b0;this.length=1;return this}if(typeof b0==="string"){if(b0.charAt(0)==="<"&&b0.charAt(b0.length-1)===">"&&b0.length>=3){b2=[null,b0,null]}else{b2=bY.exec(b0)}if(b2&&(b2[1]||!b4)){if(b2[1]){b4=b4 instanceof bF?b4[0]:b4;b6=(b4?b4.ownerDocument||b4:av);b1=bA.exec(b0);if(b1){if(bF.isPlainObject(b4)){b0=[av.createElement(b1[1])];bF.fn.attr.call(b0,b4,true)}else{b0=[b6.createElement(b1[1])]}}else{b1=bF.buildFragment([b2[1]],[b6]);b0=(b1.cacheable?bF.clone(b1.fragment):b1.fragment).childNodes}return bF.merge(this,b0)}else{b5=av.getElementById(b2[2]);if(b5&&b5.parentNode){if(b5.id!==b2[2]){return b3.find(b0)}this.length=1;this[0]=b5}this.context=av;this.selector=b0;return this}}else{if(!b4||b4.jquery){return(b4||b3).find(b0)}else{return this.constructor(b4).find(b0)}}}else{if(bF.isFunction(b0)){return b3.ready(b0)}}if(b0.selector!==L){this.selector=b0.selector;this.context=b0.context}return bF.makeArray(b0,this)},selector:"",jquery:"1.7.1",length:0,size:function(){return this.length},toArray:function(){return bK.call(this,0)},get:function(b0){return b0==null?this.toArray():(b0<0?this[this.length+b0]:this[b0])},pushStack:function(b1,b3,b0){var b2=this.constructor();if(bF.isArray(b1)){bz.apply(b2,b1)}else{bF.merge(b2,b1)}b2.prevObject=this;b2.context=this.context;if(b3==="find"){b2.selector=this.selector+(this.selector?" ":"")+b0}else{if(b3){b2.selector=this.selector+"."+b3+"("+b0+")"}}return b2},each:function(b1,b0){return bF.each(this,b1,b0)},ready:function(b0){bF.bindReady();bC.add(b0);return this},eq:function(b0){b0=+b0;return b0===-1?this.slice(b0):this.slice(b0,b0+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(bK.apply(this,arguments),"slice",bK.call(arguments).join(","))},map:function(b0){return this.pushStack(bF.map(this,function(b2,b1){return b0.call(b2,b1,b2)}))},end:function(){return this.prevObject||this.constructor(null)},push:bz,sort:[].sort,splice:[].splice};bF.fn.init.prototype=bF.fn;bF.extend=bF.fn.extend=function(){var b9,b2,b0,b1,b6,b7,b5=arguments[0]||{},b4=1,b3=arguments.length,b8=false;if(typeof b5==="boolean"){b8=b5;b5=arguments[1]||{};b4=2}if(typeof b5!=="object"&&!bF.isFunction(b5)){b5={}}if(b3===b4){b5=this;--b4}for(;b4| t |
