Difference between revisions of "SetFPSLimit"

From Multi Theft Auto: Wiki
m
m
Line 12: Line 12:
  
 
===Returns===
 
===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.
+
Returns ''true'' if successful, or ''false'' if it was not possible to set the limit or an invalid value was passed.
  
 
==Example==  
 
==Example==  

Revision as of 17:28, 28 June 2009

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 maximum FPS. This value may be between 25 and 100 FPS. You can also pass 0 or false, in which case the FPS limit will be disabled.

Returns

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

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