StopRecordingPlayerData: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Welcome| desc=Stops the recording of the actions of the player started using StartRecordingPlayerData| params=<syntaxhighlight lang="lua">(playerid)</syntaxhighlight> <p...") |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
params=<syntaxhighlight lang="lua">(playerid)</syntaxhighlight> | params=<syntaxhighlight lang="lua">(playerid)</syntaxhighlight> | ||
<poem>::playerid : The ID of the player whose actions to be stopped recording.</poem>| | <poem>::playerid : The ID of the player whose actions to be stopped recording.</poem>| | ||
retvals='''true''', if success; '''false''', on failure. Failure means either recording is not progressing/already stopped or player not connected.| | |||
example=<source lang="lua"> | example=<source lang="lua"> | ||
function onPlayerCommand(player,cmd,text) | function onPlayerCommand(player,cmd,text) | ||
| Line 17: | Line 18: | ||
} | } | ||
</source>| | </source>| | ||
relfuncs=*[[StartRecordingPlayerData]] | relfuncs=*[[StopRecordingAllPlayerData]] | ||
*[[StartRecordingPlayerData]] | |||
*[[StartRecordingAllPlayerData]] | |||
}} | }} | ||
Latest revision as of 10:41, 20 December 2023
Description:
Stops the recording of the actions of the player started using StartRecordingPlayerData
Parameters:
(playerid)
playerid : The ID of the player whose actions to be stopped recording.
Return Values:
true, if success; false, on failure. Failure means either recording is not progressing/already stopped or player not connected.
Example
function onPlayerCommand(player,cmd,text)
{
if(cmd=="stoprecord")
{
local success=StopRecordingPlayerData(player.ID);
if(success)
ClientMessage("[Recording]Stopped", player, 255, 255, 255);
else
ClientMessage("Command Failed", player,255, 255, 255);
}
}Related Functions
The following functions may be helpful as they relate to this function in one way or another.