Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/develop' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 5, 2025
2 parents 294afcb + 8e97e54 commit 49bab03
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
shell: cmd
working-directory: Manual
- name: Upload robohelp zip file
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: YoYoStudioRoboHelp
path: output\RoboHelp\*.zip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<h1><span data-field="title" data-format="default">asset_get_ids</span></h1>
<p>This function gets an array of references to assets of the given asset type.</p>
<p class="note"><span data-conref="../../../../assets/snippets/Tag_note.hts"> </span> The returned array contains assets that you added through <a data-xref="{title}" href="../../../../Introduction/The_Asset_Browser.htm">The Asset Browser</a> as well as assets that you added <a href="../Asset_Management.htm#dynamically_adding_assets">dynamically at runtime</a>.</p>
<p class="note"><span data-conref="../../../../assets/snippets/Tag_important.hts"> </span> When &quot;<strong>Automatically remove unused assets when compiling</strong>&quot; is enabled (which it is by default), the returned array will not contain any assets that are not directly referenced in your project or marked with a used tag with <span class="inline2"><a data-xref="{title}" href="../../OS_And_Compiler/gml_pragma.htm">gml_pragma</a>(&quot;MarkTagAsUsed&quot;, &lt;tags&gt;)</span>.</p>
<p class="note"><span data-conref="../../../../assets/snippets/Tag_note.hts"> </span> For the asset type <span class="inline2">asset_script</span> the function returns both script assets (the ones you add to <a data-xref="{title}" href="../../../../Introduction/The_Asset_Browser.htm">The Asset Browser</a>) and the <a href="../../../GML_Overview/Script_Functions.htm">script functions</a> they contain.</p>
<p> </p>
<h4>Syntax:</h4>
Expand Down Expand Up @@ -56,7 +57,7 @@ <h4>Example:</h4>
<div>Next: <a data-xref="{title}" href="asset_get_tags.htm">asset_get_tags</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2023 All Rights Reserved</span></h5>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2025 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
asset_get_ids
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>window_set_size</title>
<meta name="generator" content="Adobe RoboHelp 2020" />
<meta name="generator" content="Adobe RoboHelp 2022" />
<link rel="stylesheet" href="../../../../assets/css/default.css" type="text/css" />
<script src="../../../../assets/scripts/main_script.js"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand Down
17 changes: 13 additions & 4 deletions Manual/contents/IDE_Tools/Prefab_Library.htm
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,21 @@ <h2>Using Prefab Assets</h2>
<li>Use <a href="../The_Asset_Editors/Sounds.htm">Sound</a> assets in <a data-xref="{title}" href="../The_Asset_Editors/Sequences.htm">The Sequence Editor</a></li>
<li>Use <a href="../The_Asset_Editors/Tile_Sets.htm">Tile Set</a> assets in <a data-xref="{title}" href="../The_Asset_Editors/Rooms.htm">The Room Editor</a></li>
</ul>
<p>Apart from the editors mentioned above, any assets from Prefab Collections can be referenced in your code and they will be imported into your builds and be usable at runtime.</p>
<p>Assets from Prefab Collections will not be visible in the Asset Browser or in the Asset Explorers from any editors. They either have to be dragged from the Prefab Library or be referenced in code.</p>
<p class="note"><span data-conref="../assets/snippets/Tag_note.hts"> </span> If you use assets from a Collection in your project and then delete the package for that Collection, you will get a &quot;<strong>Resource load failure</strong>&quot; error window on opening the project in the IDE and potential errors at runtime.</p>
<h2>Prefab Overrides</h2>
<p>Selecting a Prefab Asset will display it in <a data-xref="{title}" href="The_Inspector.htm">The Inspector</a>, where you can override the following properties (which applies only to your current project):</p>
<ul class="colour">
<li>The Texture Group setting on Sprite, Tile Set and Font assets</li>
<li>The Audio Group setting and attributes on Sound assets</li>
</ul>
<h2>Prefab Library Features</h2>
<p>The Prefab Library window is divided into the following sections:</p>
<p><img class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_sections.png" style="cursor: nesw-resize;" />The left section displays the Folder List that contains a tree view of your Prefab Collections. The right section displays the contents of the currently open folder (or your Prefab Collections if no folder is selected). The divider between these two sections can be dragged to resize the sections.</p>
<p>The Folder List section contains the following parts:</p>
<ul class="colour">
<li><strong>Search Bar</strong>: This lets you search for any assets across all of the Prefab Collections that you have added from the <a data-xref="{title}" href="Package_Manager.htm">Package Manager</a>.</li>
<li><strong>Sort/Filter</strong>: This menu lets you switch between A-Z and Z-A sorting in both views of the Prefab Library. You can also enable Favourites so only assets that you have marked as favourite are visible. Additionally you can filter assets by type, so e.g. you only see sprites, sounds, or any other type(s) of asset you&#39;re looking for.</li>
<li><strong>Sort/Filter</strong>: This menu lets you switch between A-Z and Z-A sorting in both views of the Prefab Library. You can also enable Favourites so only assets that you have marked as favourite are visible. Additionally you can filter assets by type, so e.g. you only see sprites, sounds, or any other type(s) of asset you&#39;re looking for, or filter by used collections or used prefab assets only.</li>
<li><strong>View Menu</strong>: This lets you switch between the following views that affect how the Prefab Library is displayed:
<ul>
<li><strong>Horizontal View</strong>: This is the default view. It displays the folder list on the left and the content view on the right.</li>
Expand All @@ -55,20 +60,24 @@ <h2>Prefab Library Features</h2>
</ul>
</li>
<li><strong>Package Manager</strong>: This button opens the <a data-xref="{title}" href="Package_Manager.htm">Package Manager</a> where you can install any new Prefab Collections or delete the ones that you have installed.</li>
<li><strong>Folder List</strong>: A list of folders from imported Prefab Collections. Selecting a folder here will show its contents in the Contents view if enabled. You can use the <span class="shortcut">UP</span> and <span class="shortcut">DOWN</span> arrow keys to navigate the list and <span class="shortcut">ENTER</span> to expand/collapse a folder or view its contents in the Contents view if there are no child folders.</li>
</ul>
<p>The Content View contains the following parts:</p>
<ul class="colour">
<li><strong>Path</strong>: This displays a hierarchy of folders that you have opened. You can click on any folder to navigate back to it or click on <span class="shortcut">&lt;</span> to navigate back to the root.</li>
<li><strong>View Toggle</strong>: This button lets you toggle between grid and list mode for the contents.</li>
<li><strong>Contents</strong>: Displays the assets and folders in the selected folder. Double-clicking on an asset will display its information (name, description and icon) and you can drag assets from this view into other editors in your project (such as the Object Editor, Room Editor, etc.).</li>
</ul>
<p>The bottom bar of the window displays the number of items in the selected folder or the number of Collections if no folder is selected.</p>
<h3>RMB Menu</h3>
<p>Right-clicking on any item in the Prefab Library displays the following options:</p>
<ul class="colour">
<li><strong>Make Favourite</strong>: Add the selected folder or asset to Favourites. Your Favourites can be viewed from the <img class="icon" height="16" src="../assets/Images/Icons/Icon_ExtensionMenu.png" width="16" /> <strong>Sort/Filter</strong> menu.</li>
<li><strong>Add/Remove Collection Reference</strong>: Add or remove a reference to this Collection in the current project. When the project has a reference to the Collection, assets from the Collection can be referenced in code.</li>
<li><strong>Show In Inspector</strong>: Show the selected asset in <a data-xref="{title}" href="The_Inspector.htm">The Inspector</a>.</li>
<li><strong>Duplicate into Project</strong>: This duplicates the selected asset into your project as a local asset, i.e. the asset becomes unlinked from its Collection and is fully editable as part of the current project. It will no longer be updated if there are changes to its source asset in the Collection.</li>
<li><strong>Expand Children</strong>: This option is available in the Folder List. It expands all the folders under the selected folder.</li>
<li><b>Expand/Collapse All: </b>This option is available in the Folder List. It expands or collapses all the folders in the tree view.</li>
<li><strong>Expand/Collapse Children</strong>: This option is available in the Folder List. It expands or collapses all folders under the selected folder.</li>
<li><b>Expand/Collapse All: </b>This option is available in the Folder List. It expands or collapses all folders in the tree view.</li>
</ul>
<p> </p>
<p> </p>
Expand Down
Binary file modified Manual/contents/assets/Images/IDE_Input/Marketplace_Menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions Manual/toc/Default.toc
Original file line number Diff line number Diff line change
Expand Up @@ -265,11 +265,9 @@
<page href="../contents/Additional_Information/Compatibility_Scripts.htm" format="html" processing-role="normal"></page>
<page href="../contents/Additional_Information/Obsolete_Functions.htm" format="html" processing-role="normal"></page>
<book href="../contents/Introduction/The_Marketplace.htm" format="html" processing-role="normal">
<page href="../contents/Introduction/Marketplace/Your_Marketplace_Library.htm" format="html" processing-role="normal"></page>
<page href="../contents/Introduction/Marketplace/Purchasing_An_Asset.htm" format="html" processing-role="normal"></page>
<page href="../contents/Introduction/Marketplace/Creating_A_Publisher_Account.htm" format="html" processing-role="normal"></page>
<page href="../contents/Introduction/Marketplace/Listing_An_Asset.htm" format="html" processing-role="normal"></page>
<page href="../contents/Introduction/Marketplace/Creating_A_Marketplace_Asset.htm" format="html" processing-role="normal"></page>
<page href="../contents/Introduction/Marketplace/Listing_A_Service.htm" format="html" processing-role="normal"></page>
<page href="../contents/Introduction/Marketplace/Submission_Guidelines.htm" format="html" processing-role="normal"></page>
<page href="../contents/Introduction/Marketplace/Marketplace_Style_Guide.htm" format="html" processing-role="normal"></page>
Expand Down

0 comments on commit 49bab03

Please sign in to comment.