StartRecordingPlayerData: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
<poem style="border: 2px solid #d6d2c5; background-color: #f9f4e6; padding: 1em;"> | |||
The parameter flags was added in v1.8 (not released as of 19.Dec.2023) and will not work in previous versions. See [[Special:PermanentLink/240|StartRecordingPlayerData]] | |||
</poem> | |||
{{Welcome| | {{Welcome| | ||
desc=Starts recording player movements to a file which can be reproduced by an NPC| | desc=Starts recording player movements to a file which can be reproduced by an NPC| | ||
params=<syntaxhighlight lang="lua">(playerid, recordtype, recordname | params=<syntaxhighlight lang="lua">(playerid, recordtype=3, recordname="", flags=60)</syntaxhighlight> | ||
<poem>::playerid : The ID of the player whose actions to be recorded | <poem>::playerid : The ID of the player whose actions to be recorded | ||
::recordtype : The [[RecordingTypes|type]] of the recording. | ::recordtype : The [[RecordingTypes|type]] of the recording. | ||
::recordname : The name of the file which will store the data. The file will be saved in npcscripts/recordings with an automatically added [[.rec_file|.rec]] extension.</poem>| | ::recordname : The name of the file which will store the data. The file will be saved in npcscripts/recordings with an automatically added [[.rec_file|.rec]] extension. Uf this parameter is empty string or is omitted, plugin will create file based on system time, date and name of player. | ||
::flags : Specify one or more value combined from [[Recording_Flags|flags]] by using 'bitwise OR'. 0 means nothing will be recorded. </poem>| | |||
retvals='''true''', on success and '''false''', on failure. Failure means the player is not connected.| | retvals='''true''', on success and '''false''', on failure. Failure means the player is not connected.| | ||
example=<source lang="lua"> | example=<source lang="lua"> |
Revision as of 17:33, 19 December 2023
The parameter flags was added in v1.8 (not released as of 19.Dec.2023) and will not work in previous versions. See StartRecordingPlayerData
Description:
Starts recording player movements to a file which can be reproduced by an NPC
Parameters:
(playerid, recordtype=3, recordname="", flags=60)
playerid : The ID of the player whose actions to be recorded
recordtype : The type of the recording.
recordname : The name of the file which will store the data. The file will be saved in npcscripts/recordings with an automatically added .rec extension. Uf this parameter is empty string or is omitted, plugin will create file based on system time, date and name of player.
flags : Specify one or more value combined from flags by using 'bitwise OR'. 0 means nothing will be recorded.
Return Values:
true, on success and false, on failure. Failure means the player is not connected.
Example
function onPlayerCommand(player,cmd,text) { if(cmd=="ofrecord") { if(player.IsAdmin==false) { ClientMessage("You need Admin privilege to use this command",player,255,255,255); return; } if(player.Vehicle) { ClientMessage("You cannot be in vehicle when using this command",player,255, 255, 255); return; } if(!text) { ClientMessage("Usage: /ofrecord filename",player,255, 255, 255); return; } local success=StartRecordingPlayerData(player.ID, PLAYER_RECORDING_TYPE_ONFOOT, text); if(success) ClientMessage("[Recording]Started",player,255, 255, 255); else ClientMessage("Command Failed", player, 255, 255, 255); }else if (cmd=="vrecord") { if(player.IsAdmin==false) { ClientMessage("You need Admin privilege to use this command",player,255,255,255); return; } if(!player.Vehicle) { ClientMessage("You must be in a vehicle to use this command",player,255, 255, 255); return; } if(!text) { ClientMessage("Usage: /vrecord filename",player, 255, 255, 255); return; } local success=StartRecordingPlayerData(player.ID, PLAYER_RECORDING_TYPE_DRIVER, text); if(success) ClientMessage("[Recording]Started",player, 255, 255, 255); else ClientMessage("Command Failed", player,255, 255, 255); }else 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.