Welcome to Unknown Horizons’s documentation!

Contents:

Buildings Overview

Sailors

Warehouse

x y 5 0 1000 12 3 3 Produces:

Storage Tent

Extends stock, expands settlement range and provides collectors.

x y 10 0 350 4 1 2 2

Tent

Houses your inhabitants.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 0 | 0 | 100 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+ Produces:

Main Square

Supplies citizens with goods. Provides community.

x y 0 0 1000 5 6 6

Pavilion

Fulfills religious needs of sailors.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 15 | 5 | 500 | 5 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Signal Fire

Allows the player to trade with the free trader.

x y 0 0 50 5 1 1

Lumberjack Tent

Chops down trees and turns them into boards.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 5 | 0 | 250 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+ Produces:

Hunter’s Tent

Hunts wild forest animals, produces food.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 5 | 0 | 250 | 2 | 1 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Ruined Tent

x y 0 0 2 2

Fisherman’s Tent

Fishes the sea, produces food.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 5 | 0 | 250 | 3 | 1 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Lookout

Expands settlement range.

x y 5 0 50 2 1 1

Trail

Needed for collecting goods.

x y 0 0 5 1 1

Tree

Provides lumber. Chopped down by lumberjacks.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 50 | 1 | 1 | +——–+——–+——–+——–+——–+ Produces:

Clay Deposit

x y 0 0 3 3

Fish Deposit

| +——–+——–+——–+——–+ | | | x | y | +——–+——–+——–+——–+ | 0 | 0 | 2 | 2 | +——–+——–+——–+——–+ Produces:

Mountain

x y 0 0 5 5

Pioneers

Warehouse

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 5 | 0 | 1000 | 12 | 3 | 3 | +——–+——–+——–+——–+——–+——–+ Produces:

Storage Hut

Extends stock, expands settlement range and provides collectors.

x y 10 0 350 4 1 2 2

Hut

Houses your inhabitants.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 0 | 0 | 100 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+ Produces:

Main Square

Supplies citizens with goods. Provides community.

x y 0 0 1000 5 6 6

Pavilion

Fulfills religious needs of sailors.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 15 | 5 | 500 | 5 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Signal Fire

Allows the player to trade with the free trader.

x y 0 0 50 5 1 1

Weaver’s Hut

Turns lamb wool into cloth.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 250 | 3 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Lumberjack Hut

Chops down trees and turns them into boards.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 5 | 0 | 250 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+ Produces:

Boat Builder

Builds boats and small ships. Built on coast.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 25 | 10 | 500 | 4 | 3 | 3 | 3 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Gravel Path

Needed for collecting goods.

x y 0 0 5 1 1

Pasture

Raises sheep. Produces wool. Needs a farm.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 0 | 0 | 100 | 1 | 3 | 3 | +——–+——–+——–+——–+——–+——–+ Produces:

Potato Field

Yields food. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Farm

Grows field crops and raises livestock.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 500 | 4 | 2 | 3 | 3 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Village school

Provides education.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 15 | 5 | 500 | 4 | 4 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Sugar Field

Used in liquor production. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Brickyard

Turns clay into bricks.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 15 | 5 | 500 | 6 | 1 | 2 | 4 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Clay Pit

Gets clay from deposit.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 15 | 5 | 500 | 10 | 2 | 3 | 3 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Distillery

Turns sugar into liquor.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 250 | 2 | 2 | 4 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Wooden Tower

Defends your settlement.

x y 10 0 500 12 3 2 2 2

Fire Station

Extinguishes fires.

x y 15 5 750 3 2 4 2 2

Brewery

Consumes hops. Produces Beer.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 250 | 2 | 2 | 4 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Settlers

Warehouse

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 5 | 0 | 1000 | 12 | 3 | 3 | +——–+——–+——–+——–+——–+——–+ Produces:

House

Houses your inhabitants.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 0 | 0 | 100 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+ Produces:

Main Square

Supplies citizens with goods. Provides community.

x y 0 0 1000 5 6 6

Mine

Gets iron ore from deposit.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 15 | 5 | 500 | 10 | 2 | 5 | 5 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Smeltery

Refines all kind of ores.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 50 | 15 | 1250 | 8 | 4 | 6 | 4 | 4 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Toolmaker

Produces tools out of iron.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 500 | 2 | 2 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Charcoal Burning

Burns a lot of boards.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 250 | 2 | 1 | 3 | 2 | 3 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Tavern

Provides get-together.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 5 | 0 | 250 | 4 | 4 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Salt Ponds

Evaporates salt. Built on sea coast.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 350 | 4 | 2 | 3 | 3 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Tobacco Field

Produces tobacco. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Tobacconist

Produces tobaccos out of tobacco.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 250 | 1 | 2 | 4 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Cattle Run

Raises cattle. Needs a farm.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 0 | 0 | 100 | 1 | 3 | 3 | +——–+——–+——–+——–+——–+——–+ Produces:

Herbary

Produces herbs. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Butchery

Needs pigs or cattle. Produces food.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 15 | 5 | 500 | 3 | 4 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Doctor

Treats diseases. Consumes herbs.

x y 20 5 500 3 3 3 2 2

Spice Field

Grows spices. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Blender

Produces condiments out of spices.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 500 | 3 | 2 | 3 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Barracks

Recruits units suitable for ground combat.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 25 | 10 | 1000 | 6 | 4 | 8 | 3 | 3 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Stone Pit

Gets stone from a mountain.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 15 | 5 | 1 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Stonemason

Carves stone tops into bricks.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 15 | 5 | 1 | 2 | 2 | +——–+——–+——–+——–+——–+ Produces:

Weaponsmith

Produces weapons out of iron.

| +——–+——–+——–+——–+——–+——–+——–+——–+ | | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 500 | 2 | 2 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+——–+ Produces:

Citizens

Warehouse

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 5 | 0 | 1000 | 12 | 3 | 3 | +——–+——–+——–+——–+——–+——–+ Produces:

Stone house

Houses your inhabitants.

| +——–+——–+——–+——–+——–+——–+ | | | | | x | y | +——–+——–+——–+——–+——–+——–+ | 0 | 0 | 100 | 2 | 2 | 2 | +——–+——–+——–+——–+——–+——–+ Produces:

Main Square

Supplies citizens with goods. Provides community.

x y 0 0 1000 5 6 6

Cobblestone Street

Needed for collecting goods.

x y 0 0 5 1 1

Corn Field

Yields corn. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Windmill

Grinds corn into flour.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 10 | 0 | 400 | 4 | 5 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Bakery

Consumes flour. Produces food.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 20 | 5 | 500 | 2 | 3 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Cocoa Field

Produces cocoa beans used for confectionery. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Vineyard

Produces grapes for use in wine and confectionery. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Alvearies

Keeps bees. Produces honeycombs used for confectionery. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Pastry Shop

Produces all kinds of confectionery.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 25 | 10 | 500 | 2 | 3 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Winery

Produces wine out of grapes.

| +——–+——–+——–+——–+——–+——–+——–+ | | | | | | x | y | +——–+——–+——–+——–+——–+——–+——–+ | 20 | 5 | 500 | 2 | 3 | 2 | 2 | +——–+——–+——–+——–+——–+——–+——–+ Produces:

Hop Field

Yields hop. Needs a farm.

| +——–+——–+——–+——–+——–+ | | | | x | y | +——–+——–+——–+——–+——–+ | 0 | 0 | 150 | 3 | 3 | +——–+——–+——–+——–+——–+ Produces:

Scenario

Actions

alter_inventory(resource, amount)

Alters the inventory of each settlement.

change_increment(tier)

Changes the tier of the settlements.

db_message(database_message_id)

Shows a message with predefined text in the messagewidget.

goal_reached(goal_number)

The player reaches a certain goal in the current scenario.

highlight_position(where, play_sound, color)

Highlights a position on the minimap. where: (x, y) coordinate tuple color is a optional parameter that defines the color of the highlight.

logbook(*parameters)

Shows a logbook entry and opens the logbook after some seconds. Displays a YAML-defined notification message on logbook close.

See widgets.logbook:add_captainslog_entry for parameter documentation.

lose()

The player fails the current scenario.

message(type, *messages)

Shows a message with custom text in the messagewidget. If you pass more than one message, they are shown simultaneously.

set_var(variable, value)

Assigns values to scenario variables. Overwrites previous assignments to the same variable.

spawn_ships(owner_id, ship_id, number, *position)

Creates a number of ships controlled by a certain player around a position on the map.

wait(seconds)

Postpones any other scenario events for a certain amount of seconds.

win()

The player wins the current scenario.

Conditions

building_in_range(building_class1, building_class2)

Checks whether there is a building_class2 in range of a building_class1.

building_num_of_type_greater(building_class, limit)

Returns whether any player settlement has more than limit buildings of type building_class.

buildings_connected_to_building_gt(building_class, class2, limit)

Checks whether more than limit of building_class type buildings are connected to any building of type class2.

buildings_connected_to_building_lt(building_class, class2, limit)

Checks whether less than limit of building_class type buildings are connected to any building of type class2.

buildings_connected_to_warehouse_gt(building_class, limit)

Checks whether more than limit of building_class type buildings are connected to a warehouse or storage.

buildings_connected_to_warehouse_lt(building_class, limit)

Checks whether less than limit of building_class type buildings are connected to a warehouse or storage.

game_started()

Always return True. Used for one-off events

player_balance_greater(limit)

Returns whether the cumulative balance of all player settlements is higher than limit.

player_gold_greater(limit)

Returns whether the player has more gold than limit.

player_gold_less(limit)

Returns whether the player has less gold than limit.

player_inhabitants_greater(limit)

Returns whether all player settlements combined have more than limit inhabitants.

player_number_of_ships_gt(player_id, limit)

Returns whether the number of ships owned by the player player_id is greater than limit.

player_number_of_ships_lt(player_id, limit)

Returns whether the number of ships owned by the player player_id is less than limit.

player_produced_res_greater(resource, limit)

Returns whether more than limit of the resource resource have been produced in all player settlements combined.

player_res_stored_greater(resource, limit)

Returns whether all player settlements combined have more than limit of resource in their inventories.

player_res_stored_less(resource, limit)

Returns whether all player settlements combined have less than limit of resource in their inventories.

player_total_earnings_greater(limit)

Returns whether the player has earned more than limit money with trading in all settlements combined. Profit = sell_income - buy_expenses.

settlement_balance_greater(limit)

Returns whether the balance of at least one player settlement is higher than limit.

settlement_inhabitants_greater(limit)

Returns whether at least one player settlement has more than limit inhabitants.

settlement_produced_res_greater(resource, limit)

Returns whether more than limit resource have been produced in any player settlement.

settlement_res_stored_greater(resource, limit)

Returns whether at least one player settlement has more than limit of resource in its inventory.

settlements_num_greater(limit)

Returns whether the number of player settlements is greater than limit.

settler_level_greater(limit)

Returns whether the highest tier reached in any player settlement is greater than limit.

time_passed(seconds)

Returns whether at least seconds seconds have passed since the game started.

var_eq(variable, value)

Returns whether variable has a value equal to value. Returns False if variable was never set in the current session.

var_gt(variable, value)

Returns whether variable has a value greater than value. Returns False if variable was never set in the current session.

var_lt(variable, value)

Returns whether variable has a value less than value. Returns False if variable was never set in the current session.

Indices and tables

• Index
• Module Index
• Search Page