User Tools

Site Tools


modding:functions:index

This is an old revision of the document!


Table of Contents

Discuss this page on this page's Talk Page

#

(!= …)

(* x1 x2 … xn) → z

(+ x1 x2 … xn) → z

(- x y) → z

(- x) → -x

(/ x y) → z

(< …)

(⇐ …)

(= …)

(> …)

(>= …)

(@ list index)

A

B

C

D

E

F

G

H

I

(if ...)

(int ...)

(isatom ...)

(iserror ...)

(isfunction ...)

(isint ...)

(isprimitive ...)

(itmCreate itemUNID count) -> item

(itmCreateByName criteria name [count]) -> item

(itmCreateRandom criteria levelDistribution) -> item

(itmEnumTypes criteria item-var exp)

(itmFireEvent item|type event [data]) -> result of event

(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

(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

(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

(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(itmSetProperty item property value) -> item

(itmSetReference item)

(itmSetTypeData item attrib data) -> True/Nil

J

(join list [separator]) → string

(join list 'oxfordComma) → string

K

L

(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

M

(make 'sequence count) → list from 1 to count

(make 'sequence start end [inc]) → list from start to end

(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

(mod ['degrees] x y) → z

(modulo ['degrees] x y) → z

(msnAccept missionObj)

(msnAddRecurringTimerEvent missionObj interval event)

(msnAddTimerEvent missionObj delay event)

(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

(msnFireEvent missionObj event [data]) → result of event

(msnGetData missionObj attrib) → data

(msnGetObjRefData missionObj attrib) → obj

(msnGetProperty missionObj property) → value

(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

(msnSetUnavailable missionObj)

(msnSuccess missionObj [data])

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

(multiply x1 x2 … xn) → z

N

(neq …)

(not exp) → True/Nil

O

(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

(objCanInstallItem obj item [armorSeg|deviceSlot]) → (True/Nil resultCode resultString [itemToReplace])

(objChangeEquipmentStatus obj equipment command [duration] [options]) → True/Nil

(objCharge obj [currency] amount) → remaining balance

(objClearIdentified obj)

(objClearShowAsDestination obj)

(objCommunicate obj senderObj msg [obj] [data]) → result

(objCredit obj [currency] amount) → new balance

(objDamage obj weaponType objSource [pos] [options]) → result

(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

(objFireItemInvoke obj item) → True/Nil

(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 [shipObj] armorItem hpToRepair) → price (at which obj repairs)

(objGetArmorReplacePrice obj armorItem) → price

(objGetArmorType obj item|armorSegment) → type

(objGetBalance obj [currency]) → balance

(objGetBuyPrice obj item [options]) → price (at which obj buys item)

(objGetCargoSpaceLeft obj) → space left in Kg

(objGetCombatPower obj) → 0-100

(objGetDamageType obj) → damage type

(objGetData obj attrib) → data

(objGetDataField obj field) → data

(objGetDestiny obj) → 0-359

(objGetDisposition obj targetObj) → disposition of obj towards targetObj

(objGetDistance obj destObj) → distance in light-seconds

(objGetEquipmentStatus obj equipment) → status

(objGetEventHandler obj) → unid or Nil

(objGetID obj) → objID

(objGetImageDesc obj) → imageDesc

(objGetInstalledItemDesc obj item) → 'installed as forward armor'

(objGetItemProperty obj item property) → value

(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

(objGetOverlayProperty obj overlayID property) → value

(objGetOverlayRotation obj overlayID) → rotation

(objGetOverlays obj [criteria]) → list of overlayIDs

(objGetOverlayType obj overlayID) → type

(objGetPlayerPriceAdj obj [data]) → priceAdj (or Nil if no adj)

(objGetPos obj) → vector

(objGetProperty obj property) → value

(objGetRefuelItemAndPrice obj objToRefuel) → (item price)

(objGetSellPrice obj item ['noInventoryCheck]) → price (at which obj sells item)

(objGetShieldLevel obj) → 0-100 (or -1 for no shields)

(objGetShipBuyPrice obj shipObj) → price (at which obj buys ship)

(objGetShipSellPrice obj shipObj) → price (at which obj sells ship)

(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)

(objRecordBuyItem buyerObj sellerObj item [currency] price) → True/Nil

(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 text) → True/Nil

(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

(objSetKnown obj)

(objSetName obj name [flags])

(objSetObjRefData obj attrib obj)

(objSetOverlayData obj overlayID attrib data)

(objSetOverlayEffectProperty obj overlayID property value)

(objSetOverlayPos obj overlayID pos)

(objSetOverlayProperty obj overlayID property value)

(objSetOverlayRotation obj overlayID rotation)

(objSetPos obj vector [rotation])

(objSetProperty obj property value) → True/Nil

(objSetShowAsDestination obj [options]) → True/Nil

(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

P

(plyChangeShip player newShip [options]) → True/Nil

(plyCharge player [currency] charge) → credits left

(plyComposeString player string [arg1 arg2 … argn]) → string

(plyCredit player [currency] credit) → credits left

(plyDestroyed player epitaph)

(plyEnableMessage player messageID True/Nil) → True/Nil

(plyGetCredits player [currency]) → credits left

(plyGetGenome player) → 'humanMale | 'humanFemale

(plyGetItemStat player stat criteria|type) → value

(plyGetKeyEventStat player stat nodeID typeCriteria) → value

(plyGetRedirectMessage …)

(plyGetStat player stat) → value

(plyIsMessageEnabled player messageID) → True/Nil

(plyMessage …)

(plyRecordBuyItem player item [currency] totalPrice)

(plyRecordSellItem player item [currency] totalPrice)

(plyRedirectMessage …)

(plyUseItem player item)

(pow x y) → z

(power x y) → z

(print [string]*)

(printTo output [string]*)

Q

(quote exp) → unevaluated exp

R

(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

(resColorBlend rgbDest rgbSource srcOpacity) → rgbColor

(resCreateImageDesc imageUNID x y width height) → imageDesc

(rollDice count sides bonus)

(round ['stochastic] x) → y

S

(scrAddAction screen actionID pos label [key] [special] code)

(scrAddMinorAction 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 …)

(scrGetScreen gScreen) → screenDesc

(scrIncData screen attrib [increment])

(scrIsActionEnabled screen actionID) → True/Nil

(scrIsFirstOnInit …)

(scrRefreshScreen screen)

(scrRemoveAction screen actionID)

(scrRemoveItem …)

(scrSetActionDesc screen actionID descID)

(scrSetActionLabel screen actionID label [key] [special])

(scrSetBackgroundImage screen imageDesc)

(scrSetControlValue screen controlID value) → True/Nil

(scrSetControlValueTranslate screen controlID textID [data]) → 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 …)

(set@ list-var index value) → list

(set@ struct-var key value) → struct

(set@ 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 [deviceSlot])

(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)

(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

(sovMessage sovereignID text) → True/Nil

(sovMessageFromObj sovereignID obj text) → True/Nil

(sovSetDisposition sovereignID targetSovereignID disposition)

(split string [characters]) → list

(sqrt x) → z

(sqrtn 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)

(struct key1 value1 key2 value2 …) → struct

(struct (key1 value1) (key2 value2) ..) → struct

(struct { key1:value1 key2:value2 … } …) → struct

(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)

(sysCalcStdCombatStrength level) → standard combat strength for level

(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

(sysCreateHitEffect weaponUNID hitObj hitPos hitDir damageHP) → True/Nil

(sysCreateLookup tableName orbit) → True/Nil

(sysCreateMarker name pos sovereignID) → marker

(sysCreateShip unid pos sovereignID [options|eventHandler|controller]) → ship or list

(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 [options] [bonus]) → obj

(sysDescendObject objID pos) → obj

(sysFindObject source filter) → list of objects

(sysFindObjectAtPos source criteria pos [destPos]) → list of objects

(sysGetData [nodeID] attrib) → data

(sysGetEnvironment pos) → environmentUNID

(sysGetLevel [nodeID]) → level

(sysGetLightIntensity pos) → intensity (0-100)

(sysGetName [nodeID]) → name

(sysGetNavPathPoint sovereignID objFrom objTo ath) → vector

(sysGetNode) → nodeID

(sysGetNodes) → list of nodeIDs

(sysGetObjectByName [source] name) → obj

(sysGetProperty [nodeID] property) → value

(sysGetRandomLocation criteria [options]) → location or Nil

(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

(sysHitScan [source] startPos endPos) → (obj hitPos) or Nil

(sysIncData [nodeID] attrib increment) → new value

(sysIsKnown [nodeID]) → True/Nil

(sysMatches [nodeID] criteria) → True/Nil

(sysOrbit center radius angle [eccentricity rotation]) → orbit

(sysOrbitPos orbit [options]) → vector

(sysPlaySound unid [sourceObj]) → True/Nil

(sysPoolUsage …)

(sysSetData [nodeID] attrib data) → data

(sysSetEnvironment unid shape options) → True/Nil

(sysSetKNown [nodeID] [True/Nil]) → True/Nil

(sysSetPOV obj|vector) → True/Nil

(sysSetProperty [nodeID] property value) → True/Nil

(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

T

(typAddRecurringTimerEvent unid interval event)

(typAddTimerEvent unid delay event)

(typCancelTimerEvent unid event) → True/Nil

(typCreate unid XML) → True/Nil

(typDynamicUNID uniqueName) → UNID

(typeof item) → type

(typFind criteria) → list of UNIDs

(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

(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)

U

(uiCanPlayMusic filename) → True/Nil

(uiGetMusicCatalog) → list of files

(uiGetMusicState) → ('playing filename position length)

(uiPlayMusic filename [pos]) → True/Nil

(uiSetSoundtrackMode mode [soundtrackUNID])

(uiStopMusic)

(unvFindObject [nodeID] criteria) → list of entries

(unvGetCurrentExtensionUNID) → UNID

(unvGetElapsedGameTime [startTick] endTick format) → result

(unvGetExtensionData scope attrib) → data

(unvGetRealDate) → (year month day) GMT

(unvGetTick) → time

(unvSetExtensionData scope attrib data) → True/Nil

(unvSetObjectKnown [nodeID] criteria [True/Nil]) → True/Nil

(unvUNID string) → (unid 'itemtype name) or (unid 'shipclass name)

V

(v* scalar vec1) → result of scalar multiplication of scalar and vec1

(v+ vec1 vec2) → result of vector addition of vec1 and vec2

(v→ vec1 indexlist) → get the elements of vec1 based on indexlist

(v← vec1 indexlist datalist) → set the elements of vec1 with datalist based on the indices in indexlist

(v= vec1 vec2) → compare vec1 and vec2 for equality

(v^ vec1 vec2) → result of element-wise multiplication of vec1 and vec2

(vdot vec1 vec2) → result of vector dot product of vec1 and vec2

(vecCreate) → empty vector

(vecSetElement …)

(vector contentlist) → vector form of contentlist

(vfilled scalar shapelist) → vector filled with scalar's value

W

X

(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

Y

Z

Function Syntax Function Categories
(add x1 x2 ... xn) -> z 0.99, math
(and exp1 exp2 ... expn) -> True/Nil logical operator
(append a b [...]) -> concatenated list list
(apply lambda list) -> return value of lambda function operator
(armGetHitPoints type) -> Hit points of armor 0.99, armor, armortype
(armGetName type) -> Name of the armor armor, armortype, name
(armGetRepairCost type) -> Cost to repair 1 hit point armor, armortype, cash, repair & damage
(armGetRepairTech type) -> Tech level required to repair armor, armortype, repair & damage, station
(armIsRadiationImmune type) -> True/Nil armor, armortype, radiation
(block list exp1 ... expn) -> value of last expression control structure
(cat s1 s2 ... sn) -> string string operator
(count list) -> number of items list
(dbgLog expression^1) 0.99, debug
(dbgOutput s1 [s2 ... sn]) debug
(divide x y) -> z math
(enum list itemVar exp) -> value of last expression iteration, list
(enumWhile list condition itemVar exp) -> value of last expression iteration, list
(envHasAttribute number string) 0.99, condition query, unid
(eq exp1 [exp2 ... expn]) -> True/Nil logical operator
(errblock List function^1 function) control structure, error
(eval expr) -> value of evaluated expression function operator, string operator, variable
(filter list variable function) 0.99, list
(find source target [keyIndex]) -> position of target in source (0-based) 0.99, list, string operator
(fnchelp function) function
(for var from to exp) -> value of last expression iteration
(geq a [b ... bn]) -> True if a >= b >= bn logical operator
(gr a [b ... bn]) -> True if a > b > bn logical operator
(if condition exp1 [exp2]) -> value of invoked expression control structure
(int string) 0.99, string operator
(isAtom expr) -> True/Nil atom, condition query
(iserror expression) error
(isfunction expr) -> True/Nil condition query, function operator
(isInt expr) -> True/Nil condition query
(item list index) -> list item or Nil list
(itmAtCursor itemListCursor) -> item 0.98, item, deprecated
(itmCreate itemUNID count) -> item create, item, unid
(itmCreateByName criteria name [count]) -> item create, item, random
(itmCreateRandom criteria levelDistribution) -> item create, item, random
(itmEnumTypes criteria itemVar exp) -> value of last expression item, iteration
(itmGetActualPrice item) -> actual price of a single item cash, item
(itmGetArmorInstalledLocation item) -> segment # armor, item
(itmGetCategory item) -> item category item
(itmGetCharges item) -> charges 0.99, item
(itmGetCount item) -> count item
(itmGetDamageType item) -> damage type item, repair & damage
(itmGetData itemStruct string) 0.99, data, item
(itmGetFrequency item) -> frequency item
(itmGetGlobalData itemStruct string) 0.99, data, item
(itmGetInstallCost item) -> cost cash, item
(itmGetLevel item) -> level item
(itmGetMass item) -> mass of single item in Kg item
(itmGetMaxAppearing item) -> max number that appear randomly item
(itmGetName item flags) -> name item, name
(itmGetPrice item) -> price of a single item cash, item
(itmGetStaticData itemStruct string) 0.99, data, item
(itmGetTypeData itemStruct) -> item data data, deprecated, item
(itmGetTypes criteria) -> list of itemUNIDs 0.99, item
(itmGetUNID item) -> itemUNID item, unid
(itmGetUseScreen item) -> screenUNID or Nil item
(itmHasAttribute item attrib) -> True/Nil 0.99, condition query, item
(itmHasModifier itemStruct string) -> True/Nil 0.98, item, deprecated
(itmHasReference item) -> True/Nil condition query, item
(itmIsDamaged item) -> True/Nil condition query, item, repair & damage
(itmIsEnhanced item) -> Nil or mods enhancement, item
(itmIsInstalled item) -> True/Nil condition query, item
(itmIsKnown item) -> True/Nil condition query, item
(itmMatches item criteria) -> True/Nil condition query, item
(itmSetCharges item charges) -> item 0.99, item
(itmSetCount item count) -> item 0.99, item
(itmSetDamaged itemStruct [boolean]) 0.99, item, repair & damage
(itmSetEnhanced item mods) -> item enhancement, item
(itmSetGlobalData itemStruct string expression) 0.99, data, item
(itmSetKnown {item //or// itemUNID}) -> True or Error item
(itmSetReference item) -> True or Error item
(lambda args exp) -> lambda function operator
(leq a [b ... bn]) -> True if a &lt;= b &lt;= bn logical operator
(list i1 i2 ... in) -> list list
(lnkAppend list item) -> list list
(lnkRemove list index Nil) -> list list
(lnkRemoveNil list) -> list list
(lnkReplace list index item) -> list list
(loop condition exp) -> value of last expression iteration
(ls a [b ... bn]) -> True if a &lt; b &lt; bn logical operator
(max expression [number]^1) 0.99, math
(min expression [number]^1) 0.99, math
(modulo number number) -> number 0.99, math
(modulus number number) -> number 0.98, math changed functions
(multiply x1 [x2 ... xn]) -> z 0.99, math
(not exp) -> True/Nil logical operator
(objAddItem obj item [count]) -> True/Nil item, spaceobject
(objAddRandomItems obj table count) -> True/Nil item, random, spaceobject
(objAddSubordinate obj subordinate) -> True/Nil ship, spaceobject
(objCanAttack obj) -> True/Nil 0.99, condition query, spaceobject
(objCharge obj amount) -> remaining balance cash, spaceobject
(objCommunicate spaceObject spaceObject number [spaceObject]) orders, spaceobject
(objCredit obj amount) -> new balance cash, spaceobject
(objDepleteShields obj) -> True/Nil shield, spaceobject
(objDestroy obj [objSource]) -> True/Nil spaceobject
(objEnumItems obj criteria itemVar exp) -> value of last expression item, iteration, spaceobject
(objFireEvent obj event) -> result of event event, spaceobject
(objGateTo obj node entrypoint [effectID]) spaceobject
(objGetArmorDamage spaceObject number) armor, repair & damage, spaceobject
(objGetArmorName spaceObject number) armor, name, spaceobject
(objGetArmorType spaceObject number) armor, spaceobject
(objGetBalance spaceObject) cash, spaceobject
(objGetBuyPrice spaceObject itemStruct) cash, item, spaceobject
(objGetCargoSpaceLeft spaceObject) spaceobject
(objGetCombatPower spaceObject) spaceobject
(objGetDamageType spaceObject) spaceobject
(objGetData spaceObject string) data, spaceobject
(objGetDestiny spaceObject) spaceobject
(objGetDistance spaceObject spaceObject) spaceobject
(objGetGlobalData spaceObject string) data, spaceobject
(objGetID spaceObject) spaceobject
(objGetImageDesc spaceObject) 0.99, spaceobject, unid
(objGetInstalledItemDesc spaceObject itemStruct) spaceobject
(objGetItems spaceObject criteria) item, spaceobject
(objGetLevel obj) -> level spaceobject
(objGetMass spaceObject) 0.99, spaceobject
(objGetMaxPower spaceObject) reactor, spaceobject
(objGetName spaceObject [number]) -> string name, spaceobject
(objGetNamedItems obj name) 1.0, item, spaceobject
(objGetNearestStargate spaceObject) spaceobject
(objGetObjByID number) 0.99, spaceobject
(objGetObjRefData spaceObject string) spaceobject
(objGetOrderGiver spaceObject) orders, spaceobject
(objGetPos spaceObject) spaceobject
(objGetSellPrice spaceObject itemStruct) cash, item, spaceobject
(objGetShieldLevel spaceObject) shield, spaceobject
(objGetSovereign spaceObject) ai, spaceobject, unid
(objGetStaticData spaceObject string) data, spaceobject
(objGetStaticDataForStationType number string) -> data station, data, unid, 0.98
(objGetTarget spaceObject) spaceobject
(objGetVel spaceObject) 0.99, spaceobject, vector operator
(objGetVisibleDamage spaceObject) repair & damage, spaceobject
(objHasAttribute spaceObject string) condition query, spaceobject
(objHasItem spaceObject itemStruct) condition query, spaceobject
(objIncData spaceObject string [number]) data, spaceobject
(objIncVel spaceObject vector) spaceobject, vector operator
(objIsAbandoned spaceObject) condition query, spaceobject
(objIsDeviceSlotAvailable spaceObject) condition query, spaceobject
(objIsDockedAt spaceObject spaceObject) condition query, spaceobject, station
(objIsEnemy spaceObject spaceObject) 0.99, condition query, spaceobject
(objIsKnown obj) -> True/Nil condition query, spaceobject
(objIsShip spaceObject) condition query, spaceobject
(objIsUnderAttack spaceObject) condition query, spaceobject
(objJumpTo spaceObject vector) spaceobject
(objLowerShields spaceObject) shield, spaceobject
(objMakeParalyzed spaceObject number) repair & damage, spaceobject
(objMoveTo spaceObject vector) spaceobject
(objRegisterForEvents spaceObject spaceObject) spaceobject
(objRemoveItem spaceObject itemStruct [number]) item, spaceobject
(objRepairArmor spaceObject number [number]) armor, repair & damage, spaceobject
(objSendMessage spaceObject spaceObject string) message, spaceobject
(objSetData spaceObject string expression) data, spaceobject
(objSetGlobalData spaceObject string expression) spaceobject
(objSetKnown spaceObject) spaceobject
(objSetName spaceObject string) name, spaceobject
(objSetObjRefData spaceObject string spaceObject) spaceobject
(objSetSovereign spaceObject number) ai, spaceobject
(objUnregisterForEvents spaceObject spaceObject) spaceobject
(or [condition]^1) logical operator
(plyChangeShip player target) player, spaceobject
(plyCharge player number) cash, player
(plyClearShowHelpRefuel player) help, player
(plyComposeString player string) player, string operator
(plyCredit player number) cash, player
(plyDestroyed player string) player, repair & damage
(plyGetCredits player) cash, player
(plyGetGenome spaceObject) 0.99, player
(plyGetInsuranceClaims player) insurance, player
(plyGetRedirectMessage player) message, player
(plyIncreaseDominaRel player number) -> True player, 0.98
(plyIncreaseOracusRel player number) -> True player, 0.98
(plyInsure player) insurance, player
(plyIsInsured player) insurance, player
(plyMessage player string) message, player
(plyRedirectMessage player condition) message, player
(power number number) 0.99, math
(random expression [number]) random
(rollDice number number number) random
(scrEnableAction screen number condition) screen
(scrExitDock screen) screen
(scrGetCounter screen) input, screen
(scrGetInputText screen) input, screen
(scrGetItem screen) input, screen
(scrGetItemListCursor screen) -> itemListCursor screen, input, 0.98, deprecated
(scrIsFirstOnInit screen) screen
(scrRefreshItemListCursor_deprecated) 0.98, screen
(scrRemoveitem screen number) screen
(scrSetActionLabel screen number string [key]) screen
(scrSetCounter screen number) input, screen
(scrSetDesc screen string) screen
(scrSetInputText screen string) screen
(scrSetListFilter screen criteria) screen
(scrShowPane screen string) screen
(scrShowScreen screen string [string]) screen
(seededRandom number expression [number]) 0.99, random
(set string expression) store
(setq variable expression) store
(shpAddEnergyField ship number number) ship
(shpCancelOrders ship) orders, ship
(shpCanInstallArmor ship itemStruct) ship
(shpCanInstallDevice ship itemStruct) ship
(shpCanRemoveDevice ship item) -> installCode ship
(shpConsumeFuel ship number) ship
(shpDamageArmor ship number number number) armor, repair & damage, ship
(shpDamageItem ship itemListCursor) item, repair & damage, ship
(shpDecontaminate ship) radiation, ship
(shpEnhanceItem ship itemListCursor [number]) enhancement, item, ship
(shpEnhanceSRS ship) enhancement, ship
(shpFixBlindness ship) repair & damage, ship
(shpGetArmor ship number) armor, ship
(shpGetArmorCount ship) armor, ship
(shpGetArmorMaxHitPoints ship number) armor, ship
(shpGetClass ship) ship, unid
(shpGetDataField number string) 0.99, ship, unid
(shpGetDirection ship) ship
(shpGetFuelLeft ship) reactor, ship
(shpGetGlobalData number string) -> data/Nil data, ship, 0.98, deprecated
(shpGetImageDesc spaceObject [number]) 0.99, ship, unid
(shpGetItemCharges ship itemStruct) -> charges) 0.98, deprecated, ship, item
(shpGetMaxSpeed spaceObject) 0.99, ship
(shpGetOrder ship) orders, ship
(shpGetShieldDamage ship) repair & damage, shield, ship
(shpGetShieldItemUNID ship) shield, ship, unid
(shpGetShieldMaxHitPoints ship) shield, ship
(shpInstallArmor ship itemListCursor number) armor, install, ship
(shpInstallAutopilot ship) enhancement, ship
(shpInstallDevice ship expression) install, ship
(shpInstallTargetingComputer ship) enhancement, install, ship
(shpIsAutopilotInstalled ship) condition query, enhancement, ship
(shpIsFuelCompatible ship itemStruct) condition query, reactor, ship
(shpIsRadiationImmune ship [itemListCursor]) condition query, radiation, ship
(shpIsRadioactive ship) condition query, radiation, ship
(shpIsSRSEnhanced ship) condition query, enhancement, ship
(shpIsTargetingComputerInstalled ship) condition query, enhancement, ship
(shpMakeBlind ship number) repair & damage, ship
(shpMakeRadioactive ship) radiation, ship
(shpOrder ship string [expression]^1) orders, ship
(shpOrderAttack ship ship) orders, ship
(shpOrderDock ship spaceObject) orders, ship
(shpOrderEscort ship protect [formation]) -> True/Nil orders, ship
(shpOrderFollow ship spaceObject) orders, ship
(shpOrderGate ship [spaceObject]) orders, ship
(shpOrderGoto ship spaceObject) orders, ship
(shpOrderGuard ship spaceObject) orders, ship
(shpOrderHold ship [number]) orders, ship
(shpOrderLoot ship spaceObject) orders, ship
(shpOrderMine ship spaceObject) orders, ship
(shpOrderPatrol ship spaceObject number) orders, ship
(shpOrderWait ship number) orders, ship
(shpRechargeItem ship expression number) item, ship
(shpRechargeShield ship number) repair & damage, shield, ship
(shpRefuelFromItem ship itemStruct) item, ship
(shpRemoveDevice ship expression) install, item, ship
(shpRepairItem ship itemListCursor) item, repair & damage, ship
(shpSetController ship string) ai, ship
(shpSetGlobalData_deprecated number string expression) -> True/Nil data, ship, 0.98, deprecated
(shuffle list) 0.99, list, random
(sovSetDisposition number number number) ai
(sqrt number) 0.99, math
(staClearFireReconEvent station) event, recon, station
(staClearReconned station) recon, station
(staGetDockedShips station) ship, station
(staGetGlobalData number string) -> data data, station, deprecated
(staGetImageVariant station) station
(staGetStructuralHP station) station
(staGetSubordinates station) spaceobject, station
(staGetType station) station, unid
(staIsEncountered number) condition query, station, unid
(staIsReconned station) condition query, recon, station
(staSetActive station) station
(staSetFireReconEvent station) event, recon, station
(staSetGlobalData number string expression) -> True/Nil 0.98, data, station, deprecated
(staSetImageVariant station number) station
(staSetInactive station) station
(staSetStructuralHP station number) station
(strCapitalize string) string operator
(strFind string string) string operator
(subst string string^1) string operator
(subtract number number) math
(switch [exp1 exp2] ... [expn expn1] [defaultexp]) -> value of evaluated expression control structure
(sysAddEncounterEvent number spaceObject number spaceObject) encounter table, system, time
(sysAddEncounterEventAtDist number spaceObject number number) encounter table, system, time
(sysAddObjRecurringTimerEvent number spaceObject string) event, system, time
(sysAddObjTimerEvent number spaceObject string) event, system, time
(sysCancelTimerEvent spaceObject string) event, system, time
(sysCreateEffect number spaceObject vector) create, system, unid
(sysCreateMarker string vector number) create, system, unid
(sysCreateShip number vector number [string]) create, ship, unid
(sysCreateStation number vector) create, station, unid
(sysCreateWeaponFire weaponID objSource posVector dir speed objTarget [detonateNow]) -> obj create, system, unid
(sysFindObject spaceObject criteria) 0.99, spaceobject, system
(sysGetData [nodeID] attrib) -> data data, system
(sysGetEnvironment spaceObject) 0.99, spaceobject, unid
(sysGetLevel [string]) system
(sysGetName [string]) system
(sysGetNavPathPoint number spaceObject spaceObject number) system, unid
(sysGetNode) system
(sysGetObjectByName spaceObject string) spaceobject, system
(sysGlobals) function, system, variable
(sysPoolUsage) system
(sysSetData [string] string expression) data, system
(sysStopTime number spaceObject) system, time
(sysTicks) system, time
(sysVectorAdd vector vector) system, vector operator
(sysVectorAngle vector) 0.99, vector operator
(sysVectorDistance vector vector) system, vector operator
(sysVectorDivide vector number) system, vector operator
(sysVectorMultiply vector number) system, vector operator
(sysVectorPolarOffset vector number number) system, vector operator
(sysVectorPolarVelocity number number) system, vector operator
(sysVectorRandom vector number number criteria) system, vector operator
(sysVectorSpeed velVector) system, vector operator
(sysVectorSubtract vector vector) system, vector operator
(typFind criteria) 1.0, type, unid
(typGetDataField unid attrib) -> data data, type, unid
(typGetGlobalData number string) 0.99, data, type, unid
(typGetStaticData number string) 0.99, data, type, unid
(typIncGlobalData number string [number]) 0.99, data, math, unid
(typSetGlobalData number string expression) 0.99, data, type, unid
(unvGetTick) time
(unvUNID string) random, system, unid
modding/functions/index.1484960511.txt.gz · Last modified: 2017/01/21 01:01 (external edit)