Capture Location

This object represents a capture location on the battlefield. A list of capture locations may be retrieved from battle_capture_location_manager object, which is itself retrieved by calling the function battle:capture_location_manager.

Loaded in Campaign Loaded in Campaign
Loaded in Battle Loaded in Battle
Loaded in Frontend Loaded in Frontend
Back to top

Functionality

capture_location:position()
Returns the position of the capture location.

Returns:

  1. battle_vector position

capture_location:unique_id()
Returns the unique_id of the capture location.

Returns:

  1. number unique_id

capture_location:type()
Returns the type of the capture location, from the capture_location_types table.

Returns:

  1. string type

capture_location:contributes_to_victory()
Returns whether the capture of this capture location contributes towards victory in the battle.

Returns:

  1. boolean contributes to victory

capture_location:highlight(boolean set_highlighted)

Highlights the capture location for the tutorial

Parameters:

1

boolean

set_highlighted

Returns:

  1. nil

capture_location:linked_buildings()
Returns a battle_buildings list containing any battle_building objects linked to this capture location, if any.

Returns:

  1. battle_buildings buildings list

capture_location:is_held()
Returns whether the capture location is currently controlled by an alliance.

Returns:

  1. boolean is held

capture_location:holding_alliance_id()
Returns the id of the alliance who owns the capture location. If no alliance owns the capture location then 0 will be returned;

Returns:

  1. number alliance id

capture_location:holding_army()
Returns the army that owns the capture location. If no army holds the capture location then nothing is returned.

Returns:

  1. battle_army holding army

Capture Location Manager

The capture location manager provides an interface to obtain battle_capture_location objects on the battlefield. A handle to the capture location manager may be obtained by calling battle:capture_location_manager.

Back to top

Functionality

capture_location_manager:item()
Retrieves a battle_capture_location by numerical index. If no capture location exists at the supplied index then nothing is returned. The number of capture locations on the battlefield can be queried using capture_location_manager:count.

Returns:

  1. battle_capture_location capture location

capture_location_manager:count()
Retrieves the number of battle_capture_location objects on the battlefield. Each individual capture location can be retrieved with capture_location_manager:item.

Returns:

  1. number number of capture locations
Last updated 8/23/2024 4:55:16 PM