hsmm 0.0.1

wer das liesst kann lesen

Documentation

Table of contents

• Main Game
• Entities
• Levels
• Items
• Effects
• Utils

Main Game

dazu gibts noch nichts zu sagen tbh, soll aber cool werden i guess

Entities

Import: Entities.py

Used to create entities like the player and npcs.

Methods:

• set name
• change health
• add item
• remove item by name
• remove item by index
• add effect
• show effects
• remove effect by name
• remove effect by index
• ! all methods return False on failure

set_name

Starts promt to set the player.name by the player
reads: self
writes: self.name

usage:

Hero = Entity()
Hero.set_name()

change_health

Changes the Player.health by adding "value"
reads: self writes: self.health

usage:

Hero = Entity()
Hero.change_health(-10)

add_item

Adds item to inventory by using the item class.

reads: self, iname, itype
writes: self.inv

usage:

Hero = Entity()
Hero.add_item("item name","item type")

remove_item_by_name

Removes item from entity inventory by given name
reads: self, iname
writes: self.inv

usage:

Hero = Entity()
Hero.remove_item_by_name("Sword")

remove_item_by_index

Removes item from entity inventory by given index
reads: self, iname
writes: self.inv

usage:

Hero = Entity()
Hero.remove_item_by_index(0)    #removes first item from inventory
                                #if no index given → deletes last item from inventory

add_effect

Appends effect to corresponding list of effects.
reads: self(obj), effect(obj)
writes: entity(oby) → {geffects, beffects, eeffects} → obj.effects

usage:

Hero = Entity()
poisoning = Effect()
Hero.add_effect(poisoning)

show_effects

Prints element.name of entity.effects[]
reads: self(obj), names(bool → default True)
writes: self(obj)

usage:

Hero = Entity()
poisoning = Effect()
Hero.add_effect(poisoning)
Hero.show_effects()         #shows name for every effect
Hero.show_effects(False)    #shows vars(effect) for every effect

remove_effect_by_name

Removes effect from entity by given name.
reads: self(obj), ename(str)
writes: self(obj)

usage:

Hero = Entity()
poisoning = Effect()
Hero.add_effect(poisoning)
Hero.remove_effect_by_name(poisoning.name)

remove_effect_by_index

usage:

change_stat

usage:

let_effects_take_effect

usage:

Levels

Items

Effects

Utils