steamGameRecordingEvent: Difference between revisions
m (Fixed link to main SGR page) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(One intermediate revision by one other user not shown) | |||
Line 6: | Line 6: | ||
|gr1= System | |gr1= System | ||
|descr= Triggers a | |descr= Triggers a {{Link|https://partner.steamgames.com/doc/features/timeline|Steam Timeline}} event within the {{Link|https://store.steampowered.com/gamerecording|Game Recording}} feature. Read [[Arma 3: Steam Game Recording]] for more information and a list of all available event icons. | ||
|s1= [[steamGameRecordingEvent]] parameters | |s1= [[steamGameRecordingEvent]] parameters | ||
|p1= parameters: [[Array]] in format [eventClass, eventDuration, eventArguments, startOffset], where: | |p1= parameters: [[Array]] in format [eventClass, eventDuration, eventArguments, startOffset], where: | ||
* eventClass: [[String]] - class in [[description.ext]] >> "SteamGameRecording" or config "SteamManagerConfig" >> "GameRecording" or special utility | * eventClass: [[String]] - class in [[description.ext]] >> "SteamGameRecording" or config "SteamManagerConfig" >> "GameRecording" or a special utility string | ||
* eventDuration: [[Number]] - 0 for an instant event, or an amount of seconds this event lasted | * 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) | * eventArguments: [[Array]] of [[String]] - arguments that can be used to add dynamic info to the event (texts) |
Latest revision as of 17:50, 20 June 2025
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 a special utility string
- 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