Skip to content

Commit

Permalink
docs(feature): Updates to prefabs page, fixed descriptions on new IDE…
Browse files Browse the repository at this point in the history 
… pages
  • Loading branch information
@gurpreetsinghmatharoo
gurpreetsinghmatharoo committed Nov 29, 2024
1 parent 333ddff commit 5e6d161
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 37 deletions.
5 changes: 3 additions & 2 deletions Manual/contents/IDE_Navigation/Menus/The_Windows_Menu.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ <h1>The Windows Menu</h1>
<p>This menu is for opening the general docked IDE windows. Since docks can be rearranged and the contents can be removed as stand-alone windows or even closed entirely, this window permits you to re-open them if you find that you need them for anything. The windows that can be opened from here are <a data-xref="{title}" href="../../Introduction/The_Asset_Browser.htm">The Asset Browser</a> window and all the different <a href="../../Introduction/The_Output_Window.htm">Output</a> windows (Output, Search, Source Control, Breakpoints and Compile/Syntax Errors). Note that Feather Messages is shown instead of Syntax Errors if you&#39;ve <a href="../../Setting_Up_And_Version_Information/IDE_Preferences/Feather_Settings.htm#enable_feather">enabled Feather</a>.</p>
<p>Next you can open <a data-xref="{title}" href="../../IDE_Tools/The_Inspector.htm">The Inspector</a> window. This window is used to inspect the properties of the currently selected IDE element, and these properties can then be edited as required.</p>
<p>After the Inspector option you have the <a data-xref="{title}" href="../Recent_Windows.htm">Recent Windows</a> list, and there is also the option to open the <strong>Environment Variables</strong> window where you can see the different paths that the various environment variables used in the <a href="../../Setting_Up_And_Version_Information/IDE_Preferences.htm">Preferences</a> point to. These variables cannot be edited (neither their name nor their path/setting) but you can select and copy/paste any of them for use elsewhere.</p>
<p><img alt="Environment Variables" class="center" src="../../assets/Images/IDE_Input/Environment_Variables.png" />Finally you have an option to open the <strong>Project Tool Output</strong> window. This windows shows the output of the <a data-xref="{title}" href="../../IDE_Tools/Project_Tool.htm">ProjectTool</a>.</p>
<p><img alt="Environment Variables" class="center" src="../../assets/Images/IDE_Input/Environment_Variables.png" /><span data-condition="Export:Beta">In beta versions you can open the <a data-xref="{title}" href="../../IDE_Tools/Prefab_Library.htm">Prefab Library</a> from here.</span></p>
<p>Finally you have an option to open the <strong>Project Tool Output</strong> window. This windows shows the output of the <a data-xref="{title}" href="../../IDE_Tools/Project_Tool.htm">Project Tool</a>.</p>
<p> </p>
<p> </p>
<p> </p>
Expand All @@ -30,7 +31,7 @@ <h1>The Windows Menu</h1>
<div style="float:right">Next: <a href="The_Tools_Menu.htm">The Tools Menu</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. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
The Windows Menu
Expand Down
10 changes: 5 additions & 5 deletions Manual/contents/IDE_Tools/Additional_IDE_Tools.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
<script src="../assets/scripts/main_script.js" type="module"></script>
<meta name="rh-authors" content="Mark Alexander" />
<meta name="topic-comment" content="Section that covers IDE tools related to projects and assets" />
<meta name="rh-index-keywords" content="Additional IDE Tools" />
<meta name="search-keywords" content="IDE Tools,Additional Tools" />
<meta name="rh-index-keywords" content="Project and Assets IDE Tools" />
<meta name="search-keywords" content="Project and Assets IDE Tools" />
</head>
<body>
<!--<div class="body-scroll" style="top: 150px;">-->
<h1><span data-field="title" data-format="default">Project &amp; Assets</span></h1>
<p>This section of the manual outlines additional IDE tools that are available to help you make your games and which aren&#39;t covered in other parts of the manual, as well as those tools that are helpful accessories to the other sections of the IDE. </p>
<p>This section covers the IDE tools that help manage your projects and the assets within them.</p>
<ul class="colour">
<li><a data-xref="{title}" href="Project_Tool.htm">Project Tool</a></li>
<li><a data-xref="{title}" href="Package_Manager.htm">Package Manager</a></li>
Expand All @@ -37,10 +37,10 @@ <h1><span data-field="title" data-format="default">Project &amp; Assets</span></
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
Additional IDE Tools
Project and Assets IDE Tools
-->
<!-- TAGS
ide_tools
project_ide_tools
-->
</body>
</html>
16 changes: 8 additions & 8 deletions Manual/contents/IDE_Tools/Compiling_&_Runtime.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Compiling &amp; Runtime</title>
<title>Compiling &amp; Running</title>
<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" type="module"></script>
<meta name="rh-authors" content="Mark Alexander" />
<meta name="rh-authors" content="Gurpreet S. Matharoo" />
<meta name="topic-comment" content="Section that covers IDE tools related to compiling and runtime" />
<meta name="rh-index-keywords" content="Additional IDE Tools" />
<meta name="search-keywords" content="IDE Tools,Additional Tools" />
<meta name="rh-index-keywords" content="Compilation and Runtime IDE Tools" />
<meta name="search-keywords" content="Compilation and Runtime IDE Tools" />
</head>
<body>
<!--<div class="body-scroll" style="top: 150px;">-->
<h1><span data-field="title" data-format="default">Compiling &amp; Runtime</span></h1>
<p>This section of the manual outlines additional IDE tools that are available to help you make your games and which aren&#39;t covered in other parts of the manual, as well as those tools that are helpful accessories to the other sections of the IDE. </p>
<h1><span data-field="title" data-format="default">Compiling &amp; Running</span></h1>
<p>This section covers the IDE tools that assist with compilation or are used by the runner during testing.</p>
<ul class="colour">
<li><a data-xref="{title}" href="../Setting_Up_And_Version_Information/The_Device_Manager.htm">The Device Manager</a></li>
<li><a data-xref="{title}" href="The_Debugger.htm">The Debugger</a></li>
Expand All @@ -33,10 +33,10 @@ <h1><span data-field="title" data-format="default">Compiling &amp; Runtime</span
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
Additional IDE Tools
Compilation and Runtime IDE Tools
-->
<!-- TAGS
ide_tools
comp_run_ide_tools
-->
</body>
</html>
44 changes: 23 additions & 21 deletions Manual/contents/IDE_Tools/Prefab_Library.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,63 +8,65 @@
<meta name="topic-status" content="Draft" />
<link rel="stylesheet" type="text/css" href="../assets/css/default.css" />
<meta name="template" content="../assets/masterpages/Manual_Page.htt" />
<meta name="search-keywords" content="project,tool,project tool" />
<meta name="rh-index-keywords" content="Project Tool" />
<meta name="search-keywords" content="prefabs, prefab library, prefab" />
<meta name="rh-index-keywords" content="Prefab Library, Prefabs" />
<meta name="rh-authors" content="Gurpreet S. Matharoo" />
<meta name="topic-comment" content="Page covering the Prefab Library" />
<meta name="condition-tags" content="Export:Beta" />
</head>
<body>
<h1><span data-field="title" data-format="default">Prefab Library</span></h1>
<p><img class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_main.png" />The <strong>Prefab Library</strong> is used to import assets from a <strong>source project</strong>. A source project from which prefabs are imported is known as a <strong>Collection</strong>.</p>
<p>When you use an asset from the Prefab Library, that asset is <em>not copied</em> into your project, but is loaded from its source project when your game is built. This means that any changes in the original collection will also be reflected in your project.</p>
<p><img class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_main.png" />The <strong>Prefab Library</strong> is used to import assets from a single <strong>source project</strong> into the currently open project. A source project containing Prefab assets is known as a <strong>Collection</strong>.</p>
<p>When you use an asset from the Prefab Library, that asset is <em>not copied</em> into your project but is simply referenced. The actual asset is only loaded from its Collection (source project) when your game is built. This means your game stays up-to-date with any changes in the Collection package without you needing to re-import any assets.</p>
<p><img class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_vis.png" /></p>
<p>This allows you to use the same assets in multiple projects and have them all be updated when the source collection is updated.</p>
<p>You can also choose to duplicate an asset into your project, at which point the asset is unlinked from its collection, meaning that it will no longer receive updates from its collection however it will be fully modifiable within your project.</p>
<p>This allows you to use the same assets in multiple projects and have them all be updated when the Collection is updated.</p>
<p>You can also choose to duplicate an asset into your project, at which point the asset is unlinked from its Collection, meaning that it will no longer receive updates from its Collection however it will be fully modifiable within your project.</p>
<h2>Adding Prefab Packages</h2>
<p>Currently you can use the official <span data-keyref="GameMaker Name">GameMaker</span> Asset Bundles via the Prefab Library.</p>
<p>Open the Prefab Library via the <a href="../IDE_Navigation/Menus/The_Windows_Menu.htm">Windows menu</a> in the menu bar. When you open this for the first time, your Prefab Library will be empty.</p>
<p>Click on Package Manager to add prefab collection packages:</p>
<p>Click on &quot;<strong>Package Manager</strong>&quot; to add Collection packages:</p>
<p><img class="center" src="../assets/Images/IDE Tools/Prefabs/package_manager.png" />This opens the <a data-xref="{title}" href="Package_Manager.htm">Package Manager</a> window with the &quot;Package source&quot; drop-down set to &quot;Prefabs&quot;. From here, you can install any of the official <span data-keyref="GameMaker Name">GameMaker</span> Asset Bundles.</p>
<p>Once installed, they will show up in your Prefab Library, from where you can navigate to any individual assets within the collections:</p>
<p>Once installed, they will show up in your Prefab Library, from where you can navigate to any individual assets within the Collections:</p>
<p><img class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_packages.png" /></p>
<h2>Using Prefab Assets</h2>
<p><video class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_usage.mp4" width="860" height="580" controls=""></video></p>
<p>Assets from the Prefab Library can be dragged into compatible <a href="../The_Asset_Editors/The_Asset_Editors.htm">asset editors</a>. Currently, you can use assets in the following ways:</p>
<ul class="colour">
<li>Use <a href="../The_Asset_Editors/Sprites.htm">Sprite</a> assets in <a data-xref="{title}" href="../The_Asset_Editors/Objects.htm">The Object Editor</a>, <a data-xref="{title}" href="../The_Asset_Editors/Sequences.htm">The Sequence Editor</a>, <a data-xref="{title}" href="../The_Asset_Editors/Rooms.htm">The Room Editor</a>, <a data-xref="{title}" href="../The_Asset_Editors/Tile_Sets.htm">The Tile Set Editor</a>, <a data-xref="{title}" href="../The_Asset_Editors/Particle_Systems.htm">The Particle System Editor</a></li>
<li>Use <a href="../The_Asset_Editors/Sprites.htm">Sprite</a> assets in <a data-xref="{title}" href="../The_Asset_Editors/Objects.htm">The Object Editor</a>, <a data-xref="{title}" href="../The_Asset_Editors/Sequences.htm">The Sequence Editor</a>, <a data-xref="{title}" href="../The_Asset_Editors/Rooms.htm">The Room Editor</a>, <a data-xref="{title}" href="../The_Asset_Editors/Tile_Sets.htm">The Tile Set Editor</a>, and <a data-xref="{title}" href="../The_Asset_Editors/Particle_Systems.htm">The Particle System Editor</a></li>
<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 during runtime.</p>
<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 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" />The left section displays the Folder List that contains a tree view of your prefab folders. The right section displays the contents of the currently open folder (or the prefab collections if no folder is selected). The divider between these two sections can be dragged to resize the sections.</p>
<p><img class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_sections.png" />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 favourited are visible. Additionally you can filter assets by asset type, so e.g. you only see sprites, sounds, or any type of asset you&#39;re looking for.</li>
<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>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>
<li><strong>Vertical View</strong>: This displays the folder list at the top and the content view at the bottom of the Prefab Library.</li>
<li><strong>Vertical View</strong>: This displays the folder list at the top and the content view at the bottom.</li>
<li><strong>Simple View</strong>: This disables the folder list and only displays the content view.</li>
<li><strong>Tree View</strong>: This disables the content view and only displays the folder list. The folder list will now also show the assets within a folder so they can be dragged for use in other editors.</li>
<li><strong>Tree View</strong>: This disables the content view and only displays the folder list. The folder list will now also show the assets within folders so they can be dragged for use in other editors.</li>
</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 import any new prefab collections or delete ones that you have added before.</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>
</ul>
<p>The Content View contains the following parts:</p>
<ul class="colour">
<li><strong>Path View</strong>: This displays a hierarchy of folders that 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>Switch View</strong>: This button lets you switch between the Grid and List views.</li>
<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>
</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>
<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><img class="center" src="../assets/Images/IDE Tools/Prefabs/prefab_rmb.png" />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 <strong>Sort/Filter</strong> menu in the Folder List section.</li>
<li><strong>Duplicate into Project</strong>: This duplicates the selected asset into your project as a <strong>local asset</strong>. The asset becomes unlinked from its collection and is fully editable.</li>
<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>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><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>
</ul>
<p> </p>
Expand Down
Binary file modified Manual/contents/assets/Images/IDE Tools/Prefabs/prefab_vis.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5e6d161

Please sign in to comment.