Widelands Scripting Reference

• Core functionality
  • Global functions
    • string.bformat()
    • push_textdomain()
    • pop_textdomain()
    • _()
    • ngettext()
    • pgettext()
    • npgettext()
    • include()
    • ticks()
    • get_build_id()
    • play_sound()
  • path
    • Module Functions
  • wl
    • Module Classes
  • wl.bases
    • Module Classes
  • wl.editor
    • Module Classes
  • wl.game
    • Module Classes
  • wl.map
    • Common functions
    • Module Classes
  • wl.ui
    • Module Functions
    • Module Classes
  • styles
    • Module Functions
• World and Tribes
  • Animations
    • File Animations
    • Directional Animations
    • Spritesheet Animations
    • Converting Animation Formats
    • Map Object Types
  • Scripts for World
    • Defining the World
    • Defining Units
    • Other Scripts
  • Scripts for Tribes
    • Defining Tribes
    • Defining Units
    • Other Scripts
  • Programs
    • Immovables
    • Production Sites
    • Workers
    • Syntax
    • Data Types
    • Actions
• Themes
  • Required Files
  • init.lua
    • windows
    • buttons
    • sliders
    • tabpanels
    • editboxes
    • Dropdowns
    • scrollbars
    • statistics plots
    • building statistics
    • progress bars
    • tables
    • ware statistics
    • fonts
    • paragraph styles
    • colors
    • sizes
• Auxiliary Scripts
  • table.lua
    • array_combine()
    • ordered_pairs()
  • richtext_scenarios.lua
    • speech()
    • paragraphdivider()
    • objective_text()
  • coroutine.lua
    • run()
    • sleep()
    • wake_me()
  • set.lua
    • Set
  • starting_conditions.lua
    • sleep_then_goto()
    • launch_expeditions()
  • field_animations.lua
    • reveal_randomly()
    • hide_randomly()
    • reveal_concentric()
    • hide_concentric()
    • get_sees_fields()
  • richtext.lua
    • Blocks and Positioning
    • Headings and Paragraphs
    • Text Formatting
    • Lists
    • Images
    • Links
    • Text Composition
    • Code Example
  • ui.lua
    • scroll_to_map_pixel()
    • scroll_to_field()
    • mouse_to_pixel()
    • mouse_to_field()
    • mouse_to_panel()
    • click_building()
    • click_button()
    • close_windows()
    • wait_for_roadbuilding()
    • wait_for_roadbuilding_and_scroll()
  • help.lua
    • linkify_encyclopedia_object()
    • tree_affinity_list()
    • terrain_affinity_list()
    • terrain_affinity_help()
  • objective_utils.lua
    • check_for_buildings()
  • messages.lua
    • send_to_inbox()
    • send_to_all_inboxes()
    • message_box()
    • campaign_message_box()
    • messagebox_h_step()
    • messagebox_w_step()
    • add_campaign_objective()
    • new_objectives()
    • campaign_message_with_objective()
    • set_objective_done()
  • infrastructure.lua
    • connected_road()
    • prefilled_buildings()
    • place_building_in_region()
    • is_building()
    • add_wares_to_warehouse()
    • check_trees_rocks_poor_hamlet()
  • Training Wheels
    • Triggering a Training Weel
    • Designing a Training Wheel
    • Message Formatting
    • Example Training Wheel
  • win_condition_functions.lua
    • make_extra_data()
    • check_player_defeated()
    • count_factions()
    • broadcast()
    • broadcast_objective()
    • count_owned_valuable_fields_for_all_players()
    • rank_players()
    • format_remaining_raw_time()
    • format_remaining_time()
    • notification_remaining_time()
  • territorial_functions.lua
    • territory_points
    • calculate_territory_points()
    • territory_status()
    • winning_status_header()
    • losing_status_header()
    • territory_game_over()
  • win_condition_texts.lua
    • won_game
    • lost_game
    • won_game_over
    • lost_game_over
    • game_status