ISteamTimeline

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

List of Functions

Timeline.AddGamePhaseTag()
Timeline.AddInstantaneousTimelineEvent()
Timeline.AddRangeTimelineEvent()
Timeline.ClearTimelineTooltip()
Timeline.DoesEventRecordingExist()
Timeline.DoesGamePhaseRecordingExist()
Timeline.EndGamePhase()
Timeline.EndRangeTimelineEvent()
Timeline.OpenOverlayToGamePhase()
Timeline.OpenOverlayToTimelineEvent()
Timeline.RemoveTimelineEvent()
Timeline.SetGamePhaseAttribute()
Timeline.SetGamePhaseID()
Timeline.SetTimelineGameMode()
Timeline.SetTimelineTooltip()
Timeline.StartGamePhase()
Timeline.StartRangeTimelineEvent()
Timeline.UpdateRangeTimelineEvent()

List of Callbacks

Timeline.OnSteamTimelineGamePhaseRecordingExists()
Timeline.OnSteamTimelineEventRecordingExists()

Function Reference

Timeline.AddGamePhaseTag(pchTagName, pchTagIcon, pchTagGroup, unPriority)

🤖 Auto-generated binding

Parameters:

pchTagName (str?) –
pchTagIcon (str?) –
pchTagGroup (str?) –
unPriority (int) –

SteamWorks:

AddGamePhaseTag

Timeline.AddInstantaneousTimelineEvent(pchTitle, pchDescription, pchIcon, unIconPriority, flStartOffsetSeconds, ePossibleClip)

🤖 Auto-generated binding

Parameters:

pchTitle (str?) –
pchDescription (str?) –
pchIcon (str?) –
unIconPriority (int) –
flStartOffsetSeconds (float) –
ePossibleClip (int - ETimelineEventClipPriority) –

Returns:

(uint64 - TimelineEventHandle_t) Return value

SteamWorks:

AddInstantaneousTimelineEvent

Example:

-- Mark when player gets an achievement
Steam.Timeline.AddInstantaneousTimelineEvent(
    'Achievement Unlocked', 'First Blood', 'achievement_icon', 1, 0, 'RecordAtFarther')

Timeline.AddRangeTimelineEvent(pchTitle, pchDescription, pchIcon, unIconPriority, flStartOffsetSeconds, flDuration, ePossibleClip)

🤖 Auto-generated binding

Parameters:

pchTitle (str?) –
pchDescription (str?) –
pchIcon (str?) –
unIconPriority (int) –
flStartOffsetSeconds (float) –
flDuration (float) –
ePossibleClip (int - ETimelineEventClipPriority) –

Returns:

(uint64 - TimelineEventHandle_t) Return value

SteamWorks:

AddRangeTimelineEvent

Example:

-- Mark an entire boss fight after it ends
Steam.Timeline.AddRangeTimelineEvent(
    'Boss Fight', 'Dragon Battle', 'sword_icon', 1, -bossFightDuration, bossFightDuration, 'RecordAtFarther')

Timeline.ClearTimelineTooltip(flTimeDelta)

🤖 Auto-generated binding

Parameters:: flTimeDelta (float) –
SteamWorks:: ClearTimelineTooltip

Example:

Steam.Timeline.ClearTimelineTooltip(0)

Timeline.DoesEventRecordingExist(ulEvent, callback)

🤖 Auto-generated binding

Parameters:

ulEvent (uint64 - TimelineEventHandle_t) –
callback (function) – CallResult callback receiving struct SteamTimelineEventRecordingExists_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

DoesEventRecordingExist

Timeline.DoesGamePhaseRecordingExist(pchPhaseID, callback)

🤖 Auto-generated binding

Parameters:

pchPhaseID (str?) –
callback (function) – CallResult callback receiving struct SteamTimelineGamePhaseRecordingExists_t and a boolean

Returns:

(uint64) SteamAPICall_t handle for this async call. The result is delivered via the callback parameter when Steam.RunCallbacks() is called.

SteamWorks:

DoesGamePhaseRecordingExist

Timeline.EndGamePhase()

🤖 Auto-generated binding

SteamWorks:: EndGamePhase

Example:

Steam.Timeline.EndGamePhase()

Timeline.EndRangeTimelineEvent(ulEvent, flEndOffsetSeconds)

🤖 Auto-generated binding

Parameters:

ulEvent (uint64 - TimelineEventHandle_t) –
flEndOffsetSeconds (float) –

SteamWorks:

EndRangeTimelineEvent

Example:

Steam.Timeline.EndRangeTimelineEvent(eventHandle, 0)

Timeline.OpenOverlayToGamePhase(pchPhaseID)

🤖 Auto-generated binding

Parameters:: pchPhaseID (str?) –
SteamWorks:: OpenOverlayToGamePhase

Timeline.OpenOverlayToTimelineEvent(ulEvent)

🤖 Auto-generated binding

Parameters:: ulEvent (uint64 - const TimelineEventHandle_t) –
SteamWorks:: OpenOverlayToTimelineEvent

Example:

-- Let the player review the clip for this event
Steam.Timeline.OpenOverlayToTimelineEvent(eventHandle)

Timeline.RemoveTimelineEvent(ulEvent)

🤖 Auto-generated binding

Parameters:: ulEvent (uint64 - TimelineEventHandle_t) –
SteamWorks:: RemoveTimelineEvent

Timeline.SetGamePhaseAttribute(pchAttributeGroup, pchAttributeValue, unPriority)

🤖 Auto-generated binding

Parameters:

pchAttributeGroup (str?) –
pchAttributeValue (str?) –
unPriority (int) –

SteamWorks:

SetGamePhaseAttribute

Timeline.SetGamePhaseID(pchPhaseID)

🤖 Auto-generated binding

Parameters:: pchPhaseID (str?) –
SteamWorks:: SetGamePhaseID

Notes:

See Timeline.StartGamePhase()’s example.

Timeline.SetTimelineGameMode(eMode)

🤖 Auto-generated binding

Parameters:: eMode (int - ETimelineGameMode) –
SteamWorks:: SetTimelineGameMode

Example:

-- Set mode to show what the player is doing
Steam.Timeline.SetTimelineGameMode('Playing')

Timeline.SetTimelineTooltip(pchDescription, flTimeDelta)

🤖 Auto-generated binding

Parameters:

pchDescription (str?) –
flTimeDelta (float) –

SteamWorks:

SetTimelineTooltip

Example:

Steam.Timeline.SetTimelineTooltip('Fighting the final boss', 0)

Timeline.StartGamePhase()

🤖 Auto-generated binding

SteamWorks:: StartGamePhase

Example:

Steam.Timeline.StartGamePhase()
Steam.Timeline.SetGamePhaseID('level_3')

Timeline.StartRangeTimelineEvent(pchTitle, pchDescription, pchIcon, unPriority, flStartOffsetSeconds, ePossibleClip)

🤖 Auto-generated binding

Parameters:

pchTitle (str?) –
pchDescription (str?) –
pchIcon (str?) –
unPriority (int) –
flStartOffsetSeconds (float) –
ePossibleClip (int - ETimelineEventClipPriority) –

Returns:

(uint64 - TimelineEventHandle_t) Return value

SteamWorks:

StartRangeTimelineEvent

Example:

-- Start tracking a ranged event
local eventHandle = Steam.Timeline.StartRangeTimelineEvent(
    'Boss Fight', 'Dragon Battle', 'sword_icon', 1, 0, 'RecordAtFarther')

Timeline.UpdateRangeTimelineEvent(ulEvent, pchTitle, pchDescription, pchIcon, unPriority, ePossibleClip)

🤖 Auto-generated binding

Parameters:

ulEvent (uint64 - TimelineEventHandle_t) –
pchTitle (str?) –
pchDescription (str?) –
pchIcon (str?) –
unPriority (int) –
ePossibleClip (int - ETimelineEventClipPriority) –

SteamWorks:

UpdateRangeTimelineEvent

Callbacks

Timeline.OnSteamTimelineGamePhaseRecordingExists()

Callback for SteamTimelineGamePhaseRecordingExists_t

callback(data) receives:

data.m_rgchPhaseID (string)
data.m_ulRecordingMS (uint64)
data.m_ulLongestClipMS (uint64)
data.m_unClipCount (int)
data.m_unScreenshotCount (int)

Timeline.OnSteamTimelineEventRecordingExists()

Callback for SteamTimelineEventRecordingExists_t

callback(data) receives:

data.m_ulEventID (uint64)
data.m_bRecordingExists (bool)