diff options
Diffstat (limited to 'javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html')
| -rw-r--r-- | javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html | 356 |
1 files changed, 356 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html b/javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html new file mode 100644 index 0000000..53e177f --- /dev/null +++ b/javadoc/net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html @@ -0,0 +1,356 @@ +<!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:15 EST 2015 --> +<title>PlaySoundAtEntityEvent (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="PlaySoundAtEntityEvent (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/event/entity/EntityStruckByLightningEvent.html" title="class in net.minecraftforge.event.entity"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html" target="_top">Frames</a></li> +<li><a href="PlaySoundAtEntityEvent.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_classes_inherited_from_class_net.minecraftforge.event.entity.EntityEvent">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.event.entity</div> +<h2 title="Class PlaySoundAtEntityEvent" class="title">Class PlaySoundAtEntityEvent</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">cpw.mods.fml.common.eventhandler.Event</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../net/minecraftforge/event/entity/EntityEvent.html" title="class in net.minecraftforge.event.entity">net.minecraftforge.event.entity.EntityEvent</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.event.entity.PlaySoundAtEntityEvent</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">PlaySoundAtEntityEvent</span> +extends <a href="../../../../net/minecraftforge/event/entity/EntityEvent.html" title="class in net.minecraftforge.event.entity">EntityEvent</a></pre> +<div class="block">PlaySoundAtEntityEvent is fired a sound is to be played at an Entity<br> + This event is fired whenever a sound is set to be played at an Entity such as in + EntityPlayerSP#playSound(String, float, float), World#playSoundAtEntity(Entity, String, float, float), + and World#playerSoundToNearExcept(EntityPlayer, String, float, float).<br> + <br> + <a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#name"><code>name</code></a> contains the name of the sound to be played at the Entity.<br> + <a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#volume"><code>volume</code></a> contains the volume at which the sound is to be played.<br> + <a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#pitch"><code>pitch</code></a> contains the pitch at which the sound is to be played.<br> + Changing the <a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#name"><code>name</code></a> field will cause the sound of this name to be played instead of the originally intended sound.<br> + <br> + This event is <a href="../../../../cpw/mods/fml/common/eventhandler/Cancelable.html" title="annotation in cpw.mods.fml.common.eventhandler"><code>Cancelable</code></a>.<br> + If this event is canceled, the sound is not played.<br> + <br> + This event does not have a result. <code>HasResult</code> <br> + <br> + This event is fired on the <code>MinecraftForge#EVENT_BUS</code>.<br></div> +</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_net.minecraftforge.event.entity.EntityEvent"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class net.minecraftforge.event.entity.<a href="../../../../net/minecraftforge/event/entity/EntityEvent.html" title="class in net.minecraftforge.event.entity">EntityEvent</a></h3> +<code><a href="../../../../net/minecraftforge/event/entity/EntityEvent.CanUpdate.html" title="class in net.minecraftforge.event.entity">EntityEvent.CanUpdate</a>, <a href="../../../../net/minecraftforge/event/entity/EntityEvent.EnteringChunk.html" title="class in net.minecraftforge.event.entity">EntityEvent.EnteringChunk</a>, <a href="../../../../net/minecraftforge/event/entity/EntityEvent.EntityConstructing.html" title="class in net.minecraftforge.event.entity">EntityEvent.EntityConstructing</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_cpw.mods.fml.common.eventhandler.Event"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class cpw.mods.fml.common.eventhandler.<a href="../../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></h3> +<code><a href="../../../../cpw/mods/fml/common/eventhandler/Event.HasResult.html" title="annotation in cpw.mods.fml.common.eventhandler">Event.HasResult</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.Result.html" title="enum in cpw.mods.fml.common.eventhandler">Event.Result</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#name">name</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#pitch">pitch</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#volume">volume</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraftforge.event.entity.EntityEvent"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraftforge.event.entity.<a href="../../../../net/minecraftforge/event/entity/EntityEvent.html" title="class in net.minecraftforge.event.entity">EntityEvent</a></h3> +<code><a href="../../../../net/minecraftforge/event/entity/EntityEvent.html#entity">entity</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html#PlaySoundAtEntityEvent(net.minecraft.entity.Entity,%20java.lang.String,%20float,%20float)">PlaySoundAtEntityEvent</a></strong>(<a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> entity, + java.lang.String name, + float volume, + float pitch)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event"> +<!-- --> +</a> +<h3>Methods inherited from class cpw.mods.fml.common.eventhandler.<a href="../../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></h3> +<code><a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#getListenerList()">getListenerList</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#getPhase()">getPhase</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#getResult()">getResult</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#hasResult()">hasResult</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#isCancelable()">isCancelable</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#isCanceled()">isCanceled</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#setCanceled(boolean)">setCanceled</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#setPhase(cpw.mods.fml.common.eventhandler.EventPriority)">setPhase</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#setResult(cpw.mods.fml.common.eventhandler.Event.Result)">setResult</a>, <a href="../../../../cpw/mods/fml/common/eventhandler/Event.html#setup()">setup</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="name"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>name</h4> +<pre>public java.lang.String name</pre> +</li> +</ul> +<a name="volume"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>volume</h4> +<pre>public final float volume</pre> +</li> +</ul> +<a name="pitch"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>pitch</h4> +<pre>public final float pitch</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="PlaySoundAtEntityEvent(net.minecraft.entity.Entity, java.lang.String, float, float)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PlaySoundAtEntityEvent</h4> +<pre>public PlaySoundAtEntityEvent(<a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> entity, + java.lang.String name, + float volume, + float pitch)</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><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/event/entity/EntityStruckByLightningEvent.html" title="class in net.minecraftforge.event.entity"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/event/entity/PlaySoundAtEntityEvent.html" target="_top">Frames</a></li> +<li><a href="PlaySoundAtEntityEvent.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_classes_inherited_from_class_net.minecraftforge.event.entity.EntityEvent">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |