Function list: 1.5

This is a moderated forum that collects tutorials, guides, and references for creating Transcendence extensions and scripts.
Post Reply
User avatar
AssumedPseudonym
Militia Captain
Militia Captain
Posts: 957
Joined: Thu Aug 29, 2013 5:18 am
Location: On the other side of the screen.

Sat Dec 06, 2014 8:03 pm

 This is just a dump of functions in 1.5. I basically wrote a mod to sort out the deprecated functions and drop them to the bottom. Because I’m too lazy to sort it myself but not too lazy to write something up to do the sorting for me. Going through and sorting out what’s new and/or changed is going to be pure grunt work, though. No getting around that.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

FUNCTION LIST

(< ...)
(<= ...)
(> ...)
(>= ...)
(@ list index)
(abs x) -> z
(add x1 x2 ... xn) -> z
(and exp1 exp2 ... expn) -> True/Nil
(append a b [...]) -> lists are concatenated
(apply exp arg1 arg2 ... argn list) -> Result
(armGetRepairCost type) -> Cost to repair 1 hit point
(armGetRepairTech type) -> Tech level required to repair
(atmAddEntry ...)
(atmAtomTable ...)
(atmDeleteEntry ...)
(atmList ...)
(atmLookup ...)
(block ...)
(cat s1 s2 ... sn) -> string
(cnvDrawImage x y imageDesc [screen] [ID])
(cnvDrawLine xFrom yFrom xTo yTo width color [screen] [ID])
(cnvDrawRect x y width height color [screen] [ID])
(cnvDrawText x y [width] text font color alignment [screen] [ID])
(objCanInstallItem obj item [armorSeg]) -> (True/Nil resultCode resultString [itemToReplace])

resultCode

'ok
'armorTooHeavy
'cannotInstall
'noDeviceSlotsLeft
'noNonWeaponSlotsLeft
'noWeaponSlotsLeft
'notInstallable
'reactorIncompatible
'reactorOverloaded
'reactorTooWeak
'replacementRequired

(count list) -> number of items
(dbgLog [string]*)
(dbgOutput [string]*)
(divide x y) -> z
(ecoExchange amount fromCurrency toCurrency) -> amount
(enum list itemVar exp)
(enumwhile list condition itemVar exp)
(eq ...)
(errblock ...)
(error msg) -> error
(eval ...)
(filter list var boolean-exp) -> filtered list
(find source target ['ascending|'descending] [keyIndex]) -> position of target in source (0-based)
(fmtCurrency currency [amount]) -> string
(fmtNoun name nameFlags count formatFlags) -> string
(fncHelp ...)
(for var from to exp)
(gamSave [options]) -> True/Nil

options:

'checkpoint (or Nil)
'missionCheckpoint

(gamSetCrawlImage imageUNID) -> True/Nil
(gamSetCrawlSoundtrack soundtrackUNID) -> True/Nil
(gamSetCrawlText text) -> True/Nil
(geq a b) -> True if a >= b
(gr a b) -> True if a > b
(help) -> all functions
(help partial-name) -> all functions starting with name
(help function-name) -> help on function
(if ...)
(int ...)
(objTranslate obj textID [data] [default]) -> text (or Nil)
(isatom ...)
(iserror ...)
(isfunction ...)
(isint ...)
(isprimitive ...)
(itmCreate itemUNID count) -> item
(itmCreateByName criteria name [count]) -> item
(itmCreateRandom criteria levelDistribution) -> item
(itmEnumTypes criteria item-var exp)
(itmGetActualPrice item|type) -> actual price of a single item
(itmGetArmorInstalledLocation item) -> segment #
(itmGetArmorType item) -> type
(itmGetAverageAppearing item|type) -> average number that appear randomly
(itmGetCategory item|type) -> item category
(itmGetCount item)
(itmGetDamageType item|type) -> damage type
(itmGetData item attrib) -> data
(itmGetDefaultCurrency item|type) -> currency
(itmGetFrequency item|type [level]) -> frequency
(itmGetImageDesc item|type) -> imageDesc
(itmGetInstallCost item|type [currency]) -> cost
(itmGetInstallPos item) -> installPos
(itmGetLevel item|type) -> level
(itmGetMass item|type) -> mass of single item in Kg
(itmGetMaxAppearing item|type) -> max number that appear randomly
(itmGetName item|type flags)
(itmGetPrice item|type [currency]) -> price of a single item
(itmGetProperty item|type property) -> value

property

'blindingImmune
'canBeDisabled
'category
'charges
'damaged
'description
'deviceDamageImmune
'deviceDisruptImmune
'disintegrationImmune
'disrupted
'EMPImmune
'hp
'installed
'omnidirectional
'radiationImmune
'shatterImmune

(itmGetStaticData item attrib) -> data
(itmGetType item) -> itemUNID
(itmGetTypeData item|type attrib) -> data
(itmGetTypes criteria) -> list of itemUNIDs
(itmGetUseScreen item|type)
(itmHasAttribute item|type attrib) -> True/Nil
(itmHasReference item|type)
(itmIsEnhanced item) -> Nil or mods
(itmIsEqual item1 item2 [options]) -> True/Nil

options

'ignoreInstalled

(itmIsInstalled item)
(itmIsKnown item|type)
(itmMatches item|type criteria)
(itmSetCount item count) -> item
(itmSetData item attrib data [count]) -> item
(itmSetEnhanced item mods) -> item
(itmSetKnown type|item [True/Nil])
(itmSetProperty item property value) -> item

property

'charges charges
'damaged [True|Nil]
'disrupted [True|Nil|ticks]
'incCharges charges
'installed [True|Nil]

(itmSetReference item)
(itmSetTypeData item attrib data) -> True/Nil
(lambda ...)
(leq a b) -> True if a <= b
(link ...)
(list i1 i2 ... in) -> list
(lnkAppend list item) -> list
(lnkRemove list index) -> list
(lnkRemoveNil list) -> list
(lnkReplace list index item) -> list
(lookup source target ['ascending|'descending] [keyIndex]) -> found entry
(loop condition exp)
(ls a b) -> True if a < b
(map list ['excludeNil|'original|'reduceMax|'reduceMin] var exp) -> list
(match list var boolean-exp) -> first item that matches
(max x1 x2 ... xn) -> z
(min x1 x2 ... xn) -> z
(modulo ['degrees] x y) -> z
(msnAccept missionObj)
(msnAddRecurringTimerEvent missionObj interval event)

interval in ticks

(msnAddTimerEvent missionObj delay event)

delay in ticks

(msnCancelTimerEvent missionObj event) -> True/Nil
(msnCreate unid owner [data]) -> missionObj|Nil
(msnCreate unid-list owner [data]) -> missionObj|Nil

(msnDecline missionObj)
(msnDestroy missionObj) -> True/Nil
(msnFailure missionObj [data])
(msnFind [source] criteria) -> list of missionObjs

criteria

* Include all missions states
a Include active player missions
o Include open missions
r Include already debriefed (recorded) missions
u Include unavailable missions
S Only missions owned by source
+/-{attrib} Require/exclude missions with given attribute
+/-ownerID:{id} Require/exclude missions with given owner
+/-unid:{unid} Require/exclude missions of given unid

(msnFireEvent missionObj event [data]) -> result of event
(msnGetData missionObj attrib) -> data
(msnGetObjRefData missionObj attrib) -> obj
(msnGetProperty missionObj property) -> value

property

'acceptedOn Tick on which player accepted mission (or Nil)
'canBeDeleted Mission can be deleted by player
'debrieferID ID of the object that will debrief the player
'id Mission object ID
'isActive Is an active player mission
'isCompleted Is a completed mission (player or non-player)
'isDebriefed Player has been debriefed
'isDeclined Player has declined mission
'isFailure Mission has failed
'isIntroShown Player has been shown intro text
'isOpen Mission is available to player
'isSuccess Mission has succeeded
'isUnavailable Mission is unavailable to player
'name The name of the mission
'nodeID ID of the mission's owner system
'ownerID ID of the mission's owner object
'summary A summary description of the mission
'unid Mission type UNID

(msnGetStaticData missionObj attrib) -> data
(msnIncData missionObj attrib [increment]) -> new value
(msnRegisterForEvents missionObj obj)
(msnReward missionObj [data])
(msnSetData missionObj attrib data)
(msnSetObjRefData missionObj attrib obj)
(msnSetPlayerTarget missionObj)
(msnSetProperty obj property value) -> True/Nil

property

'debrieferID obj
'isDebriefed True|Nil
'isDeclined True|Nil
'isIntroShown True|Nil
'name newName
'summary newSummary

(msnSetUnavailable missionObj)
(msnSuccess missionObj [data])
(msnTranslate missionObj textID [data] [default]) -> text (or Nil)
(multiply x1 x2 ... xn) -> z
(neq ...)
(not exp) -> True/Nil
(objAccelerate obj angle thrust [ticks]) -> velVector
(objAddBuyOrder obj criteria priceAdj) -> True/Nil
(objAddItem obj item|type [count])
(objAddItemEnhancement obj item enhancementType [lifetime]) -> enhancementID
(objAddOverlay obj overlayType [lifetime]) -> overlayID
(objAddOverlay obj overlayType pos rotation [lifetime]) -> overlayID
(objAddRandomItems obj table count)
(objAddSellOrder obj criteria priceAdj) -> True/Nil
(objAddSubordinate obj subordinate) -> True/Nil
(objCanAttack obj) -> True/Nil
(objCanDetectTarget obj target) -> True/Nil
(objChangeEquipmentStatus obj equipment command [duration] [options]) -> True/Nil

equipment

'Autopilot
'GalacticMap
'LRS
'SRS
'SRSEnhancer
'SystemMap
'TargetingComputer

command

'damage
'install
'remove
'repair

duration is in ticks

options

'noMessage

(objCharge obj [currency] amount) -> remaining balance
(objClearIdentified obj)
(objClearShowAsDestination obj)
(objCommunicate obj senderObj msg [obj] [data]) -> result

msg

'AbortAttack
'AttackTarget
'FormUp
'QueryAttackStatus
'Wait
(objCredit obj [currency] amount) -> new balance
(objDamage obj weaponType objSource [pos])
(objDepleteShields obj)
(objDestroy obj [objSource]) -> True/Nil
(objEnumItems obj criteria itemVar exp)
(objFireEvent obj event [data]) -> result of event
(objFireItemEvent obj item event [data]) -> result of event
(objFireOverlayEvent obj overlayID event [data]) -> result of event
(objFixParalysis obj)
(objGateTo obj node entrypoint [effectID])
(objGetArmorCriticality obj item|armorSegment) -> criticalityType
(objGetArmorDamage obj item|armorSegment) -> damage to armor segment
(objGetArmorLevel obj item|armorSegment) -> 0-100
(objGetArmorName obj item|armorSegment) -> name of armor (e.g., 'forward', etc.)
(objGetArmorRepairPrice obj armorItem hpToRepair) -> price
(objGetArmorReplacePrice obj armorItem) -> price
(objGetArmorType obj item|armorSegment) -> type
(objGetBalance obj [currency]) -> balance
(objGetBuyPrice obj item [options]) -> price

options:

'noDonations

(objGetCargoSpaceLeft obj) -> space left in Kg
(objGetCombatPower obj) -> 0-100
(objGetDamageType obj) -> damage type
(objGetData obj attrib) -> data
(objGetDataField obj field) -> data
(objGetDefaultCurrency obj) -> currency
(objGetDestiny obj) -> 0-359
(objGetDisposition obj targetObj) -> disposition of obj towards targetObj
(objGetDistance obj destObj) -> distance in light-seconds
(objGetEquipmentStatus obj equipment) -> status

equipment

'Autopilot
'GalacticMap
'LRS
'SRS
'SRSEnhancer
'SystemMap
'TargetingComputer

status

'damaged
'notInstalled
'ready

(objGetEventHandler obj) -> unid or Nil
(objGetID obj) -> objID
(objGetImageDesc obj) -> imageDesc
(objGetInstalledItemDesc obj item) -> 'installed as forward armor'
(objGetItemProperty obj item property) -> value

property

'enabled
'fireArc
'installDevicePrice
'linkedFireOptions
'pos
'removeDevicePrice
'secondary

All properties for itmGetProperty are also valid.

(objGetItems obj criteria) -> list of items
(objGetLevel obj) -> level
(objGetMass obj) -> mass in tons
(objGetMaxPower obj) -> power (in 1/10 MWs)
(objGetName obj [flags]) -> Name of the object
(objGetNamedItems obj name) -> list of items
(objGetNearestStargate obj) -> obj
(objGetObjByID objID) -> obj
(objGetObjRefData obj attrib) -> obj
(objGetOpenDockingPortCount obj) -> count of open docking ports
(objGetOrderGiver obj [destroyReason]) -> obj
(objGetOverlayData obj overlayID attrib) -> data
(objGetOverlayPos obj overlayID) -> vector
(objSetOverlayProperty obj overlayID property) -> value

property

'counter
'counterLabel
'pos
'rotation
'type

(objGetOverlayRotation obj overlayID) -> rotation
(objGetOverlays obj) -> list of overlayIDs
(objGetOverlayType obj overlayID) -> type
(objGetPlayerPriceAdj obj [data]) -> priceAdj (or Nil if no adj)
(objGetPos obj) -> vector
(objGetProperty obj property) -> value

property (all)

'category
'cyberDefenseLevel
'hasDockingPorts
'id
'known
'playerMissionsGiven
'underAttack

property (ships)

'availableNonWeaponSlots
'availableWeaponSlots
'blindingImmune
'character
'characterClass
'commsKey
'deviceDamageImmune
'deviceDisruptImmune
'disintegrationImmune
'dockedAtID
'dockingEnabled
'EMPImmune
'interiorHP
'maxInteriorHP
'playerWingman
'radiationImmune
'rotation
'selectedLauncher
'selectedMissile
'selectedWeapon
'shatterImmune

property (stations)

'abandoned
'dockingPortCount
'hp
'ignoreFriendlyFire
'immutable
'installDeviceMaxLevel
'maxHP
'maxStructuralHP
'openDockingPortCount
'orbit
'parallax
'playerBlacklisted
'repairArmorMaxLevel
'shipConstructionEnabled
'shipReinforcementEnabled
'structuralHP

NOTE: All data fields (accessed via objGetDataField) are also valid properties.

(objGetRefuelItemAndPrice obj objToRefuel) -> (item price)
(objGetSellPrice obj item ['noInventoryCheck]) -> price
(objGetShieldLevel obj) -> 0-100 (or -1 for no shields)
(objGetShipwreckType obj) -> unid
(objGetSovereign obj) -> sovereignID
(objGetStargateID obj) -> gateID
(objGetStaticData obj attrib) -> data
(objGetTarget obj) -> obj
(objGetType obj) -> unid
(objGetTypeData obj attrib) -> data
(objGetVel obj) -> velVector
(objGetVisibleDamage obj) -> damage
(objHasAttribute obj attrib) -> True/Nil
(objHasItem obj item [count]) -> number of items (or Nil)
(objIncData obj attrib [increment]) -> new value
(objIncOverlayData obj overlayID attrib [increment]) -> new value
(objIncVel obj velVector) -> velVector
(objIsAngryAt obj targetObj) -> True/Nil
(objIsDeviceSlotAvailable ship) -> True/Nil
(objIsDockedAt obj stationObj) -> True/Nil
(objIsEnemy obj target) -> True/Nil
(objIsIdentified obj) -> True/Nil
(objIsKnown obj)
(objIsParalyzed obj)
(objIsRadioactive obj)
(objIsShip obj) -> True/Nil
(objJumpTo obj pos)
(objLowerShields obj)
(objMakeParalyzed obj ticks)
(objMatches obj source filter) -> True/Nil
(objProgramDamage obj hacker progName aiLevel code)
(objRegisterForEvents target obj)
(objRegisterForSystemEvents target range)
(objRemoveItem obj item [count])
(objRemoveItemEnhancement obj item enhancementID)
(objRemoveOverlay obj overlayID)
(objRepairArmor ship item|armorSegment [hpToRepair]) -> hp repaired
(objResume obj [gateObj])
(objSendMessage obj sender msg)
(objSetData obj attrib data)
(objSetDeviceActivationDelay obj deviceItem [delay]) -> True/Nil
(objSetEventHandler obj unid) -> True/Nil
(objSetIdentified obj)
(objSetItemData obj item attrib data [count]) -> item
(objSetItemProperty obj item property value [count]) -> item

property

'charges charges
'damaged [True|Nil]
'disrupted [True|Nil|ticks]
'enabled [True|Nil|'silentDisabled|'silentEnabled]
'fireArc Nil|(min max)|'omnidirectional
'hp hitPoints
'incCharges charges
'linkedFireOptions list-of-options
'pos (angle radius [z])
'secondary [True|Nil]

(objSetKnown obj)
(objSetName obj name [flags])

flags

0x0001 Definite article
0x0002 Pluralize first word
0x0004 Add 'es' to pluralize
0x0008 Custom plural after semicolon
0x0010 Pluralize second word
0x0020 Reverse 'a' vs 'an'
0x0040 No article
0x0080 Personal name

(objSetObjRefData obj attrib obj)
(objSetOverlayData obj overlayID attrib data)
(objSetOverlayEffectProperty obj overlayID property value)
(objSetOverlayPos obj overlayID pos)
(objSetOverlayPos obj overlayID property value)

property:

'counter
'counterLabel
'pos position
'rotation angle

(objSetOverlayRotation obj overlayID rotation)
(objSetPos obj vector [rotation])
(objSetProperty obj property value) -> True/Nil

property (ships)

'dockingEnabled True|Nil
'commsKey key
'known True|Nil
'playerWingman True|Nil
'rotation angle
'selectedMissile type|item
'selectedWeapon type|item

property (stations)

'ignoreFriendlyFire True|Nil
'hp hitPoints
'immutable True|Nil
'known True|Nil
'maxHP hitPoints
'maxStructuralHP hitPoints
'orbit orbit|Nil
'parallax factor
'playerBlacklisted True|Nil
'shipConstructionEnabled True|Nil
'shipReinforcementEnabled True|Nil
'structuralHP hitPoints

(objSetShowAsDestination obj [options]) -> True/Nil

options:

'autoClear Clear when in SRS range
'autoClearOnDestroy Clear when destroyed
'autoClearOnDock Clear when player docks
'showDistance Show distance
'showHighlight Show target highlight

(objSetSovereign obj sovereignID) -> True/Nil
(objSetTradeDesc obj currency [maxCurrency replenishCurrency]) -> True/Nil
(objSetTypeData obj attrib data)
(objSetVel obj velVector)
(objSuspend obj)
(objTranslate obj textID [data] [default]) -> text (or Nil)
(objUnregisterForEvents target obj)
(objUnregisterForSystemEvents target)
(or exp1 exp2 ... expn) -> True/Nil
(plyChangeShip player newShip) -> True/Nil
(plyCharge player [currency] charge) -> credits left
(plyComposeString player string [arg1 arg2 ... argn]) -> string
(plyCredit player [currency] credit) -> credits left
(plyDestroyed ...)
(plyEnableMessage player messageID True/Nil) -> True/Nil

messageID:

'allHints
'allMessages
'enabledHints
(plus all messageIDs for plyIsMessageEnabled)

(plyGetCredits player [currency]) -> credits left
(plyGetGenome player) -> 'humanMale | 'humanFemale
(plyGetItemStat player stat criteria|type) -> value

stat:

'itemsBoughtCount
'itemsBoughtValue
'itemsDamagedHP
'itemsFiredCount
'itemsSoldCount
'itemsSoldValue

(plyGetKeyEventStat player stat nodeID typeCriteria) -> value

stat:

'enemyObjsDestroyed
'friendlyObjsDestroyed
'missionCompleted
'missionFailure
'missionSuccess
'objsDestroyed

(plyGetRedirectMessage ...)
(plyGetStat player stat) -> value

stat:

'bestEnemyShipDestroyed
'enemyShipsDestroyed
'enemyStationsDestroyed
'friendlyShipsDestroyed
'friendlyStationsDestroyed
'resurrectCount
'score
'systemData
'systemsVisited

(plyIsMessageEnabled player messageID) -> True/Nil

messageID:

'autopilotHint
'commsHint
'dockHint
'enableDeviceHint
'fireMissileHint
'galacticMapHint
'gateHint
'mapHint
'refuelHint
'switchMissileHint
'useItemHint

(plyMessage ...)
(plyRecordBuyItem player item [currency] totalPrice)
(plyRecordSellItem player item [currency] totalPrice)
(plyRedirectMessage ...)
(plyUseItem player item)
(power x y) -> z
(print [string]*)
(printTo output [string]*)

output is one or more of:

'console
'log

(quote exp) -> unevaluated exp
(random from to)
(random list)
(randomGaussian low mid high) -> random number between low and high
(randomTable chance1 exp1 chance2 exp2 ... chancen expn) -> exp
(regex source pattern ['offset|'subex]) -> result
(resCreateImageDesc imageUNID x y width height) -> imageDesc
(rollDice count sides bonus)
(scrAddAction screen actionID pos label [key] [special] code)
(scrEnableAction screen actionID enabled)
(scrExitScreen screen ['forceUndock])
(scrGetCounter ...)
(scrGetData screen attrib) -> data
(scrGetDesc screen)
(scrGetInputText ...)
(scrGetItem ...)
(scrGetListCursor screen) -> cursor
(scrGetListEntry ...)
(scrIsFirstOnInit ...)
(scrRefreshScreen screen)
(scrRemoveAction screen actionID)
(scrRemoveItem ...)
(scrSetActionLabel screen actionID label [key] [special])
(scrSetControlValue screen controlID value) -> True/Nil
(scrSetCounter ...)
(scrSetData screen attrib data)
(scrSetDesc screen text [text...])
(scrSetDescTranslate screen textID [data]) -> True/Nil
(scrSetDisplayText screen ID text [text...])
(scrSetInputText ...)
(scrSetListCursor screen cursor)
(scrSetListFilter ...)
(scrShowAction screen actionID shown)
(scrShowPane ...)
(scrShowScreen screenGlobal screen [pane] [data])
(scrTranslate screen textID [data]) -> text or Nil
(seededRandom seed from to)
(seededRandom seed list)
(set ...)
([email protected] list-var index value) -> list
([email protected] struct-var key value) -> struct
([email protected] struct-var struct) -> merged structs
(setq ...)
(shpCancelOrders ship)
(shpCanRemoveDevice ship item) -> result
(shpConsumeFuel ship fuel)
(shpDamageArmor ship armorSegment damageType damage ['noSRSFlash]) -> damage done
(shpDecontaminate ship)
(shpEnhanceItem ship item [mods]) -> True/Nil
(shpGetAISetting ship setting)
(shpGetArmor ship armorSegment) -> item struct
(shpGetArmorCount ship) -> number of armor segments
(shpGetArmorMaxHitPoints obj item|armorSegment) -> damage to armor segment
(shpGetClassName class flags) -> class name
(shpGetDirection ship) -> angle
(shpGetDockObj ship) -> dockObj
(shpGetFuelLeft ship) -> fuel left
(shpGetFuelNeeded ship item) -> items needed
(shpGetImageDesc class [rotationAngle]) -> imageDesc
(shpGetItemDeviceName ship item) -> device name of item (or -1)
(shpGetMaxSpeed ship) -> max speed in of lightspeed
(shpGetOrder obj) -> order
(shpGetOrderDesc obj) -> orderDesc
(shpGetOrderTarget obj) -> obj
(shpGetShieldDamage ship) -> damage to shields
(shpGetShieldItemUNID ship) -> UNID (or Nil)
(shpGetShieldMaxHitPoints ship) -> max hp of shields
(shpInstallArmor ship item armorSegment)
(shpInstallDevice ship item)
(shpIsBlind ship)
(shpIsFuelCompatible ship item) -> True/Nil
(shpIsRadiationImmune ship [item])
(shpMakeRadioactive ship)
(shpOrder ship order [target] [count]) -> True/Nil
(shpOrderImmediate ship order [target] [count]) -> True/Nil
(shpRechargeShield ship hpToRecharge)
(shpRefuelFromItem ship item) -> True/Nil
(shpRemoveDevice ship item) -> item
(shpRepairItem ship item)
(shpSetAISetting ship setting value)

setting:

'combatStyle
= 'advanced
= 'chase
= 'flyby
= 'noRetreat
= 'standard
= 'standOff

'aggressor (True/Nil)
'ascendOnGate (True/Nil)
'flockFormation (True/Nil)
'ignoreShieldsDown (True/Nil)
'noAttackOnThreat (True/Nil)
'noDogfights (True/Nil)
'noFriendlyFire (True/Nil)
'noFriendlyFireCheck (True/Nil)
'noNavPaths (True/Nil)
'noOrderGiver (True/Nil)
'noTargetsOfOpportunity (True/Nil)

'combatSeparation {pixels}
'fireAccuracy {percent}
'fireRangeAdj {percent}
'fireRateAdj {value; 10 = normal; 20 = twice as slow}
'perception {value}

(shpSetCommandCode ship code) -> True/Nil
(shpSetController ship controller) -> True/Nil
(shuffle list) -> shuffled list
(sort list ['ascending|'descending] [keyIndex]) -> sorted list
(sovGetDisposition sovereignID targetSovereignID) -> disposition of sovereign to target
(sovSetDisposition sovereignID targetSovereignID disposition)
(split string [characters]) -> list
(sqrt x) -> z
(staClearFireReconEvent station)
(staClearReconned station)
(staGetDockedShips station) -> list of docked ships
(staGetImageVariant station) -> variant
(staGetSubordinates station) -> list of subordinates (e.g., guardians)
(staIsEncountered type) -> True/Nil
(staIsReconned station) -> True/Nil
(staSetActive station [True/Nil])
(staSetFireReconEvent station)
(staSetImageVariant station variant)
(staSetShowMapLabel station True/Nil)
(strCapitalize string) -> string
(strFind string target) -> pos of target in string (0-based)
(subset list pos [count]) -> list
(subst string arg1 arg2 ... argn) -> string
(subtract x y) -> z
(switch ...)
(sysAddEncounterEvent delay target encounterID gate)
(sysAddEncounterEventAtDist delay target encounterID distance)
(sysAddObjRecurringTimerEvent interval obj event)
(sysAddObjTimerEvent delay obj event)
(sysAddStargateTopology [nodeID] gateID destNodeID destGateID) -> True/Nil
(sysAddTypeRecurringTimerEvent interval type event)
(sysAddTypeTimerEvent delay type event)
(sysAscendObject obj) -> True/Nil
(sysCalcFireSolution targetPos targetVel speed) -> angle to shoot (Nil, if no solution)
(sysCalcTravelDistance speed time) -> distance in light-seconds
(sysCalcTravelTime distance speed) -> time in ticks
(sysCancelTimerEvent obj event) -> True/Nil
(sysCancelTypeTimerEvent type event) -> True/Nil
(sysCreateEffect effectID anchorObj pos [rotation]) -> True/Nil
(sysCreateEncounter unid) -> True/Nil
(sysCreateFlotsam item|unid pos sovereignID) -> obj
(sysCreateLookup tableName orbit) -> True/Nil
(sysCreateMarker name pos sovereignID) -> marker
(sysCreateShip unid pos sovereignID [eventHandler]) -> ship
(sysCreateShipwreck unid pos sovereignID) -> shipwreck
(sysCreateStargate unid pos gateID [destNodeID destGateID]) -> obj
(sysCreateStation unid pos [eventHandler]) -> obj
(sysCreateTerritory orbit minRadius maxRadius attributes [criteria]) -> True/Nil
(sysCreateWeaponFire weaponID objSource pos dir speed objTarget [detonateNow] [bonus]) -> obj
(sysDescendObject objID pos) -> obj
(sysFindObject source filter) -> list of objects

filter

b Include beams
m Include missiles
s Include ships
t Include stations (including planets)
z Include the player

A Active objects only (i.e., objects that can attack)
D:xyz; Only objects with data 'xyz'
E Enemy objects only
F Friendly objects only
G Stargates only
G:xyz; Stargate with ID 'xyz'
H Only objects whose base = source
I:angle Only objects that intersect line from source
J Same sovereign as source
J:unid; Sovereign unid = unid
K Killed objects only (i.e., objects that cannot attack)
L:x-y; Objects of level x to y.
M Manufactured objects only (i.e., no planets or asteroids)
N Return only the nearest object to the source
N:nn; Return only objects within nn light-seconds
O:docked; Ships that are currently docked at source
O:escort; Ships ordered to escort source
O:guard; Ships ordered to guard source
P Only objects that can be detected (perceived) by source
R Return only the farthest object to the source
R:nn; Return only objects greater than nn light-seconds away
S:sort Sort order ('d' = distance ascending; 'D' = distance descending
T Include structure-scale stations
T:xyz; Include stations with attribute 'xyz'
V Include virtual objects
X Only objects whose target is the source
Y Only objects angry at the player (or enemies)
Z Exclude the player

+xyz; Exclude objects without the given attribute
-xyz; Exclude objects with the given attribute

=n Level comparisons

(sysGetData [nodeID] attrib) -> data
(sysGetEnvironment vector) -> environmentUNID
(sysGetLevel [nodeID]) -> level
(sysGetName [nodeID]) -> name
(sysGetNavPathPoint sovereignID objFrom objTo ath) -> vector
(sysGetNode) -> nodeID
(sysGetNodes) -> list of nodeIDs
(sysGetObjectByName [source] name) -> obj
(sysGetProperty [nodeID] property) -> value

property:

'level The level of the system
'name The name of the system
'pos Node position on map (x y)

(sysGetStargateDestination [nodeID] gateID) -> (nodeID gateID)
(sysGetStargateDestinationNode [nodeID] gateID) -> nodeID
(sysGetStargates [nodeID]) -> list of gateIDs
(sysGetSystemType [nodeID]) -> systemUNID
(sysGetTopologyDistance fromID toID) -> distance (or Nil)
(sysGlobals ...)
(sysHasAttribute [nodeID] attrib) -> True/Nil
(sysIsKnown [nodeID]) -> True/Nil
(sysMatches [nodeID] criteria) -> True/Nil
(sysOrbitPos orbit [options]) -> vector

Options parameter is a struct with the following fields:

'angleOffset:n +/- n degrees along orbit arc
'arcOffset:n +/- n light-seconds along orbit arc
'radiusOffset:n +/- n light-seconds radius

For arcOffset and radiusOffset, n may also be a list with the followingformats:

(list 'gaussian min max)

(sysPlaySound unid [sourceObj]) -> True/Nil
(sysPoolUsage ...)
(sysSetData [nodeID] attrib data) -> data
(sysSetEnvironment unid shape options) -> True/Nil

shape

'arc
Creates an arc along an orbit. Options must include the
following fields:

'orbit: This is the orbit to use. The arc will be
centered on the current orbit position (e.g., the
planet location).
'length: The length of the arc (in degrees).
'width: The width at the center of the arc (in light-
seconds).

'orbital
Creates a random environment along the orbit. Options
must include the following fields:

'orbit: This is the orbit to use.
'width: The average width of the ring, in light-
seconds.

'square
Creates a square patch. Options must include the
following fields:

'center: The center position of the patch.
'height: The height of the patch (in light-seconds).
'width: The width of the patch (in light-seconds).

(sysSetKNown [nodeID] [True/Nil]) -> True/Nil
(sysSetProperty [nodeID] property value) -> True/Nil

property:

'pos Node position on map (x y)

(sysStartTime) -> True/Nil
(sysStopTime duration except) -> True/Nil
(sysStopTime targetList duration) -> True/Nil
(sysTicks ...)
(sysVectorAdd vector vector) -> vector
(sysVectorAngle vector) -> angle of vector
(sysVectorAngle pos1 pos2) -> angle of pos1 relative to pos2
(sysVectorDistance vector [vector]) -> distance in light-seconds
(sysVectorDivide vector scalar) -> vector
(sysVectorMultiply vector scalar) -> vector
(sysVectorPixelOffset center x y) -> vector
(sysVectorPolarOffset center angle radius) -> vector
(sysVectorPolarVelocity angle speed) -> velVector
(sysVectorRandom center radius minSeparation [filter]) -> vector
(sysVectorSpeed velVector) -> of light speed
(sysVectorSubtract vector vector) -> vector
(typCreate unid XML) -> True/Nil
(typDynamicUNID uniqueName) -> UNID
(typeof item) -> type

type

error
function
int32
list
primitive
string
struct

(typFind criteria) -> list of UNIDs

criteria

a AdventureDesc
b ItemTable
c EffectType
d DockScreen
e SpaceEnvironmenType
f OverlayType
h ShipTable
i ItemType
m Image
n MissionType
p Power
q SystemTable
s ShipClass
t StationType
u Sound
v Sovereign
y SystemType
z SystemMap
$ EconomyType
+/-{attrib} Require/exclude types with given attribute

(typFireEvent unid event [data]) -> result of event
(typFireObjEvent unid obj event) -> result of event
(typGetData unid attrib) -> data
(typGetDataField unid field) -> data
(typGetProperty unid property) -> value

property:

'apiVersion
'class
'extension

(typGetStaticData unid attrib) -> data
(typGetXML unid) -> xmlElement
(typHasAttribute unid attrib) -> True/Nil
(typHasEvent unid event) -> True/Nil
(typIncData unid attrib [increment]) -> new value
(typMarkImages unid) -> True/Nil
(typMatches unid criteria) -> True/Nil
(typSetData unid attrib data) -> True/Nil
(typTranslate unid textID [data] [default]) -> text (or Nil)
(uiCanPlayMusic filename) -> True/Nil
(uiGetMusicCatalog) -> list of files
(uiGetMusicState) -> ('playing filename position length)
(uiPlayMusic filename [pos]) -> True/Nil
(uiStopMusic)
(unvFindObj [nodeID] criteria) -> list of entries

criteria

s ShipClass
t StationType
+/-{attrib} Require/exclude types with given attribute

entry

({objID} {type} {nodeID} {objName} {objNameFlags})

(unvGetCurrentExtensionUNID) -> UNID
(unvGetElapsedGameTime [startTick] endTick format) -> result

format

display: Elapsed time in display format.
seconds: Elapsed time in game seconds.

(unvGetExtensionData scope attrib) -> data
(unvGetRealDate) -> (year month day) GMT
(unvGetTick) -> time
(unvSetExtensionData scope attrib data) -> True/Nil

scope

'local
'serviceExtension
'serviceUser

(unvUNID string) -> (unid 'itemtype name) or (unid 'shipclass name)
(vecSetElement ...)
(vecVector ...)
(xmlAppendSubElement xml xmlToAdd [index]) -> True/Nil
(xmlAppendText xml text [index]) -> True/Nil
(xmlCreate xml) -> xml
(xmlDeleteSubElement xml index) -> True/Nil
(xmlGetAttrib xml attrib) -> value
(xmlGetAttribList xml) -> list of attribs
(xmlGetSubElement xml tag|index) -> xml
(xmlGetSubElementCount xml) -> number of sub-elements
(xmlGetSubElementList xml [tag]) -> list of xml
(xmlGetTag xml) -> tag
(xmlGetText xml [index]) -> text
(xmlSetAttrib xml attrib value) -> value
(xmlSetText xml text [index]) -> True/Nil

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

DEPRECATED FUNCTIONS

armGetHitPoints: DEPRECATED: Use (itmGetProperty item 'hp) instead.
armGetName: DEPRECATED: Use itmGetName instead.
armIsRadiationImmune: DEPRECATED: Use itmGetProperty instead.
CshpCanInstallArmor: DEPRECATED: Use objCanInstallItem instead.
envHasAttribute: DEPRECATED: Use typHasAttribute instead
item: DEPRECATED: Alias of @
itmAtCursor: DEPRECATED
itmGetCharges: DEPRECATED: Use (itmGetProperty item 'charges) instead.
itmGetGlobalData: DEPRECATED: Use itemGetTypeData instead.
itmGetUNID: DEPRECATED: Use itemGetType instead
itmHasModifier: DEPRECATED: Use itmHasAttribute instead.
itmIsDamaged: DEPRECATED: Use (itmGetProperty item 'damaged) instead
itmSetCharges: DEPRECATED: Use (itmSetProperty item 'charges ...) instead
itmSetDamaged: DEPRECATED: Use (itmSetProperty item 'damaged ...) instead
itmSetGlobalData: DEPRECATED: Use itmSetTypeData instead.
objGetDeviceFireArc: DEPRECATED: Use objGetItemProperty instead.
objGetDeviceLinkedFireOptions: DEPRECATED: Use objGetItemProperty instead.
objGetDevicePos: DEPRECATED: Use objGetItemProperty instead.
objGetGlobalData: DEPRECATED: Use objGetTypeData instead.
objGetStaticDataForStationType: DEPRECATED: Use typGetStaticData instead.
objIncItemCharges: DEPRECATED: Use (objSetItemProperty obj item 'incCharges ...) instead
objIsAbandoned: DEPRECATED: Use objGetProperty instead.
objIsDeviceEnabled: DEPRECATED: Use objGetItemProperty instead.
objIsUnderAttack: DEPRECATED: Use objGetProperty instead.
objMoveTo: DEPRECATED: Use objSetPos instead
objSetDeviceFireArc: DEPRECATED: Use objSetItemProperty instead.
objSetDeviceLinkedFireOptions: DEPRECATED: Use objSetItemProperty instead.
objSetDevicePos: DEPRECATED: Use objSetItemProperty instead.
objSetGlobalData: DEPRECATED: Use objSetTypeData instead.
objSetItemCharges: DEPRECATED: Use (objSetItemProperty obj item 'charges ...) instead
plyClearShowHelpRefuel: DEPRECATED: Use (plyEnableMessage player 'refuelHint Nil) instead
plyGetInsuranceClaims: DEPRECATED: Use resurrection infrastructure instead.
plyInsure: DEPRECATED: Use resurrection infrastructure instead.
plyIsInsured: DEPRECATED: Use resurrection infrastructure instead.
scrExitDock: DEPRECATED: Use scrExitScreen instead.
scrGetItemListCursor: DEPRECATED: Use scrGetItem instead
scrRefreshItemListCursor: DEPRECATED
setItem: DEPRECATED: Alias of [email protected]
shpAddEnergyField: DEPRECATED: Use objAddOverlay instead
shpCanInstallDevice: DEPRECATED: Use objCanInstallItem instead.
shpDamageItem: DEPRECATED: Use (objSetItemProperty obj item 'damaged ...) instead
shpEnhanceSRS: DEPRECATED: Use objChangeEquipmentStatus instead
shpFixBlindness: DEPRECATED: Use objChangeEquipmentStatus instead
shpGetClass: DEPRECATED: Use objGetType instead
shpGetDataField: DEPRECATED: Use typGetDataField instead
shpGetGlobalData: DEPRECATED: Use typGetGlobalData instead
shpGetItemCharges: DEPRECATED: Use itmGetCharges instead
shpInstallAutopilot: DEPRECATED: Use objChangeEquipmentStatus instead
shpInstallTargetingComputer: DEPRECATED: Use objChangeEquipmentStatus instead
shpIsAutopilotInstalled: DEPRECATED: Use objGetEquipmentStatus instead
shpIsRadioactive: DEPRECATED: Use objIsRadioactive instead
shpIsSRSEnhanced: DEPRECATED: Use objGetEquipmentStatus instead
shpIsTargetingComputerInstalled: DEPRECATED: Use objGetEquipmentStatus instead
shpMakeBlind: DEPRECATED: Use objChangeEquipmentStatus instead
shpOrderAttack: DEPRECATED: Use (shpOrder ship 'attack target) instead
shpOrderDock: DEPRECATED: Use (shpOrder ship 'dock target) instead
shpOrderEscort: DEPRECATED: Use (shpOrder ship 'escort obj [formation]) instead
shpOrderFollow: DEPRECATED: Use (shpOrder ship 'follow target) instead
shpOrderGate: DEPRECATED: Use (shpOrder ship 'gate [gate]) instead
shpOrderGoto: DEPRECATED: Use (shpOrder ship 'goto obj) instead
shpOrderGuard: DEPRECATED: Use (shpOrder ship 'guard target) instead
shpOrderHold: DEPRECATED: Use (shpOrder ship 'hold [time]) instead
shpOrderLoot: DEPRECATED: Use (shpOrder ship 'loot obj) instead
shpOrderMine: DEPRECATED: Use (shpOrder ship 'mine baseObj) instead
shpOrderPatrol: DEPRECATED: Use (shpOrder ship 'patrol baseObj dist) instead
shpOrderWait: DEPRECATED: Use (shpOrder ship 'wait [time]) instead
shpRechargeItem: DEPRECATED: Use (objSetItemProperty obj item 'incCharges ...) instead
shpSetGlobalData: DEPRECATED: Use typSetGlobalData instead
shpSetPlayerWingman: DEPRECATED: Use (objSetProperty ship 'playerWingman ...) instead.
staGetGlobalData: DEPRECATED: Use typGetGlobalData instead
staGetMaxStructuralHP: DEPRECATED: Use objGetProperty instead.
staGetStructuralHP: DEPRECATED: Use objGetProperty instead.
staGetType: DEPRECATED: Use objGetType instead
staSetGlobalData: DEPRECATED: Use typSetGlobalData instead
staSetInactive: DEPRECATED: Use staSetActive instead
staSetStructuralHP: DEPRECATED: Use objSetProperty instead.
typGetGlobalData: DEPRECATED: Use typGetData instead.
typIncGlobalData: DEPRECATED: Use typIncData instead.
typSetGlobalData: DEPRECATED: Use typSetData instead.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Image

My mods on Xelerus: Click here!

Of all the things I’ve lost in life, I miss my mind the least. (I’m having a lot more fun without it!)

User avatar
digdug
Fleet Admiral
Fleet Admiral
Posts: 2601
Joined: Mon Oct 29, 2007 9:23 pm
Location: Decoding hieroglyphics on Tan-Ru-Dorem

Tue Dec 09, 2014 3:07 pm

Awesome job AssumedPseudonym !
We really needed a better way to extract a clean and reliable function list ! :)

I'll just paste here the usual informations that I manually parse and might be useful for modders that just want to check the new things/changed things:

RECENTLY ADDED FUNCTIONS 1.3b1 to 1.5

(gamSave [options]) -> True/Nil

options:

'checkpoint (or Nil)
'missionCheckpoint

(objSetOverlayProperty obj overlayID property) -> value

property

'counter
'counterLabel
'pos
'rotation
'type

(plyIsMessageEnabled player messageID) -> True/Nil

messageID:

'autopilotHint
'commsHint
'dockHint
'enableDeviceHint
'fireMissileHint
'galacticMapHint
'gateHint
'mapHint
'refuelHint
'switchMissileHint
'useItemHint

(scrRemoveAction screen actionID)
(scrSetControlValue screen controlID value) -> True/Nil
(scrSetDescTranslate screen textID [data]) -> True/Nil
(scrTranslate screen textID [data]) -> text or Nil
(split string [characters]) -> list
(sysCreateLookup tableName orbit) -> True/Nil
(sysCreateTerritory orbit minRadius maxRadius attributes [criteria]) -> True/Nil
(typGetProperty unid property) -> value

property:

'apiVersion
'class
'extension


(typGetXML unid) -> xmlElement
(typHasEvent unid event) -> True/Nil
(unvGetElapsedGameTime [startTick] endTick format) -> result

format

display: Elapsed time in display format.
seconds: Elapsed time in game seconds.

(xmlAppendSubElement xml xmlToAdd [index]) -> True/Nil
(xmlAppendText xml text [index]) -> True/Nil
(xmlCreate xml) -> xml
(xmlDeleteSubElement xml index) -> True/Nil
(xmlGetAttrib xml attrib) -> value
(xmlGetAttribList xml) -> list of attribs
(xmlGetSubElement xml tag|index) -> xml
(xmlGetSubElementCount xml) -> number of sub-elements
(xmlGetSubElementList xml [tag]) -> list of xml
(xmlGetTag xml) -> tag
(xmlGetText xml [index]) -> text
(xmlSetAttrib xml attrib value) -> value
(xmlSetText xml text [index]) -> True/Nil

---------------------------------------------
RECENTLY DEPRECATED FUNCTIONS

shpCanInstallArmor DEPRECATED: Use objCanInstallItem instead.
shpCanInstallDevice DEPRECATED: Use objCanInstallItem instead.

---------------------------------------------
RECENTLY CHANGED FUNCTIONS

(objTranslate obj textID [data] [default]) -> text (or Nil)

(itmGetProperty item|type property) -> value

property

'blindingImmune
'canBeDisabled
'category
'charges
'damaged
'description
'deviceDamageImmune
'deviceDisruptImmune
'disintegrationImmune
'disrupted
'EMPImmune
'hp
'installed
'omnidirectional
'radiationImmune
'shatterImmune


(itmIsEqual item1 item2 [options]) -> True/Nil

options

'ignoreInstalled



(msnAddRecurringTimerEvent missionObj interval event)

interval in ticks


(msnAddTimerEvent missionObj delay event)

delay in ticks


(msnFind [source] criteria) -> list of missionObjs

criteria

* Include all missions states
a Include active player missions
o Include open missions
r Include already debriefed (recorded) missions
u Include unavailable missions
S Only missions owned by source
+/-{attrib} Require/exclude missions with given attribute
+/-ownerID:{id} Require/exclude missions with given owner
+/-unid:{unid} Require/exclude missions of given unid

(msnFireEvent missionObj event [data]) -> result of event

(msnGetProperty missionObj property) -> value

property

'acceptedOn Tick on which player accepted mission (or Nil)
'canBeDeleted Mission can be deleted by player
'debrieferID ID of the object that will debrief the player
'id Mission object ID
'isActive Is an active player mission
'isCompleted Is a completed mission (player or non-player)
'isDebriefed Player has been debriefed
'isDeclined Player has declined mission
'isFailure Mission has failed
'isIntroShown Player has been shown intro text
'isOpen Mission is available to player
'isSuccess Mission has succeeded
'isUnavailable Mission is unavailable to player
'name The name of the mission
'nodeID ID of the mission's owner system
'ownerID ID of the mission's owner object
'summary A summary description of the mission
'unid Mission type UNID


(msnTranslate missionObj textID [data] [default]) -> text (or Nil)

(objAddItem obj item|type [count])

(objCommunicate obj senderObj msg [obj] [data]) -> result

msg

'AbortAttack
'AttackTarget
'FormUp
'QueryAttackStatus
'Wait

(objFireEvent obj event [data]) -> result of event

(objFireOverlayEvent obj overlayID event [data]) -> result of event

(objGetBuyPrice obj item [options]) -> price

options:

'noDonations


(objGetItemProperty obj item property) -> value

property

'enabled
'fireArc
'installDevicePrice
'linkedFireOptions
'pos
'removeDevicePrice
'secondary

All properties for itmGetProperty are also valid.


(objGetProperty obj property) -> value

property (all)

'category
'cyberDefenseLevel
'hasDockingPorts
'id

'known
'playerMissionsGiven
'underAttack

property (ships)

'availableNonWeaponSlots
'availableWeaponSlots

'blindingImmune
'character
'characterClass
'commsKey
'deviceDamageImmune
'deviceDisruptImmune
'disintegrationImmune
'dockedAtID
'dockingEnabled
'EMPImmune
'interiorHP
'maxInteriorHP

'playerWingman
'radiationImmune
'rotation
'selectedLauncher
'selectedMissile
'selectedWeapon
'shatterImmune

property (stations)

'abandoned
'dockingPortCount
'hp
'ignoreFriendlyFire
'immutable
'installDeviceMaxLevel
'maxHP
'maxStructuralHP
'openDockingPortCount
'orbit
'parallax
'playerBlacklisted
'repairArmorMaxLevel
'shipConstructionEnabled
'shipReinforcementEnabled

'structuralHP

NOTE: All data fields (accessed via objGetDataField) are also valid properties.


(objSetItemProperty obj item property value [count]) -> item

property

'charges charges
'damaged [True|Nil]
'disrupted [True|Nil|ticks]
'enabled [True|Nil|'silentDisabled|'silentEnabled]
'fireArc Nil|(min max)|'omnidirectional
'hp hitPoints
'incCharges charges
'linkedFireOptions list-of-options
'pos (angle radius [z])
'secondary [True|Nil]

(objSetName obj name [flags])

flags

0x0001 Definite article
0x0002 Pluralize first word
0x0004 Add 'es' to pluralize
0x0008 Custom plural after semicolon
0x0010 Pluralize second word
0x0020 Reverse 'a' vs 'an'
0x0040 No article
0x0080 Personal name



(objSetOverlayPos obj overlayID property value)

property:

'counter
'counterLabel
'pos position
'rotation angle


(objSetProperty obj property value) -> True/Nil

property (ships)

'dockingEnabled True|Nil
'commsKey key
'known True|Nil
'playerWingman True|Nil
'rotation angle
'selectedMissile type|item
'selectedWeapon type|item

property (stations)

'ignoreFriendlyFire True|Nil
'hp hitPoints
'immutable True|Nil
'known True|Nil
'maxHP hitPoints
'maxStructuralHP hitPoints
'orbit orbit|Nil
'parallax factor
'playerBlacklisted True|Nil
'shipConstructionEnabled True|Nil
'shipReinforcementEnabled True|Nil

'structuralHP hitPoints

(objSetShowAsDestination obj [options]) -> True/Nil

options:

'autoClear Clear when in SRS range
'autoClearOnDestroy Clear when destroyed
'autoClearOnDock Clear when player docks
'showDistance Show distance
'showHighlight Show target highlight



(objTranslate obj textID [data] [default]) -> text (or Nil)

(plyEnableMessage player messageID True/Nil) -> True/Nil

messageID:

'allHints
'allMessages
'enabledHints
(plus all messageIDs for plyIsMessageEnabled)


(plyGetItemStat player stat criteria|type) -> value

stat:

'itemsBoughtCount
'itemsBoughtValue
'itemsDamagedHP
'itemsFiredCount
'itemsSoldCount
'itemsSoldValue


(plyGetStat player stat) -> value

stat:

'bestEnemyShipDestroyed
'enemyShipsDestroyed
'enemyStationsDestroyed
'friendlyShipsDestroyed
'friendlyStationsDestroyed
'resurrectCount
'score
'systemData
'systemsVisited


(shpSetAISetting ship setting value)

setting:

'combatStyle
= 'advanced
= 'chase
= 'flyby
= 'noRetreat
= 'standard
= 'standOff

'aggressor (True/Nil)
'ascendOnGate (True/Nil)
'flockFormation (True/Nil)
'ignoreShieldsDown (True/Nil)
'noAttackOnThreat (True/Nil)
'noDogfights (True/Nil)
'noFriendlyFire (True/Nil)
'noFriendlyFireCheck (True/Nil)
'noNavPaths (True/Nil)
'noOrderGiver (True/Nil)
'noTargetsOfOpportunity (True/Nil)

'combatSeparation {pixels}
'fireAccuracy {percent}
'fireRangeAdj {percent}
'fireRateAdj {value; 10 = normal; 20 = twice as slow}
'perception {value}



(sysCreateShip unid pos sovereignID [eventHandler]) -> ship
(sysCreateStation unid pos [eventHandler]) -> obj
(sysFindObject source filter) -> list of objects

filter

b Include beams
m Include missiles
s Include ships
t Include stations (including planets)
z Include the player

A Active objects only (i.e., objects that can attack)
D:xyz; Only objects with data 'xyz'
E Enemy objects only
F Friendly objects only
G Stargates only
G:xyz; Stargate with ID 'xyz'
H Only objects whose base = source
I:angle Only objects that intersect line from source
J Same sovereign as source
J:unid; Sovereign unid = unid
K Killed objects only (i.e., objects that cannot attack)
L:x-y; Objects of level x to y.
M Manufactured objects only (i.e., no planets or asteroids)
N Return only the nearest object to the source
N:nn; Return only objects within nn light-seconds
O:docked; Ships that are currently docked at source
O:escort; Ships ordered to escort source
O:guard; Ships ordered to guard source
P Only objects that can be detected (perceived) by source
R Return only the farthest object to the source
R:nn; Return only objects greater than nn light-seconds away
S:sort Sort order ('d' = distance ascending; 'D' = distance descending
T Include structure-scale stations
T:xyz; Include stations with attribute 'xyz'
V Include virtual objects
X Only objects whose target is the source
Y Only objects angry at the player (or enemies)
Z Exclude the player

+xyz; Exclude objects without the given attribute
-xyz; Exclude objects with the given attribute

=n Level comparisons


(typTranslate unid textID [data] [default]) -> text (or Nil)




-------------------------------
VINTAGE DEPRECATED FUNCTIONS (really old stuff)

(plyIncreaseDominaRel player change)
(plyIncreaseOracusRel player change)
(shpAddArmorSpecialAbility ship armorSegment ability) -> True/Nil
(shpGetCargoSpaceLeft ship) -> space left in Kg
(shpGetEngineCore ship) -> EngineCoreTypes
(shpSetEngineCore ship EngineCoreTypes)

------------------------------------------------------------------------
#########################################################################
------------------------------------------------------------------------
DEPRECATED GLOBALS AND EVENTS

intShowContractDeliveryScreen
OnTranslateMessage

------------------------------------------------------------------------
#########################################################################
------------------------------------------------------------------------
Vanilla Global functions

(arcQuestionHandler ...)
(bamComputeArmorLevel ...)
(bamComputeOpponentList ...)
(bamComputePrize ...)
(bamComputeReputation ...)
(bamComputeShieldLevel ...)
(bamComputeSkill ...)
(bamComputeWeaponLevel ...)
(bamCreateGladiator ...)
(bamCreateGladiatorBySkill ...)
(bamCreateMeleeOpponents ...)
(bamDoorsClose ...)
(bamDoorsOpen ...)
(benedict_isFirstMission ...)
(benedict_isMissionAvailable ...)
(benedict_missionAccepted ...)
(chrCancelRaiderOrders ...)
(chrComputeAmbushPos ...)
(chrCreateRaider ...)
(chrDeployFrigateRaid ...)
(chrDeployKronosaurus ...)
(chrGetPrimaryStronghold ...)
(chrOrderRaiders ...)
(chrRaidTransport ...)
(comSealedContainerHack ...)
(comShowBuyScreen ...)
(comShowSellScreen ...)
(comTrafficControl ...)
(cscSquadronCreateShip ...)
(cscSquadronDeployShip ...)
(domGainXP ...)
(domGetDonationEntry ...)
(domGetLevel ...)
(domGetTimeRequired ...)
(domInitRelationship ...)
(domInvokePower ...)
(domShowPower ...)
(fltOrderCheckPosition ...)
(herAttackInProgress ...)
(herStatus ...)
(herStatusClear ...)
(herStatusSet ...)
(huaCheckExperience ...)
(huaHuariDestroyed ...)
(huaIsGateToHuaramarca ...)
(huaSungDestroyed ...)
(intAmmoBoxOpen ...)
(intArmorEnhanceStatus ...)
(intArmorRepairAll ...)
(intAsteroidOnMining ...)
(intAutoInstall ...)
(intBarricadeUse ...)
(intBlackMarketBuyPrice ...)
(intBlackMarketOnDestroy ...)
(intBlackMarketPromotion ...)
(intBlackMarketSellPrice ...)
(intBushidoArmorEnhancement ...)
(intBushidoShieldEnhancement ...)
(intBushidoWeaponEnhancement ...)
(intBuyItems ...)
(intCalcExplosionType ...)
(intCommonwealthCrime ...)
(intCommonwealthOnDestroy ...)
(intCommonwealthOnInit ...)
(intComputeBuyPrice ...)
(intComputeRandomEncounterCourse ...)
(intComputeRandomEncounterPos ...)
(intComputeRandomEncounterPosEx ...)
(intComputeSellPrice ...)
(intConsumeItem ...)
(intContainerGetExplosionType ...)
(intContainerOnDamage ...)
(intCorporateCrime ...)
(intCorporateGenerateEnhancement ...)
(intCorporateOnDestroy ...)
(intCorporateOnInit ...)
(intDestroyItems ...)
(intDeviceRepairAll ...)
(intEnhanceWeaponUse ...)
(intFieldCrystalInstall ...)
(intFieldCrystalUse ...)
(intFleetCreateWingmen ...)
(intFleetCrime ...)
(intFleetDisperseWingmen ...)
(intFleetPromotion ...)
(intGetGateToSystem ...)
(intGetGlobalAchievements ...)
(intHPEnhancement1 ...)
(intHPEnhancement2 ...)
(intHPEnhancement3 ...)
(intInstallAfterPurchase ...)
(intInstallDevicePrep ...)
(intInstallDevicePrepEx ...)
(intIsGateToSystem ...)
(intItemEnhanceStatus ...)
(intJettisonItem ...)
(intLootAllItems ...)
(intMakayevArmorEnhancement ...)
(intMakayevWeaponEnhancement ...)
(intMassString ...)
(intMissionAchievementString ...)
(intMissionRewardPayment ...)
(intRandomMessage ...)
(intRasiermesserArmorEnhancement ...)
(intRasiermesserWeaponEnhancement ...)
(intRingerBuyMargin ...)
(intRingerCrime ...)
(intRingerInstallDevicePrep ...)
(intRingerOnDestroy ...)
(intRingerOnInit ...)
(intRingerSellMargin ...)
(intRoundDown ...)
(intRoundUp ...)
(intSellItems ...)
(intSetCompatibleFuel ...)
(intSetCompatibleFuelEx ...)
(intTaikonBuyMargin ...)
(intTeratonBuyMargin ...)
(intTeratonGetLevelCurve ...)
(intTeratonGetValue ...)
(intTeratonMugging ...)
(intTeratonSellMargin ...)
(intZoanthropeOnObjDestroyed ...)
(intZoanthropeOnOrderChanged ...)
(korComputePlayerLevel ...)
(korEmptyFreighter ...)
(korEscortRecord ...)
(korFillFreighter ...)
(korFrigateDestroyed ...)
(korInitialize ...)
(korMissionFailure ...)
(korMissionStrongholdSuccess ...)
(korMissionSuccess ...)
(korMsgWelcome ...)
(korOnShipDestroyed ...)
(mathProbTableLookup ...)
(mathScale ...)
(milCanEnterCC ...)
(milInit ...)
(milMissionSuccess ...)
(milShowPromotionScreen ...)
(mneAllTargetsDestroyed ...)
(mradDisplay ...)
(neuConsumeCharge ...)
(neuGetCharges ...)
(objAddItemByValue ...)
(objGetFitCount ...)
(objTranslateX ...)
(rpgAdjustInstallPrice ...)
(rpgAdjustPrice ...)
(rpgAnalyzeItem ...)
(rpgBuyItem ...)
(rpgCharacterAscend ...)
(rpgCharacterChangeRel ...)
(rpgCharacterCreateShip ...)
(rpgCharacterGetQuickRel ...)
(rpgCharacterGetRel ...)
(rpgCharacterSetMeeting ...)
(rpgCharacterSetScreen ...)
(rpgCharacterShowMissionScreen ...)
(rpgCleanUpSuspendedAuton ...)
(rpgCreateSuspendedAuton ...)
(rpgDeployAutonFromItem ...)
(rpgDockServices ...)
(rpgFindIndexByID ...)
(rpgGetAutonConfig ...)
(rpgGetReactorUpgradeList ...)
(rpgInstallDevicePrep ...)
(rpgIsMissionActive ...)
(rpgIsMissionDeclined ...)
(rpgMissionAchievementString ...)
(rpgMissionAssignment ...)
(rpgMissionRewardPayment ...)
(rpgPageCount ...)
(rpgPageDesc ...)
(rpgPagePaneInit ...)
(rpgRestorePlayer ...)
(rpgSetTarget ...)
(scrShowBuyScreen ...)
(scrShowSellScreen ...)
(srvFindRepairArmor ...)
(stkDistanceToStK ...)
(stkFreshFoodPrice ...)
(stkFreshFoodStatus ...)
(stkFreshFoodUpdate ...)
(strItemList ...)
(strG ...)
(strMassString ...)
(strNumber ...)
(sunAttackTarget ...)
(sunOrderWing ...)
(sysAddRandomOreByValue ...)
(sysGetRandomOreType ...)
(sysGetStargateLeadingToCore ...)
(sysGetStargateLeadingToNode ...)
(terCreateDefender ...)
(tinkerCalcFabrication ...)
(tinkerCreateItem ...)
(tinkerFabricate ...)
(tinkerFindRecipe ...)
(trnCreateAllStargates ...)
(trnCreateStarAndZones ...)
(trnCreateStarZones ...)
(useRepairArmor ...)

---------------------------------------------
CORPORATE COMMAND GLOBAL FUNCTIONS

(corpExp_getInfectedShipyards ...)
(corpExp_isFirstMission ...)
(corpExp_isMissionAvailable ...)
(corpExp_missionAccepted ...)
(corpPriv_calcIntro ...)
(corpPriv_calcRankFromXP ...)
(corpPriv_calcReward ...)
(corpPriv_calcSummary ...)
(corpPriv_getRank ...)
(corpPriv_giveReward ...)
(corpPriv_missionCompleted ...)
(corpPriv_showMissionScreen ...)
(omnAvengeStation ...)
(stockCalcMaxSharesForPlayer ...)
(stockCalcPortfolioStats ...)
(stockCalcValue ...)
(stockDumpInvestorProfit ...)
(stockDumpStockList ...)
(stockFormatPrice ...)
(stockInvestorBuys ...)
(stockInvestorSells ...)
(stockPlayerBuys ...)
(stockPlayerSells ...)
(stockUpdateInvestor ...)
(stockUpdateStock ...)
(stockUpdateStockEvent ...)

---------------------------------------------
ETERNITY PORT RELATED GLOBAL FUNCTIONS

(apd_calcReward ...)
(cdmGetTimeRequired ...)
(cdmInvokePower ...)
(cdmIsPowerAvailable ...)
(cdmIsWillingToAttack ...)
(cdmShard_consumeItem ...)
(cdmShard_getConnectInfo ...)
(cdmShard_getItem ...)
(cdmShard_getLevelForXP ...)
(cdmShard_reset ...)
(cdmShard_switch ...)
(cdmShard_talk ...)
(cdmShard_talkMatch ...)
(cdmShard_talkMatchMulti ...)
(ed_calcReward ...)
(goron_armor ...)
(goron_launcher ...)
(goron_randomItem ...)
(goron_shields ...)
(goron_weapon ...)
(nau_calcReward ...)
(resurrectors_useAntidote ...)
(uas_calcReward ...)
(uasGetCurrentForgeLevel ...)
(uasGetCurrentXP ...)



------------------------------------------------------------------------
#########################################################################
------------------------------------------------------------------------
Vanilla Global gVariables and aVariables, temporary and hardcoded (probably not a complete list)

aCount
gScreen
aArmorDamageHP
aArmorSeg
aAttacker
aBaseObj
aBestEnemiesDestroyed
aBestEnemiesDestroyed
aCargoValue
aCause
aCharges
aDamageHP
aDamageType
aDestObj
aDestroyReason
aDestroyer
aDeviceItem
aDockTarget
aEndGameReason
aEnemiesDestroyed
aEvent
aFireAngle
aGateObj
aHP
aHitDir
aHitPos
aItemToRepair
aJumpPos
aMineDir
aMinePos
aMineProbability
aNearestObj
aObj
aObjAttacked
aObjDestroyed
aObjDocked
aOrderGiver
aOriginObj
aOriginalArmorDamageHP
aOriginalShieldDamageHP
aOverlayID
aPathPoint
aPrevObj
aResult
aShieldDamageHP
aShieldHP
aShieldReflect
aStation
aSystemsVisited
aTargetObj
aWeaponBonus
aWeaponFragment
aWeaponType
aWingmanPlayer
aWreckObj
gAmmo
gArmorSegment
gBonus
gBuyCriteria
gCanInstall
gCanRepair
gCheckMilitaryID
gCost
gCount
gCriteria
gCursor
gDesc
gDest
gDestination
gEnd
gItem
gLevel
gList
gMargin
gMatch
gMaxCount
gMaxPrice
gMission
gMissionAcceptText
gMissionDeclineText
gMissionListName
gMissionNoneText
gMissionTitle
gName
gPaid
gPlayer
gPlayership
gPrevPane2
gPrevPane
gPrevScreen2
gPrevScreen
gResult
gReward
gSelect
gSender
gShowCriteria
gSlaver
gSource
gStart
gState
gTarget
gTechLevel
gTechModifier
gTitle
gTrans
gTransport

User avatar
RPC
Fleet Admiral
Fleet Admiral
Posts: 2876
Joined: Thu Feb 03, 2011 5:21 am
Location: Hmm... I'm confused. Anybody have a starmap to the Core?

Mon Dec 29, 2014 2:00 am

Thanks AP and Dig!
Tutorial List on the Wiki and Installing Mods
Get on Discord for mod help and general chat
Image
Image
Der Tod ist der zeitlose Frieden und das leben ist der Krieg
Wir müssen wissen — wir werden wissen!
I don't want any sort of copyright on my Transcendence mods. Feel free to take/modify whatever you want.

Post Reply