Lua UnsyncedRead - Revision history

Beherith: /* Time */

2022-05-01T09:38:29Z

Time

← Older revision		Revision as of 10:38, 1 May 2022
Line 1,911:		Line 1,911:
	\|arg9 =		\|arg9 =
	\|return = {{type\|number}} userSpeedFactor, {{type\|number}} speedFactor, {{type\|bool}} paused		\|return = {{type\|number}} userSpeedFactor, {{type\|number}} speedFactor, {{type\|bool}} paused
	\|info = {{new\|98.0}}		\|info = Speed factors are by default 1.0, (the default simulation gamespeed) but are not 0 when the game is paused. Factor at 10x gamespeed is 10.0. {{new\|98.0}}
	}}		}}

Beherith: /* Time */

2022-04-20T14:09:16Z

Time

← Older revision		Revision as of 15:09, 20 April 2022
Line 2,004:		Line 2,004:
	\|prefix = Spring.		\|prefix = Spring.
	\|name = GetFrameTimer		\|name = GetFrameTimer
	\|arg1 = {{type\|bool}} lastFrameTime{{rbracket}}		\|arg1 = {{bracket}} {{type\|bool}} lastFrameTime {{rbracket}}
	\|arg2 =		\|arg2 =
	\|arg3 =		\|arg3 =
Line 2,014:		Line 2,014:
	\|arg9 =		\|arg9 =
	\|return = {{type\|timer}}		\|return = {{type\|timer}}
	\|info = {{new\|102.0}}<br>Get a timer for the start of the frame, this should give better results for camera interpolations. If given a boolean true, then it returns the game->lastFrameTime instead of the lastFrameStart		\|info = {{new\|102.0}}<br>Get a timer for the start of the frame, this should give better results for camera interpolations. If given an optional boolean true, then it returns the game->lastFrameTime instead of the lastFrameStart
	}}		}}

Beherith: /* Time */

2022-04-20T14:08:26Z

Time

← Older revision		Revision as of 15:08, 20 April 2022
Line 1,997:		Line 1,997:
	\|arg9 =		\|arg9 =
	\|return = {{type\|timer}}		\|return = {{type\|timer}}
	\|info =		\|info = This function returns a timer type object, which we can use a pair of to calculate the time difference between two timer objects with DiffTimers. However, this time is at best millisecond resolution.
	}}		}}

Line 2,004:		Line 2,004:
	\|prefix = Spring.		\|prefix = Spring.
	\|name = GetFrameTimer		\|name = GetFrameTimer
	\|arg1 =		\|arg1 = {{type\|bool}} lastFrameTime{{rbracket}}
	\|arg2 =		\|arg2 =
	\|arg3 =		\|arg3 =
Line 2,014:		Line 2,014:
	\|arg9 =		\|arg9 =
	\|return = {{type\|timer}}		\|return = {{type\|timer}}
	\|info = {{new\|102.0}}<br>Get a timer for the start of the frame, this should give better results for camera interpolations.		\|info = {{new\|102.0}}<br>Get a timer for the start of the frame, this should give better results for camera interpolations. If given a boolean true, then it returns the game->lastFrameTime instead of the lastFrameStart
	}}		}}

Beherith: /* Time */

2022-01-23T20:08:23Z

Time

← Older revision		Revision as of 21:08, 23 January 2022
Line 1,945:		Line 1,945:
	\|arg9 =		\|arg9 =
	\|return = {{type\|nil}} {{pipe}} {{type\|number}} offset		\|return = {{type\|nil}} {{pipe}} {{type\|number}} offset
	\|info =		\|info = Gets globalRendering->timeOffset, which contains the offset of the current draw frame from the last sim frame, expressed in fractions of a frame. Ideally, when running 30hz sim, and 60hz rendering, the draw frames should have and offset of either 0.0 frames, or 0.5 frames. When draw frames are not integer multiples of sim frames, some interpolation happens, and this timeoffset shows how far along it is.
	}}		}}

Masterbel at 03:07, 5 January 2022

2022-01-05T03:07:30Z

← Older revision		Revision as of 04:07, 5 January 2022
Line 1,608:		Line 1,608:
	\|arg9 =		\|arg9 =
	\|return = { {{bracket}}{{type\|number}} code{{rbracket}} = {{type\|bool}}, {{bracket}}{{type\|string}} name{{rbracket}} = {{type\|bool}}, ... }		\|return = { {{bracket}}{{type\|number}} code{{rbracket}} = {{type\|bool}}, {{bracket}}{{type\|string}} name{{rbracket}} = {{type\|bool}}, ... }
	\|info = {{new\|99.0}}: {{type\|string}} name		\|info = {{new\|99.0}}: {{type\|string}} name<br>Returns the SDL1 codes for the pressed keys, first as an integer, a string containing the hex representation.<br>Use Spring.[[Lua_UnsyncedRead#GetKeySymbol\|GetKeySymbol]] to convert to an SDL2 symbol.
	}}		}}

Line 1,626:		Line 1,626:
	\|arg9 =		\|arg9 =
	\|return = {{type\|number}} keyCode		\|return = {{type\|number}} keyCode
	\|info =		\|info = Returns the SDL1 code for the SDL2 symbol
	}}		}}

Line 1,643:		Line 1,643:
	\|arg9 =		\|arg9 =
	\|return = {{type\|string}} "keysym1", {{type\|string}} "keysym2"		\|return = {{type\|string}} "keysym1", {{type\|string}} "keysym2"
	\|info =		\|info = Converts an SDL1 keycode into an SDL2 keycode, represented as a hexadecimal string. For most cases, these values will be the same.
	}}		}}

Maddox: GetLocalAllyTeamID was written as GetLocalTeamID

2021-12-14T04:28:42Z

GetLocalAllyTeamID was written as GetLocalTeamID

← Older revision		Revision as of 05:28, 14 December 2021
Line 200:		Line 200:
	{{LuaCallout		{{LuaCallout
	\|prefix = Spring.		\|prefix = Spring.
	\|name = ~~GetLocalTeamID~~		\|name = GetLocalAllyTeamID
	\|arg1 =		\|arg1 =
	\|arg2 =		\|arg2 =

Picassoct: /* Screen Trace */ Does not need a third z argument, but can have a optional argument index (optArgIdx)https://github.com/spring/spring/blob/a8cf33ad1d2ac775e6008cd04baa7e859d1f23ec/rts/Lua/LuaUnsyncedRead.cpp#L1547

2021-11-17T22:08:43Z

Screen Trace: Does not need a third z argument, but can have a optional argument index (optArgIdx)https://github.com/spring/spring/blob/a8cf33ad1d2ac775e6008cd04baa7e859d1f23ec/rts/Lua/LuaUnsyncedRead.cpp#L1547

← Older revision		Revision as of 23:08, 17 November 2021
Line 578:		Line 578:
	\|prefix = Spring.		\|prefix = Spring.
	\|name = TraceScreenRay		\|name = TraceScreenRay
	\|arg1 = {{type\|number}} mouseX, {{type\|number}} mouseY, ~~{{type\|number}} mouseZ~~ {{bracket}}		\|arg1 = {{type\|number}} mouseX, {{type\|number}} mouseY, {{bracket}}
	\|arg2 = {{type\|bool}} onlyCoords {{bracket}}		\|arg2 = {{type\|bool}} onlyCoords {{bracket}}
	\|arg3 = {{type\|bool}} useMinimap {{bracket}}		\|arg3 = {{type\|bool}} useMinimap {{bracket}}

Master-athmos: Updated page with new anchorable templates

2021-04-19T21:28:05Z

Updated page with new anchorable templates

Show changes

Floris: /* Time */

2021-04-04T12:28:45Z

Time

← Older revision		Revision as of 13:28, 4 April 2021
Line 451:		Line 451:
	'''Spring.GetGameSpeed''' {{new\|98.0}}		'''Spring.GetGameSpeed''' {{new\|98.0}}
	( ) -> number userSpeedFactor, number speedFactor, boolean paused		( ) -> number userSpeedFactor, number speedFactor, boolean paused
			'''Spring.GetGameState''' {{new\|105.0}}
			( ) -> boolean finishedLoading, boolean loadedFromSave, boolean locallyPaused, boolean laggingWrtExpectedFromSimtime
	'''Spring.GetFrameTimeOffset'''		'''Spring.GetFrameTimeOffset'''
	( ) -> nil \| number		( ) -> nil \| number

Dmitryprofessional: /* Camera */

2020-10-15T07:25:42Z

Camera

← Older revision		Revision as of 08:25, 15 October 2020
Line 89:		Line 89:
	( ) -> number forward_x, number forward_y, number forward_z		( ) -> number forward_x, number forward_y, number forward_z
	'''Spring.GetCameraFOV'''		'''Spring.GetCameraFOV'''
	( ) -> number ~~fov~~		( ) -> number vFov, number hFov
	'''Spring.GetCameraVectors'''		'''Spring.GetCameraVectors'''
	( ) -> vectorTable = {		( ) -> vectorTable = {
Line 157:		Line 157:
	'''Spring.GetScreenGeometry''' (is missing multiscreen support!)		'''Spring.GetScreenGeometry''' (is missing multiscreen support!)
	( ) -> number screenSizeX, number screenSizeY, number ZERO, number ZERO		( ) -> number screenSizeX, number screenSizeY, number ZERO, number ZERO


	== Unit ==		== Unit ==