SpriteLibrary/SpriteLibrary/Doc/Help/html/3a7614d3-cfe9-ce52-55be-ca5...

11 lines
8.3 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>Sprite.payload Field</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="payload field" /><meta name="System.Keywords" content="Sprite.payload field" /><meta name="Microsoft.Help.F1" content="SpriteLibrary.Sprite.payload" /><meta name="Microsoft.Help.Id" content="F:SpriteLibrary.Sprite.payload" /><meta name="Description" content="A Sprite can hold a payload. Use this to store extra information about the various Sprites. Health, Armor, Shoot time, etc. But, to store information in the payload, you need to make a new class of SpritePayload." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="SpriteLibrary" /><meta name="file" content="3a7614d3-cfe9-ce52-55be-ca5324839e92" /><meta name="guid" content="3a7614d3-cfe9-ce52-55be-ca5324839e92" /><link type="text/css" rel="stylesheet" href="../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"> </script><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="66013d9b-4126-7d65-05bb-94eb9d134be6.htm" title="Sprite Class" tocid="66013d9b-4126-7d65-05bb-94eb9d134be6">Sprite 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="6d383ed6-ff9b-f1b0-a53d-54ea41795870.htm" title="Sprite Fields" tocid="6d383ed6-ff9b-f1b0-a53d-54ea41795870">Sprite Fields</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="747bfb64-7646-38ee-09e3-65455ac597e5.htm" title="CannotMoveOutsideBox Field" tocid="747bfb64-7646-38ee-09e3-65455ac597e5">CannotMoveOutsideBox Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="c39b03eb-911a-b0dc-fd7b-276ee464f6c7.htm" title="MirrorHorizontally Field" tocid="c39b03eb-911a-b0dc-fd7b-276ee464f6c7">MirrorHorizontally Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="679ff642-b87f-24d6-80c5-434c06c71523.htm" title="MirrorVertically Field" tocid="679ff642-b87f-24d6-80c5-434c06c71523">MirrorVertically Field</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="e88e79e3-3edc-69e5-1854-23968928c073.htm" title="MovementSpeed Field" tocid="e88e79e3-3edc-69e5-1854-23968928c073">MovementSpeed Field</a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="3a7614d3-cfe9-ce52-55be-ca5324839e92.htm" title="payload Field" tocid="3a7614d3-cfe9-ce52-55be-ca5324839e92">payload Field</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">Sprite<span id="LSTB96BCD79_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTB96BCD79_0?cpp=::|nu=.");</script>payload Field</td></tr></table><span class="introStyle"></span> <div class="summary">
A Sprite can hold a payload. Use this to store extra information about the various Sprites. Health, Armor,
Shoot time, etc. But, to store information in the payload, you need to make a new class of SpritePayload. The syntax
for doing so is:
<div class="codeSnippetContainer"><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EABABA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EABABA');return false;" title="Copy">Copy</a></div></div><div id="ID0EABABA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="highlight-keyword">public</span> <span class="highlight-keyword">class</span> TankPayload : SpritePayload { <span class="highlight-keyword">public</span> <span class="highlight-keyword">int</span> Armor; <span class="highlight-keyword">public</span> <span class="highlight-keyword">int</span> Speed; }</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EABABA");</script>
You can access the payload and retrieve the various values.
</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="identifier">SpritePayload</span> <span class="identifier">payload</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EACA");</script><h4 class="subHeading">Field Value</h4>Type: <a href="4e310248-8e1a-76aa-edbc-a83f4ba9b425.htm">SpritePayload</a></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="66013d9b-4126-7d65-05bb-94eb9d134be6.htm">Sprite 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>