SpriteLibrary/SpriteLibrary/Doc/Help/html/56b507fc-3071-20e9-63a7-b33...

11 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SpriteController.DestroySprite Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="DestroySprite method" /><meta name="System.Keywords" content="SpriteController.DestroySprite method" /><meta name="Microsoft.Help.F1" content="SpriteLibrary.SpriteController.DestroySprite" /><meta name="Microsoft.Help.Id" content="M:SpriteLibrary.SpriteController.DestroySprite(SpriteLibrary.Sprite)" /><meta name="Description" content="Tell a sprite to destroy itself. The sprite will have Destroying property set to true from the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself and remove itself from the controller." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="SpriteLibrary" /><meta name="file" content="56b507fc-3071-20e9-63a7-b33484f3e687" /><meta name="guid" content="56b507fc-3071-20e9-63a7-b33484f3e687" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">SpriteLibrary<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm" title="SpriteLibrary" tocid="roottoc">SpriteLibrary</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm" title="SpriteLibrary" tocid="6b7227c0-7a6a-6342-3b08-917c7de429cc">SpriteLibrary</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="07a473e4-4716-e5b9-c7d2-c4748265fc58.htm" title="SpriteController Class" tocid="07a473e4-4716-e5b9-c7d2-c4748265fc58">SpriteController Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="2788d4d5-88bf-1154-dd17-8d4b99a79118.htm" title="SpriteController Methods" tocid="2788d4d5-88bf-1154-dd17-8d4b99a79118">SpriteController Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="f28be11d-b67a-765c-441a-d7da336ccf77.htm" title="AddSprite Method " tocid="f28be11d-b67a-765c-441a-d7da336ccf77">AddSprite Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="68ba53c6-5c0d-3dd4-b9bd-56852a3b98cd.htm" title="AdjustPoint Method " tocid="68ba53c6-5c0d-3dd4-b9bd-56852a3b98cd">AdjustPoint Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="4f100dc3-39b4-fea4-6d73-8ef39eea489c.htm" title="AdjustRectangle Method " tocid="4f100dc3-39b4-fea4-6d73-8ef39eea489c">AdjustRectangle Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="662ea0d6-7a35-be51-5a25-288752509d24.htm" title="AllSprites Method " tocid="662ea0d6-7a35-be51-5a25-288752509d24">AllSprites Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="bf55ab7f-78c8-3879-b8f8-464dc203791e.htm" title="ChangeTickInterval Method " tocid="bf55ab7f-78c8-3879-b8f8-464dc203791e">ChangeTickInterval Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="dace8c3a-8d35-4ae7-ddf8-26e59dc161ae.htm" title="CountSpritesBasedOff Method " tocid="dace8c3a-8d35-4ae7-ddf8-26e59dc161ae">CountSpritesBasedOff Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="63fd5f6f-f592-0dbd-6fd2-ff4b999f012d.htm" title="DestroyAllSprites Method " tocid="63fd5f6f-f592-0dbd-6fd2-ff4b999f012d">DestroyAllSprites Method </a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="56b507fc-3071-20e9-63a7-b33484f3e687.htm" title="DestroySprite Method " tocid="56b507fc-3071-20e9-63a7-b33484f3e687">DestroySprite Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="ae6c1c82-0519-4751-0b6d-f264c484e4cb.htm" title="DuplicateSprite Method " tocid="ae6c1c82-0519-4751-0b6d-f264c484e4cb">DuplicateSprite Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="fd95464a-c61d-8ed2-a568-34b825efc047.htm" title="Invalidate Method " tocid="fd95464a-c61d-8ed2-a568-34b825efc047">Invalidate Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="50eae5e0-c59c-9d9c-d551-21dba8696ac9.htm" title="IsKeyPressed Method " tocid="50eae5e0-c59c-9d9c-d551-21dba8696ac9">IsKeyPressed Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="bcb29da5-8d8d-fa11-90ea-3a0cc73a0df0.htm" title="KeysPressed Method " tocid="bcb29da5-8d8d-fa11-90ea-3a0cc73a0df0">KeysPressed Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="a5292253-7fbd-5dfa-819f-1d67d27580d6.htm" title="NameSprite Method " tocid="a5292253-7fbd-5dfa-819f-1d67d27580d6">NameSprite Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="d329fe20-e750-bf52-a75b-f2383bf1d35a.htm" title="Pause Method " tocid="d329fe20-e750-bf52-a75b-f2383bf1d35a">Pause Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="0b27d26e-53e1-c9bd-0b52-8fe4714c831a.htm" title="PlaceSpriteBehind Method " tocid="0b27d26e-53e1-c9bd-0b52-8fe4714c831a">PlaceSpriteBehind Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="8d47a519-d5f7-c7f6-4ccb-0d310cab2435.htm" title="PlaceSpriteInFrontOf Method " tocid="8d47a519-d5f7-c7f6-4ccb-0d310cab2435">PlaceSpriteInFrontOf Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="af7fceb3-a35e-b016-3955-696b3a3c7a7e.htm" title="RegisterKeyDownFunction Method " tocid="af7fceb3-a35e-b016-3955-696b3a3c7a7e">RegisterKeyDownFunction Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="b3e934e2-1ddf-35e3-0995-3b555539f33f.htm" title="RegisterKeyUpFunction Method " tocid="b3e934e2-1ddf-35e3-0995-3b555539f33f">RegisterKeyUpFunction Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="2c9b874d-5097-98bf-908c-f6bac5d647d3.htm" title="ReplaceOriginalImage Method " tocid="2c9b874d-5097-98bf-908c-f6bac5d647d3">ReplaceOriginalImage Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="48ff9be7-1395-25af-3585-3d32eba07309.htm" title="ResetKeypressState Method " tocid="48ff9be7-1395-25af-3585-3d32eba07309">ResetKeypressState Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="41ac663a-2019-6a14-5ffd-16dfc7472578.htm" title="ReturnAdjustmentRatio Method " tocid="41ac663a-2019-6a14-5ffd-16dfc7472578">ReturnAdjustmentRatio Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="447d1a9a-0e17-9827-2a01-438434c1b879.htm" title="ReturnPictureBoxAdjustedHeight Method " tocid="447d1a9a-0e17-9827-2a01-438434c1b879">ReturnPictureBoxAdjustedHeight Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="9469b7cf-55ee-5c2e-feb7-01c7e23a6350.htm" title="ReturnPictureBoxAdjustedPoint Method " tocid="9469b7cf-55ee-5c2e-feb7-01c7e23a6350">ReturnPictureBoxAdjustedPoint Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="7c73b68e-f842-bfee-55d8-b36488fb35b7.htm" title="ReturnPictureBoxAdjustedWidth Method " tocid="7c73b68e-f842-bfee-55d8-b36488fb35b7">ReturnPictureBoxAdjustedWidth Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="e58bfa3c-4722-7f3a-9610-0a0ce62bfe99.htm" title="ReturnPointAdjustedForImage Method " tocid="e58bfa3c-4722-7f3a-9610-0a0ce62bfe99">ReturnPointAdjustedForImage Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="df0fd1e8-eac8-4f10-7f09-baa6127f3752.htm" title="SoundIsFinished Method " tocid="df0fd1e8-eac8-4f10-7f09-baa6127f3752">SoundIsFinished Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="08442d70-3a79-fa24-4f3e-eddc5c102938.htm" title="SoundPlay Method " tocid="08442d70-3a79-fa24-4f3e-eddc5c102938">SoundPlay Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="d516c33b-29ef-9613-62fb-b6717264a32b.htm" title="SpriteBackwards Method " tocid="d516c33b-29ef-9613-62fb-b6717264a32b">SpriteBackwards Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="b5c75d58-f132-f3ff-217f-e69b252db748.htm" title="SpriteForwards Method " tocid="b5c75d58-f132-f3ff-217f-e69b252db748">SpriteForwards Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="e8491570-1fda-7d8e-48b8-c15f26c41d01.htm" title="SpriteFromName Method " tocid="e8491570-1fda-7d8e-48b8-c15f26c41d01">SpriteFromName Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="90511f90-497b-fc61-6984-15d76101a6f1.htm" title="SpritesAtImagePoint Method " tocid="90511f90-497b-fc61-6984-15d76101a6f1">SpritesAtImagePoint Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="3c18bbb7-e10c-1b96-754d-7dfc878e7cf4.htm" title="SpritesAtPoint Method " tocid="3c18bbb7-e10c-1b96-754d-7dfc878e7cf4">SpritesAtPoint Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="e05efb85-3736-fa59-2720-a460b898048a.htm" title="SpritesBasedOff Method " tocid="e05efb85-3736-fa59-2720-a460b898048a">SpritesBasedOff Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="c7991a63-f63c-20d8-0605-fab6e9f13392.htm" title="SpritesBasedOffAnything Method " tocid="c7991a63-f63c-20d8-0605-fab6e9f13392">SpritesBasedOffAnything Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="c2860c42-fc4c-78f8-7d32-195e74262434.htm" title="SpritesInImageRectangle Method " tocid="c2860c42-fc4c-78f8-7d32-195e74262434">SpritesInImageRectangle Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="2c4eb5db-5c4c-6fcd-716c-532c0e2c4f35.htm" title="SpritesThatHaveBeenDrawn Method " tocid="2c4eb5db-5c4c-6fcd-716c-532c0e2c4f35">SpritesThatHaveBeenDrawn Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="5d32e0da-bbf2-10b5-ba20-fe5bdfec1963.htm" title="SpriteToBack Method " tocid="5d32e0da-bbf2-10b5-ba20-fe5bdfec1963">SpriteToBack Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="80b0403d-da14-c176-9d01-080fc170a67d.htm" title="SpriteToFront Method " tocid="80b0403d-da14-c176-9d01-080fc170a67d">SpriteToFront Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="675951bb-e09a-e9ec-95d2-c0efaf187d6d.htm" title="UnPause Method " tocid="675951bb-e09a-e9ec-95d2-c0efaf187d6d">UnPause Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn">SpriteController<span id="LST30F7FFA3_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST30F7FFA3_0?cpp=::|nu=.");</script>DestroySprite Method </td></tr></table><span class="introStyle"></span> <div class="summary">
Tell a sprite to destroy itself. The sprite will have Destroying property set to true from
the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself
and remove itself from the controller. After it is destroyed, it is completely gone.
</div><p> </p>
<strong>Namespace:</strong>
 <a href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm">SpriteLibrary</a><br />
<strong>Assembly:</strong>
 SpriteLibrary (in SpriteLibrary.dll) Version: 1.0.0.5 (1.0.0.5)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EACA');return false;" title="Copy">Copy</a></div></div><div id="ID0EACA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">void</span> <span class="identifier">DestroySprite</span>(
<span class="identifier">Sprite</span> <span class="parameter">what</span>
)</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EACA");</script><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">what</span></dt><dd>Type: <a href="66013d9b-4126-7d65-05bb-94eb9d134be6.htm">SpriteLibrary<span id="LST30F7FFA3_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST30F7FFA3_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Sprite</a><br />The Sprite to destroy</dd></dl></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="07a473e4-4716-e5b9-c7d2-c4748265fc58.htm">SpriteController Class</a></div><div class="seeAlsoStyle"><a href="6b7227c0-7a6a-6342-3b08-917c7de429cc.htm">SpriteLibrary Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>