1

table

List of buildings to test. This should be an indexed table of battle_building objects, such as (but not restricted to) those returned by functions documented in the Building Lists section of this documentation.

2

function

Filter function. This should take a battle_building object as a single argument and return a boolean result.

1

battle_vector

Position to test against.

2

table

List of buildings to test. This should be an indexed table of battle_building objects, such as (but not restricted to) those returned by functions documented in the Building Lists section of this documentation.

3

function

optional, default value=nil

Filter function. This should take a battle_building object as a single argument and return a boolean result. If no filter function is supplied then all buildings pass.

1

battle_building

building

1

battle_building

Building.

2

number

Number of connections to test.

3

number

optional, default value=false

Includes connections to buildings that are not standard fort walls (e.g. gates, towers).

1

battle_vector

Position to test against.

2

number

Number of connections to test for each building.

3

number

optional, default value=false

Includes connections to buildings that are not standard fort walls (e.g. gates, towers).

1

string

Capture location type, from the capture_point_types database table.

2

boolean

optional, default value=false

Perform a partial string match. This would allow a supplied capture location search string "major_key_building" to match capture locations with types such as "major_key_building_magic" or "major_key_building_missile".

1

string

optional, default value=nil

Capture location type, from the capture_point_types database table. If no type is specified then any type is matched.

2

boolean

optional, default value=false

Perform a partial string match. This would allow a supplied capture location search string "major_key_building" to match capture locations with types such as "major_key_building_magic" or "major_key_building_missile".

1

battle_vector

Position.

2

string

optional, default value=nil

Capture location type, from the capture_location_types<\code> database table.

3

boolean

optional, default value=false

Perform a partial string match. This would allow a supplied capture location search string "major_key_building" to match capture locations with types such as "major_key_building_magic" or "major_key_building_missile".

1

battle_vector

Position.

2

string

optional, default value=nil

Capture location type, from the capture_location_types<\code> database table.

3

boolean

optional, default value=false

Perform a partial string match. This would allow a supplied capture location search string "major_key_building" to match capture locations with types such as "major_key_building_magic" or "major_key_building_missile".

1

battle_vector

Camera target.

2

battle_vector

Initial camera position.

3

number

optional, default value=0.1745

horizontal bearing delta in radians. The default value is equivalent to 10 degrees.

1

battle_vector

Target position.

2

number

optional, default value=100

Camera-to-target distance in m.

3

number

optional, default value=0

Horizontal bearing (i.e. looking from above) from camera target to initial camera position in radians.

4

number

optional, default value=0.6175

Vertical vearing (i.e. looking from side) from camera target to initial camera position in radians. The default value is equivalent to 30 degrees.

5

number

optional, default value=0.1745

Horizontal bearing delta in radians. The default value is equivalent to 10 degrees.

1

battle_vector

Camera target.

2

number

X offset of the first camera position from the camera target, based on the horizontal bearing.

3

number

Z offset of the first camera position from the camera target, based on the horizontal bearing.

4

number

Horizontal bearing (i.e. looking from top down) in radians from which to take the offset, from the camera target.

5

number

optional, default value=0.6175

Vertical bearing (i.e. looking from side) in radians of the first camera position, from the camera target. The default value is equivalent to 30 degrees.

6

number

optional, default value=0.1745

Horizontal bearing delta in radians. The default value is equivalent to 10 degrees.

1

battle_vector

Camera target.

2

battle_vector

Bearing vector, which defines the horizontal bearing of the first computed camera position.

3

number

optional, default value=100

Distance in metres from camera target to computed camera positions.

4

number

optional, default value=0.6175

Vertical bearing in radians from the camera target to the camera positions, in radians. The default value is equivalent to 30 degrees.

5

number

optional, default value=0.1745

Horizontal bearing delta in radians. The default value is equivalent to 10 degrees.

1

script_unit

Subject script unit.

2

number

X-offset of first camera position from the script unit, by that unit's facing.

3

number

Z-offset of first camera position from the script unit, by that unit's facing.

4

number

optional, default value=0.6175

Vertical bearing from subject unit to first camera position. The default value is equivalent to 30 degrees.

5

number

optional, default value=0.1745

Horizontal bearing delta in radians. The default value is equivalent to 10 degrees.

1

script_units

Subject script units.

2

number

X-offset of first camera position from the script unit, by that unit's facing.

3

number

Z-offset of first camera position from the script unit, by that unit's facing.

4

number

optional, default value=0.6175

Vertical bearing from subject unit to first camera position. The default value is equivalent to 30 degrees.

5

number

optional, default value=nil

Horizontal bearing override in radians. By default, the average bearing of all units in the supplied scriptunits collection is used.

6

number

optional, default value=0.1745

Horizontal bearing delta in radians. The default value is equivalent to 10 degrees.

7

boolean

optional, default value=false

Activates relaxed pose. This raises the height of the camera target above the mean centre of the scriptunits collection, and changes the default vertical bearing from 30 degrees to 20 degrees. The scriptunits will be at the bottom-centre of the screen instead of the centre, with the camera raised, replicating a natural gameplay camera angle.

1

boolean

optional, default value=false

Return offset positions as the attacker i.e. from outside the fort.

1

string

Section name for the navigable tour section being created.

2

function

optional, default value=nil

Camera positions generator function. If supplied, this function should return two or three battle_vector objects. If two are supplied, these are assumed to be a camera target and position to pan the camera to when the navigable tour starts.

3

string

optional, default value=nil

Key of advice to show when the navigable tour section plays. If nil is supplied then no advice is shown.

4

table

optional, default value=nil

Table of infotext keys to show when the navigable tour section plays. If nil is supplied then no infotext is shown.

5

number

optional, default value=1000

Interval before the advice, infotext and objectives begin to display. By default this is 1000ms. A string may also be supplied, in which case it specifies an event which, when received, causes the advice/infotext/objectives to be triggered.

6

string

optional, default value=nil

Objective key of objective to show. This should be a key for a record from the scripted_objectives database table. If nil is supplied then no objective is shown.

7

function

optional, default value=nil

Objective completion test function. If supplied, a battle_manager:watch is set up with this function as the condition. When the condition passes, the supplied objective is marked as completed.

8

boolean

optional, default value=false

Leave section objective on-screen after it has been completed. By default the section objective is removed from the screen once it's completed - set this value to true to suppress this behaviour.

9

string

optional, default value=nil

Path of movie to play in window, if one is required for this navigable tour section.

1

navigable_tour

Host navigable tour.

2

boolean

optional, default value=false

If set to true, the current camera position is not recorded on the scripted tour. This is useful if the scripted tour has already done this.

1

navigable_tour

navigable tour