SetFPSLimit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Server function}} __NOTOC__ This function sets the maximum [http://en.wikipedia.org/wiki/Frame_rate FPS (Frames per second)] that players on the server can run their game at. ==Syntax...)
 
mNo edit summary
Line 12: Line 12:


===Returns===
===Returns===
Returns ''false'' if it was not possible to shut down the server.
Returns ''false'' if it was not possible to set the limit, or if an invalud value was set.  Returns ''true'' if the operation was successful.


==Example==  
==Example==  

Revision as of 20:41, 21 May 2008

This function sets the maximum FPS (Frames per second) that players on the server can run their game at.

Syntax

bool setFPSLimit ( int fpsLimit )         

Required Arguments

  • fpsLimit: An integer value representing the maxmimum FPS. This value may be between 25 and 100 FPS.

Returns

Returns false if it was not possible to set the limit, or if an invalud value was set. Returns true if the operation was successful.

Example

This command sets the fps limit in a command handler.

addCommandHandler ( "setfps", function ( player, command, limit )
  if ( hasObjectPermissionTo ( player, "function.setFPSLimit" ) ) then
    setFPSLimit ( limit )
  end
end )

See Also