Entity

Game entity that exists on a grid with sprite rendering.

Overview

An Entity is a game object that exists at a position on a Grid. Entities represent players, enemies, items, and other interactive objects. They render on top of tiles, support smooth animated movement, and integrate with the pathfinding and field-of-view systems.

Quick Reference

import mcrfpy

scene = mcrfpy.Scene("entity-demo")
mcrfpy.current_scene = scene

grid = mcrfpy.Grid(
    grid_size=(16, 12),
    texture=mcrfpy.default_texture,
    pos=(0, 0),
    size=(1024, 768),
    zoom=4.0
)
scene.children.append(grid)

for y in range(12):
    for x in range(16):
        grid.at(x, y).tilesprite = 48

# Create an entity
player = mcrfpy.Entity(grid_pos=(10, 10), texture=mcrfpy.default_texture, sprite_index=84)

# Add to a grid
grid.entities.append(player)

# Move to a new grid (tile) position -- instant, integer coordinates
player.grid_pos = (11, 10)

# Animated movement: 'x' is an alias for 'draw_x', the fractional tile
# coordinate used for smooth motion between cells.
player.animate("x", 12.0, 0.2, mcrfpy.Easing.EASE_OUT_QUAD)

# Pathfinding: find_path() returns an AStarPath (or None if unreachable);
# it does not move the entity itself.
path = player.find_path((15, 10))
if path is not None:
    print("Path found!")

# Field of view
visible = player.visible_entities(radius=8)
for enemy in visible:
    print(f"Can see: {enemy.name}")

Note: pos and grid_pos are not the same kind of value. grid_pos (and its aliases cell_pos, x/y in grid-cell terms via grid_x/grid_y) is the integer logical tile coordinate. pos is the entity’s pixel position relative to the grid (draw_pos * tile_size), and requires the entity to be attached to a grid. Setting grid_pos teleports the entity instantly, and draw_pos catches up immediately unless you are mid-animation.

Constructor

mcrfpy.Entity(grid_pos=None, texture=None, sprite_index=0, **kwargs)

Arguments:

• grid_pos (tuple, optional): Grid position as (x, y). Default: (0, 0)
• texture (Texture, optional): Texture object for sprite. Default: default texture
• sprite_index (int, optional): Index into texture atlas. Default: 0

Keyword Arguments:

• grid (Grid): Grid to attach entity to
• visible (bool): Visibility state. Default: True
• opacity (float): Opacity (0.0-1.0). Default: 1.0
• name (str): Element name for finding

Properties

Methods

Related