Anders: /* Global functions */

2025-08-03T13:15:55Z

Global functions

← Older revision		Revision as of 13:15, 3 August 2025
Line 59:		Line 59:
	\|-		\|-
	\|		\|
	\|[[Global:abort(string message)\|abort]](string message)		\|[[Global:abort(string message)\|abort]]([[string]] message)
	\|crashes the lua script with a message		\|crashes the lua script with a message
	\|-		\|-
Line 132:		Line 132:
	\|number		\|number
	\|[[Global:tonumber(nil value)\|tonumber]](nil value)		\|[[Global:tonumber(nil value)\|tonumber]](nil value)
			\|Convert input to number.
			\|-
			\|number
			\|[[Global:tonumber(Object value)\|tonumber]](Object value)
	\|Convert input to number.		\|Convert input to number.
	\|-		\|-

Anders: Created page with "{{:GlobalExampleCode}} ==Global members== {| class="wikitable" !|type !|variable !|description |- |float |PI |3.14159265359 |- |int |LUA_INDEX | |- |LuaWrapper |LUA | |- |} ==Global functions== {| class="wikitable" !|return !|function !|description |- | |require(string path) |Include another lua file. This is equal to just past in the file on this row. |- | |setRestoreData(nil data) |Set r..."

2025-07-05T14:22:34Z

Created page with "{{:GlobalExampleCode}} ==Global members== {| class="wikitable" !|type !|variable !|description |- |float |PI |3.14159265359 |- |int |LUA_INDEX | |- |LuaWrapper |LUA | |- |} ==Global functions== {| class="wikitable" !|return !|function !|description |- | |require(string path) |Include another lua file. This is equal to just past in the file on this row. |- | |setRestoreData(nil data) |Set r..."

New page

{{:GlobalExampleCode}}

==Global members==
{| class="wikitable"

!|type
!|variable
!|description
|-
|float
|PI
|3.14159265359
|-
|int
|LUA_INDEX
|
|-
|[[LuaWrapper]]
|LUA
|
|-
|}

==Global functions==
{| class="wikitable"
!|return
!|function
!|description
|-
|
|[[Global:require(string path)|require]]([[string]] path)
|Include another lua file.
This is equal to just past in the [[file]] on this row.
|-
|
|[[Global:setRestoreData(nil data)|setRestoreData]](nil data)
|Set restore data object. if data is set and the Lua script crashes the restore function is called with the first parameter being the restore data object.
If nil is set as data no restore function is called upon a Lua script crash.
|-
|nil,nil
|[[Global:ipairs(table tab)|ipairs]]([[table]] tab)
|
|-
|nil,nil
|[[Global:pairs(table tab)|pairs]]([[table]] tab)
|
|-
|nil,nil
|[[Global:spairs(table tab)|spairs]]([[table]] tab)
|
|-
|
|[[Global:assert(object input1,string output)|assert]](object input1,string output)
|if input1 is false or nil, it will raises an error and print the output message
|-
|
|[[Global:abort()|abort]]()
|crashes the lua script
|-
|
|[[Global:abort(string message)|abort]](string message)
|crashes the lua script with a message
|-
|string
|[[Global:type(nil variable)|type]](nil variable)
|returns the type name of the lua object
|-
|
|[[Global:print(string msg)|print]](string msg)
|Print to console
|-
|
|[[Global:print(Text msg)|print]]([[Text]] msg)
|Print to console
|-
|bool
|[[Global:doLineCollide(Line3D line)|doLineCollide]]([[Line3D]] line)
|Do a [[collision]] against the entire world.
|-
|[[VectorVec3]]
|[[Global:createHullList3d(Mesh aMesh)|createHullList3d]]([[Mesh]] aMesh)
|Convert a [[mesh]] into a 3d hull.
|-
|[[VectorVec2]]
|[[Global:createHullList2d(Mesh aMesh)|createHullList2d]]([[Mesh]] aMesh)
|Convert a [[mesh]] into a 2d hull.
|-
|[[Matrix]]
|[[Global:generateRotationMatrix(float x, float y, float z, float rotation)|generateRotationMatrix]](float x, float y, float z, float rotation)
|Create a rotation [[matrix]].
|-
|[[Camera]]
|[[Global:ConvertToCamera(SceneNode node)|ConvertToCamera]]([[SceneNode]] node)
|Typecast node to [[camera]].
|-
|[[Panel]]
|[[Global:convertToPanel(LuaObject node)|convertToPanel]](LuaObject node)
|Typecast node to [[Panel]].
|-
|bool
|[[Global:getScreenPosInsideAnyForm(Vec2 pos)|getScreenPosInsideAnyForm]]([[Vec2]] pos)
|Return if the screen cordinate is inside any visible [[form]].
|-
|bool
|[[Global:tobool(bool value)|tobool]](bool value)
|Convert input to boolean.
|-
|bool
|[[Global:tobool(float value)|tobool]](float value)
|Convert input to boolean. 0 is false every thing else is true
|-
|bool
|[[Global:tobool(string value)|tobool]](string value)
|Convert input to boolean. "true" is true everything else is false
|-
|number
|[[Global:tonumber(number value)|tonumber]](number value)
|Convert input to number.
|-
|number
|[[Global:tonumber(bool value)|tonumber]](bool value)
|Convert input to number. return 0 or 1
|-
|number
|[[Global:tonumber(string value)|tonumber]](string value)
|Convert input to number.
|-
|number
|[[Global:tonumber(Text value)|tonumber]](Text value)
|Convert input to number.
|-
|number
|[[Global:tonumber(nil value)|tonumber]](nil value)
|Convert input to number.
|-
|string
|[[Global:tostring(nil)|tostring]](nil)
|Convert input to string.
|-
|string
|[[Global:tostring(boolean value)|tostring]](boolean value)
|Convert boolean to string.
|-
|string
|[[Global:tostring(string value)|tostring]](string value)
|Convert string to string.
|-
|string
|[[Global:tostring(table tab)|tostring]](table tab)
|Converts a table to string. can handle number,string,boolean,Vec2,Vec3,Vec4 and tables. The Table must be in a tree structure, as recursion will create an error
|-
|string
|[[Global:tabToStrMinimal(table tab)|tabToStrMinimal]](table tab)
|Converts a table to string. return a minimalistic string without unnecessary spacing and line breaks. return like "{param1=1,param2=23}".
|-
|table
|[[Global:totable(string str)|totable]](string str)
|Must be Lua legal code and start with a table like table = {param1=1,param2="str"}. can handle number,string,boolean,Vec2,Vec3,Vec4 and tables. The Table must be in a tree structure, as recursion will create an error.
|-
|[[Vec2]]
|[[Global:tovec2(string str)|tovec2]](string str)
|Convert String of format "Vec2(1,2)"
|-
|[[Vec3]]
|[[Global:tovec3(string str)|tovec3]](string str)
|Convert String of format "Vec3(1,2,3)"
|-
|[[Vec4]]
|[[Global:tovec4(string str)|tovec4]](string str)
|Convert String of format "Vec4(1,2,3,4)"
|-
|number
|[[Global:getActiveScriptCounterTable()|getActiveScriptCounterTable]]()
|return the count of running script
|-
|{ name=string(), time=number(), count=number() }
|[[Global:getScriptTimeTable()|getScriptTimeTable]]()
|return a table of all script and amount of work time
|-
|{ name=string(), time=number(), count=number() }
|[[Global:getGroupScriptTimeTable()|getGroupScriptTimeTable]]()
|return a table of all script and amount of work time
|-
|}

==Global functions (map creation)==
{| class="wikitable"
!|return
!|function
!|description
|-
|
|[[Global:abort()|abort]]()
|Crashes the script
|-
|table
|[[Global:getCrashTable()|getCrashTable]]()
|Get crash table.
|-
|}

Global - Revision history

Anders: /* Global functions */