Skip to content

Commit

Permalink
Corrected some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Francisco Dias committed Sep 19, 2024
1 parent 751de3f commit 132cdeb
Show file tree
Hide file tree
Showing 23 changed files with 39 additions and 39 deletions.
4 changes: 2 additions & 2 deletions docs/timeline.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
* @param {real|constant.TimelineMaxPriority} priority Provide the priority to use when the UI is deciding which icons to display in crowded parts of the timeline. Events with larger priority values will be displayed more prominently than events with smaller priority values. This value must be between 0 and ${constant.TimelineMaxPriority}.
* @param {real|constant.TimelineMaxEventDuration} startOffsetSeconds The time offset in seconds to apply to the start of the event. Negative times indicate an event that happened in the past. One use of this parameter is to handle events whose significance is not clear until after the fact. For instance if the player starts a damage over time effect on another player, which kills them 3.5 seconds later, the game could pass -3.5 as the start offset and cause the event to appear in the timeline where the effect started.
* @param {real|constant.TimelineMaxEventDuration} durationSeconds The duration of the event, in seconds. Pass 0 for instantaneous events. The final duration of the event cannot be larger than ${constant.TimelineMaxEventDuration}.
* @param {constant.TimelineEventClipPriority|constant.TimelineMaxPriority} possibleClip Allows the game to describe events that should be suggested to the user as possible video clips.
* @param {constant.TimelineEventClipPriority} possibleClip Allows the game to describe events that should be suggested to the user as possible video clips.
* @returns {bool}
*
* @example
Expand Down Expand Up @@ -122,7 +122,7 @@

/**
* @module timeline
* @title Steam Timeline
* @title Timeline
* @desc Functions that allow the game to add events to the timeline that is displayed alongside recorded video.
*
* Due to the experimental nature of Steam Timeline (currently), all extension functions return a boolean.
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="/timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
14 changes: 7 additions & 7 deletions source/Steamworks_gml/extensions/steamworks/docs/_Sidebar.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="img/favicon.ico" />
<title> Sidebar - GMEXT-Steamworks</title>
<title> sidebar - GMEXT-Steamworks</title>
<link rel="stylesheet" href="css/theme.css" />
<link rel="stylesheet" href="css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -14,8 +14,8 @@

<script>
// Current page data
var mkdocs_page_name = " Sidebar";
var mkdocs_page_input_path = "_Sidebar.md";
var mkdocs_page_name = " sidebar";
var mkdocs_page_input_path = "_sidebar.md";
var mkdocs_page_url = null;
</script>

Expand Down Expand Up @@ -103,7 +103,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand All @@ -124,9 +124,9 @@
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active"> Sidebar</li>
<li class="breadcrumb-item active"> sidebar</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/YoYoGames/GMEXT-Steamworks/edit/master/docs/_Sidebar.md" class="icon icon-github"> Edit on GitHub</a>
<a href="https://github.com/YoYoGames/GMEXT-Steamworks/edit/master/docs/_sidebar.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
Expand Down Expand Up @@ -158,7 +158,7 @@ <h3 id="modules">Modules</h3>
<li><a href="networking.html">Networking</a></li>
<li><a href="input.html">Input</a></li>
<li><a href="music.html">Music</a></li>
<li><a href="timeline.html">Steam Timeline</a></li>
<li><a href="timeline.html">Timeline</a></li>
<li><a href="utilities.html">Utilities</a></li>
</ul>

Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/_footer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/achievements.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/cloud.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/dlc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/general.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/guides.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions source/Steamworks_gml/extensions/steamworks/docs/home.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down Expand Up @@ -173,7 +173,7 @@ <h2 id="modules">Modules</h2>
<li><a href="networking.html">Networking</a></li>
<li><a href="input.html">Input</a></li>
<li><a href="music.html">Music</a></li>
<li><a href="timeline.html">Steam Timeline</a></li>
<li><a href="timeline.html">Timeline</a></li>
<li><a href="utilities.html">Utilities</a></li>
</ul>
<p><br></p>
Expand Down
4 changes: 2 additions & 2 deletions source/Steamworks_gml/extensions/steamworks/docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down Expand Up @@ -198,5 +198,5 @@ <h2 id="project-layout">Project layout</h2>

<!--
MkDocs version : 1.6.0
Build Date UTC : 2024-09-19 09:06:02.038446+00:00
Build Date UTC : 2024-09-19 09:24:45.778455+00:00
-->
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/input.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/inventory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/leaderboards.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/lobbies.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/management.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions source/Steamworks_gml/extensions/steamworks/docs/music.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down Expand Up @@ -503,7 +503,7 @@ <h1 id="steammusicstatus">SteamMusicStatus</h1>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="input.html" class="btn btn-neutral float-left" title="Input"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="timeline.html" class="btn btn-neutral float-right" title="Steam Timeline">Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="timeline.html" class="btn btn-neutral float-right" title="Timeline">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>

<hr/>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/networking.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/overlay.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/social.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
12 changes: 6 additions & 6 deletions source/Steamworks_gml/extensions/steamworks/docs/timeline.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="img/favicon.ico" />
<title>Steam Timeline - GMEXT-Steamworks</title>
<title>Timeline - GMEXT-Steamworks</title>
<link rel="stylesheet" href="css/theme.css" />
<link rel="stylesheet" href="css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
Expand All @@ -14,7 +14,7 @@

<script>
// Current page data
var mkdocs_page_name = "Steam Timeline";
var mkdocs_page_name = "Timeline";
var mkdocs_page_input_path = "timeline.md";
var mkdocs_page_url = null;
</script>
Expand Down Expand Up @@ -103,7 +103,7 @@
</li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="#">Steam Timeline</a>
<li class="toctree-l1 current"><a class="reference internal current" href="#">Timeline</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#functions">Functions</a>
</li>
Expand All @@ -130,7 +130,7 @@
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Steam Timeline</li>
<li class="breadcrumb-item active">Timeline</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/YoYoGames/GMEXT-Steamworks/edit/master/docs/timeline.md" class="icon icon-github"> Edit on GitHub</a>
</li>
Expand All @@ -141,7 +141,7 @@
<div class="section" itemprop="articleBody">

<p><a id="top"></a></p>
<h1 id="steam-timeline"><strong>Steam Timeline</strong></h1>
<h1 id="timeline"><strong>Timeline</strong></h1>
<p>Functions that allow the game to add events to the timeline that is displayed alongside recorded video.</p>
<p>Due to the experimental nature of Steam Timeline (currently), all extension functions return a boolean.
If it's true, it means that the Steam Timeline API is available and the call was made.
Expand Down Expand Up @@ -304,7 +304,7 @@ <h1 id="steam_timeline_add_event">steam_timeline_add_event</h1>
</tr>
<tr>
<td>possibleClip</td>
<td><a href="timeline.html#timelineeventclippriority">TimelineEventClipPriority</a> or <a href="timeline.html#timelinemaxpriority">TimelineMaxPriority</a></td>
<td><a href="timeline.html#timelineeventclippriority">TimelineEventClipPriority</a></td>
<td>Allows the game to describe events that should be suggested to the user as possible video clips.</td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion source/Steamworks_gml/extensions/steamworks/docs/ugc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions source/Steamworks_gml/extensions/steamworks/docs/utilities.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Steam Timeline</a>
<li class="toctree-l1"><a class="reference internal" href="timeline.html">Timeline</a>
</li>
</ul>
<ul class="current">
Expand Down Expand Up @@ -581,7 +581,7 @@ <h1 id="steam_utils_get_steam_ui_language">steam_utils_get_steam_ui_language</h1
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="timeline.html" class="btn btn-neutral float-left" title="Steam Timeline"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="timeline.html" class="btn btn-neutral float-left" title="Timeline"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>

<hr/>
Expand Down

0 comments on commit 132cdeb

Please sign in to comment.