Tom Lint 92e29ba3dd Fixed compiler errors
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

525 lines
21 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:26:56 CEST 2013 -->
<title>GameComponent</title>
<meta name="date" content="2013-10-15">
<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="GameComponent";
}
//-->
</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="class-use/GameComponent.html">Use</a></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="../../../Microsoft/Xna/Framework/Game.html" title="class in Microsoft.Xna.Framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../Microsoft/Xna/Framework/GameComponentCollection.html" title="class in Microsoft.Xna.Framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?Microsoft/Xna/Framework/GameComponent.html" target="_top">Frames</a></li>
<li><a href="GameComponent.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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">Microsoft.Xna.Framework</div>
<h2 title="Class GameComponent" class="title">Class GameComponent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>Microsoft.Xna.Framework.GameComponent</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../Microsoft/Xna/Framework/IGameComponent.html" title="interface in Microsoft.Xna.Framework">IGameComponent</a>, <a href="../../../Microsoft/Xna/Framework/IUpdateable.html" title="interface in Microsoft.Xna.Framework">IUpdateable</a>, System.IDisposable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../Microsoft/Xna/Framework/DrawableGameComponent.html" title="class in Microsoft.Xna.Framework">DrawableGameComponent</a>, <a href="../../../Microsoft/Xna/Framework/GamerServices/GamerServicesComponent.html" title="class in Microsoft.Xna.Framework.GamerServices">GamerServicesComponent</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">GameComponent</span>
extends java.lang.Object
implements <a href="../../../Microsoft/Xna/Framework/IGameComponent.html" title="interface in Microsoft.Xna.Framework">IGameComponent</a>, <a href="../../../Microsoft/Xna/Framework/IUpdateable.html" title="interface in Microsoft.Xna.Framework">IUpdateable</a>, System.IDisposable</pre>
<div class="block">Base class for all XNA Framework game components.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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">&nbsp;</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>System.Event&lt;System.EventArgs&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#Disposed">Disposed</a></strong></code>
<div class="block">Raised when the GameComponent is disposed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>System.Event&lt;System.EventArgs&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#EnabledChanged">EnabledChanged</a></strong></code>
<div class="block">Raised when the Enabled property changes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>System.Event&lt;System.EventArgs&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#UpdateOrderChanged">UpdateOrderChanged</a></strong></code>
<div class="block">Raised when the UpdateOrder property changes.</div>
</td>
</tr>
</table>
</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">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#GameComponent(Microsoft.Xna.Framework.Game)">GameComponent</a></strong>(<a href="../../../Microsoft/Xna/Framework/Game.html" title="class in Microsoft.Xna.Framework">Game</a>&nbsp;game)</code>
<div class="block">Initializes a new instance of this class.</div>
</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">&nbsp;</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="../../../Microsoft/Xna/Framework/GameComponent.html#Dispose()">Dispose</a></strong>()</code>
<div class="block">Immediately releases the unmanaged resources used by this object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#Dispose(boolean)">Dispose</a></strong>(boolean&nbsp;disposing)</code>
<div class="block">Releases the unmanaged resources used by the GameComponent and optionally releases the managed resources.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#getEnabled()">getEnabled</a></strong>()</code>
<div class="block">Indicates whether GameComponent.Update should be called when Game.Update is called.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../Microsoft/Xna/Framework/Game.html" title="class in Microsoft.Xna.Framework">Game</a></code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#getGame()">getGame</a></strong>()</code>
<div class="block">Gets the Game associated with this GameComponent.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#getUpdateOrder()">getUpdateOrder</a></strong>()</code>
<div class="block">Indicates the order in which the GameComponent should be updated relative to other GameComponent instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#Initialize()">Initialize</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#OnEnabledChanged(java.lang.Object, System.EventArgs)">OnEnabledChanged</a></strong>(java.lang.Object&nbsp;sender,
System.EventArgs&nbsp;e)</code>
<div class="block">Called when the Enabled property changes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#OnUpdateOrderChanged(java.lang.Object, System.EventArgs)">OnUpdateOrderChanged</a></strong>(java.lang.Object&nbsp;sender,
System.EventArgs&nbsp;e)</code>
<div class="block">Called when the UpdateOrder property changes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#setEnabled(boolean)">setEnabled</a></strong>(boolean&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#setUpdateOrder(int)">setUpdateOrder</a></strong>(int&nbsp;value)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../Microsoft/Xna/Framework/GameComponent.html#Update(Microsoft.Xna.Framework.GameTime)">Update</a></strong>(<a href="../../../Microsoft/Xna/Framework/GameTime.html" title="class in Microsoft.Xna.Framework">GameTime</a>&nbsp;gameTime)</code>
<div class="block">Called when the GameComponent needs to be updated.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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="Disposed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Disposed</h4>
<pre>public final&nbsp;System.Event&lt;System.EventArgs&gt; Disposed</pre>
<div class="block">Raised when the GameComponent is disposed.</div>
</li>
</ul>
<a name="EnabledChanged">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EnabledChanged</h4>
<pre>public final&nbsp;System.Event&lt;System.EventArgs&gt; EnabledChanged</pre>
<div class="block">Raised when the Enabled property changes.</div>
</li>
</ul>
<a name="UpdateOrderChanged">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UpdateOrderChanged</h4>
<pre>public final&nbsp;System.Event&lt;System.EventArgs&gt; UpdateOrderChanged</pre>
<div class="block">Raised when the UpdateOrder property changes.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GameComponent(Microsoft.Xna.Framework.Game)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GameComponent</h4>
<pre>public&nbsp;GameComponent(<a href="../../../Microsoft/Xna/Framework/Game.html" title="class in Microsoft.Xna.Framework">Game</a>&nbsp;game)</pre>
<div class="block">Initializes a new instance of this class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>game</code> - Game that the game component should be attached to.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnabled</h4>
<pre>public&nbsp;boolean&nbsp;getEnabled()</pre>
<div class="block">Indicates whether GameComponent.Update should be called when Game.Update is called.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../Microsoft/Xna/Framework/IUpdateable.html#getEnabled()">getEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="../../../Microsoft/Xna/Framework/IUpdateable.html" title="interface in Microsoft.Xna.Framework">IUpdateable</a></code></dd>
</dl>
</li>
</ul>
<a name="setEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnabled</h4>
<pre>public&nbsp;void&nbsp;setEnabled(boolean&nbsp;value)</pre>
</li>
</ul>
<a name="getGame()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGame</h4>
<pre>public&nbsp;<a href="../../../Microsoft/Xna/Framework/Game.html" title="class in Microsoft.Xna.Framework">Game</a>&nbsp;getGame()</pre>
<div class="block">Gets the Game associated with this GameComponent.</div>
</li>
</ul>
<a name="getUpdateOrder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpdateOrder</h4>
<pre>public&nbsp;int&nbsp;getUpdateOrder()</pre>
<div class="block">Indicates the order in which the GameComponent should be updated relative to other GameComponent instances. Lower values are updated first.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../Microsoft/Xna/Framework/IUpdateable.html#getUpdateOrder()">getUpdateOrder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../Microsoft/Xna/Framework/IUpdateable.html" title="interface in Microsoft.Xna.Framework">IUpdateable</a></code></dd>
</dl>
</li>
</ul>
<a name="setUpdateOrder(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpdateOrder</h4>
<pre>public&nbsp;void&nbsp;setUpdateOrder(int&nbsp;value)</pre>
</li>
</ul>
<a name="Dispose()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dispose</h4>
<pre>public&nbsp;void&nbsp;Dispose()</pre>
<div class="block">Immediately releases the unmanaged resources used by this object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>Dispose</code>&nbsp;in interface&nbsp;<code>System.IDisposable</code></dd>
</dl>
</li>
</ul>
<a name="Dispose(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Dispose</h4>
<pre>protected&nbsp;void&nbsp;Dispose(boolean&nbsp;disposing)</pre>
<div class="block">Releases the unmanaged resources used by the GameComponent and optionally releases the managed resources.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>disposing</code> - true to release both managed and unmanaged resources; false to release only unmanaged resources.</dd></dl>
</li>
</ul>
<a name="Initialize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Initialize</h4>
<pre>public&nbsp;void&nbsp;Initialize()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../Microsoft/Xna/Framework/IGameComponent.html#Initialize()">Initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../Microsoft/Xna/Framework/IGameComponent.html" title="interface in Microsoft.Xna.Framework">IGameComponent</a></code></dd>
</dl>
</li>
</ul>
<a name="OnEnabledChanged(java.lang.Object, System.EventArgs)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OnEnabledChanged</h4>
<pre>protected&nbsp;void&nbsp;OnEnabledChanged(java.lang.Object&nbsp;sender,
System.EventArgs&nbsp;e)</pre>
<div class="block">Called when the Enabled property changes. Raises the EnabledChanged event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sender</code> - The GameComponent.</dd><dd><code>e</code> - Arguments to the EnabledChanged event.</dd></dl>
</li>
</ul>
<a name="OnUpdateOrderChanged(java.lang.Object, System.EventArgs)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OnUpdateOrderChanged</h4>
<pre>protected&nbsp;void&nbsp;OnUpdateOrderChanged(java.lang.Object&nbsp;sender,
System.EventArgs&nbsp;e)</pre>
<div class="block">Called when the UpdateOrder property changes. Raises the UpdateOrderChanged event.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sender</code> - The GameComponent.</dd><dd><code>e</code> - Arguments to the UpdateOrderChanged event.</dd></dl>
</li>
</ul>
<a name="Update(Microsoft.Xna.Framework.GameTime)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Update</h4>
<pre>public&nbsp;void&nbsp;Update(<a href="../../../Microsoft/Xna/Framework/GameTime.html" title="class in Microsoft.Xna.Framework">GameTime</a>&nbsp;gameTime)</pre>
<div class="block">Called when the GameComponent needs to be updated. Override this method with component-specific update code.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../Microsoft/Xna/Framework/IUpdateable.html#Update(Microsoft.Xna.Framework.GameTime)">Update</a></code>&nbsp;in interface&nbsp;<code><a href="../../../Microsoft/Xna/Framework/IUpdateable.html" title="interface in Microsoft.Xna.Framework">IUpdateable</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>gameTime</code> - Time elapsed since the last call to Update</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="class-use/GameComponent.html">Use</a></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="../../../Microsoft/Xna/Framework/Game.html" title="class in Microsoft.Xna.Framework"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../Microsoft/Xna/Framework/GameComponentCollection.html" title="class in Microsoft.Xna.Framework"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?Microsoft/Xna/Framework/GameComponent.html" target="_top">Frames</a></li>
<li><a href="GameComponent.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&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>