CustomNPC-Plus/docs/noppes/npcs/api/ISkinOverlay.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_331) on Thu Nov 24 22:55:34 CST 2022 -->
<title>ISkinOverlay</title>
<meta name="date" content="2022-11-24">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="ISkinOverlay";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../noppes/npcs/api/IPos.html" title="interface in noppes.npcs.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../noppes/npcs/api/ITileEntity.html" title="interface in noppes.npcs.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?noppes/npcs/api/ISkinOverlay.html" target="_top">Frames</a></li>
<li><a href="ISkinOverlay.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">noppes.npcs.api</div>
<h2 title="Interface ISkinOverlay" class="title">Interface ISkinOverlay</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ISkinOverlay</span></pre>
<div class="block">A skin overlay object for both NPCs and players. Several skin overlays at a time can be layered on top of each other.
 In an NPC's case, the old overlay texture is now the skin overlay with ID 0.

 Modifying these attributes, an overlay can be made to look like a powered creeper effect, just a new skin, or both!</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getAlpha--">getAlpha</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getBlend--">getBlend</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getGlow--">getGlow</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getOffsetX--">getOffsetX</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getOffsetY--">getOffsetY</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getOffsetZ--">getOffsetZ</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getSize--">getSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getSpeedX--">getSpeedX</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getSpeedY--">getSpeedY</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getTexture--">getTexture</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getTextureScaleX--">getTextureScaleX</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#getTextureScaleY--">getTextureScaleY</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setAlpha-float-">setAlpha</a></span>(float&nbsp;alpha)</code>
<div class="block">Sets the transparency of the overlay, from 0 to 1.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setBlend-boolean-">setBlend</a></span>(boolean&nbsp;blend)</code>
<div class="block">Sets whether this overlay blends on top of bottom textures at any alpha value.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setGlow-boolean-">setGlow</a></span>(boolean&nbsp;glow)</code>
<div class="block">Sets whether this overlay glows in the dark or not.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setOffset-float-float-float-">setOffset</a></span>(float&nbsp;offsetX,
         float&nbsp;offsetY,
         float&nbsp;offsetZ)</code>
<div class="block">Sets the amount in each direction by which the overlay will be offset from the entity.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setSize-float-">setSize</a></span>(float&nbsp;size)</code>
<div class="block">Sets the size of the entire overlay when rendered on the entity.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setSpeed-float-float-">setSpeed</a></span>(float&nbsp;speedX,
        float&nbsp;speedY)</code>
<div class="block">Sets the "texture speed" by which the texture shifts on each render tick.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setTexture-java.lang.String-">setTexture</a></span>(java.lang.String&nbsp;texture)</code>
<div class="block">Sets the directory texture of the overlay.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../noppes/npcs/api/ISkinOverlay.html#setTextureScale-float-float-">setTextureScale</a></span>(float&nbsp;scaleX,
               float&nbsp;scaleY)</code>
<div class="block">Sets the texture scale of the overlay.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="setTexture-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTexture</h4>
<pre>void&nbsp;setTexture(java.lang.String&nbsp;texture)</pre>
<div class="block">Sets the directory texture of the overlay. Does not support URLs.</div>
</li>
</ul>
<a name="getTexture--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTexture</h4>
<pre>java.lang.String&nbsp;getTexture()</pre>
</li>
</ul>
<a name="setGlow-boolean-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGlow</h4>
<pre>void&nbsp;setGlow(boolean&nbsp;glow)</pre>
<div class="block">Sets whether this overlay glows in the dark or not.</div>
</li>
</ul>
<a name="getGlow--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGlow</h4>
<pre>boolean&nbsp;getGlow()</pre>
</li>
</ul>
<a name="setBlend-boolean-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBlend</h4>
<pre>void&nbsp;setBlend(boolean&nbsp;blend)</pre>
<div class="block">Sets whether this overlay blends on top of bottom textures at any alpha value.</div>
</li>
</ul>
<a name="getBlend--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlend</h4>
<pre>boolean&nbsp;getBlend()</pre>
</li>
</ul>
<a name="setAlpha-float-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAlpha</h4>
<pre>void&nbsp;setAlpha(float&nbsp;alpha)</pre>
<div class="block">Sets the transparency of the overlay, from 0 to 1.</div>
</li>
</ul>
<a name="getAlpha--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAlpha</h4>
<pre>float&nbsp;getAlpha()</pre>
</li>
</ul>
<a name="setSize-float-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSize</h4>
<pre>void&nbsp;setSize(float&nbsp;size)</pre>
<div class="block">Sets the size of the entire overlay when rendered on the entity. By default, overlays render slightly on top of
 the entity's model.</div>
</li>
</ul>
<a name="getSize--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>float&nbsp;getSize()</pre>
</li>
</ul>
<a name="setTextureScale-float-float-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTextureScale</h4>
<pre>void&nbsp;setTextureScale(float&nbsp;scaleX,
                     float&nbsp;scaleY)</pre>
<div class="block">Sets the texture scale of the overlay. Higher values will "zoom in" to the texture more.</div>
</li>
</ul>
<a name="getTextureScaleX--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextureScaleX</h4>
<pre>float&nbsp;getTextureScaleX()</pre>
</li>
</ul>
<a name="getTextureScaleY--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextureScaleY</h4>
<pre>float&nbsp;getTextureScaleY()</pre>
</li>
</ul>
<a name="setSpeed-float-float-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSpeed</h4>
<pre>void&nbsp;setSpeed(float&nbsp;speedX,
              float&nbsp;speedY)</pre>
<div class="block">Sets the "texture speed" by which the texture shifts on each render tick. Used to create a powered creeper effect!
 This does not move the entire overlay, it just moves the position at which the texture begins rendering.</div>
</li>
</ul>
<a name="getSpeedX--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpeedX</h4>
<pre>float&nbsp;getSpeedX()</pre>
</li>
</ul>
<a name="getSpeedY--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpeedY</h4>
<pre>float&nbsp;getSpeedY()</pre>
</li>
</ul>
<a name="setOffset-float-float-float-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOffset</h4>
<pre>void&nbsp;setOffset(float&nbsp;offsetX,
               float&nbsp;offsetY,
               float&nbsp;offsetZ)</pre>
<div class="block">Sets the amount in each direction by which the overlay will be offset from the entity.</div>
</li>
</ul>
<a name="getOffsetX--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffsetX</h4>
<pre>float&nbsp;getOffsetX()</pre>
</li>
</ul>
<a name="getOffsetY--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffsetY</h4>
<pre>float&nbsp;getOffsetY()</pre>
</li>
</ul>
<a name="getOffsetZ--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOffsetZ</h4>
<pre>float&nbsp;getOffsetZ()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../noppes/npcs/api/IPos.html" title="interface in noppes.npcs.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../noppes/npcs/api/ITileEntity.html" title="interface in noppes.npcs.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?noppes/npcs/api/ISkinOverlay.html" target="_top">Frames</a></li>
<li><a href="ISkinOverlay.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<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="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>