StartRecordingAllPlayerData: Difference between revisions
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
{{Welcome| | {{Welcome| | ||
desc=Starts recording all players who are online and returns number of players who are put into recording freshly.| | desc=Starts recording all players who are online and returns number of players who are put into recording freshly.| | ||
params=<syntaxhighlight lang="lua">( | params=<syntaxhighlight lang="lua">(recordtype=3, flags=60, newplayers=false)</syntaxhighlight> | ||
<poem> | <poem> | ||
::recordtype : The [[RecordingTypes|type]] of the recording. | ::recordtype : The [[RecordingTypes|type]] of the recording. | ||
::flags : Specify one or more value combined from [[Recording_Flags|flags]] by using 'bitwise OR'. 0 means nothing will be recorded. </poem>| | ::flags : Specify one or more value combined from [[Recording_Flags|flags]] by using 'bitwise OR'. 0 means nothing will be recorded. | ||
::newplayers : If true, when new players join the server, recording starts on them automatically. </poem>| | |||
retvals=The total no:of recordings newly started. If some player was already under recording, that player will be ignored and the value returned will not count that player.| | retvals=The total no:of recordings newly started. If some player was already under recording, that player will be ignored and the value returned will not count that player.| | ||
relfuncs=*[[StopRecordingAllPlayerData]] | relfuncs=*[[StopRecordingAllPlayerData]] | ||
*[[StartRecordingPlayerData]] | *[[StartRecordingPlayerData]] | ||
}} | }} | ||
Revision as of 10:34, 20 December 2023
This function was added in v1.8 (not released as of 19.Dec.2023) and will not work in previous versions.
Description:
Starts recording all players who are online and returns number of players who are put into recording freshly.
Parameters:
(recordtype=3, flags=60, newplayers=false)
recordtype : The type of the recording.
flags : Specify one or more value combined from flags by using 'bitwise OR'. 0 means nothing will be recorded.
newplayers : If true, when new players join the server, recording starts on them automatically.
Return Values:
The total no:of recordings newly started. If some player was already under recording, that player will be ignored and the value returned will not count that player.
Related Functions
The following functions may be helpful as they relate to this function in one way or another.