Difference between revisions of "World"

Revision as of 13:01, 16 May 2024

This article goes through how to use the World library to create a topdown or isometric world.

Overview

The World library is split into two main parts:

Core functionality, focused on flexibility and reuse
Prefabricated content, focused on easy of use

This article will focus on the prefab content, but include enough core details to be able to take full advantage of the library.

The worlds created using this library are divided into descrete spaces, usually a square grid. So positions will be based on integer coordinates.

The prefabricated content supports both topdown and isometric perspectives, and it is very easy to switch between the two as needed. Additional perspectives are possible, but not supported by the prefab content.

All classes, types, and constants mentioned in this article can be imported from lib.world.

Easiest way to get started is to pick up one of the templates at the end of the article, and then jump to relevant sections as questions come up.

Setup

To use the prefab content you will have to use the WorldSetup class. The following sections will assume that you have an instance of this class called setup.

To start, just create the setup object like this setup = WorldSetup().

The class has the following attributes:

directions - list[tuple[int, int]]: The allowed movement directions, see directions, defaults to CARDINAL_DIRECTIONS
basic - bool: If True will draw colored geometric shapes rather than the image-based tiles and walls
perspective - "topdown" | "isometric": The perspective to use for the prefab content, defautls to "topdown"
resolution - int: The "unit size", the size of a tile in topdown, will be used for all content
block_corners - bool: If True will block diagonal movement next to a wall, should generally be enabled when using SQUARE_DIRECTIONS
debug_mode - bool: If True adds additional debugging features to the world element, see debugging
manager - PrefabManager: The object responsible for managing prefabricated assets, generally no need to override the default value

Here is an example of creating the setup object:

setup = WorldSetup(
    directions=SQUARE_DIRECTIONS,
    perspective="isometric",
    block_corners=True,
)

Directions

You can specify which directions exist in the world, which will affect how actors can move.

By default only the cardinal directions exist:

Cardinal.LEFT = (-1, 0)
Cardinal.RIGHT = (1, 0)
Cardinal.UP = (0, -1)
Cardinal.DOWN = (0, 1)

But these can be extended with diagonals:

Ordinal.LEFT_UP = (-1, -1)
Ordinal.RIGHT_UP = (1, -1)
Ordinal.LEFT_DOWN = (-1, 1)
Ordinal.RIGHT_DOWN = (1, 1)

For convenience, the following direction list constants are available:

CARDINAL_DIRECTIONS
ORDINAL_DIRECTIONS
SQUARE_DIRECTIONS

You can specify any other set of directions you want, but it will seldom make sense to do so.

World

To create the world itself you can use world = setup.create_world().

This section will not go into detail of how the World object works, that will be covered throughout this article.

Rendering

The world library can be used without rendering, but generally you do want to show the results. When using the library you will initialize and make changes to the world in the setup_state and update_state methods. Then you will want to render and re-render the world in the setup_canvas/setup_view and update_canvas/update_view methods.

When doing the initial render you can choose how the rendered element will behave:

Use world.render_resizable() to get an element which dynamically scales the world to fit within the size of the element. Recommended for smaller worlds.
Use world.render_scrollable() to get a scroll area containing the world. The size of the world is based on the resolution. Recommended for larger worlds.

No matter which way you create the initial element, you need to call world.render_changes() when you want the world to be re-rendered. No need to do anything else.

See the templates section for examples of how to do this in practice.

Tiles

Worlds consist mainly of tiles, which are used to both define the walkable area of the world and the visual tiles the world consist of.

The library comes with prefabricated graphical tiles and has built-in support for plain colored tiles, but it is also possible to make custom tiles.

There are a few ways to add tiles to the world, which to use is partly up to need and partly up to preference.

First way is to include a tiles argument to setup.create_world(). This can take the form of a dictionary with coordinates as keys and tiles as values:

world = setup.create_world(tiles={
    (0, 0): "grass",
    (1, 0): "grass",
    (0, 1): "gravel",
})

Alternatively the tiles argument can be a string as described in tile map:

world = setup.create_world(tiles="gg\nr")

Second way is to use the World methods:

world.add_tile(coordinate, data): Where data depends on what types of tiles you are using; For example adding a prefab tile: world.add_tile((1, 1), {"name": "grass"}); Or if using basic tiles: world.add_tile((1, 1), {"color": "black"})
world.fill(top_left, bottom_right, data): Which will add the same tile to the area spanned by top_left and bottom_right; For example: world.fill((0, 0), (1, 1), {"name": "mud", "color": "tan"})

It is possible to get tile data for a coordinate using world.get_tile_data(coordinate), and it is possible to get all tile coordinates using world.get_tile_coordinates().

You can remove a tile using world.remove_tile(coordinate).

Prefab tiles

Constant	Name	Code	Notes
Tile.BLOCKED	blocked	b	blocking
Tile.CARPET	carpet	c
Tile.CARPET_BLUE	carpet_blue	k
Tile.CARPET_BLUE_2	carpet_blue_2	K
Tile.CARPET_GREY	carpet_grey	C
Tile.GRASS	grass	g
Tile.GRASS_2	grass_2	G
Tile.GRAVEL	gravel	r
Tile.MUD	mud	m
Tile.PARQUET	parquet	p
Tile.PARQUET_2	parquet_2	P
Tile.TILES	tiles	t
Tile.TILES_2	tiles_2	T
Tile.WATER	water	w	blocking
Tile.WATER_2	water_2	W	blocking

Tile map

The tile map string is a convenient way of specifying what tiles to use. Each tile is specified using a code (see table in previous section), use . to mark gaps. To be able to add line breaks you will have to use triple " for the strings. Or you can use the special sequence \n instead of adding a line break. Leading and trailing whitespace is ignored, which allows indenting the tile maps.

Here are some examples:

# Example from main section
ex1 = "gg\nr"
# Equivalent to ex1
ex2 = """
    gg
    r
"""
# An example of using gaps
ex3 = """
    .wr.
    mrrg
    mrgg
    .rg.
"""
# Equivalent to ex3, but hard to read
ex4 = """.wr
mrrg
    mrgg\n.rg"""

Walls

It is possible to place walls between tiles in the world, these will block movement between the tiles.

While tiles are identified using a single coordinate, walls are identified using a pair of coordinates. The pair is the coordinates of the tiles the wall is placed between. E.g. if the wall should be placed between tiles (0, 1) and (1, 1) then the coordinate pair is ((0, 1), (1, 1)).

Like tiles, the library comes with prefabricated graphical walls and support for plain colored walls. And it is possible to make custom walls.

Walls are added to the world in a similar way as tiles, except there is no equivalent to tile maps.

First way is to include a walls argument to setup.create_world(). This takes the form of a dictionary with coordinate pairs as keys and walls as values:

world = setup.create_world(tiles={
    ((0, 0), (1, 0)): "hedge",
    ((0, 0), (0, 1)): "stone",
})

Second way is to use the World method:

world.add_wall(coordinate_pair, data): Where data depends on what types of walls you are using; For example adding a prefab wall: world.add_wall(((0, 1), (1, 1)), {"name": "hedge_2"}); Or if using basic walls: world.add_wall(((1, 0), (1, 1)), {"color": "orange", "height": 0.3})

It is possible to get wall data for a pair of coordinates using world.get_wall_data(coordinate_pair).

You can remove a wall using world.remove_wall(coordinate_pair).

Prefab walls

Constant	Name
Wall.BRICK	brick
Wall.BRICK_FENCE	brick_fence
Wall.HEDGE	hedge
Wall.HEDGE_2	hedge_2
Wall.PICKET_FENCE	picket_fence
Wall.PLAIN	plain
Wall.STONE	stone

Block corners

Due to the geometry of a square grid, you will generally only want to have visual walls between tiles in the cardinal directions. However, when allowing diagonal movement (e.g. using directions=SQUARE_DIRECTIONS) the characters can move diagonally across the corners. This will look incorrect and not make intuitive sense for the users.

To solve this you can set block_corners=True in the WorldSetup or World constructors. This will automatically add invisible walls at the corners next to walls so that movement is blocked as expected.

Note that these walls must be manually removed if needed.

Actors

Everything that is not a tile or a wall is an Actor. This includes characters, objects, and even props like flowers.

The easiest way to create actors is to use the WorldSetup methods (see following sections), but you can also create them manually if you need more flexibility.

The World class has the following Actor-related methods:

world.add_actor(coordinate, actor)

Places the actor in the world at the given coordinate.

The actor will be configured to follow the movement rules of the world.

Multiple actors can be placed on the same coordinate.

world.remove_actor(actor)

Removes the actor from the world.

world.find_actors()

Allows looking up actors based on various criteria, returns a list.

If given no arguments it returns all actors in the world.

The following arguments are supported:

at - tuple[int, int]: Coordinate (tile) to search at.; Example: world.find_actors(at=(0, 0))
tags - set[str]: Tags the actor must have.; Example: world.find_actors(tags={"my_tag"})
tags_match_any - bool: Only requires that one tag of tags matches.; Example: world.find_actors(tags={"player", "enemy"}, tags_match_any=True)

Attributes

All actors have a number of attributes that usually can be set when creating the actor:

actor.coordinate - tuple[int, int] | None: The current coordinate of the actor, or None if the actor is not in a world.
actor.offset - tuple[float, float] | None: A visual offset on the current tile, mainly used to add small props (such as rocks and flowers).
actor.tags - set[str]: A set of tags for the actor, which are used in world.find_actors or other features.
actor.block_tags - set[str]: A set of tags this actor is blocked by. If a space has an actor with any of these tags, then this actor can not move there.

Deletion

All actors have the actor.delete() method with will ask for the actor to be removed from existence, such as the world or a container. If the actor was rendered manually, this will have no effect.

Movement

This library has a pathing system which enables actors to find the quickest path from point a to point b.

In order for this system to work, you must call world.update_world_graph(). This should be done after finishing setting up the world, and when you have modified any tiles or walls.

Actors have a set of methods related to movement:

actor.can_move(direction): Returns True if the actor currently can move in the given direction.
actor.move(direction): Moves the actor one step in the given direction.; Does not require movement to be properly set up.; Example: actor.move(Cardinal.LEFT)
actor.move(direction, check=True): Same as above, but includes additional checks (such as blocked check).; Returns False if the movement failed.; Requires movement to be properly set up.; Example: actor.move(Ordinal.LEFT_DOWN, check=True)
actor.possible_moves(): Returns the possible directions this actor can move (currently).
actor.next_move_towards(coordinate): Returns the current direction the actor should move to get one step closer to the given coordinate along a shortest path.; Returns None if there is no path to to coordinate or if the actor is already there.
actor.move_towards(coordinate): Moves the actor one step towards the given coordinate along a shortest path.; Returns False if the movement failed or the actor is already there.; Example: actor.move_towards((3, 4))

You can have a callback trigger whenever the actor performs a successful movement, by supplying the following argument when creating an actor:

on_move - (ActorMoveEventData) -> None: Callback to call when the actor successfully moves (one step)

The ActorMoveEventData object has the following attributes:

source - Actor: The actor that moved
direction - tuple[int, int]: The direction the actor moved
origin - tuple[int, int]: The coordinate the actor came from

Keyboard Input

This library has a keyboard input system which enables users to use the keyboard to move actors or perform other actions.

When creating an actor you can supply the following arguments:

key_map - dict[str, tuple[int, int] | (ActorKeyboardEventData) -> None] | None: Maps keys to movements and/or callbacks.
on_key_up - (ActorKeyboardEventData) -> None: Callback to call if the key is not found in the key map.

The ActorKeyboardEventData object has the following attributes:

source - Actor: The actor that received the key event
key - str: The key value

We supply a default keymap for cardinal movement called MOVE_KEY_MAP which supports arrow keys and WASD movement.

Example of using default movement for a main character:

world.add_actor((0, 0), setup.create_character("skilly", "blue", key_map=MOVE_KEY_MAP))

Example of adding an additional action when pressing "p":

world.add_actor((0, 0), setup.create_character("skilly", "orange", key_map=MOVE_KEY_MAP | {"p": lambda e: e.source.pick_up()}))

Example of just printing the value when a key is pressed:

world.add_actor((0, 0), setup.create_character("skilly", "orange", on_key_up=lambda e: print(e.key)))

Interaction

This library has an interaction system with allows responding to mouse clicks or can be used with keyboard input or just through code.

Actors have a set of methods related to interaction:

actor.interact(): Invokes the actors on_interact callback.
actor.interact(agent=agent): Invokes the actors on_interact callback, specifying the interaction agent (must be an Actor).

When creating an actor you can supply the following arguments:

on_interact - (ActorInteractEventData) -> None: Callback to call when this actor is interacted with.
interact_on_click - bool: If set to True, on_interact will be called when the user clicks on this actor.

The ActorInteractEventData object has the following attributes:

source/target - Actor: The actor that received the key event
agent - Actor | None: The actor that caused the event, set to None if not caused by another actor (such as clicked by user).

Some prefab actors have predefined on_interact callbacks, which can be overridden and are detailed under their respective section.

Characters

Character actors have a few extra features and, most importantly, are animated. The characters will automatically get appropriate walking animations based on movement, and there are a couple of additional actions with dedicated animations.

When you call world.render_changes() the appropriate animation will be chosen. If you want to perform multiple movements or actions, you have to use canvas.split_step() and call world.render_changes() multiple times.

Like with props, there is a dedicated method to create a character setup.create_character(name, color). Available characters and colors are listed in the following tables:

Constant	Name	Description
Character.ADA	ada	a girl
Character.DOUGLAS	douglas	a dog
Character.KATNISS	katniss	a cat
Character.RUST	rust	a boy
Character.SKILLY	skilly	a robot

Constant	Name
CharacterColor.BLACK	black
CharacterColor.BLUE	blue
CharacterColor.ORANGE	orange
CharacterColor.RED	red
CharacterColor.WHITE	white
CharacterColor.YELLOW	yellow

Character actors have an additional set of methods with animations:

actor.pick_up()

Interacts with any other actors on the current tile, and plays a picking up animation.

actor.gesture(direction)

Plays a gesturing animation in the given direction.

Example: actor.gesture(Cardinal.DOWN)

actor.say(text)

Plays a speaking animation and shows a speech bubble with the given text.

Example: actor.say("Hello World!")

Additional optional parameters:

font_size - Adjust the font size for the bubble.
theme - See speech bubble documentation.

actor.interact_with(dir=dir): Interacts with any actors on the tile in the specified direction, and plays a gesturing animation.

Props

Prop actors are simply prefabricated actors that can be placed in the world. It is up to you to decide how to use them.

Props are created using setup.create_prop(name) which also accepts various Actor and Image attributes. The available prefab props are listed in the following table:

Constant	Name	Notes
Container.BARREL	barrel	container
Container.BARREL_SIDE	barrel_side	container
Container.CHEST	chest	container
Container.CHEST_BAND	chest_band	container
Container.CRATE	crate	container
Container.CRATE_TALL	crate_tall	container
Item.COIN	coin	item
Item.HEART	heart	item
Item.KEY	key	item
Item.STAR	star	item
Prop.BUSH	bush
Prop.FLOWER	flower
Prop.FLOWER_2	flower_2
Prop.STONE	stone
Prop.STONE_2	stone_2
Prop.TREE	tree
Prop.TREE_STONES	tree_stones

Smaller props such as flowers and stones can preferably be added as cosmetic scenary to world, with an offset from the center. Here is an example where a couple of stones and flowers are added:

scenary = [
    ("stone", (0, 0), (-0.3, 0)),
    ("flower", (0, 0), (0.3, 0.4)),
    ("stone", (1, 0), (0.2, -0.4)),
]
for name, coord, offset in scenary:
    world.add_actor(coord, setup.create_prop(name, offset=offset))

Bigger props should generally be used without an offset to avoid intersecting walls and characters. You would generally also want to give the bigger props a tag that can be used to block movement:

world.add_actor((0, 2), setup.create_prop("bush", tags={"obstacle"}))

The props marked as container or item can be used as normal props, but if you want to have them be opened/broken, then you should take a look at the containers section or items section.

Containers

Container actors are created using the method setup.create_container(name) with one of the names marked as Container in the props table.

Containers have the following extra attributes:

actor.opened - bool: Whether the container currently is opened/broken or not, readonly

And the following extra methods:

actor.open(): Opens/breaks the container
actor.close(): Closes/un-breaks the container

The containers have animations that play when they open/break, and then they will keep the open/broken appearance. They can then be closed, but there currently are no animations playing for this action.

Items

Item actors are created using the method setup.create_item(name) with one of the names marked as Item in |the props table.

Items have the following extra attributes:

actor.hidden - bool: Whether the item currently is hidden or not, readonly