diff options
| author | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
|---|---|---|
| committer | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
| commit | dc3df3edd5843bde0c1335d6a8e460b2c832aa48 (patch) | |
| tree | af13bfeee567f2351e35e1ef176d168fe37c8aac /javadoc/net/minecraftforge/common/ISpecialArmor.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/net/minecraftforge/common/ISpecialArmor.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/ISpecialArmor.html | 296 |
1 files changed, 296 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/ISpecialArmor.html b/javadoc/net/minecraftforge/common/ISpecialArmor.html new file mode 100644 index 0000000..dbf967a --- /dev/null +++ b/javadoc/net/minecraftforge/common/ISpecialArmor.html @@ -0,0 +1,296 @@ +<!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 (version 1.7.0_65) on Thu Feb 05 20:10:17 EST 2015 --> +<title>ISpecialArmor (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ISpecialArmor (Forge API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../net/minecraftforge/common/IShearable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/ISpecialArmor.html" target="_top">Frames</a></li> +<li><a href="ISpecialArmor.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All 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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">net.minecraftforge.common</div> +<h2 title="Interface ISpecialArmor" class="title">Interface ISpecialArmor</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">ISpecialArmor</span></pre> +<div class="block">This interface is to be implemented by ItemArmor classes. It will allow to + modify computation of damage and health loss. Computation will be called + before the actual armor computation, which can then be cancelled.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../net/minecraft/item/ItemArmor.html" title="class in net.minecraft.item"><code>ItemArmor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.html#damageArmor(net.minecraft.entity.EntityLivingBase,%20net.minecraft.item.ItemStack,%20net.minecraft.util.DamageSource,%20int,%20int)">damageArmor</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + int damage, + int slot)</code> +<div class="block">Applies damage to the ItemStack.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.html#getArmorDisplay(net.minecraft.entity.player.EntityPlayer,%20net.minecraft.item.ItemStack,%20int)">getArmorDisplay</a></strong>(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + int slot)</code> +<div class="block">Get the displayed effective armor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.html#getProperties(net.minecraft.entity.EntityLivingBase,%20net.minecraft.item.ItemStack,%20net.minecraft.util.DamageSource,%20double,%20int)">getProperties</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + double damage, + int slot)</code> +<div class="block">Retrieves the modifiers to be used when calculating armor damage.</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="getProperties(net.minecraft.entity.EntityLivingBase, net.minecraft.item.ItemStack, net.minecraft.util.DamageSource, double, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a> getProperties(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + double damage, + int slot)</pre> +<div class="block">Retrieves the modifiers to be used when calculating armor damage. + + Armor will higher priority will have damage applied to them before + lower priority ones. If there are multiple pieces of armor with the + same priority, damage will be distributed between them based on there + absorption ratio.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>player</code> - The entity wearing the armor.</dd><dd><code>armor</code> - The ItemStack of the armor item itself.</dd><dd><code>source</code> - The source of the damage, which can be used to alter armor + properties based on the type or source of damage.</dd><dd><code>damage</code> - The total damage being applied to the entity</dd><dd><code>slot</code> - The armor slot the item is in.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A ArmorProperties instance holding information about how the armor effects damage.</dd></dl> +</li> +</ul> +<a name="getArmorDisplay(net.minecraft.entity.player.EntityPlayer, net.minecraft.item.ItemStack, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArmorDisplay</h4> +<pre>int getArmorDisplay(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + int slot)</pre> +<div class="block">Get the displayed effective armor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>player</code> - The player wearing the armor.</dd><dd><code>armor</code> - The ItemStack of the armor item itself.</dd><dd><code>slot</code> - The armor slot the item is in.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The number of armor points for display, 2 per shield.</dd></dl> +</li> +</ul> +<a name="damageArmor(net.minecraft.entity.EntityLivingBase, net.minecraft.item.ItemStack, net.minecraft.util.DamageSource, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>damageArmor</h4> +<pre>void damageArmor(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + int damage, + int slot)</pre> +<div class="block">Applies damage to the ItemStack. The mod is responsible for reducing the + item durability and stack size. If the stack is depleted it will be cleaned + up automatically.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entity</code> - The entity wearing the armor</dd><dd><code>stack</code> - The ItemStack of the armor item itself.</dd><dd><code>source</code> - The source of the damage, which can be used to alter armor + properties based on the type or source of damage.</dd><dd><code>damage</code> - The amount of damage being applied to the armor</dd><dd><code>slot</code> - The armor slot the item is in.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../net/minecraftforge/common/IShearable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/ISpecialArmor.html" target="_top">Frames</a></li> +<li><a href="ISpecialArmor.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All 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: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |