DarkRP.Player.Arrest
From GMod Wiki
Revision as of 12:17, 16 November 2011 by [RV] TJjokerR (Talk | contribs)
This page has been nominated for deletion. Deletion is due within approximately 30 days from nomination, unless the deletion has been disputed on the talk page. See more pages nominated for deletion here. Reason for deletion: Not what Garry wants the wiki to be used for Last Edit was made on 11/16/2011 |
Gamemode Function: DarkRP.Player.Arrest | |
---|---|
DarkRP.Player.Arrest is a function that is defined in the DarkRP Gamemode and its derivatives. |
Function | |
Syntax |
Player:Arrest( Integer time, Boolean rejoin ) Where is this used? |
Description: | |
Arrests the player with the given time or the default jailing time. | |
Returns: | nil |
Part of Library: | Player |
Realm: | |
BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=DarkRP.Player.Arrest]DarkRP.Player.Arrest [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
Description | Arrests all players for default jail time |
---|---|
Used on | |
Code | function ArrestAll( ) for k, v in pairs(player.GetAll()) do v:Arrest() end end |
Output | N/A |
Additional Notes
- The rejoin argument is used by the function, it forces the arrest and teleports the player to jail even if they are already arrested.
- If time is set to nothing, the arrest function will use the default time.
- You can call it like this, Player:Arrest() without the arguments.