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.