AtlasMediaGroup/Scissors-Website
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors-Website.git synced 2024-12-28 21:07:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
old-website
Scissors-Website/public/javadoc/1.18.2/org/bukkit/map/MapCanvas.html
Telesphoreo 21e269497a Add Javadocs
2022-07-05 18:33:56 -05:00

289 lines
19 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>MapCanvas (Scissors-API 1.18.2-R0.1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.bukkit.map, interface: MapCanvas">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.bukkit.map</a></div>
<h1 title="Interface MapCanvas" class="title">Interface MapCanvas</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">MapCanvas</span></div>
<div class="block">Represents a canvas for drawing to a map. Each canvas is associated with a
specific <a href="MapRenderer.html" title="class in org.bukkit.map"><code>MapRenderer</code></a> and represents that renderer's layer on the
map.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#drawImage(int,int,java.awt.Image)" class="member-name-link">drawImage</a><wbr>(int&nbsp;x,
int&nbsp;y,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/Image.html" title="class or interface in java.awt" class="external-link">Image</a>&nbsp;image)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Draw an image to the map.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#drawText(int,int,org.bukkit.map.MapFont,java.lang.String)" class="member-name-link">drawText</a><wbr>(int&nbsp;x,
int&nbsp;y,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapFont.html" title="class in org.bukkit.map">MapFont</a>&nbsp;font,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;text)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Render text to the map using fancy formatting.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getBasePixel(int,int)" class="member-name-link">getBasePixel</a><wbr>(int&nbsp;x,
int&nbsp;y)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get a pixel from the layers below this canvas.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapCursorCollection.html" title="class in org.bukkit.map">MapCursorCollection</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCursors()" class="member-name-link">getCursors</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the cursor collection associated with this canvas.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapView.html" title="interface in org.bukkit.map">MapView</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMapView()" class="member-name-link">getMapView</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the map this canvas is attached to.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPixel(int,int)" class="member-name-link">getPixel</a><wbr>(int&nbsp;x,
int&nbsp;y)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get a pixel from the canvas.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCursors(org.bukkit.map.MapCursorCollection)" class="member-name-link">setCursors</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapCursorCollection.html" title="class in org.bukkit.map">MapCursorCollection</a>&nbsp;cursors)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set the cursor collection associated with this canvas.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setPixel(int,int,byte)" class="member-name-link">setPixel</a><wbr>(int&nbsp;x,
int&nbsp;y,
byte&nbsp;color)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Draw a pixel to the canvas.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getMapView()">
<h3>getMapView</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapView.html" title="interface in org.bukkit.map">MapView</a></span>&nbsp;<span class="element-name">getMapView</span>()</div>
<div class="block">Get the map this canvas is attached to.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The MapView this canvas is attached to.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCursors()">
<h3>getCursors</h3>
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapCursorCollection.html" title="class in org.bukkit.map">MapCursorCollection</a></span>&nbsp;<span class="element-name">getCursors</span>()</div>
<div class="block">Get the cursor collection associated with this canvas.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The MapCursorCollection associated with this canvas.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setCursors(org.bukkit.map.MapCursorCollection)">
<h3>setCursors</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setCursors</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapCursorCollection.html" title="class in org.bukkit.map">MapCursorCollection</a>&nbsp;cursors)</span></div>
<div class="block">Set the cursor collection associated with this canvas. This does not
usually need to be called since a MapCursorCollection is already
provided.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cursors</code> - The MapCursorCollection to associate with this canvas.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setPixel(int,int,byte)">
<h3>setPixel</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setPixel</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y,
byte&nbsp;color)</span></div>
<div class="block">Draw a pixel to the canvas.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - The x coordinate, from 0 to 127.</dd>
<dd><code>y</code> - The y coordinate, from 0 to 127.</dd>
<dd><code>color</code> - The color. See <a href="MapPalette.html" title="class in org.bukkit.map"><code>MapPalette</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getPixel(int,int)">
<h3>getPixel</h3>
<div class="member-signature"><span class="return-type">byte</span>&nbsp;<span class="element-name">getPixel</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y)</span></div>
<div class="block">Get a pixel from the canvas.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - The x coordinate, from 0 to 127.</dd>
<dd><code>y</code> - The y coordinate, from 0 to 127.</dd>
<dt>Returns:</dt>
<dd>The color. See <a href="MapPalette.html" title="class in org.bukkit.map"><code>MapPalette</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getBasePixel(int,int)">
<h3>getBasePixel</h3>
<div class="member-signature"><span class="return-type">byte</span>&nbsp;<span class="element-name">getBasePixel</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y)</span></div>
<div class="block">Get a pixel from the layers below this canvas.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - The x coordinate, from 0 to 127.</dd>
<dd><code>y</code> - The y coordinate, from 0 to 127.</dd>
<dt>Returns:</dt>
<dd>The color. See <a href="MapPalette.html" title="class in org.bukkit.map"><code>MapPalette</code></a>.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="drawImage(int,int,java.awt.Image)">
<h3>drawImage</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">drawImage</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/Image.html" title="class or interface in java.awt" class="external-link">Image</a>&nbsp;image)</span></div>
<div class="block">Draw an image to the map. The image will be clipped if necessary.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - The x coordinate of the image.</dd>
<dd><code>y</code> - The y coordinate of the image.</dd>
<dd><code>image</code> - The Image to draw.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="drawText(int,int,org.bukkit.map.MapFont,java.lang.String)">
<h3>drawText</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">drawText</span><wbr><span class="parameters">(int&nbsp;x,
int&nbsp;y,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="MapFont.html" title="class in org.bukkit.map">MapFont</a>&nbsp;font,
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;text)</span></div>
<div class="block">Render text to the map using fancy formatting. Newline (\n) characters
will move down one line and return to the original column, and the text
color can be changed using sequences such as "§12;", replacing 12 with
the palette index of the color (see <a href="MapPalette.html" title="class in org.bukkit.map"><code>MapPalette</code></a>).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - The column to start rendering on.</dd>
<dd><code>y</code> - The row to start rendering on.</dd>
<dd><code>font</code> - The font to use.</dd>
<dd><code>text</code> - The formatted text to render.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink