mirror of
https://git.do.srb2.org/STJr/UltimateZoneBuilder.git
synced 2024-11-27 22:22:32 +00:00
15bcea9417
Snippets: changed token syntax from $XX to [XX] [LB] (Line Break) marker can now be used in snippets. Game Configurations: added "enabledbydefault" parameter. When set to true, a game configuration will be available by default (e.g. when an user starts the editor for the first time). GZDB will no longer throw an exception when trying to update default value in a TypeHandler, which doesn't implement default value handling.
53 lines
3 KiB
HTML
53 lines
3 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
<head>
|
|
|
|
<title>GZDoom Builder features</title>
|
|
|
|
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
|
|
<link rel="stylesheet" type="text/css" href="../../../default.css" media="screen" title="Default" />
|
|
<style type="text/css">
|
|
<!--
|
|
.style1 {
|
|
color: #990000;
|
|
font-weight: bold;
|
|
}
|
|
-->
|
|
</style>
|
|
</head>
|
|
<body>
|
|
|
|
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
|
|
<param name="keyword" value="Template">
|
|
</object>
|
|
|
|
<div id="gz_title">
|
|
<h1>Code Snippets</h1>
|
|
</div>
|
|
|
|
<div id="contents">
|
|
<div style="float:right; padding-left:10px;"><br /><img src="snippets1.jpg"/></div>
|
|
<p>In the Script Editor you can use and create code snippets, which are small blocks of reusable code that you can insert where you need it in your code.</p>
|
|
<p><strong>Using code snippets:</strong><br />
|
|
To use a snippet, pick it from the drop-down menu.<br />
|
|
Alternatively, type the name of a snippet (or place the cursor inside of already existing one), then press the <strong>Tab</strong> key to expand it.<br /><br />
|
|
<strong>Example:</strong> to create the while loop, type "<strong>while</strong>"...<br /><img src="snippets_expand1.jpg"/><br />
|
|
<br />...and press the <strong>Tab</strong> key.<br /><img src="snippets_expand2.jpg"/></p>
|
|
<p><strong>Creating new code snippets:</strong><br />
|
|
Code snippets are plain text files stored in [GZDB]\Snippets\[category], so just create a new text file there and add the code you want into it.<br />
|
|
There are several special tokens you can use: </p>
|
|
<ul>
|
|
<li><strong>[EP]</strong> (Entry Point) - that's the place where the cursor will be placed after inserting a snippet.</li>
|
|
<li><strong>[LB]</strong> (Line Break)
|
|
- these will be converted to line breaks when "<strong>Allman-style bracing in snippets</strong>" (located in Preferences -> Appearance -> Script Editor) setting is enabled, or a space character when it's not.
|
|
</ul>
|
|
<span class="style1">Warning:</span> snippet's file name must not contain spaces.
|
|
<p><strong>Creating new code snippets for custom scripting configurations:</strong><br />
|
|
To add snippets to a scripting configuration, which doesn't already have existing snippets ("Insert a Code Snippet" drop-down is disabled in the Script Editor), you'll have to:</p>
|
|
<ol>
|
|
<li>Add a new folder inside of "Snippets" folder (for example, "[GZDB]\Snippets\Decorate").</li>
|
|
<li>Add the "<strong>snippetsdir</strong>" parameter to a scripting configuration, in which you want to use snippets, and set it to the folder name you've just created (for example, <strong>snippetsdir = "Decorate";</strong>).</li>
|
|
<li>Add the snippets to the folder you've created.</li>
|
|
</ol>
|
|
</div>
|
|
</body>
|