Page tree
Skip to end of metadata
Go to start of metadata


Introduced in

Version:3.7

Description

Description: Stops and saves the recording of player (or AI) activities (which was started via UPRStartRecording).
Once the recording has been saved, the event UPRRecordEnd will fire.

Syntax

Syntax: unit UPRSaveRecording path
Parameters:
  • unit: Unit - Player or AI unit which is currently recording (or whose recording has just been UPRStopRecording).
  • path: String - Path to save recording to. Can be either an absolute path (the directory must exist already), or a name (without an extension). If only the name is specified, then a time stamp (YYYY_MM_DD_hh_mm_ss) is inserted before the name, the worldName and the extension .upr are added, and the file will be saved to %userprofile%\Documents\VBS3\RecordedPaths.
Return Value: String - The file name the recording was saved under (without any path information).
If the recording couldn't be saved (e.g. wrong path info, or no recording present), then an empty string is returned.

Examples

Examples:
_file = player UPRSaveRecording "rec1"; // might return "2015_04_20_13_02_50.rec1.Intro.upr"
_file = player UPRSaveRecording "c:\bi\rec1.upr"; // will return "rec1.upr"

Additional Information

See also: UPRStartRecording, UPRStopRecording, UPRDiscardRecording,UPRGetTimelineInfo, UPRGetMetaInfo, UPRRecordEnd
Multiplayer: 
Problems: 

Notes