Advanced-Portals/docs/portal-tags/index.html

19 lines
17 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html class="docs-version-current" lang="en" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.13">
<title data-react-helmet="true">Portal Tags | Advanced Portals</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:image" content="https://advancedportals.sekwah.com//img/advancedportalsbanner.png"><meta data-react-helmet="true" name="twitter:image" content="https://advancedportals.sekwah.com//img/advancedportalsbanner.png"><meta data-react-helmet="true" property="og:url" content="https://advancedportals.sekwah.com//docs/portal-tags"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Portal Tags | Advanced Portals"><meta data-react-helmet="true" name="description" content="Information on all portal tags included in Advanced Portals."><meta data-react-helmet="true" property="og:description" content="Information on all portal tags included in Advanced Portals."><link data-react-helmet="true" rel="icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://advancedportals.sekwah.com//docs/portal-tags"><link data-react-helmet="true" rel="alternate" href="https://advancedportals.sekwah.com//docs/portal-tags" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://advancedportals.sekwah.com//docs/portal-tags" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.48ccaa5b.css">
<link rel="preload" href="/assets/js/runtime~main.50ceeefe.js" as="script">
<link rel="preload" href="/assets/js/main.a20c8a88.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/advancedportals.png" alt="Advanced Portals Logo" class="themedImage_TMUO themedImage--light_4Vu1"><img src="/img/advancedportals.png" alt="Advanced Portals Logo" class="themedImage_TMUO themedImage--dark_uzRr"></div><b class="navbar__title">Advanced Portals</b></a><a class="navbar__item navbar__link" href="/docs/intro">Tutorial</a><a class="navbar__item navbar__link" href="/docs/commands">Commands</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/portal-tags">Portal Tags</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/sekwah41/Advanced-Portals" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="toggle_iYfV toggle_2i4l toggleDisabled_xj38"><div class="toggleTrack_t-f2" role="button" tabindex="-1"><div class="toggleTrackCheck_mk7D"><span class="toggleIcon_pHJ9">🌜</span></div><div class="toggleTrackX_dm8H"><span class="toggleIcon_pHJ9">🌞</span></div><div class="toggleTrackThumb_W6To"></div></div><input type="checkbox" class="toggleScreenReader_h9qa" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper docs-doc-page"><div class="docPage_lDyR"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_i9tI" type="button"></button><aside class="docSidebarContainer_0YBq"><div class="sidebar_a3j0"><nav class="menu thin-scrollbar menu_cyFh"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Tutorial Intro</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/commands">Commands</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/docs/portal-tags">Portal Tags</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/worldedit">WorldEdit Integration</a></li></ul></nav></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="docItemContainer_oiyr"><article><div class="tocCollapsible_aw-L theme-doc-toc-mobile tocMobile_Tx6Y"><button type="button" class="clean-btn tocCollapsibleButton_zr6a">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Portal Tags</h1></header><p>Below is a list of currently accepted tags for portals. Only the name: tag is necessary though other tags may be needed to give the portal&#x27;s functionality.</p><p>Example use: <code>/portal create name:testportal desti:somedesti triggerblock:WATER</code></p><h2 class="anchor anchorWithStickyNavbar_y2LR" id="necessary-tags">Necessary Tags<a aria-hidden="true" class="hash-link" href="#necessary-tags" title="Direct link to heading"></a></h2><h3 class="anchor anchorWithStickyNavbar_y2LR" id="namename-for-portal"><code>name:(name for portal)</code><a aria-hidden="true" class="hash-link" href="#namename-for-portal" title="Direct link to heading"></a></h3><p>Sets the name for the portal. These have to be unique across the whole server.</p><h2 class="anchor anchorWithStickyNavbar_y2LR" id="available-tags">Available Tags<a aria-hidden="true" class="hash-link" href="#available-tags" title="Direct link to heading"></a></h2><p>These add or alter specific functionality for the portals.</p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="destinationdestination-name-or-destidestination-name"><code>destination:(destination name)</code> or <code>desti:(destination name)</code><a aria-hidden="true" class="hash-link" href="#destinationdestination-name-or-destidestination-name" title="Direct link to heading"></a></h3><p>Sets the desired destination for the portal. If this is defined if the portal is triggered, the player will be teleported to the desired location.</p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="delayedtrue"><code>delayed:true</code><a aria-hidden="true" class="hash-link" href="#delayedtrue" title="Direct link to heading"></a></h3><p>The portal uses the portal event rather than movement events. Will trigger with a delay on portal events. While this does the normal delayed behaviour for nether portals (instant if you are in creative), the end portals will trigger instantly anyway as that is normal behaviour for them.</p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="triggerblockmaterial"><code>triggerblock:(material)</code><a aria-hidden="true" class="hash-link" href="#triggerblockmaterial" title="Direct link to heading"></a></h3><p>Sets the material of the trigger block of the portal. This is the material that you need to be inside to trigger the portal. Suggestions/Tab complete will work for the names though they are in block caps and use the spigot names </p><p><a href="https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html" target="_blank" rel="noopener noreferrer">A full list of materials for 1.13+ can be found here</a></p><p><a href="https://helpch.at/docs/1.12.2/org/bukkit/Material.html" target="_blank" rel="noopener noreferrer">And a 1.12 and below list here</a></p><p>The most common types generally used are <code>NETHER_PORTAL</code>, <code>END_PORTAL</code>, <code>END_GATEWAY</code> and <code>WATER</code></p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="bungeeserver_name"><code>bungee:(server_name)</code><a aria-hidden="true" class="hash-link" href="#bungeeserver_name" title="Direct link to heading"></a></h3><p>Specifies which server to send the player too if connected through bungee. It needs to be the same as whatever you would use for <code>/server (server_name)</code> to swap manually.</p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="messageword-or-messagesome-sentence-you-want"><code>message:(word)</code> or <code>message:&quot;(some sentence you want)&quot;</code><a aria-hidden="true" class="hash-link" href="#messageword-or-messagesome-sentence-you-want" title="Direct link to heading"></a></h3><p>Sets the warp message for the portal. Colour codes can be used e.g. &amp;c is red. <a href="https://minecraft.gamepedia.com/Formatting_codes" target="_blank" rel="noopener noreferrer">See here for color codes</a>.</p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="permissionsomecustomtestperms"><code>permission:(some.custom.test.perms)</code><a aria-hidden="true" class="hash-link" href="#permissionsomecustomtestperms" title="Direct link to heading"></a></h3><p>Sets what permission you need to use the portal(can be customised to anything)</p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="commandcommand-or-commandmulti-word-command"><code>command:(command) or command:&quot;(multi-word command)&quot;</code><a aria-hidden="true" class="hash-link" href="#commandcommand-or-commandmulti-word-command" title="Direct link to heading"></a></h3><p>Whatever is typed in here the player will execute as a command, there are several flags you can use listed below to alter the execution, however only one can be used at once.</p><p>You can also use <code>@player</code> to place the teleporting user&#x27;s name into the command.</p><p>Example: <code>command:&quot;#say @player has triggered a console command portal&quot;</code></p><p>A common request is how to rtp players.
We recommend using <a href="https://www.spigotmc.org/resources/betterrtp-random-wild-teleport.36081/" target="_blank" rel="noopener noreferrer">BetterRTP</a> and using the <code>rtp player</code> command.
This can be specified using the tag <code>command:&quot;#rtp player @player (worldname)&quot;</code>. This will automatically insert the player name and run the command in the console.</p><h3 class="anchor anchorWithStickyNavbar_y2LR" id="command-tag-flags">Command Tag Flags<a aria-hidden="true" class="hash-link" href="#command-tag-flags" title="Direct link to heading"></a></h3><p>You can only use one of these at the start of a command tag.</p><p><code>!</code> Execute command as op</p><p><code>^</code> Execute command with * permission</p><p><code>#</code> Execute command as console</p><p><code>%</code> Send command to bungee</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/sekwah41/Advanced-Portals/edit/website/docs/portal-tags.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_mt2f"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/commands"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« <!-- -->Commands</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/worldedit"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">WorldEdit Integration<!-- --> »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#necessary-tags" class="table-of-contents__link toc-highlight">Necessary Tags</a><ul><li><a href="#namename-for-portal" class="table-of-contents__link toc-highlight"><code>name:(name for portal)</code></a></li></ul></li><li><a href="#available-tags" class="table-of-contents__link toc-highlight">Available Tags</a><ul><li><a href="#destinationdestination-name-or-destidestination-name" class="table-of-contents__link toc-highlight"><code>destination:(destination name)</code> or <code>desti:(destination name)</code></a></li><li><a href="#delayedtrue" class="table-of-contents__link toc-highlight"><code>delayed:true</code></a></li><li><a href="#triggerblockmaterial" class="table-of-contents__link toc-highlight"><code>triggerblock:(material)</code></a></li><li><a href="#bungeeserver_name" class="table-of-contents__link toc-highlight"><code>bungee:(server_name)</code></a></li><li><a href="#messageword-or-messagesome-sentence-you-want" class="table-of-contents__link toc-highlight"><code>message:(word)</code> or <code>message:&quot;(some sentence you want)&quot;</code></a></li><li><a href="#permissionsomecustomtestperms" class="table-of-contents__link toc-highlight"><code>permission:(some.custom.test.perms)</code></a></li><li><a href="#commandcommand-or-commandmulti-word-command" class="table-of-contents__link toc-highlight"><code>command:(command) or command:&quot;(multi-word command)&quot;</code></a></li><li><a href="#command-tag-flags" class="table-of-contents__link toc-highlight">Command Tag Flags</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Downloads</div><ul class="footer__items"><li class="footer__item"><a href="https://dev.bukkit.org/projects/advanced-portals" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Bukkit.org<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://github.com/sekwah41/Advanced-Portals/releases" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a href="https://discord.sekwah.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://twitter.com/sekwah" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/sekwah41/Advanced-Portals/blob/spigot-1.13-1.16/CHANGELOG.md" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Changelog<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://github.com/sekwah41/Advanced-Portals" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Source Code<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 Sekwah.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.50ceeefe.js"></script>
<script src="/assets/js/main.a20c8a88.js"></script>
</body>
</html>