Class ISteamTimeline

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamTimeline : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamTimeline

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

INTERFACE_VERSION

public const string INTERFACE_VERSION = "STEAMTIMELINE_INTERFACE_V004"

Field Value

string

Methods

AddGamePhaseTag(string, string, string, uint)

public void AddGamePhaseTag(string tagName, string tagIcon, string tagGroup, uint priority)

Parameters

tagName string

tagIcon string

tagGroup string

priority uint

AddInstantaneousTimelineEvent(string, string, string, uint, float, ETimelineEventClipPriority)

public TimelineEventHandle AddInstantaneousTimelineEvent(string title, string description, string icon, uint iconPriority, float startOffsetSeconds, ETimelineEventClipPriority possibleClip)

Parameters

title string

description string

icon string

iconPriority uint

startOffsetSeconds float

possibleClip ETimelineEventClipPriority

Returns

TimelineEventHandle

AddRangeTimelineEvent(string, string, string, uint, float, float, ETimelineEventClipPriority)

public TimelineEventHandle AddRangeTimelineEvent(string title, string description, string icon, uint iconPriority, float startOffsetSeconds, float duration, ETimelineEventClipPriority possibleClip)

Parameters

title string

description string

icon string

iconPriority uint

startOffsetSeconds float

duration float

possibleClip ETimelineEventClipPriority

Returns

TimelineEventHandle

ClearTimelineTooltip(float)

public void ClearTimelineTooltip(float timeDelta)

Parameters

timeDelta float

DoesEventRecordingExist(TimelineEventHandle)

public Promise<SteamTimelineEventRecordingExists> DoesEventRecordingExist(TimelineEventHandle @event)

Parameters

event TimelineEventHandle

Returns

Promise<SteamTimelineEventRecordingExists>

DoesGamePhaseRecordingExist(string)

public Promise<SteamTimelineGamePhaseRecordingExists> DoesGamePhaseRecordingExist(string phaseID)

Parameters

phaseID string

Returns

Promise<SteamTimelineGamePhaseRecordingExists>

EndGamePhase()

public void EndGamePhase()

EndRangeTimelineEvent(TimelineEventHandle, float)

public void EndRangeTimelineEvent(TimelineEventHandle @event, float endOffsetSeconds)

Parameters

event TimelineEventHandle

endOffsetSeconds float

OpenOverlayToGamePhase(string)

public void OpenOverlayToGamePhase(string phaseID)

Parameters

phaseID string

OpenOverlayToTimelineEvent(TimelineEventHandle)

public void OpenOverlayToTimelineEvent(TimelineEventHandle @event)

Parameters

event TimelineEventHandle

RemoveTimelineEvent(TimelineEventHandle)

public void RemoveTimelineEvent(TimelineEventHandle @event)

Parameters

event TimelineEventHandle

SetGamePhaseAttribute(string, string, uint)

public void SetGamePhaseAttribute(string attributeGroup, string attributeValue, uint priority)

Parameters

attributeGroup string

attributeValue string

priority uint

SetGamePhaseID(string)

public void SetGamePhaseID(string phaseID)

Parameters

phaseID string

SetTimelineGameMode(ETimelineGameMode)

public void SetTimelineGameMode(ETimelineGameMode mode)

Parameters

mode ETimelineGameMode

SetTimelineTooltip(string, float)

public void SetTimelineTooltip(string description, float timeDelta)

Parameters

description string

timeDelta float

StartGamePhase()

public void StartGamePhase()

StartRangeTimelineEvent(string, string, string, uint, float, ETimelineEventClipPriority)

public TimelineEventHandle StartRangeTimelineEvent(string title, string description, string icon, uint priority, float startOffsetSeconds, ETimelineEventClipPriority possibleClip)

Parameters

title string

description string

icon string

priority uint

startOffsetSeconds float

possibleClip ETimelineEventClipPriority

Returns

TimelineEventHandle

UpdateRangeTimelineEvent(TimelineEventHandle, string, string, string, uint, ETimelineEventClipPriority)

public void UpdateRangeTimelineEvent(TimelineEventHandle @event, string title, string description, string icon, uint priority, ETimelineEventClipPriority possibleClip)

Parameters

event TimelineEventHandle

title string

description string

icon string

priority uint

possibleClip ETimelineEventClipPriority