StartRecordingPlayerData: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 5: | Line 5: | ||
::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.</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"> | ||
function onPlayerCommand(player,cmd,text) | function onPlayerCommand(player,cmd,text) |
Revision as of 16:45, 1 April 2022
Description:
Starts recording player movements to a file which can be reproduced by an NPC
Parameters:
(playerid, recordtype, recordname[])
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.
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.