SCRIPTING & DATA

# Give the character or item a name (if they differ from the template)
set_attr("name", "Golden Key")

# Set the tile ID for the character or item. Get the tile ID from the tile-picker.
set_tile("tile_id")

# Make the character or item visible / invisible
set_attr("visible", False)

# Change the collision radius for characters and items (default is 0.5)
set_attr("radius", 0.3)

# Item specific

# Make the item blocking (based on its radius)
set_attr("blocking", True)

# Make the item static (doors, campfires etc.). Static items cannot be picked up.
set_attr("static", True)

# Setting general purpose attributes
set_attr("STR", 10)

[attributes]

# Give the character or item a name (if they differ from the template)
name = "Orc"

# Set the tile ID for the character or item. Get the tile ID from the tile-picker
tile_id = "tile_id"

# Make the character or item visible / invisible
visible = false

# Change the collision radius for characters and items (default is 0.5)
radius = 0.3

# Item specific

# Make the item blocking (based on its radius)
blocking = true

# Make the item static (doors, campfires etc.). Static items cannot be picked up
static = true

# General purpose attributes
STR = 10

# Block the listed events from being send to the character or item for the given amount
# of in-game minutes.
block_events(minutes, "event1", "event2",...)

# Deal damage to the given entity or item identified by its ID.
# Damage is a Python array of information which gets send to the receiver via an
# `take_damage` event.
# Example: deal_damage(id, {"physical": 10})
# Send all relevant data to the receiver who can calculate the final damage and apply it.
deal_damage(entity_id | item_id, damage)

# Send a debug message to the Log.
debug(arg1, arg2, ...)

# Get an attribute of the current character or item.
get_attr("key")

# Get an attribute of the given character.
get_entity_attr(entity_id, "key")

# Get an attribute of the given item.
get_item_attr(item_id,"key")

# Returns an array of filtered item ids of the given character's inventory.
# Returns all items if filter_string is empty. Otherwise, returns items whose name
# or class names contain the filter_string.
inventory_items_of(entity_id, filter_string)

# Return a list of entity ids within the radius of the character or item.
# This has many use cases, like a door checking if it can close as no players overlap.
entities_in_radius()

# Return the name of the sector the character or item is in.
get_sector_name()

# Send the event string to the character or item after a given amount of in-game minutes.
# By default, one in game minute is one second in real time.
notify_in(minutes, event_string)

# Set an attribute of the current character or item. Value can be any Python value.
set_attr("key", value)

# Enables / disable entity proximity tracking. If enabled, the entity or item will receive
# "proximity_warning" events with a list of entity ids within the radius.
# Works similarly to entities_in_radius(), but auto generates events.
# Use with get_entity_attr() to check for entities to take action on (attack, heal, talk etc).
set_proximity_tracking(True / False, radius)

# Send a message to the given character.
tell(entity_id, message)

# Creates a new item of the given class name and add it to the character's inventory.
add_item(class_name)

# Returns an array of filtered item ids in the character's inventory.
# Returns all items if filter_string is empty. Otherwise, returns items whose name
# or class names contain the filter_string.
inventory_items(filter_string)

# Drops items in the character's inventory.
# Drops all items if filter_string is empty. Otherwise, drops items whose name
# or class names contain the filter_string.
drop_items(filter_string)

# Loop: Walks the character in a random direction for the given distance and speed.
# After arrival, sleeps for a random amount of in-game-minutes between max_sleep / 2 and max_sleep.
# Example: random_walk(1.0, 1.0, 8)
# Mostly used for NPCs
random_walk(distance, speed, max_sleep)

# Loop: Walks the character in a random direction in the current sector for the given distance and speed.
# In between sleeps the character for a random amount of in-game-minutes between max_sleep / 2 and max_sleep.
# This command is useful for NPCs that need to move around randomly without leaving a sector (shop etc.)
# Example: random_walk_in_sector(1.0, 8)
# Mostly used for NPCs
random_walk_in_sector(distance, speed, max_sleep)

# Register a player character. Only than do they receive user inputevents from the game.
register_player()

# Take an item from the region. The item is removed from the region and added to the character's inventory.
take(item_id)

# None yet

def user_event(self, event, value):
    if event == 'key_down':
        if value == 'w':
            action("forward")
        if value == 'a':
            action("left")
        if value == 'd':
            action("right")
        if value == 's':
            action("backward")
    if event == 'key_up':
            action("none")

# 2D and Isometric: Move the player north.
# First-Person: Move the player forward in their current facing direction.
action("forward")

# 2D and Isometric: Move the player west.
# First-Person: Rotate the player to their left.
action("left")

# 2D and Isometric: Move the player east.
# First-Person: Rotate the player to their right.
action("right")

# 2D and Isometric: Move the player south.
# First-Person: Move the player backward in their current facing direction.
action("backward")

# Stop any movement / action.
action("none")