nqp.world_elements package

Submodules

nqp.world_elements.actions module

class Action(game)

Bases: object

__init__(game)

use()

class Fireball(*args)

Bases: nqp.world_elements.actions.Action

__init__(*args)

use(location)

nqp.world_elements.camera module

class Camera(size: pygame.math.Vector2)

Bases: object

Basic math for getting view of game world

zoom

positive numbers “zoom out”, negative numbers “zoom in”

• World units are equal to pixels at zoom level of 0.0

__init__(size: pygame.math.Vector2)

centre(pos: pygame.math.Vector2)

Immediately centre the camera on a world point

clamp(rect: pygame.Rect)

Move camera so that it is contained in the rect

Has same behaviour as pygame.Rect.clamp

get_centre() → pygame.math.Vector2

Get copy of the position

get_rect() → pygame.Rect

Return Pygame Rect representing the visible area of the camera

get_size() → pygame.math.Vector2

Return vector of the size after zoom is applied

move(x: int = 0, y: int = 0)

Immediately move the camera by relative amount

render_offset() → pygame.math.Vector2

Return vector for drawing offset

reset_movement()

Immediately move camera to tracked position

set_target_entity(entity: Optional[int])

Smoothly track a game entity. Pass None to clear.

set_target_position(pos: Optional[pygame.math.Vector2])

Move camera to position over time. Pass None to clear.

update(delta_time: float)

Update camera movements

nqp.world_elements.entity_components module

class AI(behaviour: BasicEntityBehaviour)

Bases: snecs.component.RegisteredComponent

An Entity’s AI. This should handle the outputs of AI decisions and actions.

__init__(behaviour: BasicEntityBehaviour)

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class Aesthetic(animation: nqp.base_classes.animation.Animation)

Bases: snecs.component.RegisteredComponent

An Entity’s visual information

__init__(animation: nqp.base_classes.animation.Animation)

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class Allegiance(team: str, unit: nqp.command.unit.Unit)

Bases: snecs.component.RegisteredComponent

An Entity’s allegiance.

__init__(team: str, unit: nqp.command.unit.Unit)

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class Attributes

Bases: snecs.component.RegisteredComponent

A series of flags defining the attributes of a Unit

__init__()

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class DamageReceived(amount: int, damage_type: nqp.core.constants.DamageType, penetration: int, is_crit: bool)

Bases: snecs.component.RegisteredComponent

Damage to be applied to the Entity.

__init__(amount: int, damage_type: nqp.core.constants.DamageType, penetration: int, is_crit: bool)

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class HealReceived(amount: int, healing_source: nqp.core.constants.HealingSource)

Bases: snecs.component.RegisteredComponent

Healing to be applied to the Entity.

__init__(amount: int, healing_source: nqp.core.constants.HealingSource)

add_heal(amount: int, healing_source: nqp.core.constants.HealingSource)

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class IsDead

Bases: snecs.component.RegisteredComponent

Flag to indicate if the Entity is dead.

__init__()

class IsReadyToAttack

Bases: snecs.component.RegisteredComponent

Flag to indicate if the Entity is ready to attack.

class Position(pos: pygame.math.Vector2)

Bases: snecs.component.RegisteredComponent

An Entity’s location in the world.

__init__(pos: pygame.math.Vector2)

classmethod deserialize(pos: pygame.math.Vector2)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

property x: float

property y: float

class RangedAttack(ammo: int, projectile_sprite: nqp.base_classes.image.Image, projectile_speed: int)

Bases: snecs.component.RegisteredComponent

An Entity’s ability to use projectiles.

__init__(ammo: int, projectile_sprite: nqp.base_classes.image.Image, projectile_speed: int)

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class Stats(parent_unit: nqp.command.unit.Unit)

Bases: snecs.component.RegisteredComponent

An Entity’s stats, such as attack.

__init__(parent_unit: nqp.command.unit.Unit)

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

classmethod get_stat_names() → List[str]

Get a list of all the stats.

N.B. this is manually populated so if a stat is missing check here.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

class Tracked

Bases: snecs.component.RegisteredComponent

A component to track an entity’s actions.

__init__()

classmethod deserialize(*serialised)

Deserialize a serialized instance of this component.

Will get the output of serialize as an argument.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

serialize()

Serialize an instance of this component into a simpler type.

Override this in all your Component classes to make use of snecs’ full-World serialization feature.

nqp.world_elements.hitbox module

class Hitbox(entities, shape_type, shape_data, damage, owner=None, friendly_fire=False)

Bases: object

__init__(entities, shape_type, shape_data, damage, owner=None, friendly_fire=False)

apply()

nqp.world_elements.item module

class Item(name: str, is_signature: bool)

Bases: snecs.component.RegisteredComponent

Item component – WIP

__init__(name: str, is_signature: bool)

class ItemData(name: str, is_signature: bool, effects: List[Dict[str, str]])

Bases: object

Schema for the YAML Item data files

__init__(name: str, is_signature: bool, effects: List[Dict[str, str]]) → None

effects: List[Dict[str, str]]

is_signature: bool

name: str

nqp.world_elements.particle module

class Particle(loc: pygame.math.Vector2, vel: pygame.math.Vector2, dur, colour)

Bases: object

__init__(loc: pygame.math.Vector2, vel: pygame.math.Vector2, dur, colour)

draw(surf: pygame.Surface, offset: pygame.math.Vector2 = <Vector2(0, 0)>)

update(dt)

nqp.world_elements.particle_manager module

class ParticleManager

Bases: object

Class to manage all particles and their functionality, including creating, drawing and deletion.

__init__()

create_blood_spray(pos: pygame.Vector2, blood_colour: Tuple[int, int, int] = Colour.BLOOD_RED)

create_smoke(pos: pygame.math.Vector2)

draw(surface: pygame.Surface, offset=(0, 0))

update(delta_time: float)

nqp.world_elements.projectile module

class Projectile(game: Game, owner: EntityID, target: EntityID, projectile_data: Dict[str, Union[Image, int]], damage: int, damage_type: DamageType, penetration: int, is_crit: bool)

Bases: object

__init__(game: Game, owner: EntityID, target: EntityID, projectile_data: Dict[str, Union[Image, int]], damage: int, damage_type: DamageType, penetration: int, is_crit: bool)

draw(surf, offset: pygame.math.Vector2)

update(delta_time: float)

nqp.world_elements.projectile_manager module

class ProjectileManager(game: Game)

Bases: object

__init__(game: Game)

add_projectile(owner: EntityID, target: EntityID, projectile_data: Dict[str, Union[Image, int]], damage: int, damage_type: DamageType, penetration: int, is_crit: bool)

draw(surf, offset: pygame.math.Vector2)

update(delta_time: float)

nqp.world_elements.stats module

class FloatStat(base_value: float)

Bases: nqp.base_classes.stat.Stat

__init__(base_value: float)

property base_value: float

property value: float

class IntStat(base_value: int)

Bases: nqp.base_classes.stat.Stat

__init__(base_value: int)

property base_value: int

property value: int

nqp.world_elements.unit_attribute module

class UnitAttribute(base_value: bool)

Bases: abc.ABC

A container for a Unit’s Attribute

# TODO - This is currently a copy of Stat and needs to be updated to work for bools only

with False taking precedence over True

__init__(base_value: bool)

apply_modifier(func: Callable, key: Any)

Add a modifier

When value is calculated, func will be called with the base value

Parameters

• func – Any callable function

• key – Unique identifier for adding and removing

property base_value

has_modifier(key: Any)

Check if modifier is applied

Parameters

key – Unique identifier for adding and removing

override(value)

Force the value and ignore modifiers

remove_modifier(key: Any)

Remove a modifier

Parameters

key – Unique identifier for adding and removing

reset()

Set value back to base value.

property value

Module contents