User Tools

Site Tools


modding:functions:index

This is an old revision of the document!


Discuss this page on this page's Talk Page

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 <= b <= 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 < b < 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.1419655255.txt.gz · Last modified: (external edit)