Blueprint

float tick( Object& arg0, double arg1 )

Tick function to handle the blueprint, should be called from the object script handler's tick.

Object& arg0 — Object this blueprint is for.
double arg1 — Time passed since last tick.

Returns float : Suggestion for the amount of time to wait until the next tick.

void destroy( Object& arg0 )

Call when the object holding the blueprint is destroyed.

Object& arg0 — Object this blueprint is for.

void ownerChange( Object& arg0, Empire@ arg1, Empire@ arg2 )

Call when the blueprint changes owners.

Object& arg0 — Object this blueprint is for.
Empire@ arg1 — Previous empire.
Empire@ arg2 — New Empire.

HexStatus@ getHexStatus( uint x, uint y )

uint x — X coordinate of the hex.
uint y — Y coordinate of the hex.

Returns HexStatus@ : Current status of the hex on this blueprint.

SysStatus@ getSysStatus( uint index )

uint index — Index of the subsystem

Returns SysStatus@ : Current status of the subsystem.

SysStatus@ getSysStatus( uint x, uint y )

uint x — X coordinate of the hex.
uint y — Y coordinate of the hex.

Returns SysStatus@ : Current status of the subsystem the hex belongs to.

bool hasTagActive( SubsystemTag tag )

SubsystemTag tag — Tag to check for.

Returns bool : Whether any subsystems with this tag are present and active.

double getTagEfficiency( SubsystemTag tag, bool ignoreInactive = true )

Calculate the total efficiency of subsystems with a particular tag.

SubsystemTag tag — Tag to check for.
bool ignoreInactive — Whether to ignore remaining efficiency on subsystems that are disabled.

Returns double : Total efficiency.

double getEfficiencySum( SubsystemVariable var, SubsystemTag tag = ST_NULL, bool ignoreInactive = true )

Calculate the total value of a subsystem variable as affected by subsystem efficiency.

SubsystemVariable var — Variable to total.
SubsystemTag tag — Tag to filter subsystems by.
bool ignoreInactive — Whether to ignore remaining efficiency on subsystems that are disabled.

Returns double : Total value.

double getEfficiencyFactor( SubsystemVariable var, SubsystemTag tag = ST_NULL, bool ignoreInactive = true )

Calculate the total percentage efficiency with respect to a variable.

SubsystemVariable var — Variable to use.
SubsystemTag tag — Tag to filter subsystems by.
bool ignoreInactive — Whether to ignore remaining efficiency on subsystems that are disabled.

Returns double : Efficiency factor..

vec3d getOptimalFacing( SubsystemVariable var, SubsystemTag tag = ST_NULL, bool ignoreInactive = true )

Calculate the optimal facing so that effectors in this blueprint can fire with optimal value for the passed variable.

SubsystemVariable var — Variable to use.
SubsystemTag tag — Tag to filter subsystems by.
bool ignoreInactive — Whether to ignore remaining efficiency on subsystems that are disabled.

Returns vec3d : Optimal facing.

Object@ getCombatTarget( )

Find a target this ship is firing on.

const HexStatus@ getHexStatus( uint index ) const

uint index — Hex index.

Returns const HexStatus@ : Current status of the hex on this blueprint.

const HexStatus@ getHexStatus( uint x, uint y ) const

uint x — X coordinate of the hex.
uint y — Y coordinate of the hex.

Returns const HexStatus@ : Current status of the hex on this blueprint.

const SysStatus@ getSysStatus( uint index ) const

uint index — X coordinate of the hex.

Returns const SysStatus@ : Y coordinate of the hex.

const SysStatus@ getSysStatus( uint x, uint y ) const

uint x — X coordinate of the hex.
uint y — Y coordinate of the hex.

Returns const SysStatus@ : Current status of the subsystem the hex belongs to.

bool canTarget( Object& obj, Object& target )

Check whether the effectors in this blueprint can target an object.

Object& obj — Object this blueprint is for.
Object& target — Object to check targeting for.

Returns bool : Whether the object can be targeted.

bool doesAutoTarget( Object& obj, Object& target )

Check whether the effectors in this blueprint can auto-target an object.

Object& obj — Object this blueprint is for.
Object& target — Object to check auto-targeting for.

Returns bool : Whether the object can be auto-targeted.

void target( Object& obj, Object& target, uint flags = 0 )

Set all effectors in this blueprint to target a particular object.

Object& obj — Object this blueprint is for.
Object& target — Object to target with all effectors.
uint flags — Flags for the effector target.

void target( Object& obj, uint efftrIndex, Object& target, uint flags = 0 )

Set an effector in this blueprint to target a particular object.

Object& obj — Object this blueprint is for.
uint efftrIndex — Index of the effector to target for.
Object& target — Object to target with the effector.
uint flags — Flags for the effector target.

void target( Object& obj, const Subsystem@ sys, Object& target, uint flags = 0 )

Set all effectors in a subsystem to target a particular object.

Object& obj — Object this blueprint is for.
const Subsystem@ sys — Subsystem to set targets for.
Object& target — Object to target with all effectors.
uint flags — Flags for the effector target.

void clearTracking( Object& obj )

Clear the turret tracking for all effectors, letting them retrack fast.

Object& obj — Object this blueprint is for.

void sendDetails( Object& obj, Message& msg ) const

For networking: sends the details of this blueprint through the message.

Object& obj — Object this blueprint is for.
Message& msg — Message to add details to.

void recvDetails( Object& obj, Message& msg )

For networking: read the details of this blueprint from a message.

Object& obj — Object this blueprint is for.
Message& msg — Message to read details from.

bool sendDelta( Object& obj, Message& msg ) const

For networking: sends a delta of this blueprint through the message.

Object& obj — Object this blueprint is for.
Message& msg — Message to add delta to.

Returns bool : Whether a delta was needed/written.

void recvDelta( Object& obj, Message& msg )

For networking: read the delta of this blueprint from a message.

Object& obj — Object this blueprint is for.
Message& msg — Message to read delta from.

void create( Object& obj, const Design@ design )

Initialize this blueprint.

Object& obj — Object this blueprint is for.
const Design@ design — Design to initialize the blueprint with.

void start( Object& obj, bool fromRetrofit = false )

Start the blueprint's effects.

Object& obj — Object this blueprint is for.
bool fromRetrofit — Whether this was started from a retrofit event.

void retrofit( Object& obj, const Design@ toDesign )

Retrofit the blueprint to a new design.

Object& obj — Object this blueprint is for.
const Design@ toDesign — Design to retrofit to.

any@ getHookData( uint index )

Get data storage for a hook index.

uint index — Hook index

Returns any@ : Data for that hook.

int integer( const Subsystem@ sys, uint num )

const Subsystem@ sys — Subsystem to retrieve the state for.
uint num — Index of the state to get.

Returns int : Integer state value for the subsystem.

double decimal( const Subsystem@ sys, uint num )

const Subsystem@ sys — Subsystem to retrieve the state for.
uint num — Index of the state to get.

Returns double : Decimal state value for the subsystem.

bool boolean( const Subsystem@ sys, uint num )

const Subsystem@ sys — Subsystem to retrieve the state for.
uint num — Index of the state to get.

Returns bool : Boolean state value for the subsystem.

void damage( Object& obj, DamageEvent& evt, vec2d& direction )

Handle damage to the blueprint from a particular direction.

Object& obj — Object the blueprint is for.
DamageEvent& evt — Event relating information about the damage dealt.
vec2d& direction — Direction vector towards the object of the damage.

void damage( Object& obj, DamageEvent& evt, double position, vec2d& direction )