GetGravity: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Syntax fix, added return info, added template, added sections)
m (Fixed section)
Line 24: Line 24:
addCommandHandler ( getGravityLevel, "gravity" )
addCommandHandler ( getGravityLevel, "gravity" )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{World functions}}</section>
{{World functions}}</section>

Revision as of 20:43, 4 August 2007

This function returns the current gravity level for the context in which it is called (server or client).

Syntax

Click to collapse [-]
Server and Client
float getGravity()

Returns

Returns a float with the current server or client (depending on where you call the function) gravity level.

Example

Click to collapse [-]
Server

This serverside command outputs the serverside gravity level.

function getGravityLevel( playerSource )
    local gravity = getGravity()
    outputConsole ( "The gravity is currently set to "..gravity, playerSource )
end
-- attach the 'getGravityLevel' function to the "gravity" command
addCommandHandler ( getGravityLevel, "gravity" )

See Also

Shared

</section>