Meaning#

purposelookup: X4 attribute schema type: base types, constraints and value alternatives.

An XSD type constrains XML, rather than declaring a Lua return or the payload type of event.param. A valid schema value does not prove a successful game effect.

Schema structure#

libraries/common.xsd

Property Value
Construction union
Union members expression

Additional inline union branch:

Property Value
Construction restriction
Base type xs:string
Constraint Value
enumeration purpose.trade
enumeration purpose.fight
enumeration purpose.build
enumeration purpose.mine
enumeration purpose.auxiliary
enumeration purpose.hack
enumeration purpose.scan
enumeration purpose.production
enumeration purpose.storage
enumeration purpose.connection
enumeration purpose.habitation
enumeration purpose.defence
enumeration purpose.docking
enumeration purpose.venture
enumeration purpose.welfare
enumeration purpose.processing
enumeration purpose.salvage
enumeration purpose.dismantling
enumeration purpose.rig

restriction narrows a base type; union accepts one of its branches; list describes whitespace-separated items. Enumeration values in one restriction are alternatives. Pattern syntax is XML Schema regex, not Lua patterns or JavaScript RegExp. Constraints inherited from the base type still apply.

Example and result#

Use the attribute pages below for contextual examples. A generic executable example is not inferred from a type name alone.

Used by#

Element Attribute Schema
find_cluster primarypurpose libraries/common.xsd
find_dockingbay primarypurpose libraries/common.xsd
find_object primarypurpose libraries/common.xsd
find_object_component primarypurpose libraries/common.xsd
find_room primarypurpose libraries/common.xsd
find_sector primarypurpose libraries/common.xsd
find_sector_in_range primarypurpose libraries/common.xsd
find_ship primarypurpose libraries/common.xsd
find_ship_by_true_owner primarypurpose libraries/common.xsd
find_station primarypurpose libraries/common.xsd
find_station_by_true_owner primarypurpose libraries/common.xsd
match_content primarypurpose libraries/common.xsd

All schema types · Lua / MD value types