steamGameRecordingEvent: Difference between revisions

From Bohemia Interactive Community
(First draft SGR command (WIP))
 
m (Fixed link to main SGR page)
Line 24: Line 24:
|x3= <sqf>steamGameRecordingEvent ["StartGamePhase", "ArmaInvaders"]; //Starting a game phase for [[Arma 3: Invaders]] with a unique ID</sqf>
|x3= <sqf>steamGameRecordingEvent ["StartGamePhase", "ArmaInvaders"]; //Starting a game phase for [[Arma 3: Invaders]] with a unique ID</sqf>


|seealso= [[Steam Game Recording]]
|seealso= [[Arma 3: Steam Game Recording]]


}}
}}

Revision as of 11:48, 20 June 2025

Hover & click on the images for description

Description

Description:
Triggers a Steam Timeline event within the Game Recording feature. Read Arma 3: Steam Game Recording for more information and a list of all available event icons.
Groups:
System

Syntax

Syntax:
steamGameRecordingEvent parameters
Parameters:
parameters: Array in format [eventClass, eventDuration, eventArguments, startOffset], where:
  • eventClass: String - class in description.ext >> "SteamGameRecording" or config "SteamManagerConfig" >> "GameRecording" or special utility
  • eventDuration: Number - 0 for an instant event, or an amount of seconds this event lasted
  • eventArguments: Array of String - arguments that can be used to add dynamic info to the event (texts)
  • startOffset: Number - amount of seconds relative to the even trigger time
Return Value:
String - event handle (which can be used to edit an event after it has been triggered)

Examples

Example 1:
steamGameRecordingEvent ["UnitKilled", 0, ["Player1", "50"]; //"UnitKilled" event, happening now, with arguments
Example 2:
steamGameRecordingEvent ["ZeusUI", 5, [], -5]; //Was in the Zeus UI during the last 5 seconds
Example 3:
steamGameRecordingEvent ["StartGamePhase", "ArmaInvaders"]; //Starting a game phase for Arma 3: Invaders with a unique ID

Additional Information

See also:
Arma 3: Steam Game Recording

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note