Transcendence Community Wiki - modding:function https://wiki.kronosaur.com/ 2026-06-06T01:07:50+00:00 Transcendence Community Wiki https://wiki.kronosaur.com/ https://wiki.kronosaur.com/lib/exe/fetch.php/wiki/dokuwiki.svg text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) abs https://wiki.kronosaur.com/doku.php/modding/function/abs?rev=1419655256&do=diff abs. abs The abs function is not included in the Xelerus list. Syntax (abs number1) Argument List number1: the number that you want the absolute value of Returns number2: the absolute value of number1 (supplied to the function) Category math Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) add https://wiki.kronosaur.com/doku.php/modding/function/add?rev=1419655255&do=diff add add add Syntax (add x1 x2 ... xn) -> z Arguments x1: A number to add. x2 ... xn: Optional numbers to add. Returns z: The sum of all the numbers passed in Category 0.99, math Description Sums up the numbers passed to it and returns the result. Example text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) ai_functions https://wiki.kronosaur.com/doku.php/modding/function/ai_functions?rev=1419655255&do=diff ai_functions. Ai functions * shpSetController * sovSetDisposition * objSetSovereign * objGetSovereign ai_functions See also ai Return to functions list text/html 2017-01-27T02:17:37+00:00 Anonymous (anonymous@undisclosed.example.com) and https://wiki.kronosaur.com/doku.php/modding/function/and?rev=1485483457&do=diff Discuss this page and See and on Xelerus Syntax (and exp1 [exp2 ... expn]) -> value/Nil Arguments exp1: an expression that evaluates to Nil or non-Nil [exp2 ... expn]: optional expressions that each evaluate to Nil or non-Nil. Returns If all arguments return a non-Nil value, then returns the value of the last argument. Otherwise, returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) append https://wiki.kronosaur.com/doku.php/modding/function/append?rev=1419655255&do=diff append append append Syntax (append a b [...]) -> concatenated list Arguments a: A list, string, integer, boolean or literal you want to start the new list. b: A list, string, integer, boolean or literal you want to append on to the previous argument. [ text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) apply https://wiki.kronosaur.com/doku.php/modding/function/apply?rev=1419655255&do=diff apply apply apply Syntax (apply lambda list) -> return value of lambda Arguments lambda: The function (lambda) you want to run. list: A list of arguments you want the function to be run with. Returns Whatever the lambda returns. Category function operator' Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) armgethitpoints https://wiki.kronosaur.com/doku.php/modding/function/armgethitpoints?rev=1419655256&do=diff Discuss this page on this pages TalkPage armGetHitPoints See armGetHitPoints at Xelerus Syntax (armGetHitPoints type) -> Hit points of armor Arguments type: The type of the armor you want to get the name from. This is not the UNID. Returns The amount of hit points of the armor text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) armgetname https://wiki.kronosaur.com/doku.php/modding/function/armgetname?rev=1419655255&do=diff Discuss this page on this pages TalkPage armGetName See armGetName at Xelerus Syntax (armGetName type) -> Name of the armor Arguments type: The type of the armor you want to get the name from. This is not the UNID. Returns string: The name of the armor Category armor, armortype, name Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) armgetrepaircost https://wiki.kronosaur.com/doku.php/modding/function/armgetrepaircost?rev=1419655255&do=diff Discuss this page on this pages TalkPage armGetRepairCost See armGetRepairCost at Xelerus Syntax (armGetRepairCost type) -> Cost to repair 1 hit point Arguments type: The type of the armor you want to get the repair cost from. This is not the UNID. Returns integer: The cost of repairing one point of damage of this armor. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) armgetrepairtech https://wiki.kronosaur.com/doku.php/modding/function/armgetrepairtech?rev=1419655255&do=diff Discuss this page on this pages TalkPage armGetRepairTech See armGetRepairTech at Xelerus Syntax (armGetRepairTech type) -> Tech level required to repair Arguments type: The type of the armor you want to get the repair tech from. This is not the UNID. Returns integer: The tech level needed for a station to repair this armor. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) armisradiationimmune https://wiki.kronosaur.com/doku.php/modding/function/armisradiationimmune?rev=1419655256&do=diff Discuss this page on this pages TalkPage armIsRadiationImmune See armIsRadiationImmune at Xelerus Syntax (armIsRadiationImmune type) -> True/Nil Arguments type: The type of the armor you want to get if the armor is radiation immune from. This is not the UNID. Returns boolean: True if the armor is radiation immune ,otherwise returns Nil. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) armortype_functions https://wiki.kronosaur.com/doku.php/modding/function/armortype_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. ArmorType functions * armGetRepairTech * armGetHitPoints * armGetName * armGetRepairCost * armIsRadiationImmune armortype_functions. See also armor functions See also details on armor items. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) armor_functions https://wiki.kronosaur.com/doku.php/modding/function/armor_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Armor functions * armGetName * armIsRadiationImmune * armGetRepairTech * itmGetArmorInstalledLocation * objGetArmorType * shpGetArmor * shpGetArmorCount * shpGetArmorMaxHitPoints * shpInstallArmor * objGetArmorName * shpDamageArmor * armGetRepairCost * objGetArmorDamage * objRepairArmor * armGetHitPoints armor_functions See also ArmorType Functions See also details on armor items. Return to functions list Func text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) atmaddentry https://wiki.kronosaur.com/doku.php/modding/function/atmaddentry?rev=1419655255&do=diff Discuss this page on this page's Talk Page. atmAddEntry atmAddEntry is not included in the Xelerus list. Syntax (atmAddEntry atmtable number object) -> object Argument List atmtable: variable that contains the table of 'atoms' number: integer that denotes where the atom is contained. Used for lookup. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) atmatomtable https://wiki.kronosaur.com/doku.php/modding/function/atmatomtable?rev=1419655256&do=diff Discuss this page on this page's Talk Page. atmAtomTable atmAtomTable is not included in the Xelerus list. Syntax (atmAtomTable ((atom1 entry1) (atom2 entry2) ... (atomn entryn))) -> atmtable Argument List atom1, atom2, ...: integers used to look up entries in the atom table. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) atmdeleteentry https://wiki.kronosaur.com/doku.php/modding/function/atmdeleteentry?rev=1419655256&do=diff Discuss this page on this page's Talk Page. atmDeleteEntry atmDeleteEntry is not included in the Xelerus list. Syntax (atmDeleteEntry atmtable atom) -> unknown Argument List atmtable: atom table from which entry is being deleted. atom: integer that denotes the entry to be deleted. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) atmlist https://wiki.kronosaur.com/doku.php/modding/function/atmlist?rev=1419655255&do=diff Discuss this page on this page's Talk Page. atmList atmList is not included in the Xelerus list. Syntax (atmList atmtable) -> list Argument List atmtable: The atom table to be listed. Returns list: List of integer atom values (as used to look up entries). text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) atmlookup https://wiki.kronosaur.com/doku.php/modding/function/atmlookup?rev=1419655255&do=diff Discuss this page on this page's Talk Page. atmLookup atmLookup is not included in the Xelerus list. Syntax (atmLookup atmtable atom) -> entry Argument List atmtable: The atom table you are looking up an entry in. atom: The integer atom value that specifies the entry to be looked up. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) atom_functions https://wiki.kronosaur.com/doku.php/modding/function/atom_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Atom functions * isAtom * atmAddEntry * atmAtomTable * atmDeleteEntry * atmList * atmLookup atom_functions. Only the isAtom function is included in the Xelerus list. A post by alterecco gives more details on them. IMPORTANT: The atom functions other than isAtom may not yet be fully functional. See text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) block https://wiki.kronosaur.com/doku.php/modding/function/block?rev=1419655255&do=diff block block block Syntax (block list exp1 ... expn) -> value of last expression Arguments list: A list of local variables. Can be Nil or empty. Can contain initial values. exp1 ... expn: A series of expressions (anything you want to do). Returns Whatever the last expression in the block returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) canvas_functions https://wiki.kronosaur.com/doku.php/modding/function/canvas_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Canvas functions * cnvDrawImage * cnvDrawRect * cnvDrawText Canvas functions are not included in the Xelerus list. See PKodan's post for more details. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) cash_functions https://wiki.kronosaur.com/doku.php/modding/function/cash_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Cash functions * objCharge * objCredit * objGetBalance * objGetSellPrice * plyCharge * plyCredit * plyGetCredits * armGetRepairCost * itmGetActualPrice * itmGetInstallCost * itmGetPrice * objGetBuyPrice text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) cat https://wiki.kronosaur.com/doku.php/modding/function/cat?rev=1419655255&do=diff cat cat cat Syntax (cat s1 s2 ... sn) -> string Arguments s1: A string, integer, boolean or literal that you want to concatenate with others s2 ... sn: Optional strings, integers, booleans or literals, each to be contcatenated. Returns string: A string composed of all the arguments concatenated together in the order of the argument list. text/html 2017-06-04T22:10:00+00:00 Anonymous (anonymous@undisclosed.example.com) ceil https://wiki.kronosaur.com/doku.php/modding/function/ceil?rev=1496614200&do=diff Talk Page ceil Syntax (ceil x) -> y Arguments x: A real number Returns y: x after being rounding up Category math Description Rounds up a non-integer to the next integer Example Return to Functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) condition_query_functions https://wiki.kronosaur.com/doku.php/modding/function/condition_query_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Condition query functions * isInt * objIsKnown * objHasAttribute * objHasItem * objIsAbandoned * objIsDeviceSlotAvailable * objIsEnemy * objIsShip * objIsUnderAttack * shpIsFuelCompatible * isfunction text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) control_structure_functions https://wiki.kronosaur.com/doku.php/modding/function/control_structure_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Control structure functions * block * if * switch * errblock control_structure_functions. Return to functions list text/html 2015-08-26T18:46:55+00:00 Anonymous (anonymous@undisclosed.example.com) count https://wiki.kronosaur.com/doku.php/modding/function/count?rev=1440614815&do=diff count count count Syntax (count list) -> number of items Arguments list: A list elements you want to count. Returns integer: The number of elements in the list. Category list Description Counts how many elements are in the list and returns that number. It doesn't care what the elements are they can even be other lists. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) create_functions https://wiki.kronosaur.com/doku.php/modding/function/create_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Create functions * sysCreateEffect * itmCreateRandom * sysCreateShip * sysCreateStation * sysCreateWeaponFire * sysCreateMarker * itmCreateByName * itmCreate create_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) data_functions https://wiki.kronosaur.com/doku.php/modding/function/data_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Data functions * itmGetTypeData * objGetData * objGetStaticData * objIncData * shpGetGlobalData * objSetData * objGetStaticDataForStationType * shpSetGlobalData * staGetGlobalData * staSetGlobalData * sysGetData * sysSetData * typGetGlobalData * typGetStaticData * typIncGlobalData * typSetGlobalData * itmGetData * itmGetGlobalData * objGetGlobalData * itmGetStaticData * itmSetGlobalData data_functions. Retu… text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) dbglog https://wiki.kronosaur.com/doku.php/modding/function/dbglog?rev=1419655255&do=diff Discuss this page on this page's Talk Page dbgLog See dbgLog at Xelerus Syntax (dbgLog expression) -> string Arguments expression: Prints out the expression to the log. Returns string: A string representing what was output to the log file. Category 0.99, debug Description Outputs the expressions to the debug.log file. Can be lists, strings, functions (only outputs the name of the function), or numbers. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) dbgoutput https://wiki.kronosaur.com/doku.php/modding/function/dbgoutput?rev=1419655255&do=diff Discuss this page on this pages TalkPage dbgOutput See dbgOutput at Xelerus Syntax (dbgOutput s1 [s2 ... sn]) Arguments string: The stuff you want outputted to the debug console. If the argument is not a string it will be converted into a string. [s2 ... sn]: More strings to be outputted. They will be concatenated onto the previous strings text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) debug_functions https://wiki.kronosaur.com/doku.php/modding/function/debug_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Debug functions * dbgOutput * dbgLog debug_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) deprecated_functions https://wiki.kronosaur.com/doku.php/modding/function/deprecated_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Deprecated functions Functions whose use is discouraged, but have been retained for compatibility with old mods. * envHasAttribute * plyGetInsuranceClaims * plyInsure * plyIsInsured * shpAddEnergyField text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) divide https://wiki.kronosaur.com/doku.php/modding/function/divide?rev=1419655255&do=diff divide divide divide Syntax (divide x y) -> z Arguments x: The dividend of the two numbers. y: The divisor of the two numbers. Returns z: The result of the two numbers divided with everything after the decimal point dropped. Category math Description Returns the result of the two numbers divided and dropping everything after the decimal point. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) dsf_common https://wiki.kronosaur.com/doku.php/modding/function/dsf_common?rev=1419655255&do=diff dsf_common. DSF Common Functions Data wrappers * dsf_SetData * dsf_GetData * dsf_AppendData * dsf_IncData * dsf_RemoveData * dsf_AddDataStoreKey * dsf_ResetDataStore List helpers * dsf_ListToOID * dsf_ListFromOID * dsf_ListReverse * dsf_ListUnion * dsf_ListIntersect * dsf_ListComplement * dsf_ListMap * dsf_ListReduce * dsf_ListDetect * dsf_ListInsert * dsf_ListSort Hash functions * dsf_HashSet * dsf_HashGet * dsf_HashRemove * dsf_HashFind * ds… text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) encounter_table_functions https://wiki.kronosaur.com/doku.php/modding/function/encounter_table_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Encounter table functions * sysAddEncounterEvent * sysAddEncounterEventAtDist encounter_table_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) enhancement_functions https://wiki.kronosaur.com/doku.php/modding/function/enhancement_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Enhancement functions * itmSetEnhanced * shpEnhanceSRS * shpIsTargetingComputerInstalled * shpIsSRSEnhanced * shpInstallAutopilot * shpInstallTargetingComputer * shpIsAutopilotInstalled * itmIsEnhanced * shpEnhanceItem enhancement_functions. Return to functions list text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) enum https://wiki.kronosaur.com/doku.php/modding/function/enum?rev=1419655256&do=diff enum enum enum Syntax (enum list itemVar exp) -> value Arguments list: A list of elements you want to walk through. itemVar: Name of variable that will be used to hold the current element you are at in the enum. Does not need to be defined beforehand. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) enumwhile https://wiki.kronosaur.com/doku.php/modding/function/enumwhile?rev=1419655255&do=diff Discuss this page on this page's Talk Page enumWhile See enumWhile at Xelerus Syntax (enumWhile list condition itemVar exp) -> value Arguments list: A list of elements you want to walk through. condition: Stops enum if condition is Nil. itemVar: Name of the variable that will be used to hold the current element you are at in the enum. Does not need to be defined beforehand. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) envhasattribute https://wiki.kronosaur.com/doku.php/modding/function/envhasattribute?rev=1419655255&do=diff Discuss this page on this page's Talk Page envHasAttribute See envHasAttribute at Xelerus Syntax (envHasAttribute number string) Arguments number: The unid of the space environment you are querying about. string: The name of the attribute. Returns True if it has it nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) eq https://wiki.kronosaur.com/doku.php/modding/function/eq?rev=1419655256&do=diff eq eq eq Syntax (eq exp1 [exp2 ... expn]) -> True/Nil Arguments exp1: An expression you want to check for equality to other expressions. It will be evaluated, and it's value used for the comparison [exp2 ... expn]: More expressions to compare. Returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) errblock https://wiki.kronosaur.com/doku.php/modding/function/errblock?rev=1419655255&do=diff errblock errblock errblock Syntax (errblock List function1 function) Arguments List: A list of temporary variables. The first variable gets any error stored in it that happens. function: The functions you want to run. 1 function: The function you want to run if there is an error in the other functions. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) error_functions https://wiki.kronosaur.com/doku.php/modding/function/error_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Error functions * iserror * errblock error_functions. Return to functions list text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) eval https://wiki.kronosaur.com/doku.php/modding/function/eval?rev=1419655256&do=diff eval eval eval Syntax (eval expr) -> value of evaluated expression Arguments expression: The thing you want to evaluate. It can handle numbers, function, strings, and lists. What it does, depends on what argument it gets. Returns If it is passed a number or lamdba function it just returns that otherwise tries to run the list as a function and returns what that function returns, or if it is a string it returns the value of the variable with that name. text/html 2015-08-19T14:13:20+00:00 Anonymous (anonymous@undisclosed.example.com) event_functions https://wiki.kronosaur.com/doku.php/modding/function/event_functions?rev=1439993600&do=diff Discuss this page on this page's Talk Page. * EVENT RELATED FUNCTIONS: * (msnAddRecurringTimerEvent missionObj interval event) * (msnAddTimerEvent missionObj delay event) * (msnCancelTimerEvent missionObj event) -> True/Nil * (msnFireEvent missionObj event [data]) text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) extitmcreaterandomstats https://wiki.kronosaur.com/doku.php/modding/function/extitmcreaterandomstats?rev=1419655256&do=diff Discuss this page on this page's Talk Page. extItmCreateRandomStats See forum post by alterecco. Syntax (extItmCreateRandomStats levelstring(s) criteria iterations) -> table(s) Argument List levelstring(s): list of level strings used in calculating table contents. criteria: types of items that are valid for inclusion in calculations. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) extstringtodieroll https://wiki.kronosaur.com/doku.php/modding/function/extstringtodieroll?rev=1419655256&do=diff Discuss this page on this page's Talk Page. extStringToDieRoll See forum post by alterecco. Syntax (extStringToDieRoll string) -> number Argument List string: A string that can be interpreted as a number range or dice roll. Returns number: A random number resulting from that dice roll, or selected from that range. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) filter https://wiki.kronosaur.com/doku.php/modding/function/filter?rev=1419655255&do=diff filter filter filter Syntax (filter list variable function) Arguments list: The list that will be filtered. variable: The name of the variable to be used in the function. function: A boolean function that is used to filter the list. Returns list: A list where all elements belong to the passed in list and return true for the boolean function. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) find https://wiki.kronosaur.com/doku.php/modding/function/find?rev=1419655255&do=diff find find find Syntax (find source target [keyIndex]) -> position of target in source (0-based) Arguments source: The string or list that you are looking for the other expression in. target: The expression you are looking for. [keyindex]: The index in the source you want to start looking at text/html 2017-06-04T22:11:49+00:00 Anonymous (anonymous@undisclosed.example.com) floor https://wiki.kronosaur.com/doku.php/modding/function/floor?rev=1496614309&do=diff Talk Page floor Syntax (floor x) -> y Arguments x: A real number Returns y: x after being rounded down Category math Description Rounds down a non-integer to the previous integer Example Return to Functions list text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) fnchelp https://wiki.kronosaur.com/doku.php/modding/function/fnchelp?rev=1419655256&do=diff fnchelp fnchelp fnchelp Syntax (fnchelp function) Arguments function: The function that you want to get the help text of. Returns string: The help text of the passes in function. Category function Description Returns the help text for the given function. Example text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) for https://wiki.kronosaur.com/doku.php/modding/function/for?rev=1419655255&do=diff for for for Syntax (for var from to exp) -> value of last expression Arguments var: The storage for the counter. This will increase by one at the end of the function every time it is run. from: The number that will be the initial value to: The last number that the variable will be run as. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) function_functions https://wiki.kronosaur.com/doku.php/modding/function/function_functions?rev=1419655255&do=diff function_functions. function functions * sysGlobals * fnchelp * isPrimitive The isPrimitive function is not included in the Xelerus list. function_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) function_operator_functions https://wiki.kronosaur.com/doku.php/modding/function/function_operator_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Function operator functions * apply * eval * isfunction * lambda * link function_operator_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) game_functions https://wiki.kronosaur.com/doku.php/modding/function/game_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Game functions * gamSetCrawlImage * gamSetCrawlText Game functions are not included in the Xelerus list. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) geq https://wiki.kronosaur.com/doku.php/modding/function/geq?rev=1419655255&do=diff geq geq geq Syntax (geq a [b ... bn]) -> True if a >= b >= bn Arguments a: The first expression you want to compare. [b ... bn]: The next expressions you want to compare. Returns boolean: The expressions are compared left to right. If there is any case where the left value is text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) globals https://wiki.kronosaur.com/doku.php/modding/function/globals?rev=1419655255&do=diff globals Global variables in Transcendence * gPlayer: Object representing the player. Very useful for many functions, such as plyMessage and other player functions. * gPlayerShip: The id of the player's ship. * gScreen: The id of the DockScreen. This is a static id that does not change throughout the game. It has text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) globals_talk_page https://wiki.kronosaur.com/doku.php/modding/function/globals_talk_page?rev=1419655255&do=diff This is the Talk Page for Globals Globals: Talk Page Re: Recent update I took the liberty of editing this page a bit and adding some info. The globals have nothing in particular to do with DockScreens, so I thought we should avoid inferring that. alterecco " " text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) gr https://wiki.kronosaur.com/doku.php/modding/function/gr?rev=1419655255&do=diff gr gr gr Syntax (gr a [b ... bn]) -> True if a > b > bn Arguments a: The first expression you want to compare. [b ... bn]: The next expressions you want to compare. Returns boolean: The expressions are compared left to right. If there is any case where the left value is less or equal to the right value, `gr' will return Nil. Else it returns True. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) help_functions https://wiki.kronosaur.com/doku.php/modding/function/help_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Help functions * plyClearShowHelpRefuel help_functions. Return to functions list text/html 2017-01-25T23:31:55+00:00 Anonymous (anonymous@undisclosed.example.com) if https://wiki.kronosaur.com/doku.php/modding/function/if?rev=1485387115&do=diff Discuss this page if See if at Xelerus Syntax (if condition exp1 [exp2]) -> value Arguments condition: anything that evaluates to Nil or non-Nil exp1: an expression that gets evaluated if 'condition' evaluates to non-Nil (if it is 'true') [exp2]: an optional expression that gets evaluated if 'condition' evaluates to Nil (i.e. is 'false') text/html 2017-01-20T23:08:34+00:00 Anonymous (anonymous@undisclosed.example.com) index_talk_page https://wiki.kronosaur.com/doku.php/modding/function/index_talk_page?rev=1484953714&do=diff This is the Talk Page for the index of the functions namespace. index: Talk Page Function categories This page is being restructured. Please do not add to the table of functions on the bottom. -Xephyr ---------- " The following is a version of the functions text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) input_functions https://wiki.kronosaur.com/doku.php/modding/function/input_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Input functions * scrGetCounter * scrGetInputText * scrGetListEntry * scrGetItem * scrGetItemListCursor * scrSetCounter scrGetListEntry is not included in the Xelerus list. input_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) install_functions https://wiki.kronosaur.com/doku.php/modding/function/install_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Install functions * shpInstallArmor * shpInstallDevice * shpInstallTargetingComputer * shpRemoveDevice install_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) insurance_functions https://wiki.kronosaur.com/doku.php/modding/function/insurance_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Insurance functions * plyGetInsuranceClaims * plyInsure * plyIsInsured insurance_functions. Return to functions list text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) int https://wiki.kronosaur.com/doku.php/modding/function/int?rev=1419655256&do=diff int int int Syntax (int string) Arguments string: a string you want returned as number Returns number: the integer version of the string Category 0.99, string operator Description Takes a string representation of a number and returns it as an actual number. I can also convert hexadecimal strings. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) isatom https://wiki.kronosaur.com/doku.php/modding/function/isatom?rev=1419655256&do=diff Discuss this page on this pages TalkPage isAtom See isAtom at Xelerus Syntax (isAtom expr) -> True/Nil Arguments expr: The expression you want to test for being an atom. Returns boolean: True if the expression is an atom, Nil otherwise. Category atom, condition query Description Returns True if the expression is an atom. An atom is anything that can not be split up (*hrhhmm*), so it includes everything that is not a list. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) iserror https://wiki.kronosaur.com/doku.php/modding/function/iserror?rev=1419655255&do=diff iserror iserror iserror Syntax (iserror expression) Arguments expression: The expression that you want run and see if it is an error. Returns conditional: True if it does contain an error, Nil otherwise. Category error Description Returns if the expression evaluated to an error or not. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) isfunction https://wiki.kronosaur.com/doku.php/modding/function/isfunction?rev=1419655256&do=diff isfunction isfunction isfunction Syntax (isfunction expr) -> True/Nil Arguments expr: The expression you want to test for being a function (lambda or builtin). Returns boolean: True if the expression is a function (lambda or builtin). Nil otherwise. Category condition query, text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) isint https://wiki.kronosaur.com/doku.php/modding/function/isint?rev=1419655255&do=diff Discuss this page on this pages TalkPage isInt See isInt at Xelerus Syntax (isInt expr) -> True/Nil Arguments expr: The expression you want to test for being an integer. Returns boolean: True if expression is an integer. Nil otherwise. Category condition query Description Checks to see if the expression is an integer and if it is returns True. Otherwise returns Nil. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) item https://wiki.kronosaur.com/doku.php/modding/function/item?rev=1419655256&do=diff item item item Syntax (item list index) -> list item or Nil Arguments list: the list you want to get an element from. index: the integer position of the element you want to get. Returns If index is less than zero, return first element. If the index is greater or equal than the length of the list, return Nil. Otherwise return the element at given index in the list. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) item_functions https://wiki.kronosaur.com/doku.php/modding/function/item_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Item functions * itmAtCursor * itmCreate * itmCreateByName * itmCreateRandom * itmEnumTypes * itmGetActualPrice * itmGetArmorInstalledLocation * itmGetArmorType * itmGetAverageAppearing * itmGetCategory * itmGetCharges * itmGetCount * itmGetDamageType * itmGetData * itmGetFrequency * itmGetGlobalData * itmGetImageDesc * itmGetInstallCost * itmGetInstallPos * itmGetLevel * itmGetMass * itmGetMaxAppearing * … text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) iteration_functions https://wiki.kronosaur.com/doku.php/modding/function/iteration_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Iteration functions * enum * for * loop * enumWhile * itmEnumTypes * objEnumItems iteration_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmcreate https://wiki.kronosaur.com/doku.php/modding/function/itmcreate?rev=1419655255&do=diff Discuss this page on this page's Talk Page itmCreate See itmCreate at Xelerus Syntax (itmCreate itemUNID count) -> item Arguments itemUNID: The UNID of the item you want to create. count: The amount of items you want to create. Returns item: An itemStruct of the items you created. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmcreatebyname https://wiki.kronosaur.com/doku.php/modding/function/itmcreatebyname?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmCreateByName See itmCreateByName at Xelerus Syntax (itmCreateByName criteria name [count]) -> item Arguments criteria: the criteria that the item must meet. name: the name or part of the name of the item to create. [count]: the optional number of items you want to create. If not given, one item will be created. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmcreaterandom https://wiki.kronosaur.com/doku.php/modding/function/itmcreaterandom?rev=1419655256&do=diff Discuss this page on this page's Talk Page itmCreateRandom See itmCreateRandom at Xelerus Syntax (itmCreateRandom criteria levelDistribution) -> item Arguments criteria: A string representing the criteria of the item you want to create. levelDistribution: A formatted string specifying what rarity of items will appear at what level. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmenumtypes https://wiki.kronosaur.com/doku.php/modding/function/itmenumtypes?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmEnumTypes See itmEnumTypes at Xelerus Syntax (itmEnumTypes criteria itemVar exp) -> value of last expression Arguments criteria: The criteria an item must meet to be enumerated. itemVar: The name of a variable that will contain each item that we are enumerating. Does not need to be defined beforehand. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetactualprice https://wiki.kronosaur.com/doku.php/modding/function/itmgetactualprice?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetActualPrice See itmGetActualPrice at Xelerus Syntax (itmGetActualPrice item) -> actual price of a single item Arguments item: The item from what you want to get the real price from. Must be an itemStruct, not a UNID Returns integer: The actual price of the object. It ignores the unknown price (like barrels before you use them all cost the same, this would see past that) text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetarmorinstalledlocation https://wiki.kronosaur.com/doku.php/modding/function/itmgetarmorinstalledlocation?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetArmorInstalledLocation See itmGetArmorInstalledLocation at Xelerus Syntax (itmGetArmorInstalledLocation item) -> segment # Arguments item: The item of armor you want to know the location of. Must be an itemStruct not a UNID Returns -1 one if not installed, otherwise returns the segment number of where it is installed. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetcategory https://wiki.kronosaur.com/doku.php/modding/function/itmgetcategory?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetCategory See itmGetCategory at Xelerus Syntax (itmGetCategory item) -> item category Arguments item: The item you want to know the category of. Returns An integer representing what category the item belongs to. See description for categories. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetcharges https://wiki.kronosaur.com/doku.php/modding/function/itmgetcharges?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetCharges See itmGetCharges at Xelerus Syntax (itmGetCharges item) -> charges Arguments item: The itemStruct of the item you want to get the charges from. Returns The number of charges. Category 0.99, item Description Returns the number of charges. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetcount https://wiki.kronosaur.com/doku.php/modding/function/itmgetcount?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetCount See itmGetCount at Xelerus Syntax (itmGetCount item) -> count Arguments item: The itemStruct of the item you want to get the number of items from. Returns The number of items. Category item Description Returns the number of items. An itemsStruct can contain many items, represented as a stack. This function is used for getting the number of items in that stack text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetdamagetype https://wiki.kronosaur.com/doku.php/modding/function/itmgetdamagetype?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetDamageType See itmGetDamageType at Xelerus Syntax (itmGetDamageType item) -> damage type Arguments item: The itemStruct of the item you want to get the damage type of. Returns The number of the items damage type if it is a weapon. Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetdata https://wiki.kronosaur.com/doku.php/modding/function/itmgetdata?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmGetData See itmGetData at Xelerus Syntax (itmGetData itemStruct string) Arguments itemStruct: The item you want to get the data from. string: The name of the data. Returns The data named by the string from the item. Returns Nil if there is no data as named by the string. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetfrequency https://wiki.kronosaur.com/doku.php/modding/function/itmgetfrequency?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetFrequency See itmGetFrequency at Xelerus Syntax (itmGetFrequency item) -> frequency Arguments item: The itemStruct of the item you want to get the frequency of. Returns An integer representing the frequency. Category item Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetglobaldata https://wiki.kronosaur.com/doku.php/modding/function/itmgetglobaldata?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmGetGlobalData See itmGetGlobalData at Xelerus Syntax (itmGetGlobalData itemStruct string) Arguments itemStruct : The item struct of the item that you want the data from. string: The name of the data you want. Returns The data named by the string from the item struct type. All space objects in the same class share the same global data. Returns Nil if there is no data as named by the string. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetinstallcost https://wiki.kronosaur.com/doku.php/modding/function/itmgetinstallcost?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetInstallCost See itmGetInstallCost at Xelerus Syntax (itmGetInstallCost item) -> cost Arguments item: The itemStruct of the item you want to get the install cost of. Returns The cost to install the item. Category cash, item Description Returns the cost to install the item. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetlevel https://wiki.kronosaur.com/doku.php/modding/function/itmgetlevel?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetLevel See itmGetLevel at Xelerus Syntax (itmGetLevel item) -> level Arguments item: The itemStruct of the item you want to get the level of. Returns The level of the item. Category item Description Returns the level of the item. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetmass https://wiki.kronosaur.com/doku.php/modding/function/itmgetmass?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetMass See itmGetMass at Xelerus Syntax (itmGetMass item) -> mass of single item in Kg Arguments item: The itemStruct of the item you want to get the mass of. Returns The mass of the item in Kg. Category item Description Returns the mass of the item. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetmaxappearing https://wiki.kronosaur.com/doku.php/modding/function/itmgetmaxappearing?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmGetMaxAppearing See itmGetMaxAppearing at Xelerus Syntax (itmGetMaxAppearing item) -> max number that appear randomly Arguments item: The itemStruct of the item you want to get the max number of appearing. Returns The max number that will appear randomly. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetname https://wiki.kronosaur.com/doku.php/modding/function/itmgetname?rev=1419655255&do=diff Discuss this page on this page's Talk Page itmGetName See itmGetName at Xelerus Syntax (itmGetName item flags) -> name Arguments item: The itemStruct of the item you want to get the name of. flags: The flags to determine what form of the name is to be used. Returns The name of the item. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetprice https://wiki.kronosaur.com/doku.php/modding/function/itmgetprice?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmGetPrice See itmGetPrice at Xelerus Syntax (itmGetPrice item) -> price of a single item Arguments item: The itemStruct of the item you want to get the value of. Returns If unknown returns the value of the unknown type otherwise returns the value of the item. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetstaticdata https://wiki.kronosaur.com/doku.php/modding/function/itmgetstaticdata?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmGetStaticData See itmGetStaticData at Xelerus Syntax (itmGetStaticData itemStruct string) Arguments itemStruct: The item struct of the type you want to get the static data from. string: The name of the static data. Returns data: The data from the xml named by the string from the item structs type. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmgettypes https://wiki.kronosaur.com/doku.php/modding/function/itmgettypes?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmGetTypes See itmGetTypes at Xelerus Syntax (itmGetTypes criteria) -> list of itemUNIDs Arguments criteria: a string that limits which items will be returned. Returns a list of item UNID's containing all the items in game (including mods) that match the criteria specified text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetunid https://wiki.kronosaur.com/doku.php/modding/function/itmgetunid?rev=1419655255&do=diff Discuss this page on this page's Talk Page itmGetUNID See itmGetUNID at Xelerus Syntax (itmGetUNID item) -> itemUNID Arguments item: The itemStruct of the item you want to get the UNID of. Returns The UNID of the item. Category item, UNID Description Returns the UNID of the item. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmgetusescreen https://wiki.kronosaur.com/doku.php/modding/function/itmgetusescreen?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmGetUseScreen See itmGetUseScreen at Xelerus Syntax (itmGetUseScreen item) -> screenUNID or Nil Arguments item: The itemStruct of the item you want to get the use screen UNID from. Returns The use screen UNID of the item, or Nil if it has none text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmhasattribute https://wiki.kronosaur.com/doku.php/modding/function/itmhasattribute?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmHasAttribute See itmHasAttribute at Xelerus Syntax (itmHasAttribute item attrib) -> True/Nil Arguments item: The item you want to test attrib: The attribute you want to test Returns True if the 'item' contains the 'attrib', Nil otherwise text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmhasreference https://wiki.kronosaur.com/doku.php/modding/function/itmhasreference?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmHasReference See itmHasReference at Xelerus Syntax (itmHasReference item) -> True/Nil Arguments item: The itemStruct of the item you want to test. Returns boolean: True if the item is referenced, Nil otherwise. Category condition query, item Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmisdamaged https://wiki.kronosaur.com/doku.php/modding/function/itmisdamaged?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmIsDamaged See itmIsDamaged at Xelerus Syntax (itmIsDamaged item) -> True/Nil Arguments item: The itemStruct of the item you want to check for damage. Returns boolean: True if the item is damaged, Nil otherwise. Category condition query, item, damage Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmisenhanced https://wiki.kronosaur.com/doku.php/modding/function/itmisenhanced?rev=1419655256&do=diff Discuss this page on this page's Talk Page itmIsEnhanced See itmIsEnhanced at Xelerus Syntax (itmIsEnhanced item) -> enhancement Arguments item: The itemStruct of the item you want to get the enhancement status of. Returns enhancement: Either the enhancement flag (if it is enhanced) or Nil. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmisinstalled https://wiki.kronosaur.com/doku.php/modding/function/itmisinstalled?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmIsInstalled See itmIsInstalled at Xelerus Syntax (itmIsInstalled item) -> True/Nil Arguments item: The itemStruct of the item you want to see if it is installed or not. Returns condition: True if the item is installed, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmisknown https://wiki.kronosaur.com/doku.php/modding/function/itmisknown?rev=1419655256&do=diff Discuss this page on this page's Talk Page itmIsKnown See itmIsKnown at Xelerus Syntax (itmIsKnown item) -> True/Nil Arguments item: The itemStruct of the item you want to test. Returns condition: True if the item is known, Nil otherwise. Category condition query, item Description Query function to see if the item is known. For more on known items, see item criteria on the text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmmatches https://wiki.kronosaur.com/doku.php/modding/function/itmmatches?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmMatches See itmMatches at Xelerus Syntax (itmMatches item criteria) -> True/Nil Arguments item: The itemStruct of the item you want to test. criteria: The criteria you want to test if the item matches. Returns boolean: True if the item matches the criteria, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmsetcharges https://wiki.kronosaur.com/doku.php/modding/function/itmsetcharges?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmSetCharges See itmSetCharges at Xelerus Syntax (itmSetCharges item charges) -> item Arguments item: the item whose charges you want to change charges: the amount of charges you want to make the item have Returns a new item, with the charges set. This item contains all other attributes of the original item text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmsetcount https://wiki.kronosaur.com/doku.php/modding/function/itmsetcount?rev=1419655256&do=diff Discuss this page on this pages TalkPage itmSetCount See itmSetCount at Xelerus Syntax (itmSetCount item count) -> item Arguments item: the item whose stack count you want to set count: the count you want the item stack to have Returns a new item, with the stack count you specified. You should use this item in place of the one you modified to keep the changes text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmsetdamaged https://wiki.kronosaur.com/doku.php/modding/function/itmsetdamaged?rev=1419655255&do=diff Discuss this page on this page's Talk Page itmSetDamaged See itmSetDamaged at Xelerus Syntax (itmSetDamaged itemStruct [boolean]) -> itemStruct Arguments itemStruct: The item you want to create a damaged or undamaged version of. boolean: An optional argument that if true makes the returned item damaged and if not makes it undamaged. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmsetenhanced https://wiki.kronosaur.com/doku.php/modding/function/itmsetenhanced?rev=1419655255&do=diff Discuss this page on this page's Talk Page itmSetEnhanced See itmSetEnhanced at Xelerus Syntax (itmSetEnhanced item mods) -> item Arguments item: The itemStruct of the item you want to enhance. enhanceflag: The flag saying what what type of enhancement you want to enhance the item with. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmsetglobaldata https://wiki.kronosaur.com/doku.php/modding/function/itmsetglobaldata?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmSetGlobalData See itmSetGlobalData at Xelerus Syntax (itmSetGlobalData itemStruct string expression) Arguments itemStruct: The item struct of the type you want to set global data to. string: The name of the data you are setting. expression: The value you want to be set. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) itmsetknown https://wiki.kronosaur.com/doku.php/modding/function/itmsetknown?rev=1419655256&do=diff Discuss this page on this page's Talk Page itmSetKnown See itmSetKnown at Xelerus Syntax (itmSetKnown {item | itemUNID}) -> True or Error Arguments item: An itemStruct or the UNID of the item you want to make known. Returns True if successful, or an Error if the argument is not an item text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) itmsetreference https://wiki.kronosaur.com/doku.php/modding/function/itmsetreference?rev=1419655255&do=diff Discuss this page on this pages TalkPage itmSetReference See itmSetReference at Xelerus Syntax (itmSetReference item) -> True or Error Arguments item: The itemStruct of the item you want to make referenced. Returns Almost always returns True. If passed a non-item arguement, it will return an Error text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) lambda https://wiki.kronosaur.com/doku.php/modding/function/lambda?rev=1419655255&do=diff lambda lambda lambda Syntax (lambda args exp) -> lambda Arguments args: A list of arguments you want to pass into the function. Can also be Nil. exp: The code you want to pass the arguments to. It is not evaluated. Returns The new function. Category text/html 2017-09-19T04:27:15+00:00 Anonymous (anonymous@undisclosed.example.com) legend https://wiki.kronosaur.com/doku.php/modding/function/legend?rev=1505795235&do=diff TIPS and TRICKS On Ministry, you can use Inactive + API Spec to see all the updates that George has done. You can CTRL+CLICK to set the default tab on dockscreens. Function Legend This page will contain a legend for terms often used when talking about Transcendence functions and their syntax. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) leq https://wiki.kronosaur.com/doku.php/modding/function/leq?rev=1419655255&do=diff leq leq leq Syntax (leq a [b ... bn]) -> True if a &lt;= b &lt;= bn Arguments a: The first expression you want to compare. [b ... bn]: The next expressions you want to compare. Returns boolean: The expressions are compared left to right. If there is any case where the left value is text/html 2017-06-04T22:36:38+00:00 Anonymous (anonymous@undisclosed.example.com) link https://wiki.kronosaur.com/doku.php/modding/function/link?rev=1496615798&do=diff Talk Page link Syntax (link string) -> data Arguments string: A string that may contain a list or struct Returns data: If list or struct that was contained in the string, then it returns that if it was properly formatted or an error if not. Returns True text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) list https://wiki.kronosaur.com/doku.php/modding/function/list?rev=1419655255&do=diff Discuss this page on this page's Talk Page list list Syntax (list i1 [i2 ... in]) -> list Arguments i1: expression you want to be an element of the list. i2 ... in: (Optional) Expressions you want to be elements of the list Returns list: A list of all the expressions passed as arguments. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) list_functions https://wiki.kronosaur.com/doku.php/modding/function/list_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. List functions * append * count * enum * enumWhile * item * list * lnkAppend * lnkRemove * lnkRemoveNil * lnkReplace * filter * subset * shuffle * find Subset is not included in the Xelerus list. list_functions. Return to functions list text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) lnkappend https://wiki.kronosaur.com/doku.php/modding/function/lnkappend?rev=1419655256&do=diff Discuss this page on this pages TalkPage lnkAppend See lnkAppend at Xelerus Syntax (lnkAppend list item) -> list Arguments list: the list you want to append the expression to, as the last element. item: The expression you want to append as the last element of the list. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) lnkremove https://wiki.kronosaur.com/doku.php/modding/function/lnkremove?rev=1419655255&do=diff Discuss this page on this page's Talk Page lnkRemove See lnkRemove at Xelerus Syntax (lnkRemove list index Nil) -> list Arguments list: The list you want to remove the element at `index' from. index: the position of the element you want to remove, counting from 0. Nil: this is a bug, but must be present. It has no effect on the function. The only reasonable value to pass is Nil. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) lnkremovenil https://wiki.kronosaur.com/doku.php/modding/function/lnkremovenil?rev=1419655256&do=diff Discuss this page on this pages TalkPage lnkRemoveNil See lnkRemoveNil at Xelerus Syntax (lnkRemoveNil list) -> list Arguments list: The list where you want to remove all values that are Nil. Returns A list with all the elements that equal Nil removed. Category list Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) lnkreplace https://wiki.kronosaur.com/doku.php/modding/function/lnkreplace?rev=1419655255&do=diff Discuss this page on this pages TalkPage lnkReplace See lnkReplace at Xelerus Syntax (lnkReplace list index item) -> list Arguments list: The list in which you want to replace an element. index: The position of the item in the list which you want to replace with a new item. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) logical_operator_functions https://wiki.kronosaur.com/doku.php/modding/function/logical_operator_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Logical operator functions * and * eq * geq or >= * gr or > * leq or <= * ls or < * not * or The functions >=, >, <= and < are not included in the xelerus list, but are believed to be equivalent to the text versions. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) loop https://wiki.kronosaur.com/doku.php/modding/function/loop?rev=1419655255&do=diff loop loop loop Syntax (loop condition exp) -> value of last expression Arguments condition: The function keeps on running as long as the condition is not Nil. exp: The expression you want to evaluate as long as the condition is not Nil. Returns Whatever the last evaluated expression returns. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) ls https://wiki.kronosaur.com/doku.php/modding/function/ls?rev=1419655255&do=diff ls ls ls Syntax (ls a [b ... bn]) -> True if a &lt; b &lt; bn Arguments a: The first expression you want to compare. [b ... bn]: The next expressions you want to compare. Returns boolean: The expressions are compared left to right. If there is any case where the left value is text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) math_functions https://wiki.kronosaur.com/doku.php/modding/function/math_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Math functions * abs * divide * modulus (changed) * multiply * add * subtract * modulo * max * min * typIncGlobalData * sqrt * power The abs function is not included in the Xelerus list. math_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) max https://wiki.kronosaur.com/doku.php/modding/function/max?rev=1419655255&do=diff max max max Syntax (max expression [number]1) Arguments expression: A list or a number to find the greatest of. number: One of the numbers that you want to find the greatest of. Returns number: The greatest of the passed in numbers. Category 0.99, text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) message_functions https://wiki.kronosaur.com/doku.php/modding/function/message_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Message functions * objSendMessage * plyGetRedirectMessage * plyRedirectMessage * plyMessage message_functions. Return to functions list text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) min https://wiki.kronosaur.com/doku.php/modding/function/min?rev=1419655256&do=diff min min min Syntax (min expression [number]1) Arguments expression: A list or a number to find the least of. number: One of the numbers that you want to find the least of. Returns number: Returns the least of the passed in numbers. Category 0.99, math text/html 2017-01-20T06:11:45+00:00 Anonymous (anonymous@undisclosed.example.com) mission_functions https://wiki.kronosaur.com/doku.php/modding/function/mission_functions?rev=1484892705&do=diff Discuss this page on this page's Talk Page. Mission functions * msnAccept * msnAddTimerEvent * msnAddRecurringTimerEvent * msnCancelTimerEvent * msnCreate * msnDecline * msnDestroy * msnFailure * msnFind * msnFireEvent * msnGetData * msnGetObjRefData * msnGetProperty * msnGetStaticData * msnIncData * msnRegisterForEvents * msnReward * msnSetData * msnSetObjRefData * msnSetPlayerTarget * msnSetProperty * msnSetUnavailable * msnSuccess * msnTransla… text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) modulo https://wiki.kronosaur.com/doku.php/modding/function/modulo?rev=1419655256&do=diff modulo modulo modulo Syntax (modulo dividend divisor) -> remainder Arguments dividend: The dividend of the two numbers. divisor: The divisor of the two numbers. Returns remainder: The remainder of the two numbers passed Category 0.99, math Description Finds the remainder of the two numbers and returns it. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) modulus https://wiki.kronosaur.com/doku.php/modding/function/modulus?rev=1419655255&do=diff modulus. modulus modulus Syntax (modulus dividend divisor) -> remainder Argument List dividend: The dividend of the two numbers. divisor: The divisor of the two numbers. Returns remainder: The remainder of the two numbers passed Category math Description text/html 2017-01-31T22:31:44+00:00 Anonymous (anonymous@undisclosed.example.com) msnaccept https://wiki.kronosaur.com/doku.php/modding/function/msnaccept?rev=1485901904&do=diff Discuss this page on this pages TalkPage msnAccept Syntax (msnAccept missionObj) Arguments missionObj: the mission object to accept Returns Category mission_functions Description Accepts a mission, and calls the <OnAccepted> event on the mission type. Example (block (theMission) (setq theMission (msnCreate &msMissionExample; Nil)) (msnAccept theMission) text/html 2017-01-31T22:29:58+00:00 Anonymous (anonymous@undisclosed.example.com) msnaddrecurringtimerevent https://wiki.kronosaur.com/doku.php/modding/function/msnaddrecurringtimerevent?rev=1485901798&do=diff Discuss this page on this pages TalkPage msnAddRecurringTimerEvent Syntax (msnAddRecurringTimerEvent missionObj interval event) Arguments missionObj: The mission object to add the event to interval: the delay, in ticks, between firing the event event: the event to fire text/html 2017-01-31T22:32:13+00:00 Anonymous (anonymous@undisclosed.example.com) msnaddtimerevent https://wiki.kronosaur.com/doku.php/modding/function/msnaddtimerevent?rev=1485901933&do=diff Discuss this page on this pages TalkPage msnAddTimerEvent Syntax (msnAddTimerEvent missionObj delay event) Arguments missionObj: The mission object to add the event to delay: the delay, in ticks, before the event fires event: the event to fire Returns text/html 2017-01-23T02:13:40+00:00 Anonymous (anonymous@undisclosed.example.com) msncanceltimerevent https://wiki.kronosaur.com/doku.php/modding/function/msncanceltimerevent?rev=1485137620&do=diff Discuss this page on this pages TalkPage msnCancelTimerEvent Syntax (msnCancelTimerEvent missionObj event) Arguments missionObj: The mission object the timer event is on event: the timer event to cancel Returns True if successful, Nil otherwise Category text/html 2017-01-31T22:30:45+00:00 Anonymous (anonymous@undisclosed.example.com) msncreate https://wiki.kronosaur.com/doku.php/modding/function/msncreate?rev=1485901845&do=diff Discuss this page on this pages TalkPage msnCreate Syntax (msnCreate unid owner [data]) Arguments unid: the unid of the mission object owner: the space object the mission is stored on (can be nil) data: data to pass on to the mission Returns The mission object if successful, Nil otherwise text/html 2017-01-31T22:31:10+00:00 Anonymous (anonymous@undisclosed.example.com) msndecline https://wiki.kronosaur.com/doku.php/modding/function/msndecline?rev=1485901870&do=diff Discuss this page on this pages TalkPage msnDecline Syntax (msnDecline missionObj) Arguments missionObj: the mission object to decline Returns Category mission_functions Description Declines a mission. and calls the OnDeclined event on the mission object. Example text/html 2017-01-31T22:31:27+00:00 Anonymous (anonymous@undisclosed.example.com) msndestroy https://wiki.kronosaur.com/doku.php/modding/function/msndestroy?rev=1485901887&do=diff Discuss this page on this pages TalkPage msnDestroy Syntax (msnDestroy missionObj) Arguments missionObj: the mission object to destroy Returns True if successful, Nil otherwise Category mission_functions Description Destroys the mission object and calls the mission object's <OnDestroy> event. text/html 2017-01-31T02:16:32+00:00 Anonymous (anonymous@undisclosed.example.com) msnfailure https://wiki.kronosaur.com/doku.php/modding/function/msnfailure?rev=1485828992&do=diff Discuss this page on this pages TalkPage msnFailure Syntax (msnFailure missionObj [data]) Arguments missionObj: the mission object data: arbitrary data to pass on to the mission, which is passed on as gData in the <OnCompleted> event. Returns Category text/html 2017-01-31T22:32:39+00:00 Anonymous (anonymous@undisclosed.example.com) msnfind https://wiki.kronosaur.com/doku.php/modding/function/msnfind?rev=1485901959&do=diff Discuss this page on this pages TalkPage msnFind Syntax (msnFind [source] criteria) Arguments [source]: Optional field; a spaceobject to search for missions from. eg. gSource. criteria: criteria list Returns list of mission objects Category mission_functions Description text/html 2017-01-31T22:32:55+00:00 Anonymous (anonymous@undisclosed.example.com) msnfireevent https://wiki.kronosaur.com/doku.php/modding/function/msnfireevent?rev=1485901975&do=diff Discuss this page on this pages TalkPage msnFireEvent Syntax (msnFireEvent missionObj event [data]) Arguments missionObj: the mission object event: the event to fire. data: arbitrary data to pass on to the event, which is passed on as gData in the event. text/html 2017-01-31T22:33:16+00:00 Anonymous (anonymous@undisclosed.example.com) msngetdata https://wiki.kronosaur.com/doku.php/modding/function/msngetdata?rev=1485901996&do=diff Discuss this page on this pages TalkPage msnGetData Syntax (msnGetData missionObj attrib) Arguments missionObj: the mission object the data is stored on attrib: Name of the data to retrieve Returns Category mission_functions Description retrieves the named data stored on the mission object. text/html 2017-02-02T20:37:43+00:00 Anonymous (anonymous@undisclosed.example.com) msngetproperty https://wiki.kronosaur.com/doku.php/modding/function/msngetproperty?rev=1486067863&do=diff Discuss this page on this pages TalkPage msnGetProperty Syntax (msnGetProperty missionObj property) Arguments missionObj: The mission object to get the property from property: The property to retrieve Returns value Category mission_functions Description Returns a certain property of a given mission type. text/html 2017-01-31T22:33:59+00:00 Anonymous (anonymous@undisclosed.example.com) msngetstaticdata https://wiki.kronosaur.com/doku.php/modding/function/msngetstaticdata?rev=1485902039&do=diff Discuss this page on this page's Talk Page msnGetStaticData Syntax (msnGetStaticData missionObj attrib) Arguments missionObj: The mission object you want to get the static data from. attrib: The name of the static data. Returns the data Category data, text/html 2017-01-31T22:34:25+00:00 Anonymous (anonymous@undisclosed.example.com) msnincdata https://wiki.kronosaur.com/doku.php/modding/function/msnincdata?rev=1485902065&do=diff Discuss this page on this page's Talk Page msnIncData Syntax (msnIncData missionObj attrib [increment]) Arguments missionObj: The mission object you want to increase data on. attrib: The name of the data to increase. [increment] : The value to add to the data text/html 2017-01-31T22:34:43+00:00 Anonymous (anonymous@undisclosed.example.com) msnregisterforevents https://wiki.kronosaur.com/doku.php/modding/function/msnregisterforevents?rev=1485902083&do=diff Discuss this page on this page's Talk Page msnRegisterForEvents Syntax (msnRegisterForEvents missionObj obj) Arguments missionObj: The mission object the event is stored on. obj: The spaceObject to receive the event Returns Category mission functions Description Allows a spaceObject to receive events from a mission object. text/html 2017-01-31T22:35:29+00:00 Anonymous (anonymous@undisclosed.example.com) msnreward https://wiki.kronosaur.com/doku.php/modding/function/msnreward?rev=1485902129&do=diff Discuss this page on this page's Talk Page msnReward Syntax (msnReward missionObj [data]) Arguments missionObj: The mission object. data: Data to pass on to <OnReward>. Returns Category data functions, mission functions Description Calls the <OnReward> event on the mission object, passing on the optional data. text/html 2017-01-31T22:35:40+00:00 Anonymous (anonymous@undisclosed.example.com) msnsetdata https://wiki.kronosaur.com/doku.php/modding/function/msnsetdata?rev=1485902140&do=diff Discuss this page on this page's Talk Page msnSetData Syntax (msnSetData missionObj attrib data) Arguments missionObj: The mission object. attrib: Name of the data field to set. data: New value to set the data to. Returns Category data functions, mission functions Description text/html 2017-01-31T22:36:00+00:00 Anonymous (anonymous@undisclosed.example.com) msnsetplayertarget https://wiki.kronosaur.com/doku.php/modding/function/msnsetplayertarget?rev=1485902160&do=diff Discuss this page on this page's Talk Page msnsetplayertarget Syntax (msnSetPlayerTarget missionObj) Arguments missionObj: The mission object to get the target from. Returns Category mission functions Description Calls the <OnSetPlayerTarget> event on the mission object. text/html 2017-01-31T22:36:15+00:00 Anonymous (anonymous@undisclosed.example.com) msnsetproperty https://wiki.kronosaur.com/doku.php/modding/function/msnsetproperty?rev=1485902175&do=diff Discuss this page on this pages TalkPage msnSetProperty Syntax (msnSetProperty obj property value) Arguments obj: the object to set the property on property: the property to set value: the new value. see “properties” table below. Returns True if succesful, Nil otherwise text/html 2017-01-31T22:36:58+00:00 Anonymous (anonymous@undisclosed.example.com) msnsetunavailable https://wiki.kronosaur.com/doku.php/modding/function/msnsetunavailable?rev=1485902218&do=diff Discuss this page on this page's Talk Page msnSetUnavailable Syntax (msnSetUnavailable missionObj) Arguments missionObj: The mission object to make unavailable. Returns Category mission functions Description Starts the mission without the player, running the <OnCreate> event on the mission object text/html 2017-01-31T22:37:14+00:00 Anonymous (anonymous@undisclosed.example.com) msnsuccess https://wiki.kronosaur.com/doku.php/modding/function/msnsuccess?rev=1485902234&do=diff Discuss this page on this page's Talk Page msnSuccess Syntax (msnSuccess missionObj [data]) Arguments missionObj: The mission object. data: arbitrary data to pass on to the <OnCompleted> event Returns Category mission functions Description Calls the <OnCompleted> and <OnCanDebrief> event on the mission object text/html 2017-01-31T02:28:47+00:00 Anonymous (anonymous@undisclosed.example.com) msntranslate https://wiki.kronosaur.com/doku.php/modding/function/msntranslate?rev=1485829727&do=diff Discuss this page on this page's Talk Page msnTranslate Syntax (msnTranslate missionObj textID [data] [default]) Arguments missionObj: The mission object the text is stored on. textID: ID of the text to translate data: arbitrary data to pass on to the text text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) multiply https://wiki.kronosaur.com/doku.php/modding/function/multiply?rev=1419655255&do=diff multiply multiply multiply Syntax (multiply x1 [x2 ... xn]) -> z Arguments x1: One of the integers you want to multiply. [x2 ... xn]: The next integers you want to multiply. Returns z: The product of the numbers passed in Category 0.99, math Description Calculates the product of the arguments and returns it. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) name_functions https://wiki.kronosaur.com/doku.php/modding/function/name_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Name functions * armGetName * itmGetName * objGetArmorName * objGetName * objSetName name_functions. Return to functions list text/html 2017-01-28T03:47:28+00:00 Anonymous (anonymous@undisclosed.example.com) not https://wiki.kronosaur.com/doku.php/modding/function/not?rev=1485575248&do=diff not not not Syntax (not exp) -> True/Nil Arguments exp: The expression you want to negate. Returns condition: True if the expression evaluates to Nil, otherwise Nil. If there is no expression, then always Nil Category logical operator Description Returns the logical negation of the expression. text/html 2017-02-03T02:43:14+00:00 Anonymous (anonymous@undisclosed.example.com) objaccelerate https://wiki.kronosaur.com/doku.php/modding/function/objaccelerate?rev=1486089794&do=diff Discuss this page on this pages TalkPage objAccelerate Syntax (objAccelerate obj angle thrust [ticks]) Arguments obj: The object to accelerate angle: Angle (direction) to accelerate; 0 is to the right thrust: power of thrust [ticks]: Duration, in ticks, that the acceleration lasts text/html 2017-02-03T02:55:01+00:00 Anonymous (anonymous@undisclosed.example.com) objaddbuyorder https://wiki.kronosaur.com/doku.php/modding/function/objaddbuyorder?rev=1486090501&do=diff Discuss this page on this pages TalkPage objAddBuyOrder Syntax (objAddBuyOrder obj criteria priceAdj) Arguments obj: The space object to add the buy order to criteria: criteria chain; see Item Criteria priceAdj: Price adjustment for the buy order, in percent of the item's value. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objadditem https://wiki.kronosaur.com/doku.php/modding/function/objadditem?rev=1419655255&do=diff Discuss this page on this page's Talk Page objAddItem See objAddItem at Xelerus Syntax (objAddItem obj item [count]) -> True/Nil Arguments obj: The spaceObject that you want to add the item to. item: The itemStruct of the item you want to add. [count]: An optional amount of items you want to add. It overrides the amount in the itemStruct text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objadditemenhancement https://wiki.kronosaur.com/doku.php/modding/function/objadditemenhancement?rev=1419655256&do=diff Discuss this page on this page's Talk Page objAddItemEnhancement objAddItemEnhancement has no entry in the Xelerus list. Syntax (objAddItemEnhancement obj item enhancementType [lifetime]) -> enhancementID Arguments obj: ???. item: ??? enhancementType: ?Arbitrary string naming enhancement. If blank it can stack with itself? text/html 2017-02-03T04:01:21+00:00 Anonymous (anonymous@undisclosed.example.com) objaddoverlay https://wiki.kronosaur.com/doku.php/modding/function/objaddoverlay?rev=1486094481&do=diff Discuss this page on this pages TalkPage objAddOverlay Syntax (objAddOverlay obj overlayType [lifetime]) -> overlayID (objAddOverlay obj overlayType pos rotation [lifetime]) -> overlayID Arguments obj: The space object to add the overlay on overlayType text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objaddrandomitems https://wiki.kronosaur.com/doku.php/modding/function/objaddrandomitems?rev=1419655256&do=diff Discuss this page on this pages TalkPage objAddRandomItems See objAddRandomItems at Xelerus Syntax (objAddRandomItems obj table count) -> True/Nil Arguments obj: The spaceObject that you want to add the items to. table: The itemTable UNID where you want to get the items from. text/html 2017-02-03T02:56:45+00:00 Anonymous (anonymous@undisclosed.example.com) objaddsellorder https://wiki.kronosaur.com/doku.php/modding/function/objaddsellorder?rev=1486090605&do=diff Discuss this page on this pages TalkPage objAddSellOrder Syntax (objAddSellOrder obj criteria priceAdj) Arguments obj: The space object to add the sell order to criteria: criteria chain; see Item Criteria priceAdj: Price adjustment for the sell order, in percent of the item's value. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objaddsubordinate https://wiki.kronosaur.com/doku.php/modding/function/objaddsubordinate?rev=1419655255&do=diff Discuss this page on this pages TalkPage objAddSubordinate See objAddSubordinate at Xelerus Syntax (objAddSubordinate obj subordinate) -> True/Nil Arguments obj: The spaceObject that you want to add the subordinate too. subordinate: The ship that you want to make subordinate to the `obj'. text/html 2017-02-03T22:06:15+00:00 Anonymous (anonymous@undisclosed.example.com) objcalcbesttarget https://wiki.kronosaur.com/doku.php/modding/function/objcalcbesttarget?rev=1486159575&do=diff Discuss this page on this pages TalkPage From API 34 on Ministry objCalcBestTarget Syntax (objCalcBestTarget obj [objList]) Arguments obj: The object to calculate the target for [objList]: A list of objects to check Returns With one argument, returns the nearest visible target (non-friendly) to obj. With a list, returns the nearest visible target in the list. Returns nil if unsuccessful. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objcanattack https://wiki.kronosaur.com/doku.php/modding/function/objcanattack?rev=1419655255&do=diff Discuss this page on this pages TalkPage objCanAttack See objCanAttack at Xelerus Syntax (objCanAttack obj) -> True/Nil Arguments obj: The spaceObject you want to test Returns True if the spaceObject is capable of attacking, Nil otherwise. Category 0.99, condition query, spaceobject Description Some spaceObjects are not able to attack, mainly if they don't have any armament. This function is used to check that. text/html 2017-02-03T04:05:18+00:00 Anonymous (anonymous@undisclosed.example.com) objcandetecttarget https://wiki.kronosaur.com/doku.php/modding/function/objcandetecttarget?rev=1486094718&do=diff Discuss this page objCanDetectTarget Syntax (objCanDetectTarget obj target) Arguments obj: The space object to detect a target target: The target to check that the space object can detect Returns True if succesful, Nil otherwise Category spaceObject functions Description Checks if a space object can detect a target. text/html 2017-02-03T04:02:57+00:00 Anonymous (anonymous@undisclosed.example.com) objcaninstallitem https://wiki.kronosaur.com/doku.php/modding/function/objcaninstallitem?rev=1486094577&do=diff Discuss this page on this pages TalkPage objCanInstallItem Syntax (objCanInstallItem obj item [armorSeg, deviceSlot]) Arguments obj: The space object to check if the item can be installed item: the item to check if can be installed [armorSeg, deviceSlot]: Either text/html 2017-02-03T20:57:49+00:00 Anonymous (anonymous@undisclosed.example.com) objchangeequipmentstatus https://wiki.kronosaur.com/doku.php/modding/function/objchangeequipmentstatus?rev=1486155469&do=diff Discuss this page on this pages TalkPage objChangeEquipmentStatus Syntax (objChangeEquipmentStatus obj equipment command [duration] [options]) Arguments obj: The space object to change equipment status on equipment: the equipment to alter status on text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objcharge https://wiki.kronosaur.com/doku.php/modding/function/objcharge?rev=1419655255&do=diff Discuss this page on this pages TalkPage objCharge See objCharge at Xelerus Syntax (objCharge obj amount) -> remaining balance Arguments obj: The spaceObject that you want to take credits away from. amount: The amount of credits you want to remove. Returns integer: The remaining balance of the spaceObject you removed creadits from text/html 2017-02-03T21:14:27+00:00 Anonymous (anonymous@undisclosed.example.com) objclearidentified https://wiki.kronosaur.com/doku.php/modding/function/objclearidentified?rev=1486156467&do=diff Discuss this page on this pages TalkPage objClearIdentified Syntax (objClearIdentified obj) Arguments obj: The object to unidentify Returns True if successful, Nil otherwise Category spaceObject functions Description Makes the spaceObject unknown to the player. Could be useful for hiding the position of character ships after identifying them. text/html 2017-02-03T21:19:36+00:00 Anonymous (anonymous@undisclosed.example.com) objclearshowasdestination https://wiki.kronosaur.com/doku.php/modding/function/objclearshowasdestination?rev=1486156776&do=diff Discuss this page on this pages TalkPage objClearShowAsDestination Syntax (objClearShowAsDestination obj) Arguments obj: The spaceobject shown as a destination Returns True if succesful, Nil otherwise Category spaceObject functions Description Use to clear a destination object from the player's map. Useful for clearing destination targets during missions, for example. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objcommunicate https://wiki.kronosaur.com/doku.php/modding/function/objcommunicate?rev=1419655256&do=diff Discuss this page on this page's Talk Page objCommunicate See objCommunicate at Xelerus Syntax (objCommunicate spaceObject spaceObject number [spaceObject]) Arguments spaceObject: The space object that is sent the message. spaceObject: The space object that sent the message. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objcredit https://wiki.kronosaur.com/doku.php/modding/function/objcredit?rev=1419655255&do=diff Discuss this page on this page's Talk Page objCredit See objCredit at Xelerus Syntax (objCredit obj amount) -> new balance Arguments obj: The spaceObject that you want to give credits too. amount: The amount of credits you want to give. Returns integer: The new balance of the spaceObject you added credits to text/html 2017-06-26T03:40:01+00:00 Anonymous (anonymous@undisclosed.example.com) objdamage https://wiki.kronosaur.com/doku.php/modding/function/objdamage?rev=1498448401&do=diff Discuss this page on this pages TalkPage objDamage Syntax (objDamage obj weaponType objSource [pos] [options]) -> result Arguments obj: The SpaceObject to damage weaponType: unid of weapon to use to damage the object objSource: the source of the damage text/html 2017-02-03T21:47:01+00:00 Anonymous (anonymous@undisclosed.example.com) objdepleteshields https://wiki.kronosaur.com/doku.php/modding/function/objdepleteshields?rev=1486158421&do=diff Discuss this page on this pages TalkPage objDepleteShields See objDepleteShields at Xelerus Syntax (objDepleteShields obj) -> True/Nil Arguments obj: The spaceObject that you want to deplete the shields of. Returns boolean: True if successful, otherwise Nil Category space object functions Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objdestroy https://wiki.kronosaur.com/doku.php/modding/function/objdestroy?rev=1419655255&do=diff Discuss this page on this page's Talk Page objDestroy See objDestroy at Xelerus Syntax (objDestroy obj [objSource]) -> True/Nil Arguments obj: The spaceObject that you want to destroy. [objSource]: An optional spaceObject that destroys the other object. Returns boolean: True if successful, otherwise Nil. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objenumitems https://wiki.kronosaur.com/doku.php/modding/function/objenumitems?rev=1419655255&do=diff Discuss this page on this pages TalkPage objEnumItems See objEnumItems at Xelerus Syntax (objEnumItems obj criteria itemVar exp) -> value of last expression Arguments obj: The spaceObject whose items will be enumerated over. criteria: The criteria of the items you want from the spaceObject. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objfireevent https://wiki.kronosaur.com/doku.php/modding/function/objfireevent?rev=1419655255&do=diff Discuss this page on this pages TalkPage objFireEvent See objFireEvent at Xelerus Syntax (objFireEvent obj event) -> result of event Arguments obj: The spaceObject that has the event to be run. event: The name of the event you want to run. Returns Whatever the last run expression of the event returns. Nil if the event doesn't exist. text/html 2017-02-03T22:43:03+00:00 Anonymous (anonymous@undisclosed.example.com) objfireitemevent https://wiki.kronosaur.com/doku.php/modding/function/objfireitemevent?rev=1486161783&do=diff Discuss this page on this pages TalkPage objFireItemEvent Syntax (objFireItemEvent obj item event [data]) Arguments obj: A space object to trigger the event from - usually the space object holding the item. item: the item the event is stored on event: the name of the event on the item text/html 2017-02-03T23:12:02+00:00 Anonymous (anonymous@undisclosed.example.com) objfireiteminvoke https://wiki.kronosaur.com/doku.php/modding/function/objfireiteminvoke?rev=1486163522&do=diff Discuss this page on this pages TalkPage objFireItemInvoke Syntax (objFireItemInvoke obj item) Arguments obj: The object to fire the invoke from. item: The item the invoke is on Returns True if succesful, Nil otherwise Category spaceObject functions Description Immediately fires an item's <Invoke> from a space object. text/html 2017-02-03T23:57:17+00:00 Anonymous (anonymous@undisclosed.example.com) objfireoverlayevent https://wiki.kronosaur.com/doku.php/modding/function/objfireoverlayevent?rev=1486166237&do=diff Discuss this page on this pages TalkPage objFireOverlayEvent Syntax (objFireOverlayEvent obj overlayID event [data]) Arguments obj: The object to fire the event overlayID: ID of the overlay to fire the event on event: The named event to fire on the overlay text/html 2017-02-04T00:02:03+00:00 Anonymous (anonymous@undisclosed.example.com) objfixparalysis https://wiki.kronosaur.com/doku.php/modding/function/objfixparalysis?rev=1486166523&do=diff Discuss this page on this pages TalkPage objFixParalysis Syntax (objFixParalysis obj) Arguments obj: The object to unparalyze Returns True if succesful Category spaceObject functions Description Un-paralyzes a space object Example (objFixParalysis gPlayership) If the playership is paralyzed by EMP, then this fixes it. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgateto https://wiki.kronosaur.com/doku.php/modding/function/objgateto?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGateTo See objGateTo at Xelerus Syntax (objGateTo obj node entrypoint [effectID]) Arguments obj: The spaceObject you want to gate somewhere. node: The node id of the system you want to gate to. entrypoint: The label in the system you want to go to. This label can be hardcoded in xml, or usually one of the two labels Inbound/Outbound can be used. text/html 2017-02-04T06:39:05+00:00 Anonymous (anonymous@undisclosed.example.com) objgetarmorcriticality https://wiki.kronosaur.com/doku.php/modding/function/objgetarmorcriticality?rev=1486190345&do=diff Discuss this page on this pages TalkPage objGetArmorCriticality Syntax (objGetArmorCriticality obj armorSegment) Arguments obj: the space object armorSegment: The armor segment to check. Also accepts an item type(?) Returns criticality type Category text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetarmordamage https://wiki.kronosaur.com/doku.php/modding/function/objgetarmordamage?rev=1419655256&do=diff Discuss this page on this page's Talk Page objGetArmorDamage See objGetArmorDamage at Xelerus Syntax (objGetArmorDamage spaceObject number) Arguments spaceObject: The space object that you want to get the damage of the armor from. number: The segment number of the armor of the space object from what you want to get the damaged from. text/html 2017-02-04T06:43:23+00:00 Anonymous (anonymous@undisclosed.example.com) objgetarmorlevel https://wiki.kronosaur.com/doku.php/modding/function/objgetarmorlevel?rev=1486190603&do=diff Discuss this page on this pages TalkPage objGetArmorLevel Syntax (objGetArmorLevel obj item/armorSegment) Arguments obj: Spaceobject the armor is on item/armorSegment: Returns Percentage Category spaceObject functions Description Returns the armor's hitpoints as a percentage of full. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetarmorname https://wiki.kronosaur.com/doku.php/modding/function/objgetarmorname?rev=1419655256&do=diff Discuss this page on this pages TalkPage objGetArmorName See objGetArmorName at Xelerus Syntax (objGetArmorName spaceObject number) Arguments spaceObject: The space object that you want to get the name of the segment of. number: The segment number that you want to get the name of. text/html 2017-02-04T06:52:50+00:00 Anonymous (anonymous@undisclosed.example.com) objgetarmorrepairprice https://wiki.kronosaur.com/doku.php/modding/function/objgetarmorrepairprice?rev=1486191170&do=diff Discuss this page on this pages TalkPage objGetArmorRepairPrice Syntax (objGetArmorRepairPrice obj [shipObj] armorItem hpToRepair) Arguments obj: The object you want to get the repair price from [shipObj]: The ship object the armor is on (optional; skip to just check an armor type) text/html 2017-02-04T06:57:39+00:00 Anonymous (anonymous@undisclosed.example.com) objgetarmorreplaceprice https://wiki.kronosaur.com/doku.php/modding/function/objgetarmorreplaceprice?rev=1486191459&do=diff Discuss this page on this pages TalkPage objGetArmorReplacePrice Syntax (objGetArmorReplacePrice obj armorItem) Arguments obj: The object you want to get the price from armorItem: The armor item to be installed Returns Price Category spaceObject functions Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetarmortype https://wiki.kronosaur.com/doku.php/modding/function/objgetarmortype?rev=1419655256&do=diff Discuss this page on this pages TalkPage objGetArmorType See objGetArmorType at Xelerus Syntax (objGetArmorType spaceObject number) Arguments spaceObject: The space object that you want to get the type of armor from. number: The segment number that you want to get the name of. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetbalance https://wiki.kronosaur.com/doku.php/modding/function/objgetbalance?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetBalance See objGetBalance at Xelerus Syntax (objGetBalance spaceObject) Arguments spaceObject: The space object that you want to get the amount of credits from. Returns number: The amount of credits that the space object has. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetbuyprice https://wiki.kronosaur.com/doku.php/modding/function/objgetbuyprice?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetBuyPrice See objGetBuyPrice at Xelerus Syntax (objGetBuyPrice spaceObject itemStruct) Arguments spaceObject: The space object that you want to get the buying price of. itemStruct: The itemStruct of the item that you want to get the price of. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetcargospaceleft https://wiki.kronosaur.com/doku.php/modding/function/objgetcargospaceleft?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetCargoSpaceLeft See objGetCargoSpaceLeft at Xelerus Syntax (objGetCargoSpaceLeft spaceObject) Arguments spaceObject: The space object that you want to get the cargo space left of. Returns number: The amount of space left in the cargo bay. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetcombatpower https://wiki.kronosaur.com/doku.php/modding/function/objgetcombatpower?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetCombatPower See objGetCombatPower at Xelerus Syntax (objGetCombatPower spaceObject) Arguments spaceObject: The space object that you want to get the combat power of. Returns number: A number between 1 and 100 representing the combat power of the space object. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetdamagetype https://wiki.kronosaur.com/doku.php/modding/function/objgetdamagetype?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetDamageType See objGetDamageType at Xelerus Syntax (objGetDamageType spaceObject) Arguments spaceObject: The thing you want to know the damage type of. Returns number: The damage type. Category spaceobject Description Returns the damage type of the object. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetdata https://wiki.kronosaur.com/doku.php/modding/function/objgetdata?rev=1419655256&do=diff Discuss this page on this page's Talk Page objGetData See objGetData at Xelerus Syntax (objGetData spaceObject string) Arguments spaceObject: The space object you want the data from. string: The name of the data you want. Returns The data named by the string from the space object. Returns Nil if there is no data as named by the string. text/html 2017-02-04T07:04:24+00:00 Anonymous (anonymous@undisclosed.example.com) objgetdatafield https://wiki.kronosaur.com/doku.php/modding/function/objgetdatafield?rev=1486191864&do=diff Discuss this page on this pages TalkPage objGetDataField Syntax (objGetDataField obj field) Arguments obj: The object the data field is on field: The data field to retrieve Returns Data Category spaceObject functions Description Retrieves data from a space object. Functionally the same as text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetdestiny https://wiki.kronosaur.com/doku.php/modding/function/objgetdestiny?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetDestiny See objGetDestiny at Xelerus Syntax (objGetDestiny spaceObject) Arguments spaceObject: The space object you want the destiny of. Returns number: A number from 0 to 359 Category spaceobject Description Returns the destiny code of the space object. text/html 2017-02-04T18:00:23+00:00 Anonymous (anonymous@undisclosed.example.com) objgetdisposition https://wiki.kronosaur.com/doku.php/modding/function/objgetdisposition?rev=1486231223&do=diff Discuss this page objGetDisposition Syntax (objGetDisposition obj targetObj) Arguments obj: The object you want the disposition of targetObj: the object you want to check obj against Returns Disposition Category spaceObject functions Description Checks the disposition of the first object's sovereign toward the target object's sovereign. text/html 2017-01-21T00:38:29+00:00 Anonymous (anonymous@undisclosed.example.com) objgetdistance https://wiki.kronosaur.com/doku.php/modding/function/objgetdistance?rev=1484959109&do=diff Discuss this page on this pages TalkPage objGetDistance See objGetDistance at Xelerus Syntax (objGetDistance spaceObject spaceObject) Arguments spaceObject: The space object you want to find the distance from. spaceObject: The space object you want to find the distance to. Returns text/html 2017-02-04T07:13:33+00:00 Anonymous (anonymous@undisclosed.example.com) objgetequipmentstatus https://wiki.kronosaur.com/doku.php/modding/function/objgetequipmentstatus?rev=1486192413&do=diff Discuss this page on this pages TalkPage objGetEquipmentStatus Syntax (objGetEquipmentStatus obj equipment) Arguments obj: The space object to check equipment status on equipment: The equipment status to check Returns Status Category spaceObject functions Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetglobaldata https://wiki.kronosaur.com/doku.php/modding/function/objgetglobaldata?rev=1419655255&do=diff Discuss this page on this page's Talk Page objGetGlobalData See objGetGlobalData at Xelerus Syntax (objGetGlobalData spaceObject string) Arguments spaceObject: The space object belonging to the class you want the data from. string: The name of the data you want. Returns The data named by the string from the space objects class. All space objects in the same class share the same global data. Returns Nil if there is no data as named by the string. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetid https://wiki.kronosaur.com/doku.php/modding/function/objgetid?rev=1419655256&do=diff Discuss this page on this page's Talk Page objGetID See objGetID at Xelerus Syntax (objGetID spaceObject) Arguments spaceObject: The space object you want to find the ID of. Returns number: The ID of the space object. Category spaceObject Description Returns the ID of the space object. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetimagedesc https://wiki.kronosaur.com/doku.php/modding/function/objgetimagedesc?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetImageDesc See objGetImageDesc at Xelerus Syntax (objGetImageDesc spaceObject) Arguments spaceObject: the spaceobject that you want the details of the image used. Returns list: a list of 5 numbers, the first is the UNID of the image resource as a number, the second and the third are the x,y coordinates in pixels of the resource image (from the top left corner of the image) the fourth and fifth are the sizes of the resource image in pixels. (f… text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetinstalleditemdesc https://wiki.kronosaur.com/doku.php/modding/function/objgetinstalleditemdesc?rev=1419655256&do=diff Discuss this page on this pages TalkPage objGetInstalledItemDesc See objGetInstalledItemDesc at Xelerus Syntax (objGetInstalledItemDesc spaceObject itemStruct) Arguments spaceObject: The space object that the item is in. itemStruct: The itemstruct of the item that you want the installed description of. text/html 2015-04-23T14:41:45+00:00 Anonymous (anonymous@undisclosed.example.com) objgetitems https://wiki.kronosaur.com/doku.php/modding/function/objgetitems?rev=1429800105&do=diff Discuss this page on this page's Talk Page objGetItems See objGetItems at Xelerus Syntax (objGetItems spaceObject criteria) Arguments spaceObject: The space object that the items are in. (See also gPlayerShip) criteria: The criteria that you want the items you get to match. Returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetlevel https://wiki.kronosaur.com/doku.php/modding/function/objgetlevel?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetLevel See objGetLevel at Xelerus Syntax (objGetLevel obj) -> level Arguments obj: The spaceObject you want to get the level of Returns level: an integer representing the level of the object Category spaceobject Description easy to use function to get the level of an object in the current system text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetmass https://wiki.kronosaur.com/doku.php/modding/function/objgetmass?rev=1419655255&do=diff Discuss this page on this page's Talk Page objGetMass See objGetMass at Xelerus Syntax (objGetMass spaceObject) Arguments spaceObject: The space object that you want the mass from. Returns number: the mass of the spaceobject and all of its cargo expressed in tons. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetmaxpower https://wiki.kronosaur.com/doku.php/modding/function/objgetmaxpower?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetMaxPower See objGetMaxPower at Xelerus Syntax (objGetMaxPower spaceObject) Arguments spaceObject: The space object that you want the max power from. Returns number: The max power of the space object. Category reactor, spaceobject Description Returns the max power of ship space object. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetname https://wiki.kronosaur.com/doku.php/modding/function/objgetname?rev=1419655256&do=diff Discuss this page on this page's Talk Page objGetName See objGetName at Xelerus Syntax (objGetName spaceObject [nameflags]) -> string Arguments spaceObject: The space object that you want the name from. [nameflags]: An optional naming code Returns string: The name of the space object. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetnameditems https://wiki.kronosaur.com/doku.php/modding/function/objgetnameditems?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetNamedItems See objGetNamedItems at Xelerus Syntax (objGetNamedItems obj name) Arguments obj: obj you want to get weapon of name: string defining what item you want to get Returns list Category 1.0, item, spaceobject Description Returns data on one of the ships selected weapons text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetneareststargate https://wiki.kronosaur.com/doku.php/modding/function/objgetneareststargate?rev=1419655256&do=diff Discuss this page on this pages TalkPage objGetNearestStargate See objGetNearestStargate at Xelerus Syntax (objGetNearestStargate spaceObject) Arguments spaceObject: The space object that you want to get the nearest star gate from. Returns spaceObject: The nearest star gate. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetobjbyid https://wiki.kronosaur.com/doku.php/modding/function/objgetobjbyid?rev=1419655255&do=diff Discuss this page on this page's Talk Page objGetObjByID See objGetObjByID at Xelerus Syntax (objGetObjByID number) -> spaceObject Arguments number: the ID of the spaceObject that uniquely identifies it. Returns spaceObject: the spaceobject with the unique ID. Category 0.99, spaceObject text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetobjrefdata https://wiki.kronosaur.com/doku.php/modding/function/objgetobjrefdata?rev=1419655255&do=diff Discuss this page on this page's Talk Page objGetObjRefData See objGetObjRefData at Xelerus Syntax (objGetObjRefData spaceObject string) Arguments spaceObject: The space object that you want to get the space object reference from. string: The name of the space object reference. text/html 2017-02-05T07:03:20+00:00 Anonymous (anonymous@undisclosed.example.com) objgetopendockingportcount https://wiki.kronosaur.com/doku.php/modding/function/objgetopendockingportcount?rev=1486278200&do=diff Discuss this page on this pages TalkPage objGetOpenDockingPortCount Syntax (objGetOpenDockingPortCount obj) Arguments obj: The spaceObject to count open docking ports on Returns value; count of open docking ports Category spaceObject functions Description Returns the number of open docking ports on a spaceObject. text/html 2017-06-26T02:52:10+00:00 Anonymous (anonymous@undisclosed.example.com) objgetordergiver https://wiki.kronosaur.com/doku.php/modding/function/objgetordergiver?rev=1498445530&do=diff Discuss this page on this pages TalkPage objGetOrderGiver See objGetOrderGiver at Xelerus Syntax (objGetOrderGiver spaceObject [destroyReason]) Arguments spaceObject: The space object that you want to get the order giver from. destroyReason: ? Returns spaceObject: The order giver. text/html 2017-02-05T07:07:34+00:00 Anonymous (anonymous@undisclosed.example.com) objgetoverlaydata https://wiki.kronosaur.com/doku.php/modding/function/objgetoverlaydata?rev=1486278454&do=diff Discuss this page on this pages TalkPage objGetOverlayData Syntax (objGetOverlayData obj overlayID attrib) Arguments obj: The spaceobject the overlay is on overlayID: The ID of the overlay attrib: Named data to retrieve Returns data Category spaceObject functions, Overlay functions Description text/html 2017-02-05T07:09:25+00:00 Anonymous (anonymous@undisclosed.example.com) objgetoverlaypos https://wiki.kronosaur.com/doku.php/modding/function/objgetoverlaypos?rev=1486278565&do=diff Discuss this page on this pages TalkPage objGetOverlayPos Syntax (objGetOverlayPos obj overlayID) Arguments obj: The object the overlay is on overlayID: The ID of the overlay Returns vector Category spaceObject functions, overlay functions Description Gets the position of the overlay on the object. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetpos https://wiki.kronosaur.com/doku.php/modding/function/objgetpos?rev=1419655255&do=diff Discuss this page on this page's Talk Page objGetPos See objGetPos at Xelerus Syntax (objGetPos spaceObject) -> vector Arguments spaceObject: The space object that you want the position of. Returns vector: The position of the space object. Category spaceObject Description Returns the vector position of the space object. text/html 2017-03-30T04:23:59+00:00 Anonymous (anonymous@undisclosed.example.com) objgetproperty https://wiki.kronosaur.com/doku.php/modding/function/objgetproperty?rev=1490847839&do=diff Discuss this page on this pages TalkPage obGetProperty Syntax (objGetProperty obj property) Arguments obj: The space object to check the property on property: The property to retrieve Returns Value Category spaceObject functions Description Retrieves a property from a space object. Functionally the same as text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetsellprice https://wiki.kronosaur.com/doku.php/modding/function/objgetsellprice?rev=1419655256&do=diff Discuss this page on this pages TalkPage objGetSellPrice See objGetSellPrice at Xelerus Syntax (objGetSellPrice spaceObject itemStruct) Arguments spaceObject: The space object that you want to get the selling price of. itemStruct: The itemStruct of the item that you want to get the price you can sell it at. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetshieldlevel https://wiki.kronosaur.com/doku.php/modding/function/objgetshieldlevel?rev=1419655256&do=diff Discuss this page on this pages TalkPage objGetShieldLevel See objGetShieldLevel at Xelerus Syntax (objGetShieldLevel spaceObject) Arguments spaceObject: The space object that you want to get the shield level of. Returns number: The amount of shield left divided by the max amount of shield on the space object. Returns -1 if no shield is equipped. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetsovereign https://wiki.kronosaur.com/doku.php/modding/function/objgetsovereign?rev=1419655256&do=diff Discuss this page on this page's Talk Page objGetSovereign See objGetSovereign at Xelerus Syntax (objGetSovereign spaceObject) Arguments spaceObject: The space object that you want to get the sovereign of. Returns number: The UNID of the sovereign. Category ai, spaceObject, UNID Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetstaticdata https://wiki.kronosaur.com/doku.php/modding/function/objgetstaticdata?rev=1419655256&do=diff Discuss this page on this page's Talk Page objGetStaticData See objGetStaticData at Xelerus Syntax (objGetStaticData spaceObject string) Arguments spaceObject: The space object of the type you want to get the static data from. string: The name of the static data. Returns data: The data from the xml named by the string from the space objects type. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgettarget https://wiki.kronosaur.com/doku.php/modding/function/objgettarget?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetTarget See objGetTarget at Xelerus Syntax (objGetTarget spaceObject) Arguments spaceObject: The space object you want to get the current target of. Returns spaceObject: The target of the space object. Category spaceobject Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objgetvel https://wiki.kronosaur.com/doku.php/modding/function/objgetvel?rev=1419655256&do=diff Discuss this page on this page's Talk Page objGetVel See objGetVel at Xelerus Syntax (objGetVel spaceObject) Arguments spaceObject: The space object you want to get the current velocity of. Returns vector: the current velocity of the spaceObject. Category 0.99, spaceObject, vector operator Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objgetvisibledamage https://wiki.kronosaur.com/doku.php/modding/function/objgetvisibledamage?rev=1419655255&do=diff Discuss this page on this pages TalkPage objGetVisibleDamage See objGetVisibleDamage at Xelerus Syntax (objGetVisibleDamage spaceObject) Arguments spaceObject: The space object you want to get the most damaged armor damage percent. Returns number: The percent of damage the most damaged armor on the space object. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objhasattribute https://wiki.kronosaur.com/doku.php/modding/function/objhasattribute?rev=1419655255&do=diff Discuss this page on this pages TalkPage objHasAttribute See objHasAttribute at Xelerus Syntax (objHasAttribute spaceObject string) Arguments spaceObject: The space object you want to see if it has the attribute. string: The attribute's that you want name. Returns condition: True if the space object has that attribute. Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objhasitem https://wiki.kronosaur.com/doku.php/modding/function/objhasitem?rev=1419655256&do=diff Discuss this page on this pages TalkPage objHasItem See objHasItem at Xelerus Syntax (objHasItem spaceObject itemStruct) Arguments spaceObject: The space object you want to see if it has the item. itemStruct: The itemStruct of the item you want to see if the space object has. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objincdata https://wiki.kronosaur.com/doku.php/modding/function/objincdata?rev=1419655255&do=diff Discuss this page on this pages TalkPage objIncData See objIncData at Xelerus Syntax (objIncData spaceObject string [number]) Arguments spaceObject: The space object you want to alter a numerical data in. string: The name of the data you want to alter. [number]: The amount you want to add to the data. If this value is left out, then the value 1 is automatically used. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objincvel https://wiki.kronosaur.com/doku.php/modding/function/objincvel?rev=1419655255&do=diff Discuss this page on this page's Talk Page objIncVel See objIncVel at Xelerus Syntax (objIncVel spaceObject vector) -> vector Arguments spaceObject: The space object you want to alter a numerical data in. vector: The vector you want to change the space object velocity by. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objisabandoned https://wiki.kronosaur.com/doku.php/modding/function/objisabandoned?rev=1419655256&do=diff Discuss this page on this pages TalkPage objIsAbandoned See objIsAbandoned at Xelerus Syntax (objIsAbandoned spaceObject) Arguments spaceObject: The space object you want to see if it is abandoned. Returns condition: True if the space object is abandoned. Nil otherwise. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objisdeviceslotavailable https://wiki.kronosaur.com/doku.php/modding/function/objisdeviceslotavailable?rev=1419655255&do=diff Discuss this page on this pages TalkPage objIsDeviceSlotAvailable See objIsDeviceSlotAvailable at Xelerus Syntax (objIsDeviceSlotAvailable spaceObject) Arguments spaceObject: The space object you want to see if it has a device slot available. Returns condition: True if the space object has a device slot available. Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objisdockedat https://wiki.kronosaur.com/doku.php/modding/function/objisdockedat?rev=1419655255&do=diff Discuss this page on this pages TalkPage objIsDockedAt See objIsDockedAt at Xelerus Syntax (objIsDockedAt spaceObject spaceObject) Arguments spaceObject: the spaceObject of a ship. spaceObject: the spaceObject of a station. Returns condition: True if the first space object is docked with the station. Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objisenemy https://wiki.kronosaur.com/doku.php/modding/function/objisenemy?rev=1419655255&do=diff Discuss this page on this pages TalkPage objIsEnemy See objIsEnemy at Xelerus Syntax (objIsEnemy spaceObject spaceObject) Arguments spaceObject: The space object you want to find enemy of. spaceObject: The space object you want to see if is an enemy of the first space object. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objisknown https://wiki.kronosaur.com/doku.php/modding/function/objisknown?rev=1419655256&do=diff Discuss this page on this pages TalkPage objIsKnown See objIsKnown at Xelerus Syntax (objIsKnown obj) -> True/Nil Arguments obj: The spaceObject that you want to test. Returns boolean: True if the space object is known, otherwise Nil. Category condition query, spaceobject Description Query function asking if the spaceObject is known, the object can be known by objSetKnown, seeing it onscreen, or targeting it. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objisship https://wiki.kronosaur.com/doku.php/modding/function/objisship?rev=1419655256&do=diff Discuss this page on this pages TalkPage objIsShip See objIsShip at Xelerus Syntax (objIsShip spaceObject) Arguments spaceObject: The space object you want to see if it is a ship. Returns condition: True if the space object is a ship. Nil otherwise. Category condition query, spaceobject Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objisunderattack https://wiki.kronosaur.com/doku.php/modding/function/objisunderattack?rev=1419655255&do=diff Discuss this page on this pages TalkPage objIsUnderAttack See objIsUnderAttack at Xelerus Syntax (objIsUnderAttack spaceObject) Arguments spaceObject: The space object you want to see if it is under attack. Returns condition: True if the space object is under attack. Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objjumpto https://wiki.kronosaur.com/doku.php/modding/function/objjumpto?rev=1419655255&do=diff Discuss this page on this pages TalkPage objJumpTo See objJumpTo at Xelerus Syntax (objJumpTo spaceObject vector) Arguments spaceObject: The space object you want to move. vector: Where you want to move the space object to. Returns condition: True if successful. Category text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objlowershields https://wiki.kronosaur.com/doku.php/modding/function/objlowershields?rev=1419655256&do=diff Discuss this page on this pages TalkPage objLowerShields See objLowerShields at Xelerus Syntax (objLowerShields spaceObject) Arguments spaceObject: The space object you want to disable the shields. Returns condition: True if successful. Category shield, spaceobject Description Disables the shields of the space object. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objmakeparalyzed https://wiki.kronosaur.com/doku.php/modding/function/objmakeparalyzed?rev=1419655256&do=diff Discuss this page on this pages TalkPage objMakeParalyzed See objMakeParalyzed at Xelerus Syntax (objMakeParalyzed spaceObject number) Arguments spaceObject: The space object you want to paralyze. number: How many ticks you want the space object to be paralyzed. Returns condition: True if successful. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objmoveto https://wiki.kronosaur.com/doku.php/modding/function/objmoveto?rev=1419655255&do=diff Discuss this page on this page's Talk Page objMoveTo See objMoveTo at Xelerus Syntax (objMoveTo spaceObject vector) -> condition Arguments spaceObject: The space object you want to move. vector: Where you want to move the space object to. Returns condition: True if successful. text/html 2017-02-05T00:23:00+00:00 Anonymous (anonymous@undisclosed.example.com) objprogramdamage https://wiki.kronosaur.com/doku.php/modding/function/objprogramdamage?rev=1486254180&do=diff Discuss this page objProgramDamage Syntax (objProgramDamage obj hacker progName aiLevel code) -> True/Nil Arguments obj: The ship that will receive a cyberattack hacker: The object carrying out the cyberattack progName: The name that shows up when the obj detects the attack. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objregisterforevents https://wiki.kronosaur.com/doku.php/modding/function/objregisterforevents?rev=1419655255&do=diff Discuss this page on this pages TalkPage objRegisterForEvents See objRegisterForEvents at Xelerus Syntax (objRegisterForEvents spaceObject spaceObject) Arguments spaceObject: The space object you want to send the events to. spaceObject: Where the events are coming from. Returns condition: True if successful. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objremoveitem https://wiki.kronosaur.com/doku.php/modding/function/objremoveitem?rev=1419655255&do=diff Discuss this page on this pages TalkPage objRemoveItem See objRemoveItem at Xelerus Syntax (objRemoveItem spaceObject itemStruct [number]) Arguments spaceObject: The space object you want to remove an item from. itemStruct: The item you want to remove from the object. [number]: The optional number of items you want to remove. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objrepairarmor https://wiki.kronosaur.com/doku.php/modding/function/objrepairarmor?rev=1419655255&do=diff Discuss this page on this page's Talk Page objRepairArmor See objRepairArmor at Xelerus Syntax (objRepairArmor spaceObject number [number]) Arguments spaceObject: The space object you want to repair some armor of. number: Where on the space object you want to repair the armor on. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objsendmessage https://wiki.kronosaur.com/doku.php/modding/function/objsendmessage?rev=1419655255&do=diff Discuss this page on this pages TalkPage objSendMessage See objSendMessage at Xelerus Syntax (objSendMessage spaceObject spaceObject string) Arguments spaceObject: The space object you want to send the message to. spaceObject: The space object you want to send the message from. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objsetdata https://wiki.kronosaur.com/doku.php/modding/function/objsetdata?rev=1419655256&do=diff Discuss this page on this pages TalkPage objSetData See objSetData at Xelerus Syntax (objSetData spaceObject string expression) Arguments spaceObject: The space object you want to set data in. string: The name of the data. expression: Can be anything except a pointer or a list containing pointers. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) objsetglobaldata https://wiki.kronosaur.com/doku.php/modding/function/objsetglobaldata?rev=1419655256&do=diff Discuss this page on this pages TalkPage objSetGlobalData See objSetGlobalData at Xelerus Syntax (objSetGlobalData spaceObject string expression) Arguments spaceObject: The space object of the type you want to set data in. string: The name of the data. expression: Can be anything except a pointer or a list containing pointers. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objsetknown https://wiki.kronosaur.com/doku.php/modding/function/objsetknown?rev=1419655255&do=diff Discuss this page on this pages TalkPage objSetKnown See objSetKnown at Xelerus Syntax (objSetKnown spaceObject) Arguments spaceObject: The space object that you want have known. Returns condition: True if successful. Category spaceobject Description Sets the space object known. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objsetname https://wiki.kronosaur.com/doku.php/modding/function/objsetname?rev=1419655255&do=diff Discuss this page on this pages TalkPage objSetName See objSetName at Xelerus Syntax (objSetName spaceObject string) Arguments spaceObject: The space object that you want to rename. string: The new name. Returns condition: True if successful. Category name, spaceobject Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objsetobjrefdata https://wiki.kronosaur.com/doku.php/modding/function/objsetobjrefdata?rev=1419655255&do=diff Discuss this page on this pages TalkPage objSetObjRefData See objSetObjRefData at Xelerus Syntax (objSetObjRefData spaceObject string spaceObject) Arguments spaceObject: The space object that you want store the other space obect in. string: The name of the space object reference. text/html 2017-01-24T05:35:39+00:00 Anonymous (anonymous@undisclosed.example.com) objsetoverlaydata https://wiki.kronosaur.com/doku.php/modding/function/objsetoverlaydata?rev=1485236139&do=diff Discuss this page on this pages TalkPage objSetOverlayData Syntax (objSetOverlayData obj overlayID attrib data) Arguments obj: the object the overlay is on (can be itself, gSource) overlayID: The ID of the overlay. If the overlay itself is calling this function use aOverlayID. text/html 2017-01-24T05:33:50+00:00 Anonymous (anonymous@undisclosed.example.com) objsetoverlayproperty https://wiki.kronosaur.com/doku.php/modding/function/objsetoverlayproperty?rev=1485236030&do=diff Discuss this page on this pages TalkPage objSetOverlayProperty Syntax (objSetOverlayProperty obj overlayID property value) Arguments obj: the object the overlay is on (can be itself) overlayID: The ID of the overlay. If the overlay itself is calling this function use aOverlayID. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objsetpos https://wiki.kronosaur.com/doku.php/modding/function/objsetpos?rev=1419655255&do=diff Discuss this page on this page's Talk Page objSetPos See objSetPos at Xelerus Syntax (objSetPos spaceObject vector) Arguments spaceObject: The space object that you want to locate. vector: The position you want to move it to. Returns vector: The new vector of the object(?) text/html 2017-02-03T04:09:03+00:00 Anonymous (anonymous@undisclosed.example.com) objsetshowasdestination https://wiki.kronosaur.com/doku.php/modding/function/objsetshowasdestination?rev=1486094943&do=diff Discuss this page objSetShowAsDestination Syntax (objSetShowAsDestination obj [options]) -> True/Nil Arguments obj: The space object to mark [options]: An optional parameter that specifies how the object should be marked Returns True if succesful, Nil otherwise text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objsetsovereign https://wiki.kronosaur.com/doku.php/modding/function/objsetsovereign?rev=1419655255&do=diff Discuss this page on this page's Talk Page objSetSovereign See objSetSovereign at Xelerus Syntax (objSetSovereign spaceObject number) Arguments spaceObject: The space object that you want to change the sovereign of. number: The UNID of the sovereign you want to set the space objects sovereign to. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objsetvel https://wiki.kronosaur.com/doku.php/modding/function/objsetvel?rev=1419655255&do=diff Discuss this page on this page's Talk Page FIXME This has not been checked for accuracy and completeness. objSetVel objSetVel is not in the Xelerus list. Syntax (objSetVel spaceObject velVector) Arguments spaceObject: The space object you want to get the current velocity of. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) objunregisterforevents https://wiki.kronosaur.com/doku.php/modding/function/objunregisterforevents?rev=1419655255&do=diff Discuss this page on this pages TalkPage objUnregisterForEvents See objUnregisterForEvents at Xelerus Syntax (objUnregisterForEvents spaceObject spaceObject) Arguments spaceObject: The space object that you want to stop getting messages to. spaceObject: The space object that you want to stop getting messages from. text/html 2017-01-26T00:26:46+00:00 Anonymous (anonymous@undisclosed.example.com) or https://wiki.kronosaur.com/doku.php/modding/function/or?rev=1485390406&do=diff Discuss this page or See or at Xelerus Syntax (or exp1 [exp2 ... expn]) -> value/Nil Arguments exp1: An expression that evaluates to Nil or something else [exp2 ... expn] Additional expressions to be evaluated Category logical operator Returns The value of the first expression that does not return text/html 2017-06-26T02:38:23+00:00 Anonymous (anonymous@undisclosed.example.com) orders_functions https://wiki.kronosaur.com/doku.php/modding/function/orders_functions?rev=1498444703&do=diff Discuss this page on this page's Talk Page. Order functions * objGetOrderGiver * shpCancelOrders * shpGetOrder * objCommunicate * shpOrder * shpOrderAttack * shpOrderDock * shpOrderEscort * shpOrderFollow * shpOrderGate * shpOrderGoto * shpOrderGuard * shpOrderHold * shpOrderLoot * shpOrderMine * shpOrderPatrol * shpOrderWait orders_functions. Return to functions list text/html 2017-01-21T19:47:18+00:00 Anonymous (anonymous@undisclosed.example.com) player_functions https://wiki.kronosaur.com/doku.php/modding/function/player_functions?rev=1485028038&do=diff Discuss this page on this page's Talk Page. Player functions * plyChangeShip * plyCharge * plyComposeString * plyCredit * plyDestroyed * plyEnableMessage * plyGetCredits * plyGetGenome * plyGetItemStat * plyGetKeyEventStat * plyGetRedirectMessage * plyGetStat * plyIsMessageEnabled * plyMessage * plyRecordBuyItem * plyRecordSellItem * plyRedirectMessage * plyUseItem Return to functions list text/html 2017-03-18T23:05:01+00:00 Anonymous (anonymous@undisclosed.example.com) plychangeship https://wiki.kronosaur.com/doku.php/modding/function/plychangeship?rev=1489878301&do=diff Discuss this page on this page's Talk Page plyChangeShip See plyChangeShip at Xelerus Syntax (plyChangeShip player target) -> True/Nil Arguments player: The player. (See gPlayer) target: The target ship to transfer to. Returns True or Nil depending on success of transfer Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plycharge https://wiki.kronosaur.com/doku.php/modding/function/plycharge?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyCharge See plyCharge at Xelerus Syntax (plyCharge player number) Arguments player: The player. number: The number of credits to charge. Returns number: The number of credits left. Category cash, player Description Charges the player the given number of credits and returns how much the player has left. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plyclearshowhelprefuel https://wiki.kronosaur.com/doku.php/modding/function/plyclearshowhelprefuel?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyClearShowHelpRefuel See plyClearShowHelpRefuel at Xelerus Syntax (plyClearShowHelpRefuel player) Arguments player: The player. Returns condition: True if successful. Category help, player Description Stops the help message showing when the players fuel gets low. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plycomposestring https://wiki.kronosaur.com/doku.php/modding/function/plycomposestring?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyComposeString See plyComposeString at Xelerus Syntax (plyComposeString player string) Arguments player: The player. string: The formatted string. Returns string: the string with the special escape strings replaced with the appropriate things. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plycredit https://wiki.kronosaur.com/doku.php/modding/function/plycredit?rev=1419655255&do=diff Discuss this page on this page's Talk Page plyCredit See plyCredit at Xelerus Syntax (plyCredit player credit) -> total Arguments player: The player. (See gPlayer) credit: The number of credits to credit. Returns total: The number of credits the player now has. Category cash, player text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) plycredit_talk_page https://wiki.kronosaur.com/doku.php/modding/function/plycredit_talk_page?rev=1419655256&do=diff This is the Talk Page for plyCredit plyCredit: Talk Page Globals " I am not sure gPlayer (globals) belongs in the functions namespace. -- alterecco" " " It would be more accurate to have called it the tscript namespace, but I don't really want to move everything again. Neither I nor George Moromisato were text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plydestroyed https://wiki.kronosaur.com/doku.php/modding/function/plydestroyed?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyDestroyed See plyDestroyed at Xelerus Syntax (plyDestroyed player string) Arguments player: The player. string: The ending string. Returns condition: True (I don't really know) Category player, damage Description Ends the game with the string on the last screen. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plygetcredits https://wiki.kronosaur.com/doku.php/modding/function/plygetcredits?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyGetCredits See plyGetCredits at Xelerus Syntax (plyGetCredits player) Arguments player: The player. Returns number: The number of credits that the player has. Category cash, player Description Returns the amount of credits the player has. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plygetgenome https://wiki.kronosaur.com/doku.php/modding/function/plygetgenome?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyGetGenome See plyGetGenome at Xelerus Syntax (plyGetGenome spaceObject) Arguments spaceObject: works only with gPlayership Returns string: the sex of the player Category 0.99, player Description This function returns if the player is male or female depending on what the player choose in the main game screen. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) plygetinsuranceclaims https://wiki.kronosaur.com/doku.php/modding/function/plygetinsuranceclaims?rev=1419655256&do=diff Discuss this page on this pages TalkPage plyGetInsuranceClaims See plyGetInsuranceClaims at Xelerus Syntax (plyGetInsuranceClaims player) Arguments player: The player. Returns number: The number of insurance claims the player has had. Category insurance, player Description Returns the amount of insurance claims the player has had. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plygetitemstat https://wiki.kronosaur.com/doku.php/modding/function/plygetitemstat?rev=1419655255&do=diff Discuss this page on this page's Talk Page plyGetItemStat See plyGetItemStat at Xelerus Syntax (plyGetItemStat player stat criteria) -> value Arguments player: The player. (See gPlayer) stat: An identifier naming the stat to obtain (see below). criteria: An item criteria specifying the set of items for which to return the stat. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plygetredirectmessage https://wiki.kronosaur.com/doku.php/modding/function/plygetredirectmessage?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyGetRedirectMessage See plyGetRedirectMessage at Xelerus Syntax (plyGetRedirectMessage player) Arguments player: The player. Returns string: The stored redirected messages. Category message, player Description Returns the stored redirect messages. When a message is stored it is concatenated onto the redirect string. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plyinsure https://wiki.kronosaur.com/doku.php/modding/function/plyinsure?rev=1419655255&do=diff Discuss this page on this pages TalkPage plyInsure See plyInsure at Xelerus Syntax (plyInsure player) Arguments player: The player. Returns condition: True Category insurance, player Description Insures the players ship. Example (plyInsure gplayer) Insures the players ship. Return to text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) plyisinsured https://wiki.kronosaur.com/doku.php/modding/function/plyisinsured?rev=1419655256&do=diff Discuss this page on this pages TalkPage plyIsInsured See plyIsInsured at Xelerus Syntax (plyIsInsured player) Arguments player: The player. Returns condition: True if the player is insured, Nil otherwise. Category insurance, player Description Returns wether or not the player is insured. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) plymessage https://wiki.kronosaur.com/doku.php/modding/function/plymessage?rev=1419655256&do=diff Discuss this page on this page's Talk Page plyMessage See plyMessage at Xelerus Syntax (plyMessage player string) Arguments player: The player. (See gPlayer) string: The message string. Returns condition: True Category message, player Description Attempts to message the player. If the RedirectMessage is set then cat onto the stored messages. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) plymessage_talk_page https://wiki.kronosaur.com/doku.php/modding/function/plymessage_talk_page?rev=1419655255&do=diff This is the Talk Page for plyMessage plyMessage: Talk Page See plyCredit talk page See plycredit_talk_page -- alterecco text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) plyredirectmessage https://wiki.kronosaur.com/doku.php/modding/function/plyredirectmessage?rev=1419655256&do=diff Discuss this page on this pages TalkPage plyRedirectMessage See plyRedirectMessage at Xelerus Syntax (plyRedirectMessage player condition) Arguments player: The player. condition: If Nil makes any future plyMessages display during flight, otherwise sets the redirect message to “ text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) power https://wiki.kronosaur.com/doku.php/modding/function/power?rev=1419655255&do=diff power power power Syntax (power number number) Arguments number: The base of the exponentiation function. number: The exponent of the exponentiation function. Returns number: The first argument raised by the second argument. Category 0.99, math Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) radiation_functions https://wiki.kronosaur.com/doku.php/modding/function/radiation_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Radiation functions * armIsRadiationImmune * shpDecontaminate * shpIsRadioactive * shpIsRadiationImmune * shpMakeRadioactive radiation_functions. Return to functions list text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) random https://wiki.kronosaur.com/doku.php/modding/function/random?rev=1419655256&do=diff Discuss this page on this page's Talk Page random random Syntax (random expression1 [number]) -> expression2 Arguments expression1 : A list or number. number: Optional. The number you want to a random number between them the second must be greater than the first number. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) random_functions https://wiki.kronosaur.com/doku.php/modding/function/random_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Random functions * itmCreateByName * itmCreateRandom * random * rollDice * objAddRandomItems * unvUNID * shuffle * seededRandom random_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) reactor_functions https://wiki.kronosaur.com/doku.php/modding/function/reactor_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Reactor functions * shpGetFuelLeft * shpIsFuelCompatible * objGetMaxPower reactor_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) recon_functions https://wiki.kronosaur.com/doku.php/modding/function/recon_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Recon functions * staClearFireReconEvent * staClearReconned * staSetFireReconEvent * staIsReconned recon_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) repair_damage_functions https://wiki.kronosaur.com/doku.php/modding/function/repair_damage_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Repair and damage functions * armGetRepairTech * objGetVisibleDamage * plyDestroyed * objGetArmorDamage * shpDamageArmor * shpFixBlindness * shpGetShieldDamage * shpDamageItem * objMakeParalyzed text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) rolldice https://wiki.kronosaur.com/doku.php/modding/function/rolldice?rev=1419655255&do=diff Discuss this page on this page's Talk Page rollDice See rollDice at Xelerus Syntax (rollDice number sides [bonus]) -> result Arguments number: The number of dice you want to roll. sides: The number of sides you want each of the dice to have. [bonus]: Optional. A bonus that is added at the end. text/html 2017-01-21T19:50:46+00:00 Anonymous (anonymous@undisclosed.example.com) screen_functions https://wiki.kronosaur.com/doku.php/modding/function/screen_functions?rev=1485028246&do=diff Discuss this page on this page's Talk Page. Screen functions Screen functions are used in dockscreens. * scrAddAction * scrAddMinorAction * scrEnableAction * scrExitScreen * scrGetCounter * scrGetData * scrGetDesc * scrGetInputText * scrGetItem * scrGetListCursor * scrGetListEntry * scrGetScreen * scrIncData * scrIsActionEnabled * scrIsFirstOnInit * scrRefreshScreen * scrRemoveAction * scrRemoveItem * scrSetActionDesc * scrSetActionLabel * scrSetBackg… text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) screnableaction https://wiki.kronosaur.com/doku.php/modding/function/screnableaction?rev=1419655256&do=diff Discuss this page on this page's Talk Page scrEnableAction See scrEnableAction at Xelerus Syntax (scrEnableAction screen number condition) -> result Arguments screen: The screen where you want to enable or disable an action. number: What number starting from zero at the top of the screen the action you want to work with is. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) screxitdock https://wiki.kronosaur.com/doku.php/modding/function/screxitdock?rev=1419655255&do=diff Discuss this page on this pages TalkPage scrExitDock See scrExitDock at Xelerus Syntax (scrExitDock screen) Arguments screen: The screen you want to exit after this code. Returns condition: True if successful. Category screen Description Returns the player to normal fight after this function is done. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) scrgetcounter https://wiki.kronosaur.com/doku.php/modding/function/scrgetcounter?rev=1419655256&do=diff Discuss this page on this page's Talk Page scrGetCounter See scrGetCounter at Xelerus Syntax (scrGetCounter screen) Arguments screen: The screen you want to get the counter from. Returns number: The currently displayed counters value. Category input functions, screen functions Description Returns what the counter is currently displaying. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrgetinputtext https://wiki.kronosaur.com/doku.php/modding/function/scrgetinputtext?rev=1419655255&do=diff Discuss this page on this pages TalkPage scrGetInputText See scrGetInputText at Xelerus Syntax (scrGetInputText screen) Arguments screen: The screen you want to get the input text from. Returns string: The currently inputted text. Category input, screen Description Returns what the text the player inputted. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrgetitem https://wiki.kronosaur.com/doku.php/modding/function/scrgetitem?rev=1419655255&do=diff Discuss this page on this page's Talk Page scrGetItem See scrGetItem at Xelerus Syntax (scrGetItem screen) -> itemStruct Arguments screen: The screen you want to get the currently selected item from. Returns itemStruct: The currently selected item. Category input, screen Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrgetitemlistcursor https://wiki.kronosaur.com/doku.php/modding/function/scrgetitemlistcursor?rev=1419655255&do=diff Discuss this page on this page's Talk Page scrGetItemListCursor See scrGetItemListCursor at Xelerus Syntax (scrGetItemListCursor screen) -> itemListCursor Arguments screen: The screen you want to get the currently selected cursor from. Returns itemListCursor: The currently selected cursor. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrgetlistentry https://wiki.kronosaur.com/doku.php/modding/function/scrgetlistentry?rev=1419655255&do=diff Discuss this page on this page's Talk Page. scrGetListEntry This function is not included in the Xelerus list. Syntax (scrGetListEntry screen) -> listitem Argument List screen: The screen you want to get the currently selected list item from. Returns listitem: the currently selected list item text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) scrisfirstoninit https://wiki.kronosaur.com/doku.php/modding/function/scrisfirstoninit?rev=1419655256&do=diff Discuss this page on this pages TalkPage scrIsFirstOnInit See scrIsFirstOnInit at Xelerus Syntax (scrIsFirstOnInit screen) Arguments screen: The screen you want to see if it is the first screen the player sees. Returns condition: True if the screen is the first one the player sees. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) scrremoveitem https://wiki.kronosaur.com/doku.php/modding/function/scrremoveitem?rev=1419655256&do=diff Discuss this page on this pages TalkPage scrRemoveitem See scrRemoveitem at Xelerus Syntax (scrRemoveitem screen number) Arguments screen: The screen you want to remove the item from. number: How many of the item you want to remove. Returns itemStruct: The removed items. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) scrsetactionlabel https://wiki.kronosaur.com/doku.php/modding/function/scrsetactionlabel?rev=1419655256&do=diff Discuss this page on this pages TalkPage scrSetActionLabel See scrSetActionLabel at Xelerus Syntax (scrSetActionLabel screen number string [key]) Arguments screen: The screen you want to change the action text on. number: How far from the top starting at 0 the action is. string: What you want to change the text too. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrsetcounter https://wiki.kronosaur.com/doku.php/modding/function/scrsetcounter?rev=1419655255&do=diff Discuss this page on this page's Talk Page scrSetCounter See scrSetCounter at Xelerus Syntax (scrSetCounter screen number) Arguments screen: The screen you want to set the counter on. number: The number you want to set the counter to. Returns condition: True if successful. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrsetdesc https://wiki.kronosaur.com/doku.php/modding/function/scrsetdesc?rev=1419655255&do=diff Discuss this page on this pages TalkPage scrSetDesc See scrSetDesc at Xelerus Syntax (scrSetDesc screen string) Arguments screen: The screen you want to set the description on. string: The string you want to set the description too. Returns condition: True is successful. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) scrsetinputtext https://wiki.kronosaur.com/doku.php/modding/function/scrsetinputtext?rev=1419655256&do=diff Discuss this page on this pages TalkPage scrSetInputText See scrSetInputText at Xelerus Syntax (scrSetInputText screen string) Arguments screen: The screen you want to set the input text on. string: The string you want to set the input text too. Returns condition: True is successful. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) scrsetlistfilter https://wiki.kronosaur.com/doku.php/modding/function/scrsetlistfilter?rev=1419655256&do=diff Discuss this page on this page's Talk Page scrSetListFilter See scrSetListFilter at Xelerus Syntax (scrSetListFilter screen expression) Arguments screen: The screen you want to filter the items on. expression: This can be one of three things. a) A string containing the criteria you want to filter the item list with. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrshowpane https://wiki.kronosaur.com/doku.php/modding/function/scrshowpane?rev=1419655255&do=diff Discuss this page on this pages TalkPage scrShowPane See scrShowPane at Xelerus Syntax (scrShowPane screen string) Arguments screen: The current screen. string: The name of the pane you want to navigate to. Returns condition: True is successful. Category screen Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) scrshowscreen https://wiki.kronosaur.com/doku.php/modding/function/scrshowscreen?rev=1419655255&do=diff Discuss this page on this pages TalkPage scrShowScreen See scrShowScreen at Xelerus Syntax (scrShowScreen screen string [string]) Arguments screen: The current screen. string: The name of the screen you want to navigate to. [string]: which pane to display from the screen. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) seededrandom https://wiki.kronosaur.com/doku.php/modding/function/seededrandom?rev=1419655255&do=diff Discuss this page on this pages TalkPage seededRandom See seededRandom at Xelerus Syntax (seededRandom number expression [number]) Arguments number: the seed of the random number generator expression: can be a number or a list. [number]: The number you want to a random number between them the second must be greater than the first number. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) set https://wiki.kronosaur.com/doku.php/modding/function/set?rev=1419655255&do=diff set set set Syntax (set string expression) Arguments string: The name of the variable you want to set. expression: The thing you want to store in the variable. Returns expression: Whatever the expression is. Category store Description Stores the expression in the variable named by the string. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) setq https://wiki.kronosaur.com/doku.php/modding/function/setq?rev=1419655255&do=diff setq setq setq Syntax (setq variable expression) -> expression Arguments variable: The variable you want to set. expression: The thing you want to store in the variable. Returns expression: Whatever the expression is. Category store Description Stores the expression in the variable. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shield_functions https://wiki.kronosaur.com/doku.php/modding/function/shield_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Shield functions * shpGetShieldItemUNID * shpGetShieldMaxHitPoints * objLowerShields * objGetShieldLevel * objDepleteShields * shpGetShieldDamage * shpRechargeShield shield_functions. Return to functions list text/html 2017-01-21T19:29:20+00:00 Anonymous (anonymous@undisclosed.example.com) ship_functions https://wiki.kronosaur.com/doku.php/modding/function/ship_functions?rev=1485026960&do=diff Discuss this page on this page's Talk Page. Ship functions * shpCancelOrders * shpCanRemoveDevice * shpConsumeFuel * shpDamageArmor * shpDecontaminate * shpEnhanceItem * shpGetAISetting * shpGetArmor * shpGetArmorCount * shpGetArmorMaxHitPoints * shpGetClassName * shpGetDirection * shpGetDockObj * shpGetFuelLeft * shpGetFuelNeeded * shpGetImageDesc * shpGetItemDeviceName * shpGetMaxSpeed * shpGetOrder * shpGetOrderDesc * shpGetOrderTarget * shpGetShi… text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpaddenergyfield https://wiki.kronosaur.com/doku.php/modding/function/shpaddenergyfield?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpAddEnergyField See shpAddEnergyField at Xelerus Syntax (shpAddEnergyField ship number number) Arguments ship: The ship that is using the energy field. number: The UNID of the energy field. number: How long in ticks the energy field will last. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpcancelorders https://wiki.kronosaur.com/doku.php/modding/function/shpcancelorders?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpCancelOrders See shpCancelOrders at Xelerus Syntax (shpCancelOrders ship) Arguments ship: The ship that you want to cancel the orders of. Returns condition: True is successful. Category orders, ship Description Removes any orders the ship currently has. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpcaninstallarmor https://wiki.kronosaur.com/doku.php/modding/function/shpcaninstallarmor?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpCanInstallArmor See shpCanInstallArmor at Xelerus Syntax (shpCanInstallArmor ship itemStruct) Arguments ship: The ship that you want to see if it can equip the armor. itemStruct: The armor you want to see if it can be equipped. Returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpcaninstalldevice https://wiki.kronosaur.com/doku.php/modding/function/shpcaninstalldevice?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpCanInstallDevice See shpCanInstallDevice at Xelerus Syntax (shpCanInstallDevice ship itemStruct) Arguments ship: The ship that you want to see if it can equip the device. itemStruct: The device you want to see if it can be equipped. Returns text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpcanremovedevice https://wiki.kronosaur.com/doku.php/modding/function/shpcanremovedevice?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpCanRemoveDevice See shpCanRemoveDevice at Xelerus Syntax (shpCanRemoveDevice ship item) -> installCode Arguments ship: The ship that has the item you want to check installed. item: The item you want to check. Returns installCode: 1 if removing the device would cause the cargo hold to become too small, 0 if it can be removed. 2 if the item is not installed in the first place. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpconsumefuel https://wiki.kronosaur.com/doku.php/modding/function/shpconsumefuel?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpConsumeFuel See shpConsumeFuel at Xelerus Syntax (shpConsumeFuel ship number) Arguments ship: The ship that you want to remove fuel from. number: How much fuel you want to remove. Returns number: Fuel remaining. Category ship Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpdamagearmor https://wiki.kronosaur.com/doku.php/modding/function/shpdamagearmor?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpDamageArmor See shpDamageArmor at Xelerus Syntax (shpDamageArmor ship number number number) Arguments ship: The ship that you want to damage an armor segment on. number: Where on the ship the armor segment is. number: The damage type. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpdamageitem https://wiki.kronosaur.com/doku.php/modding/function/shpdamageitem?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpDamageItem See shpDamageItem at Xelerus Syntax (shpDamageItem ship itemListCursor) Arguments ship: The ship that you want to damage an item in. itemListCursor: Where on the ship the item is. Returns condition: True is successful. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpdecontaminate https://wiki.kronosaur.com/doku.php/modding/function/shpdecontaminate?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpDecontaminate See shpDecontaminate at Xelerus Syntax (shpDecontaminate ship) Arguments ship: The ship that you want to decontaminate. Returns condition: True is successful. Category radiation, ship Description Removes any radiation from the given ship. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpenhanceitem https://wiki.kronosaur.com/doku.php/modding/function/shpenhanceitem?rev=1419655255&do=diff Discuss this page on this page's Talk Page shpEnhanceItem See shpEnhanceItem at Xelerus Syntax (shpEnhanceItem ship itemListCursor [number]) -> condition Arguments ship: The ship that you want to enhance an item in. itemListCursor: Where on the ship the item is. number: The enhance code. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpenhancesrs https://wiki.kronosaur.com/doku.php/modding/function/shpenhancesrs?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpEnhanceSRS See shpEnhanceSRS at Xelerus Syntax (shpEnhanceSRS ship) Arguments ship: The ship that you want to enhance the visual display. Returns condition: True is successful. Category enhancement, ship Description Enhances the visual display of the ship. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpfixblindness https://wiki.kronosaur.com/doku.php/modding/function/shpfixblindness?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpFixBlindness See shpFixBlindness at Xelerus Syntax (shpFixBlindness ship [noMessage]) Arguments ship: The ship that you want to fix the visual display. [noMessage]: If True will disable the message the player gets when the function is used. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetarmor https://wiki.kronosaur.com/doku.php/modding/function/shpgetarmor?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpGetArmor See shpGetArmor at Xelerus Syntax (shpGetArmor ship number) Arguments ship: The ship that you want to get the armor from. number: Where on the ship you want to get the armor from. Returns itemStruct: The item struct of the armor. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetarmorcount https://wiki.kronosaur.com/doku.php/modding/function/shpgetarmorcount?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetArmorCount See shpGetArmorCount at Xelerus Syntax (shpGetArmorCount ship) Arguments ship: The ship that you want to get how many segments of armor it has. Returns number: The number of segments of armor that the ship has. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetarmormaxhitpoints https://wiki.kronosaur.com/doku.php/modding/function/shpgetarmormaxhitpoints?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetArmorMaxHitPoints See shpGetArmorMaxHitPoints at Xelerus Syntax (shpGetArmorMaxHitPoints ship number) Arguments ship: The ship that you want to get what the max hp of the segment of armor is. number: Where on the ship the armor you want to get the max hp of. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetclass https://wiki.kronosaur.com/doku.php/modding/function/shpgetclass?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetClass See shpGetClass at Xelerus Syntax (shpGetClass ship) Arguments ship: The ship that you want to get the UNID of. Returns number: The UNID of the ship. Category ship, unid Description Returns the UNID of the ship. Example Return to text/html 2017-01-20T02:09:48+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetdatafield https://wiki.kronosaur.com/doku.php/modding/function/shpgetdatafield?rev=1484878188&do=diff Discuss this page on this page's Talk Page DEPRECATED: Use typGetDataField instead shpGetDataField See shpGetDataField at Xelerus Syntax (shpGetDataField number string) Arguments number: the space object or the shipclass UNID of the ship you want data from. string: the name of the data field of the ship. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetdirection https://wiki.kronosaur.com/doku.php/modding/function/shpgetdirection?rev=1419655255&do=diff Discuss this page on this page's Talk Page shpGetDirection See shpGetDirection at Xelerus Syntax (shpGetDirection ship) -> number Arguments ship: The ship that you want to get the direction of. Returns number: The direction of the ship in degrees. Category ship Description Returns the direction of the ship. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetfuelleft https://wiki.kronosaur.com/doku.php/modding/function/shpgetfuelleft?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetFuelLeft See shpGetFuelLeft at Xelerus Syntax (shpGetFuelLeft ship) Arguments ship: The ship that you want the remaining fuel of. Returns number: The amount of fuel left. Category reactor, ship Description Returns the amount of fuel in the ship. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetimagedesc https://wiki.kronosaur.com/doku.php/modding/function/shpgetimagedesc?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetImageDesc See shpGetImageDesc at Xelerus Syntax (shpGetImageDesc spaceObject [number]) Arguments spaceObject: the spaceobject that you want the details of the image used. number: optional parameter that specifies the rotation of the ship. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetmaxspeed https://wiki.kronosaur.com/doku.php/modding/function/shpgetmaxspeed?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetMaxSpeed See shpGetMaxSpeed at Xelerus Syntax (shpGetMaxSpeed spaceObject) Arguments spaceObject: a ship that you want the max speed from. Returns number: the max speed of the ship. Category 0.99, ship Description This function returns the value of the maxSpeed of the shipclass, the value is a % of the lightspeed. (so lightspeed is 100) text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetorder https://wiki.kronosaur.com/doku.php/modding/function/shpgetorder?rev=1419655255&do=diff Discuss this page on this page's Talk Page shpGetOrder See shpGetOrder at Xelerus Syntax (shpGetOrder ship) -> string Arguments ship: The ship that you want the order from. Returns string: A string representation of the ships current order. Category orders, ship Description Returns what orders the ship is currently under. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetshielddamage https://wiki.kronosaur.com/doku.php/modding/function/shpgetshielddamage?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetShieldDamage See shpGetShieldDamage at Xelerus Syntax (shpGetShieldDamage ship) Arguments ship: The ship that you want get the amount of damage the shields have. Returns number: The amount of damage the ship's shield has. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetshielditemunid https://wiki.kronosaur.com/doku.php/modding/function/shpgetshielditemunid?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpGetShieldItemUNID See shpGetShieldItemUNID at Xelerus Syntax (shpGetShieldItemUNID ship) Arguments ship: The ship that you want get the UNID the shields have. Returns number: The UNID of the ship's shield. Category shield, ship, unid Description Returns the UNID of the ship's shield. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpgetshieldmaxhitpoints https://wiki.kronosaur.com/doku.php/modding/function/shpgetshieldmaxhitpoints?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpGetShieldMaxHitPoints See shpGetShieldMaxHitPoints at Xelerus Syntax (shpGetShieldMaxHitPoints ship) Arguments ship: The ship that you want get the max hit point the shields have. Returns number: The max hit points of the ship\'s shield. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpinstallarmor https://wiki.kronosaur.com/doku.php/modding/function/shpinstallarmor?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpInstallArmor See shpInstallArmor at Xelerus Syntax (shpInstallArmor ship itemListCursor number) Arguments ship: The ship that you want install the armor. itemListCursor: The pointer to the armor you want to install. number: Where on the ship you want to install the armor. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpinstallautopilot https://wiki.kronosaur.com/doku.php/modding/function/shpinstallautopilot?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpInstallAutopilot See shpInstallAutopilot at Xelerus Syntax (shpInstallAutopilot ship) Arguments ship: The ship that you want install the auto pilot. Returns condition: True is successful, Nil otherwise. Category enhancement, ship Description Attempts to install the auto pilot. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpinstalldevice https://wiki.kronosaur.com/doku.php/modding/function/shpinstalldevice?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpInstallDevice See shpInstallDevice at Xelerus Syntax (shpInstallDevice ship expression) Arguments ship: The ship that you want install the device on. expression: Can take a item struct or an item list pointer. The device to install. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpinstalltargetingcomputer https://wiki.kronosaur.com/doku.php/modding/function/shpinstalltargetingcomputer?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpInstallTargetingComputer See shpInstallTargetingComputer at Xelerus Syntax (shpInstallTargetingComputer ship) Arguments ship: The ship that you want install the targeting computer on. Returns condition: True is successful, Nil otherwise. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpisautopilotinstalled https://wiki.kronosaur.com/doku.php/modding/function/shpisautopilotinstalled?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpIsAutopilotInstalled See shpIsAutopilotInstalled at Xelerus Syntax (shpIsAutopilotInstalled ship) Arguments ship: The ship that you want check if it has an auto pilot. Returns condition: True if the ship has an auto pilot, Nil otherwise. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpisfuelcompatible https://wiki.kronosaur.com/doku.php/modding/function/shpisfuelcompatible?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpIsFuelCompatible See shpIsFuelCompatible at Xelerus Syntax (shpIsFuelCompatible ship itemStruct) Arguments ship: The ship that you want check if the fuel is compatible. itemStruct: The item struct of the fuel you want to check. Returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpisradiationimmune https://wiki.kronosaur.com/doku.php/modding/function/shpisradiationimmune?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpIsRadiationImmune See shpIsRadiationImmune at Xelerus Syntax (shpIsRadiationImmune ship [itemListCursor]) Arguments ship: The ship that you want check if it is radiation immune. itemListCursor: The optional location of the armor to check. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpisradioactive https://wiki.kronosaur.com/doku.php/modding/function/shpisradioactive?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpIsRadioactive See shpIsRadioactive at Xelerus Syntax (shpIsRadioactive ship) Arguments ship: The ship that you want check if it is radioactive. Returns condition: True if the ship is radioactive, Nil otherwise. Category condition query, radiation, ship Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpissrsenhanced https://wiki.kronosaur.com/doku.php/modding/function/shpissrsenhanced?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpIsSRSEnhanced See shpIsSRSEnhanced at Xelerus Syntax (shpIsSRSEnhanced ship) Arguments ship: The ship that you want check if it's SRS is enhanced. Returns condition: True if the ship's SRS is enhanced, Nil otherwise. Category condition query, enhancement, ship text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpistargetingcomputerinstalled https://wiki.kronosaur.com/doku.php/modding/function/shpistargetingcomputerinstalled?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpIsTargetingComputerInstalled See shpIsTargetingComputerInstalled at Xelerus Syntax (shpIsTargetingComputerInstalled ship) Arguments ship: The ship that you want check if it's targeting computer is installed. Returns condition: True if the ship's targeting computer is installed, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpmakeblind https://wiki.kronosaur.com/doku.php/modding/function/shpmakeblind?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpMakeBlind See shpMakeBlind at Xelerus Syntax (shpMakeBlind ship number) Arguments ship: The ship that you want to make blind. number: How long in ticks you want to make the ship blind. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpmakeradioactive https://wiki.kronosaur.com/doku.php/modding/function/shpmakeradioactive?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpMakeRadioactive See shpMakeRadioactive at Xelerus Syntax (shpMakeRadioactive ship) Arguments ship: The ship that you want to make radioactive. Returns condition: True if successful, Nil otherwise. Category radiation, ship Description Makes the ship radioactive. text/html 2017-06-25T05:06:38+00:00 Anonymous (anonymous@undisclosed.example.com) shporder https://wiki.kronosaur.com/doku.php/modding/function/shporder?rev=1498367198&do=diff Discuss this page on this pages TalkPage shpOrder See shpOrder at Xelerus Syntax (shpOrder ship string [expression]) Arguments ship: The ship that you want to order. string: A string representing the order. expression: The optional arguments if needed by the order. Multiple arguments possible text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shporderattack https://wiki.kronosaur.com/doku.php/modding/function/shporderattack?rev=1419655256&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderAttack See shpOrderAttack at Xelerus Syntax (shpOrderAttack ship ship) Arguments ship: The ship that you want to order to attack. ship: The target. Returns condition: True if successful, Nil otherwise. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shporderdock https://wiki.kronosaur.com/doku.php/modding/function/shporderdock?rev=1419655255&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderDock See shpOrderDock at Xelerus Syntax (shpOrderDock ship spaceObject) Arguments ship: The ship that you want to order to dock. spaceObject: The target to dock with. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shporderescort https://wiki.kronosaur.com/doku.php/modding/function/shporderescort?rev=1419655256&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderEscort See shpOrderEscort at Xelerus Syntax (shpOrderEscort ship protect [formation]) -> True/Nil Arguments ship: The ship that you want to order to escort. protect: The target to escort. [formation]: an optional value that represents the ships position in formation. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shporderfollow https://wiki.kronosaur.com/doku.php/modding/function/shporderfollow?rev=1419655255&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderFollow See shpOrderFollow at Xelerus Syntax (shpOrderFollow ship spaceObject) Arguments ship: The ship that you want to order to follow. spaceObject: The target to follow. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shpordergate https://wiki.kronosaur.com/doku.php/modding/function/shpordergate?rev=1419655255&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderGate See shpOrderGate at Xelerus Syntax (shpOrderGate ship [spaceObject]) Arguments ship: The ship that you want to order to gate. spaceObject: The star gate you want to gate at. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpordergoto https://wiki.kronosaur.com/doku.php/modding/function/shpordergoto?rev=1419655256&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderGoto See shpOrderGoto at Xelerus Syntax (shpOrderGoto ship spaceObject) Arguments ship: The ship that you want to fly to a position. spaceObject: an object the ship will fly to. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shporderguard https://wiki.kronosaur.com/doku.php/modding/function/shporderguard?rev=1419655255&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderGuard See shpOrderGuard at Xelerus Syntax (shpOrderGuard ship spaceObject) Arguments ship: The ship that you want to order to guard. spaceObject: The target to guard. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shporderhold https://wiki.kronosaur.com/doku.php/modding/function/shporderhold?rev=1419655255&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderHold See shpOrderHold at Xelerus Syntax (shpOrderHold ship [number]) Arguments ship: The ship that you want to order to hold position. number: How long to hold position. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shporderloot https://wiki.kronosaur.com/doku.php/modding/function/shporderloot?rev=1419655255&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderLoot See shpOrderLoot at Xelerus Syntax (shpOrderLoot ship spaceObject) Arguments ship: The ship that you want to order to loot. spaceObject: The target to loot. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpordermine https://wiki.kronosaur.com/doku.php/modding/function/shpordermine?rev=1419655256&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderMine See shpOrderMine at Xelerus Syntax (shpOrderMine ship spaceObject) Arguments ship: The ship that you want to order to mine. spaceObject: The target to return the mined ore too. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shporderpatrol https://wiki.kronosaur.com/doku.php/modding/function/shporderpatrol?rev=1419655255&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderPatrol See shpOrderPatrol at Xelerus Syntax (shpOrderPatrol ship spaceObject number) Arguments ship: The ship that you want to order to patrol. spaceObject: What to patrol around. number: How far out to patrol. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shporderwait https://wiki.kronosaur.com/doku.php/modding/function/shporderwait?rev=1419655256&do=diff Discuss this page on this pages TalkPage Deprecated Use shpOrder shpOrderWait See shpOrderWait at Xelerus Syntax (shpOrderWait ship number) Arguments ship: The ship that you want to order to wait. number: How long you want the ship to wait. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shprechargeitem https://wiki.kronosaur.com/doku.php/modding/function/shprechargeitem?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpRechargeItem See shpRechargeItem at Xelerus Syntax (shpRechargeItem ship expression number) Arguments ship: The ship that has the item to recharge. expression: An item struct or item list pointer to the item you want to recharge. number: The number of charges you want to add to the item. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shprechargeshield https://wiki.kronosaur.com/doku.php/modding/function/shprechargeshield?rev=1419655256&do=diff Discuss this page on this pages TalkPage shpRechargeShield See shpRechargeShield at Xelerus Syntax (shpRechargeShield ship number) Arguments ship: The ship that has a shield to recharge. number: The amount you want to recharge. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shprefuelfromitem https://wiki.kronosaur.com/doku.php/modding/function/shprefuelfromitem?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpRefuelFromItem See shpRefuelFromItem at Xelerus Syntax (shpRefuelFromItem ship itemStruct) Arguments ship: The ship that want to refuel from an item. itemStruct: The item you want to use. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) shpremovedevice https://wiki.kronosaur.com/doku.php/modding/function/shpremovedevice?rev=1419655256&do=diff Discuss this page on this page's Talk Page shpRemoveDevice See shpRemoveDevice at Xelerus Syntax (shpRemoveDevice ship expression) Arguments ship: The ship that want to uninstall an device on. expression: The item you want to uninstall, can be a item struct or item list pointer. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shprepairitem https://wiki.kronosaur.com/doku.php/modding/function/shprepairitem?rev=1419655255&do=diff Discuss this page on this pages TalkPage shpRepairItem See shpRepairItem at Xelerus Syntax (shpRepairItem ship itemListCursor) Arguments ship: The ship that want to repair an item on. itemListCursor: The itemListCursor of the item you want to repair. Returns condition: True if successful, Nil otherwise. text/html 2017-06-25T05:55:11+00:00 Anonymous (anonymous@undisclosed.example.com) shpsetcontroller https://wiki.kronosaur.com/doku.php/modding/function/shpsetcontroller?rev=1498370111&do=diff Discuss this page on this page's Talk ;Page shpSetController See shpSetController at Xelerus Syntax (shpSetController ship string) Arguments ship: The ship that want to change the ai on. string: The name of the controller. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) shuffle https://wiki.kronosaur.com/doku.php/modding/function/shuffle?rev=1419655255&do=diff shuffle shuffle shuffle Syntax (shuffle list) Arguments list: The list you want to put in random order. Returns list: A list containing the same elements as the passed in list but in a random order. Category 0.99, list, random Description Makes a new list based on the passed in lists elements ordered randomly. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sovsetdisposition https://wiki.kronosaur.com/doku.php/modding/function/sovsetdisposition?rev=1419655255&do=diff Discuss this page on this page's Talk Page sovSetDisposition See sovSetDisposition at Xelerus Syntax (sovSetDisposition number number number) Arguments number: The UNID of the sovereign to change its disposition. number: The UNID of the sovereign the first one changes its disposition about. text/html 2017-02-03T01:45:55+00:00 Anonymous (anonymous@undisclosed.example.com) spaceobject_functions https://wiki.kronosaur.com/doku.php/modding/function/spaceobject_functions?rev=1486086355&do=diff Discuss this page on this page's Talk Page. Spaceobject functions These functions can be used on any space object type. * objAccelerate * objAddBuyOrder * objAddItem * objAddItemEnhancement * objAddOverlay * objAddRandomItems * objAddSellOrder * objAddSubordinate * objCalcBestTarget * objCanAttack * objCanDetectTarget * objCanInstallItem * objChangeEquipmentStatus * objCharge * objClearIdentified * objClearShowAsDestination * objCommunicate * objCredit * … text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sqrt https://wiki.kronosaur.com/doku.php/modding/function/sqrt?rev=1419655255&do=diff sqrt sqrt sqrt Syntax (sqrt number) Arguments number: The number you want to find the square root to. Returns number: The square root of the given number. It will be truncated at the decimal point. Category 0.99, math Description Finds the square root of the given number. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) staclearfirereconevent https://wiki.kronosaur.com/doku.php/modding/function/staclearfirereconevent?rev=1419655255&do=diff Discuss this page on this pages TalkPage staClearFireReconEvent See staClearFireReconEvent at Xelerus Syntax (staClearFireReconEvent station) Arguments station: The station you want to clear the recon event from. Returns condition: True if successful, Nil otherwise. Category event, recon, station text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) staclearreconned https://wiki.kronosaur.com/doku.php/modding/function/staclearreconned?rev=1419655255&do=diff Discuss this page on this pages TalkPage staClearReconned See staClearReconned at Xelerus Syntax (staClearReconned station) Arguments station: The station you want not to be reconned anymore. Returns condition: True if successful, Nil otherwise. Category recon, station Description Makes the station not to be reconned anymore. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stagetdockedships https://wiki.kronosaur.com/doku.php/modding/function/stagetdockedships?rev=1419655255&do=diff Discuss this page on this pages TalkPage staGetDockedShips See staGetDockedShips at Xelerus Syntax (staGetDockedShips station) Arguments station: The station that you want to query. Returns list: the list of docked ships. Category ship, station Description Returns the list of ships that are docked to the queried station. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stagetimagevariant https://wiki.kronosaur.com/doku.php/modding/function/stagetimagevariant?rev=1419655255&do=diff Discuss this page on this pages TalkPage staGetImageVariant See staGetImageVariant at Xelerus Syntax (staGetImageVariant station) Arguments station: The station you want to get the image variant of. Returns number: The number of the image variant. Category station Description Gets the image variant of the station. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stagetstructuralhp https://wiki.kronosaur.com/doku.php/modding/function/stagetstructuralhp?rev=1419655255&do=diff Discuss this page on this pages TalkPage staGetStructuralHP See staGetStructuralHP at Xelerus Syntax (staGetStructuralHP station) Arguments station: The station you want to get the structural hp of. Returns number: The structural hp of the station. Category station Description Returns the structural hp of the station. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stagetsubordinates https://wiki.kronosaur.com/doku.php/modding/function/stagetsubordinates?rev=1419655255&do=diff Discuss this page on this pages TalkPage staGetSubordinates See staGetSubordinates at Xelerus Syntax (staGetSubordinates station) Arguments station: The station that you want the subordinates from. Returns list: the list of spaceObjects subordinates. Category spaceobject, station Description Returns the list of spaceObjects that are subordinates of the queried station. These include ships and satellites. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stagettype https://wiki.kronosaur.com/doku.php/modding/function/stagettype?rev=1419655255&do=diff Discuss this page on this pages TalkPage staGetType See staGetType at Xelerus Syntax (staGetType station) Arguments station: The station you want to set the UNID of. Returns number: The UNID of the station. Category station, unid Description Returns the UNID of the station. Example text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) staisencountered https://wiki.kronosaur.com/doku.php/modding/function/staisencountered?rev=1419655255&do=diff Discuss this page on this pages TalkPage staIsEncountered See staIsEncountered at Xelerus Syntax (staIsEncountered number) Arguments number: The UNID of the station you want to check if it has been created. Returns condition: True if the station has been created before, Nil otherwise. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) staisreconned https://wiki.kronosaur.com/doku.php/modding/function/staisreconned?rev=1419655255&do=diff Discuss this page on this pages TalkPage staIsReconned See staIsReconned at Xelerus Syntax (staIsReconned station) Arguments station: The station you want check if it is reconned. Returns condition: True if the station has been reconned, Nil otherwise. Category condition query, recon, station Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stasetactive https://wiki.kronosaur.com/doku.php/modding/function/stasetactive?rev=1419655255&do=diff Discuss this page on this pages TalkPage staSetActive See staSetActive at Xelerus Syntax (staSetActive station) Arguments station: The station you want to set active. Returns condition: True if successful, Nil otherwise. Category station Description Sets the data in the station named by text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stasetfirereconevent https://wiki.kronosaur.com/doku.php/modding/function/stasetfirereconevent?rev=1419655255&do=diff Discuss this page on this pages TalkPage staSetFireReconEvent See staSetFireReconEvent at Xelerus Syntax (staSetFireReconEvent station) Arguments station: The station you want fire events when it is reconned. Returns condition: True if successful, Nil otherwise. Category event, recon, station Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) stasetimagevariant https://wiki.kronosaur.com/doku.php/modding/function/stasetimagevariant?rev=1419655256&do=diff Discuss this page on this pages TalkPage staSetImageVariant See staSetImageVariant at Xelerus Syntax (staSetImageVariant station number) Arguments station: The station you want to set the image variant of. number: The number of the image variant you want to change it to. Returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) stasetinactive https://wiki.kronosaur.com/doku.php/modding/function/stasetinactive?rev=1419655255&do=diff Discuss this page on this pages TalkPage staSetInactive See staSetInactive at Xelerus Syntax (staSetInactive station) Arguments station: The station you want to set inactive. Returns condition: True if successful, Nil otherwise. Category station Description Sets the data in the station named by text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) stasetstructuralhp https://wiki.kronosaur.com/doku.php/modding/function/stasetstructuralhp?rev=1419655256&do=diff Discuss this page on this pages TalkPage staSetStructuralHP See staSetStructuralHP at Xelerus Syntax (staSetStructuralHP station number) Arguments station: The station you want to set the structural hp of. number: What you want to set the structural hp to. Returns condition: True if successful, Nil otherwise. text/html 2017-01-21T19:53:23+00:00 Anonymous (anonymous@undisclosed.example.com) station_functions https://wiki.kronosaur.com/doku.php/modding/function/station_functions?rev=1485028403&do=diff Discuss this page on this page's Talk Page. Station functions These functions are used on station objects. * staClearFireReconEvent * staClearReconned * staGetDockedShips * staGetImageVariant * staGetSubordinates * staIsEncountered * staIsReconned * staSetActive * staSetFireReconEvent * staSetImageVariant * staSetShowMapLabel Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) store_functions https://wiki.kronosaur.com/doku.php/modding/function/store_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Store functions * set * setq store_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) strcapitalize https://wiki.kronosaur.com/doku.php/modding/function/strcapitalize?rev=1419655255&do=diff Discuss this page on this pages TalkPage strCapitalize See strCapitalize at Xelerus Syntax (strCapitalize string) Arguments string: The string that you want the first character capitalized. Returns string: The passed in string with the first character capitalized. Category text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) strfind https://wiki.kronosaur.com/doku.php/modding/function/strfind?rev=1419655256&do=diff Discuss this page on this pages TalkPage strFind See strFind at Xelerus Syntax (strFind string string) Arguments string: The string that to search. string: The string you want to search for. Returns number: The index where the second string is found starting at 0, if not found returns Nil. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) string_operator_functions https://wiki.kronosaur.com/doku.php/modding/function/string_operator_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. String operator functions * cat * eval * find * int * link * plyComposeString * strCapitalize * strFind * subst string_operator_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) subst https://wiki.kronosaur.com/doku.php/modding/function/subst?rev=1419655255&do=diff subst subst subst Syntax (subst string string1) Arguments string: A string that contains %number% parts. string: The strings you are inserting into the first string. 1 Returns string: The string with the appropriate parts replaced. Category string operator Description text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) subtract https://wiki.kronosaur.com/doku.php/modding/function/subtract?rev=1419655256&do=diff subtract subtract subtract Syntax (subtract number number) Arguments number: The first number you want subtracted. number: The second number you want subtracted. Returns number: The number that results when you subtracts the two numbers. Category math Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) switch https://wiki.kronosaur.com/doku.php/modding/function/switch?rev=1419655255&do=diff switch switch switch Syntax (switch [exp1 exp2] ... [expn expn1] [defaultexp]) -> value of evaluated expression Arguments [exp1 exp2] ... [expn expn1]: A group of two expressions following each other. It the first expression evaluates to non-Nil, then the second expression is evaluated. Else the switch moves on to test the next group. There can be as many of these groups as neccessary. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) symbol_functions https://wiki.kronosaur.com/doku.php/modding/function/symbol_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. Symbol functions * symAddEntry * symCreate * symDeleteEntry * symList * symLookup Symbol functions are not included in the Xelerus list. IMPORTANT: The symbol functions are believed to be not yet functional. See list functions for similar functionality. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysaddencounterevent https://wiki.kronosaur.com/doku.php/modding/function/sysaddencounterevent?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysAddEncounterEvent See sysAddEncounterEvent at Xelerus Syntax (sysAddEncounterEvent number spaceObject number spaceObject) Arguments number: The delay before the encounter event can happens. spaceObject: The space object the encounter ships target. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysaddencountereventatdist https://wiki.kronosaur.com/doku.php/modding/function/sysaddencountereventatdist?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysAddEncounterEventAtDist See sysAddEncounterEventAtDist at Xelerus Syntax (sysAddEncounterEventAtDist number spaceObject number number) Arguments number: The delay before the encounter event can happens. spaceObject: The space object the encounter ships target. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysaddobjrecurringtimerevent https://wiki.kronosaur.com/doku.php/modding/function/sysaddobjrecurringtimerevent?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysAddObjRecurringTimerEvent See sysAddObjRecurringTimerEvent at Xelerus Syntax (sysAddObjRecurringTimerEvent number spaceObject string) Arguments number: The ticks between each of the timed events. spaceObject: The space object that will be calling the events. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysaddobjtimerevent https://wiki.kronosaur.com/doku.php/modding/function/sysaddobjtimerevent?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysAddObjTimerEvent See sysAddObjTimerEvent at Xelerus Syntax (sysAddObjTimerEvent number spaceObject string) Arguments number: The delay before the event is run. spaceObject: The space object that will be calling the event. string: The name of the event. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) syscalcfiresolution https://wiki.kronosaur.com/doku.php/modding/function/syscalcfiresolution?rev=1419655256&do=diff Discuss this page on this pag's Talk Page sysCalcFireSolution See sysCalcFireSolution at Xelerus Syntax (sysCalcFireSolution targetPos targetVel speed) -> angle or nil Arguments targetPos: the vector position of the target targetVel: the vector velocity of the target speed: the speed of the projectile text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) syscanceltimerevent https://wiki.kronosaur.com/doku.php/modding/function/syscanceltimerevent?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysCancelTimerEvent See sysCancelTimerEvent at Xelerus Syntax (sysCancelTimerEvent spaceObject string) Arguments spaceObject: The space object that will call the event that needs to be canceled. string: The name of the event. Returns condition: True if successful, Nil otherwise. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) syscreateeffect https://wiki.kronosaur.com/doku.php/modding/function/syscreateeffect?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysCreateEffect See sysCreateEffect at Xelerus Syntax (sysCreateEffect number spaceObject vector) Arguments number: the UNID of the effect you want to display. spaceObject: the spaceObject that called the effect, can be a ship or a station or Nil text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) syscreatemarker https://wiki.kronosaur.com/doku.php/modding/function/syscreatemarker?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysCreateMarker See sysCreateMarker at Xelerus Syntax (sysCreateMarker string vector number) Arguments string: the name of the marker vector: position of the newly created marker number: the UNID of the sovereign of the marker Returns text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) syscreateship https://wiki.kronosaur.com/doku.php/modding/function/syscreateship?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysCreateShip See sysCreateShip at Xelerus Syntax (sysCreateShip number vector number [string]) Arguments number: the UNID of the ship that has to be created vector: can be vector, gSource or gStart or any spaceObject number: The UNID of the sovereign assigned to the created ship text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) syscreatestation https://wiki.kronosaur.com/doku.php/modding/function/syscreatestation?rev=1419655255&do=diff Discuss this page on this page's Talk Page sysCreateStation See sysCreateStation at Xelerus Syntax (sysCreateStation number vector) -> spaceObject Arguments number: the UNID of the station that has to be created vector: the position of the new station Returns spaceObject: returns the spaceObject of successfully created. text/html 2017-02-14T02:36:57+00:00 Anonymous (anonymous@undisclosed.example.com) syscreateweaponfire https://wiki.kronosaur.com/doku.php/modding/function/syscreateweaponfire?rev=1487039817&do=diff Discuss this page on this pages TalkPage sysCreateWeaponFire See sysCreateWeaponFire at Xelerus Syntax (sysCreateWeaponFire weaponID objSource posVector dir speed objTarget [options] [bonus]) -> obj Arguments weaponID: the UNID of the called weapon effect. Can also be an itemStruct (for weapon scaling) text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysfindobject https://wiki.kronosaur.com/doku.php/modding/function/sysfindobject?rev=1419655255&do=diff Discuss this page on this page's Talk Page sysFindObject See sysFindObject at Xelerus Syntax (sysFindObject spaceObject criteria) -> list Arguments spaceObject: The space object in the system you want a list of space objects from. criteria: The critieria for inclusion in the list. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysgetdata https://wiki.kronosaur.com/doku.php/modding/function/sysgetdata?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysGetData See sysGetData at Xelerus Syntax (sysGetData [nodeID] attrib) -> data Arguments [nodeID]: The optional name of the system node. If not given it uses the current system. attrib: The attribute you want to retrieve the data of. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysgetenvironment https://wiki.kronosaur.com/doku.php/modding/function/sysgetenvironment?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysGetEnvironment See sysGetEnvironment at Xelerus Syntax (sysGetEnvironment spaceObject) Arguments spaceObject: The space object you want to check its environment. Returns number: The unid of the space environment. Category 0.99, spaceobject, unid Description text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysgetlevel https://wiki.kronosaur.com/doku.php/modding/function/sysgetlevel?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysGetLevel See sysGetLevel at Xelerus Syntax (sysGetLevel [string]) Arguments [string]: An optional nodeId of the system you want the level of. Returns number: The level of the current system or the system you requested. Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysgetname https://wiki.kronosaur.com/doku.php/modding/function/sysgetname?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysGetName See sysGetName at Xelerus Syntax (sysGetName [string]) Arguments [string]: An optional nodeId of the system you want the name from. Returns string: The name of the system. Category system Description Returns the name of the current system if no arguments otherwise returns the name of the system referenced by the string. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysgetnavpathpoint https://wiki.kronosaur.com/doku.php/modding/function/sysgetnavpathpoint?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysGetNavPathPoint See sysGetNavPathPoint at Xelerus Syntax (sysGetNavPathPoint number spaceObject spaceObject number) Arguments number: The UNID of the sovereign of the point. spaceObject: One of the two objects to find a point between. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysgetnode https://wiki.kronosaur.com/doku.php/modding/function/sysgetnode?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysGetNode See sysGetNode at Xelerus Syntax (sysGetNode) Returns string: The name of the node of the current system. Category system Description Returns the name of the node of the current system. Example (sysGetNode) If called in St. K's system will return a text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysgetobjectbyname https://wiki.kronosaur.com/doku.php/modding/function/sysgetobjectbyname?rev=1419655256&do=diff Discuss this page on this page's Talk Page sysGetObjectByName See sysGetObjectByName at Xelerus Syntax (sysGetObjectByName spaceObject string) Arguments spaceObject: A space object in the same system as the thing you are looking for. string: The name of the space object you are looking for. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysglobals https://wiki.kronosaur.com/doku.php/modding/function/sysglobals?rev=1419655256&do=diff Discuss this page on this pages TalkPage sysGlobals See sysGlobals at Xelerus Syntax (sysGlobals) Returns list: A list of strings naming all the globals. Category function, system, variable Description Returns a list of all the names of the global functions and global variables. Example Return to text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) syspoolusage https://wiki.kronosaur.com/doku.php/modding/function/syspoolusage?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysPoolUsage See sysPoolUsage at Xelerus Syntax (sysPoolUsage) Returns list: A list of numbers representing how much resources the game is using. Category system Description Returns a list of numbers representing how much resources the game is using. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) syssetdata https://wiki.kronosaur.com/doku.php/modding/function/syssetdata?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysSetData See sysSetData at Xelerus Syntax (sysSetData [string] string expression) Arguments string: The optional name of the system node. If not there uses the current system. string: The name of the data. expression: The data you want to store. text/html 2017-01-28T04:11:15+00:00 Anonymous (anonymous@undisclosed.example.com) sysstoptime https://wiki.kronosaur.com/doku.php/modding/function/sysstoptime?rev=1485576675&do=diff Discuss this page sysStopTime See sysStopTime at Xelerus Syntax 1 (sysStopTime duration except) -> True/Nil Syntax 2 (sysStopTime targetList duration) -> True/Nil Arguments 1 duration: How many ticks you want to stop time for. except: A space object that you want immune from the time stop. Can be any spaceobject. (can not be Nil) text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) system_functions https://wiki.kronosaur.com/doku.php/modding/function/system_functions?rev=1419655256&do=diff Discuss this page on this page's Talk Page. System functions * sysAddEncounterEvent * sysAddEncounterEventAtDist * sysAddObjRecurringTimerEvent * sysAddObjTimerEvent * sysAddStargateTopology * sysCalcTravelDistance * sysCalcTravelTime * sysCancelTimerEvent * sysCreateEffect * sysCreateEncounter * sysCreateMarker text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) systicks https://wiki.kronosaur.com/doku.php/modding/function/systicks?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysTicks See sysTicks at Xelerus Syntax (sysTicks) Returns number: A timer from your computer. Category system, time Description Returns the current time from your computer in ticks. Example Return to Functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectoradd https://wiki.kronosaur.com/doku.php/modding/function/sysvectoradd?rev=1419655255&do=diff Discuss this page on this page's Talk Page sysVectorAdd See sysVectorAdd at Xelerus Syntax (sysVectorAdd vector vector) -> vector Arguments vector: first vector to add vector: second vector to add Returns vector: the sum of the 2 vectors Category system, vector operator Description Function used to sum 2 vectors. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectorangle https://wiki.kronosaur.com/doku.php/modding/function/sysvectorangle?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysVectorAngle See sysVectorAngle at Xelerus Syntax (sysVectorAngle vector) Arguments vector: The vector you want to find the angle of with respect to the origin of the system. Returns number: The angle in degrees with respect to the origin of the system. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectordistance https://wiki.kronosaur.com/doku.php/modding/function/sysvectordistance?rev=1419655256&do=diff Discuss this page on this page's Talk Page sysVectorDistance See sysVectorDistance at Xelerus Syntax (sysVectorDistance vector vector) -> number Arguments vector: the first vector vector: the second vector for calculating the distance Returns number: distance between the 2 vectors in light-seconds text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectordivide https://wiki.kronosaur.com/doku.php/modding/function/sysvectordivide?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysVectorDivide See sysVectorDivide at Xelerus Syntax (sysVectorDivide vector number) Arguments vector: the vector you want to be divided by number: the integer that divide the vector Returns vector: the resulting position after the division text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectormultiply https://wiki.kronosaur.com/doku.php/modding/function/sysvectormultiply?rev=1419655255&do=diff Discuss this page on this page's Talk Page sysVectorMultiply See sysVectorMultiply at Xelerus Syntax (sysVectorMultiply vector number) Arguments vector: the vector you want to be multiplied number: the integer that multiply the vector Returns vector: the new position after the multiplication text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectorpolaroffset https://wiki.kronosaur.com/doku.php/modding/function/sysvectorpolaroffset?rev=1419655255&do=diff Discuss this page on this page's Talk Page sysVectorPolarOffset See sysVectorPolarOffset at Xelerus Syntax (sysVectorPolarOffset vector number number) -> vector Arguments vector: The origin of the new vector. Same as the systems origin if Nil. number: The angle of the vector from 0 to 360. 0 is to the right. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectorpolarvelocity https://wiki.kronosaur.com/doku.php/modding/function/sysvectorpolarvelocity?rev=1419655255&do=diff Discuss this page on this page's Talk Page sysVectorPolarVelocity See sysVectorPolarVelocity at Xelerus Syntax (sysVectorPolarVelocity number number) Arguments number: The angle of the vector from 0 to 360. 0 is to the right. number: the speed of the vector (in % of c) Returns velVector: returns the new velocity vector text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectorrandom https://wiki.kronosaur.com/doku.php/modding/function/sysvectorrandom?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysVectorRandom See sysVectorRandom at Xelerus Syntax (sysVectorRandom vector number number criteria) Arguments vector: The origin of the new vector. Same as the systems origin if Nil. number: The radius in ls away from the origin. number: The minimum separation in light-seconds away from any spaceObject that matches 'filter' criteria. If criteria is Nil, then we avoid all objects. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectorrandom_talk_page https://wiki.kronosaur.com/doku.php/modding/function/sysvectorrandom_talk_page?rev=1419655256&do=diff This is the Talk Page for sysVectorRandom sysVectorRandom: Talk Page Comment from George on sysVectorRandom Useful comment posted by George and copied from the forums (sysVectorRandom) is designed to find a spot that is not near anything. The “10” in your call is the minimum distance from any text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectorspeed https://wiki.kronosaur.com/doku.php/modding/function/sysvectorspeed?rev=1419655255&do=diff Discuss this page on this page's Talk Page sysVectorSpeed See sysVectorSpeed at Xelerus Syntax (sysVectorSpeed velVector) Arguments velVector: a velocity vector Returns number - an integer representing a speed (in % of c) Category system, vector operator Description A very useful function to transform messy velVectors into human readable speeds. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) sysvectorsubtract https://wiki.kronosaur.com/doku.php/modding/function/sysvectorsubtract?rev=1419655255&do=diff Discuss this page on this pages TalkPage sysVectorSubtract See sysVectorSubtract at Xelerus Syntax (sysVectorSubtract vector vector) Arguments vector: the first vector to be subtracted vector: the subtracting vector Returns vector: resulting position after the subtraction. Category text/html 2017-01-28T04:13:05+00:00 Anonymous (anonymous@undisclosed.example.com) time_functions https://wiki.kronosaur.com/doku.php/modding/function/time_functions?rev=1485576785&do=diff Discuss this page on this page's Talk Page. Time functions * unvGetTick * sysAddEncounterEvent * sysAddEncounterEventAtDist * sysAddObjRecurringTimerEvent * sysAddObjTimerEvent * sysCancelTimerEvent * sysTicks * sysStopTime time_functions. Return to functions list text/html 2017-01-20T03:14:34+00:00 Anonymous (anonymous@undisclosed.example.com) typaddrecurringtimerevent https://wiki.kronosaur.com/doku.php/modding/function/typaddrecurringtimerevent?rev=1484882074&do=diff Discuss this page on this pages TalkPage Added in API30 typAddRecurringTimerEvent Syntax (typAddRecurringTimerEvent unid interval event) Arguments unid: The unid of the type you want to add the event on. interval: interval in ticks between events. event: the event on the type to fire text/html 2017-01-20T03:18:32+00:00 Anonymous (anonymous@undisclosed.example.com) typaddtimerevent https://wiki.kronosaur.com/doku.php/modding/function/typaddtimerevent?rev=1484882312&do=diff Discuss this page on this pages TalkPage Added in API30 typAddTimerEvent Syntax (typAddTimerEvent unid delay event) Arguments unid: The unid of the type you want to add a timer event on. delay: delay, in ticks, before the event fires. event: the event on the type to fire text/html 2017-01-20T03:23:24+00:00 Anonymous (anonymous@undisclosed.example.com) typcanceltimerevent https://wiki.kronosaur.com/doku.php/modding/function/typcanceltimerevent?rev=1484882604&do=diff Discuss this page on this pages TalkPage Added in API30 typCancelTimerEvent Syntax (typCancelTimerEvent unid event) Arguments unid: The unid of the type you want to cancel the timer event on. event: the name of the event on the type to cancel Returns text/html 2017-06-12T01:07:36+00:00 Anonymous (anonymous@undisclosed.example.com) typcreate https://wiki.kronosaur.com/doku.php/modding/function/typcreate?rev=1497229656&do=diff Talk Page typCreate Syntax (typCreate unid XML) -> True/Nil Arguments unid: The UNID to assign to the created type. Must not already be bound to a type unless the code is run in OnGlobalTypesInit XML: The XML that defines the created type. Must be valid for type creation to work. Certain dynamic types are not supported at certain times. text/html 2017-06-12T01:07:56+00:00 Anonymous (anonymous@undisclosed.example.com) typdynamicunid https://wiki.kronosaur.com/doku.php/modding/function/typdynamicunid?rev=1497229676&do=diff Talk Page typDynamicUNID Syntax (typDynamicUNID uniqueName) -> UNID Arguments uniqueName: A string that represents the UNID to return. Must be at least one character long. Returns A UNID between 0xF0000000 and 0xFFFFFFFF. If the string has not been bound to any UNID, then the function will return a new UNID and bind the string to it. Otherwise, it will return the UNID that was bound to the name. text/html 2017-01-20T05:31:38+00:00 Anonymous (anonymous@undisclosed.example.com) typefireobjevent https://wiki.kronosaur.com/doku.php/modding/function/typefireobjevent?rev=1484890298&do=diff ~~GOTO>modding:function:typfireobjevent~~ text/html 2017-01-20T05:31:31+00:00 Anonymous (anonymous@undisclosed.example.com) typefirobjevent https://wiki.kronosaur.com/doku.php/modding/function/typefirobjevent?rev=1484890291&do=diff ~~GOTO>modding:function:typfireobjevent~~ text/html 2017-01-20T05:43:44+00:00 Anonymous (anonymous@undisclosed.example.com) typeof https://wiki.kronosaur.com/doku.php/modding/function/typeof?rev=1484891024&do=diff Discuss this page on this pages TalkPage typeOf Syntax (typeof expression) Arguments expression: the expression you want to know the type of Returns The kind of expression, eg. 'list Category type, unid Description Use to check the type of expression being used text/html 2017-01-20T05:44:09+00:00 Anonymous (anonymous@undisclosed.example.com) typeof_talk_page https://wiki.kronosaur.com/doku.php/modding/function/typeof_talk_page?rev=1484891049&do=diff No, this isn't really a type function, we'll find a home for it later. text/html 2017-01-20T02:55:27+00:00 Anonymous (anonymous@undisclosed.example.com) type_functions https://wiki.kronosaur.com/doku.php/modding/function/type_functions?rev=1484880927&do=diff Discuss this page on this page's Talk Page. Type functions * typAddRecurringTimerEvent * typAddTimerEvent * typCancelTimerEvent * typCreate * typDynamicUNID * typFind * typFireEvent * typFireObjEvent * typGetData * typGetDataField * typGetGlobalData * typGetProperty * typGetStaticData * typSetGlobalData * typGetXML * typHasAttribute * typHasEvent * typIncData * typMarkImages * typMatches * typSetData * typTranslate * typeOf type_functions. R… text/html 2017-01-20T02:29:59+00:00 Anonymous (anonymous@undisclosed.example.com) type_functions_talk_page https://wiki.kronosaur.com/doku.php/modding/function/type_functions_talk_page?rev=1484879399&do=diff We'll have to be sure to link to this page in the main function list. text/html 2017-01-20T05:05:33+00:00 Anonymous (anonymous@undisclosed.example.com) typfind https://wiki.kronosaur.com/doku.php/modding/function/typfind?rev=1484888733&do=diff Discuss this page on this pages TalkPage typFind See typFind at Xelerus Syntax (typFind criteria) Arguments Criteria: a string describing what structures you want to find (List) Returns list of UNID's Category 1.0, type, unid Description This function allow you to return a list of all the xml structures defined in Transcendence. text/html 2017-01-20T03:38:41+00:00 Anonymous (anonymous@undisclosed.example.com) typfireevent https://wiki.kronosaur.com/doku.php/modding/function/typfireevent?rev=1484883521&do=diff Discuss this page on this pages TalkPage typFireEvent Syntax (typFireEvent unid event [data]) Arguments unid: The unid of the type to fire the event on event: The event on the type to fire data: Data to pass on to the event (can be empty) Returns Result of event text/html 2017-01-20T05:31:22+00:00 Anonymous (anonymous@undisclosed.example.com) typfireobjevent https://wiki.kronosaur.com/doku.php/modding/function/typfireobjevent?rev=1484890282&do=diff Discuss this page on this pages TalkPage typFireObjEvent Syntax (typFireObjEvent unid obj event) Arguments unid: The unid of the type that holds the event obj: The space object to fire the event on event: the event to fire on the space object Returns text/html 2017-01-20T05:31:09+00:00 Anonymous (anonymous@undisclosed.example.com) typfirobjevent https://wiki.kronosaur.com/doku.php/modding/function/typfirobjevent?rev=1484890269&do=diff ~~GOTO>modding:function:typfireobjevent~~ text/html 2017-03-03T07:11:08+00:00 Anonymous (anonymous@undisclosed.example.com) typgetdata https://wiki.kronosaur.com/doku.php/modding/function/typgetdata?rev=1488525068&do=diff Discuss this page on this pages TalkPage typGetData Syntax (typGetData unid attrib) Arguments unid: The unid you want to get the data from. attrib: Name of the data you want to retrieve Returns Data Category type, unid Description Use for retrieving dynamic data from types. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) typgetdatafield https://wiki.kronosaur.com/doku.php/modding/function/typgetdatafield?rev=1419655255&do=diff Discuss this page on this page's Talk Page typGetDataField Syntax (typGetDataField unid attrib) -> data Arguments unid: The unid of the type you want to get the value of an attribute from. attrib: The name of the attribute you want to get. Returns data: The value of the attribute. text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) typgetglobaldata https://wiki.kronosaur.com/doku.php/modding/function/typgetglobaldata?rev=1419655255&do=diff Discuss this page on this pages TalkPage typGetGlobalData See typGetGlobalData at Xelerus Syntax (typGetGlobalData number string) Arguments number: The UNID of the type you want to get the data from. string: The name of the data you want to get. Returns The data named by the string for the given type. Returns Nil if there is no data as named by the string. text/html 2017-03-30T04:30:10+00:00 Anonymous (anonymous@undisclosed.example.com) typgetproperty https://wiki.kronosaur.com/doku.php/modding/function/typgetproperty?rev=1490848210&do=diff Discuss this page on this pages TalkPage typGetProperty Syntax (typGetProperty unid property) Arguments unid: The unid you want to get the property from. property: property you want to retrieve Returns value Category type_functions, unid, property Description Use for retrieving a property from a type. text/html 2017-01-20T04:19:59+00:00 Anonymous (anonymous@undisclosed.example.com) typgetproperty_talk_page https://wiki.kronosaur.com/doku.php/modding/function/typgetproperty_talk_page?rev=1484885999&do=diff Type properties 'apiVersion 'class 'extension Playerships 'dockServicesScreen 'shipStatusScreen 'startingSystem Ships 'armorCount 'armorHP 'armorItems 'balanceType 'cargoSpace 'combatStrength 'damage 'defaultSovereign 'defenseStrength text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) typgetstaticdata https://wiki.kronosaur.com/doku.php/modding/function/typgetstaticdata?rev=1419655256&do=diff Discuss this page on this pages TalkPage typGetStaticData See typGetStaticData at Xelerus Syntax (typGetStaticData number string) Arguments number: The UNID of the type you want to get the data from. string: The name of the data you want to get. Returns The data named by the string for the given type. Returns Nil if there is no data as named by the string. text/html 2017-01-20T04:29:31+00:00 Anonymous (anonymous@undisclosed.example.com) typhasattribute https://wiki.kronosaur.com/doku.php/modding/function/typhasattribute?rev=1484886571&do=diff Discuss this page on this pages TalkPage typHasAttribute Syntax (typHasAttribute unid attrib) Arguments unid: The unid you want to check for attributes. attrib: attribute to check for Returns True if successful, Nil otherwise Category type, unid, attributes text/html 2017-01-20T04:28:52+00:00 Anonymous (anonymous@undisclosed.example.com) typhasevent https://wiki.kronosaur.com/doku.php/modding/function/typhasevent?rev=1484886532&do=diff Discuss this page on this pages TalkPage typHasEvent Syntax (typHasEvent unid event) Arguments unid: The unid you want to check for events. event: the event to check for Returns True if successful, Nil otherwise Category type, unid Description Use for checking if a type holds an event. text/html 2017-01-20T04:36:23+00:00 Anonymous (anonymous@undisclosed.example.com) typincdata https://wiki.kronosaur.com/doku.php/modding/function/typincdata?rev=1484886983&do=diff Discuss this page on this pages TalkPage typIncData Syntax (typIncData unid attrib [increment]) Arguments unid: the unid of the type you want to increment data on attrib: the data that you want to increment increment: the value to add to the data Returns text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) typincglobaldata https://wiki.kronosaur.com/doku.php/modding/function/typincglobaldata?rev=1419655255&do=diff Discuss this page on this pages TalkPage typIncGlobalData See typIncGlobalData at Xelerus Syntax (typIncGlobalData number string [number]) Arguments number: The UNID of the type you want to increment the data in. string: The name of the data you want to increment. number: The optional number that gets added to the data. text/html 2017-01-20T04:44:33+00:00 Anonymous (anonymous@undisclosed.example.com) typmarkimages https://wiki.kronosaur.com/doku.php/modding/function/typmarkimages?rev=1484887473&do=diff Discuss this page on this pages TalkPage typMarkImages Syntax (typMarkImages unid) Arguments unid: the unid to load an image from Returns True if successful,Nil otherwise Category type, unid Description Forces the engine to load images needed by the unid to prevent lag when using them later. Useful when you generate lots of space objects through script - very large ship images or fleets with lots of different ships would benefit from this. text/html 2017-01-20T05:04:21+00:00 Anonymous (anonymous@undisclosed.example.com) typmatches https://wiki.kronosaur.com/doku.php/modding/function/typmatches?rev=1484888661&do=diff Discuss this page on this pages TalkPage typMatches Syntax (typMatches unid criteria) Arguments unid: the unid to check criteria: the criteria to check Returns True if successful,Nil otherwise Category type, unid Description Checks if a type matches the criteria. text/html 2017-01-20T05:11:19+00:00 Anonymous (anonymous@undisclosed.example.com) typsetdata https://wiki.kronosaur.com/doku.php/modding/function/typsetdata?rev=1484889079&do=diff Discuss this page on this pages TalkPage typSetData Syntax (typSetData unid attrib data) Arguments unid: the unid to set data on attrib: the name of the data to set data: the value to set the data to Returns True if successful,Nil otherwise Category text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) typsetglobaldata https://wiki.kronosaur.com/doku.php/modding/function/typsetglobaldata?rev=1419655255&do=diff Discuss this page on this pages TalkPage typSetGlobalData See typSetGlobalData at Xelerus Syntax (typSetGlobalData number string expression) Arguments number: The UNID of the type you want to set the data of. string: The name of the data you want to set. expression: The value that the data will be. text/html 2017-01-20T05:21:34+00:00 Anonymous (anonymous@undisclosed.example.com) typtranslate https://wiki.kronosaur.com/doku.php/modding/function/typtranslate?rev=1484889694&do=diff Discuss this page on this pages TalkPage typTranslate Syntax (typTranslate unid textID [data] [default]) Arguments unid: the unid the text is stored on textID: ID of the text data: data to pass on to the text default: ? Returns Text if found; Nil otherwise text/html 2017-01-31T00:17:31+00:00 Anonymous (anonymous@undisclosed.example.com) uicanplaymusic https://wiki.kronosaur.com/doku.php/modding/function/uicanplaymusic?rev=1485821851&do=diff Discuss this page on this pages Talk Page uicanplaymusic Note: This function does not seem to be functional. Syntax (uiCanPlayMusic filename) Arguments filename: Path to the file Returns True if successful, nil otherwise Category ui_functions, broken functions Description Evaluates if the file is a music track the engine can play. Doesn't seem functional. text/html 2017-01-31T00:14:57+00:00 Anonymous (anonymous@undisclosed.example.com) uigetmusiccatalog https://wiki.kronosaur.com/doku.php/modding/function/uigetmusiccatalog?rev=1485821697&do=diff Discuss this page on this pages Talk Page uigetmusiccatalog Syntax (uiGetMusicCatalog) Arguments none Returns List of files Category ui_functions, broken functions Description Gets a list of all the music files on your device. Probably not useful for anything anymore, as the other music functions don't work. text/html 2017-01-31T00:20:15+00:00 Anonymous (anonymous@undisclosed.example.com) uigetmusicstate https://wiki.kronosaur.com/doku.php/modding/function/uigetmusicstate?rev=1485822015&do=diff Discuss this page on this pages Talk Page uigetmusicstate Note: This function does not seem to be functional. Syntax (uigetmusicstate) Arguments Returns ('playing filename position length) Category ui_functions, broken functions Description Used for determining how long a track has been playing. Doesn't seem functional. text/html 2017-01-31T00:22:08+00:00 Anonymous (anonymous@undisclosed.example.com) uiplaymusic https://wiki.kronosaur.com/doku.php/modding/function/uiplaymusic?rev=1485822128&do=diff Discuss this page on this pages Talk Page uiPlayMusic Note: This function does not seem to be functional. Syntax (uiPlayMusic filename [pos]) Arguments filename: Path to the music file pos: the position to start playing the track in Returns True if successful, nil otherwise text/html 2017-01-31T00:34:04+00:00 Anonymous (anonymous@undisclosed.example.com) uiqueuesoundtrack https://wiki.kronosaur.com/doku.php/modding/function/uiqueuesoundtrack?rev=1485822844&do=diff Discuss this page on this pages TalkPage uiQueueSoundtrack Syntax (uiQueueSoundtrack soundtrackUNID [options]) Arguments soundtrackUNID: UNID of the soundtrack type to queue. options: Options to pass on to the soundtrack manager Returns Category text/html 2017-01-31T00:41:47+00:00 Anonymous (anonymous@undisclosed.example.com) uisetsoundtrackmode https://wiki.kronosaur.com/doku.php/modding/function/uisetsoundtrackmode?rev=1485823307&do=diff Discuss this page on this pages TalkPage uiSetSoundtrackMode Syntax (uiSetSoundtrackMode mode [soundtrackUNID]) Arguments mode: The mode to set the track to. soundtrackUNID: UNID of the soundtrack. Can be blank to refer to current track. Returns Category text/html 2017-01-31T00:08:12+00:00 Anonymous (anonymous@undisclosed.example.com) uistopmusic https://wiki.kronosaur.com/doku.php/modding/function/uistopmusic?rev=1485821292&do=diff Discuss this page on this pages Talk Page uiStopMusic Note: This function does not seem to be functional. Syntax (uiStopMusic) Arguments none Returns True if successful Category ui_functions broken functions Description Stops the currently playing music. Does not seem to be functional. text/html 2017-01-31T00:10:23+00:00 Anonymous (anonymous@undisclosed.example.com) ui_functions https://wiki.kronosaur.com/doku.php/modding/function/ui_functions?rev=1485821423&do=diff UI Functions Soundtrack Functions uiQueueSoundtrack uiSetSoundtrackMode Music Functions Most of these functions are broken. Use soundtrack types instead. uiCanPlayMusic uiGetMusicCatalog uiGetMusicState uiPlayMusic uiStopMusic See Also Soundtrack Types Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) uncategorized_functions https://wiki.kronosaur.com/doku.php/modding/function/uncategorized_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Uncategorised functions FIXME Insufficient information exists on these functions to categorize them. * lookup * sovGetDisposition * typFireObjEvent * typGetDataField * typHasAttribute * unvGetRealDate Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) unid_functions https://wiki.kronosaur.com/doku.php/modding/function/unid_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. UNID functions * itmCreate * itmGetUNID * sysCreateShip * shpGetDataField * shpGetShieldItemUNID * unvUNID * objGetSovereign * shpGetClass * staGetType * objGetImageDesc * shpGetImageDesc * sysGetEnvironment * typSetGlobalData * objGetStaticDataForStationType * typIncGlobalData * typGetGlobalData * typGetStaticData * sysGetNavPathPoint * envHasAttribute * sysCreateEffect * sysCreateStation * sysCreateWeapon… text/html 2017-06-04T21:56:39+00:00 Anonymous (anonymous@undisclosed.example.com) unvgetextensiondata https://wiki.kronosaur.com/doku.php/modding/function/unvgetextensiondata?rev=1496613399&do=diff Talk Page unvGetExtensionData Syntax (unvGetExtensionData scope attrib) -> data Arguments scope: Where the data is stored. 'local means the data is kept in the Storage.xml file. 'serviceExtension and 'serviceUser are meant to use the Multiverse services, but they are not implemented. text/html 2017-01-28T05:12:43+00:00 Anonymous (anonymous@undisclosed.example.com) unvgettick https://wiki.kronosaur.com/doku.php/modding/function/unvgettick?rev=1485580363&do=diff Discuss this page unvGetTick See unvGetTick at Xelerus Syntax (unvGetTick) Returns number: The number of ticks since the game has started. Category time Description Returns how many ticks since that game was started. Can be used to track the passage of time when firing events. An event may store the last tick it fired on as data and then subtract that from the current tick to see how much time passed between those two firings. text/html 2014-12-27T04:40:56+00:00 Anonymous (anonymous@undisclosed.example.com) unvunid https://wiki.kronosaur.com/doku.php/modding/function/unvunid?rev=1419655256&do=diff Discuss this page on this page's Talk Page unvUNID See unvUNID at Xelerus Syntax (unvUNID string) Arguments string: Part of the name of the item or ship you want. Returns list: A list that has a random item or ship that matches part of the name. The list looks like if a ship (UNID 'shipclass name) and if a item (UNID 'itemtype name) text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) variable_functions https://wiki.kronosaur.com/doku.php/modding/function/variable_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Variable functions * eval * sysGlobals variable_functions. Return to functions list text/html 2014-12-27T04:40:55+00:00 Anonymous (anonymous@undisclosed.example.com) vector_operator_functions https://wiki.kronosaur.com/doku.php/modding/function/vector_operator_functions?rev=1419655255&do=diff Discuss this page on this page's Talk Page. Vector operator functions * objGetVel * objIncVel * objSetVel * sysVectorAdd * sysVectorAngle * sysVectorDistance * sysVectorDivide * sysVectorMultiply * sysVectorPolarOffset * sysVectorPolarVelocity * sysVectorRandom * sysVectorSpeed * sysVectorSubtract * vecVector vecVector is not included in the Xelerus list. vector_operator_functions. Return to functions list text/html 2017-01-28T19:09:29+00:00 Anonymous (anonymous@undisclosed.example.com) xmlcreate https://wiki.kronosaur.com/doku.php/modding/function/xmlcreate?rev=1485630569&do=diff Discuss this page xmlCreate Syntax (xmlCreate xml) -> xml Arguments xml: The XML or string to use Returns A new XML pointer Category XML Description Creates a new XML pointer from existing XML or converts a string into XML data. String must be properly formatted XML data. text/html 2017-01-28T19:54:07+00:00 Anonymous (anonymous@undisclosed.example.com) xmlgettext https://wiki.kronosaur.com/doku.php/modding/function/xmlgettext?rev=1485633247&do=diff Discuss this page xmlGetText Syntax (xmlGetText xml index) -> xml Arguments xml: The XML element to get the text data from index: The 0-based index of the text to get Returns The block of text at the specified index in xml Category XML Description “Text” text/html 2017-01-21T19:15:37+00:00 Anonymous (anonymous@undisclosed.example.com) xml_functions https://wiki.kronosaur.com/doku.php/modding/function/xml_functions?rev=1485026137&do=diff Discuss this page on this page's Talk Page. XML functions * xmlAppendSubElement * xmlAppendText * xmlCreate * xmlDeleteSubElement * xmlGetAttrib * xmlGetAttribList * xmlGetSubElement * xmlGetSubElementCount * xmlGetSubElementList * xmlGetTag * xmlGetText * xmlSetAttrib * xmlSetText Return to functions list