Funktioner som gör att spelet kan lägga till händelser på tidslinjen som visas tillsammans med videoinspelning.

Se Steam-tidslinjer och diagrammet längst ned på sidan för mer information.

Medlemsfunktioner

Medlemsfunktioner för ISteamTimeline anropas via den globala accessorfunktionen ISteamTimeline.

SetTimelineStateDescription

Namn	Typ	Beskrivning
pchDescription	const char *	En lokaliserad sträng på språket som returneras av SteamUtils()->GetSteamUILanguage()
flTimeDelta	float	Tidsförskjutningen i sekunder för denna tillståndsändring. Negativa tider indikerar en händelse som hände tidigare.

Anger en beskrivning (B) för spelets nuvarande tillstånd på tidslinjen. Beskrivningarna hjälper användarna att hitta specifika ögonblick på tidslinjen när de sparar klipp. Om du anger en ny tillståndsbeskrivning ersätts den föregående beskrivningen.

Exempel kan vara:

• när en användare befinner sig i världen i ett enspelarspel
  
• vilken runda som pågår i ett flerspelarspel
  
• ställningen i ett sportspel.

ClearTimelineStateDescription

Namn	Typ	Beskrivning
flTimeDelta	float	Tidsförskjutningen i sekunder för denna tillståndsändring. Negativa tider indikerar en händelse som hände tidigare.

Rensar det tidigare angivna speltillståndet på tidslinjen.

AddTimelineEvent

Namn	Typ	Beskrivning
pchIcon	const char *	Namnet på ikonen som ska visas på tidslinjen vid denna tidpunkt. Det kan vara en av ikonerna som har laddats upp på Steamworks-partnersidan för ditt spel eller en av de medföljande ikonerna som börjar med steam_. Översikten över Steam-tidslinjer innehåller en lista över tillgängliga ikoner.
pchTitle	const char *	En lokaliserad sträng från spelet, på språket som returneras av SteamUtils()->GetSteamUILanguage().
pchDescription	const char *	En lokaliserad sträng från spelet, på språket som returneras av SteamUtils()->GetSteamUILanguage().
unPriority	uint32	Ange den prioritet som ska användas när gränssnittet bestämmer vilka ikoner som ska visas i överfulla delar av tidslinjen. Händelser med högre prioritetsvärden visas mer framträdande än händelser med lägre prioritetsvärden. Värdet måste vara mellan 0 och k_unMaxTimelinePriority.
flStartOffsetSeconds	float	Tidsförskjutningen i sekunder för händelsens start. Negativa tider indikerar en händelse som hände tidigare. Denna parameter kan användas till att hantera händelser vars betydelse inte blir tydlig förrän i efterhand. Om spelaren till exempel startar en effekt, som skadar en annan spelare över tid och dödar den spelaren 3,5 sekunder senare, kan spelet skicka -3,5 som startförskjutning och få händelsen att visas där effekten startade på tidslinjen.
flDurationSeconds	float	Händelsens varaktighet i sekunder. Skicka 0 för omedelbara händelser.
ePossibleClip	ETimelineEventClipPriority	Tillåter spelet beskriva händelser som ska föreslås till användaren som möjliga videoklipp.

Använd detta för att markera en händelse (A) på tidslinjen. Händelsen kan vara omedelbar eller ta en viss tid att slutföra, beroende på värdet som skickas i flDurationSeconds.

Exempel kan vara:

• en bosskamp
  
• en mellansekvens
  
• en stor lagkamp
  
• när man plockar upp ett nytt föremål eller ammunition
  
• när man gör mål.

Spelet kan nominera en händelse som lämplig för ett klipp genom att skicka k_ETimelineEventClipPriority_Standard eller k_ETimelineEventClipPriority_Featured till ePossibleClip. Spelare kan skapa egna klipp när som helst, men med detta kan spelet föreslå några alternativ till Steam för att göra processen enklare för spelare.

SetTimelineGameMode

Namn	Typ	Beskrivning
eMode	ETimelineGameMode	Läget som spelet är i.

Ändrar färgen på tidslinjefältet (C). Läs om hur man använder värdena här: ETimelineGameMode.

Uppräknare

Uppräknare som definieras för användning med ISteamTimeline.

ETimelineGameMode

Styr färgen på tidslinjefältets segment. Namnen på värdena som listas här passar för flerspelarspel där användaren startar ett spel (från menyerna) och sedan går med i en flerspelarsession som har karaktärval i lobbyn innan flerspelarsessionen startar. Men du kan också omordna värdena så att de passar vilket som helst slags spel. I ett enspelarspel där du besöker städer och fängelsehålor kan du ange k_ETimelineGameMode_Menus när spelaren är i en stad
och köper föremål, k_ETimelineGameMode_Staging när en fängelsehåla läses in och k_ETimelineGameMode_Playing när
spelaren är i fängelsehålan och bekämpar monster.

Namn	Värde	Beskrivning
k_ETimelineGameMode_Playing	1	Spelaren är helt inne i spelet och spelar.
k_ETimelineGameMode_Staging	2	Spelaren är i en flerspelarlobby.
k_ETimelineGameMode_Menus	3	Spelaren är i spelets huvudmeny eller pausmeny.
k_ETimelineGameMode_LoadingScreen	4	Spelaren väntar på laddningsskärmen.

ETimelineEventClipPriority

Används i AddTimelineEvent där framhävda händelser erbjuds före standardhändelser.

Namn	Värde	Beskrivning
k_ETimelineEventClipPriority_None	1	Händelsen passar inte som klipp.
k_ETimelineEventClipPriority_Standard	2	Användaren kanske vill skapa ett klipp om denna händelse.
k_ETimelineEventClipPriority_Featured	3	Spelaren kommer sannolikt att vilja skapa ett klipp om denna händelse. De klippen bör marknadsföras mer framträdande än klipp med k_ETimelineEventClipPriority_Standard-prioritet.

Diagram