GetGameSpeed: Difference between revisions
Jump to navigation
Jump to search
JackZipper (talk | contribs) (→Syntax) |
Dutchman101 (talk | contribs) (Fixed function name; including the typo it had, this example code didn't even work: outputChatbox doesnt exist, outputChatBox does.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">float getGameSpeed()</syntaxhighlight> | <syntaxhighlight lang="lua">float getGameSpeed ( )</syntaxhighlight> | ||
===Returns=== | ===Returns=== | ||
Returns a ''float''. | Returns a ''float'' representing the speed of the game. | ||
==Example== | ==Example== | ||
<section name="Server and Client" class="both" show="true"> | <section name="Server and Client" class="both" show="true"> | ||
This example adds a 'gamespeed' console command that prints the game speed to the | This example adds a 'gamespeed' console command that prints the game speed to the chatbox. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function | function gameSpeedValue( ) | ||
local speed = getGameSpeed ( ) | local speed = getGameSpeed( ) | ||
outputChatBox( "Game speed is currently set to " .. speed .. "." ) | |||
end | end | ||
addCommandHandler ( "gamespeed", | addCommandHandler( "gamespeed", gameSpeedValue ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
| Line 23: | Line 23: | ||
==See Also== | ==See Also== | ||
{{World functions}} | {{World functions}} | ||
[[ru:getGameSpeed]] | [[ru:getGameSpeed]] | ||
Latest revision as of 22:13, 10 January 2015
This function gets the current game speed value.
Syntax
float getGameSpeed ( )
Returns
Returns a float representing the speed of the game.
Example
Click to collapse [-]
Server and ClientThis example adds a 'gamespeed' console command that prints the game speed to the chatbox.
function gameSpeedValue( )
local speed = getGameSpeed( )
outputChatBox( "Game speed is currently set to " .. speed .. "." )
end
addCommandHandler( "gamespeed", gameSpeedValue )
See Also
- areTrafficLightsLocked
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getCloudsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGravity
- getHeatHaze
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getOcclusionsEnabled
- getRainLevel
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getWeather
- getWindVelocity
- getSkyGradient
- getPlayerBlurLevel
- getZoneName
- isGarageOpen
- removeWorldModel
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetWindVelocity
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setCloudsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorSoundsEnabled
- setMinuteDuration
- setMoonSize
- setOcclusionsEnabled
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightState
- setTrafficLightsLocked
- setWeather
- setWeatherBlended
- setWindVelocity
- setJetpackMaxHeight
- setPlayerBlurLevel