-
Notifications
You must be signed in to change notification settings - Fork 1
/
class_b_w_a_p_i_1_1_broodwar_output_device.html
1 lines (1 loc) · 9.57 KB
/
class_b_w_a_p_i_1_1_broodwar_output_device.html
1
<!DOCTYPE html><html><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>BWAPI: BWAPI::BroodwarOutputDevice Class Reference</title><link rel="shortcut icon" href="favicon.ico" type="image/x-icon"><link rel="icon" href="favicon.ico" type="image/x-icon"><script>if(window.location.protocol!="file:"){(function(d,e,j,h,f,c,b){d.GoogleAnalyticsObject=f;d[f]=d[f]||function(){(d[f].q=d[f].q||[]).push(arguments)},d[f].l=1*new Date();c=e.createElement(j),b=e.getElementsByTagName(j)[0];c.async=1;c.src=h;b.parentNode.insertBefore(c,b)})(window,document,"script","//www.google-analytics.com/analytics.js","ga");ga("create","UA-11415685-4","auto");ga("send","pageview")};</script><link href="doxygen.css" rel="stylesheet"><script src="search/search.js"></script></head><body><div id="top"><div id="titlearea"><table><tbody><tr style="height: 56px;"><td id="projectlogo"><img style="width:110px;height:55px;" alt="Logo" src="logo.png"></td><td style="padding-left: 0.5em;"><div id="projectname">BWAPI <span id="projectnumber">4.2.0</span></div><div id="projectbrief">An API for interacting with Starcraft: Broodwar (1.16.1)</div></td></tr></tbody></table><div class="ribbon"><a href="//github.com/bwapi/bwapi">Fork me on GitHub</a></div></div><script>var searchBox=new SearchBox("searchBox","search",false,"Search");</script><div id="navrow1" class="tabs"><ul class="tablist"><li><a href="index.html"><span>Main Page</span></a></li><li><a href="modules.html"><span>Modules</span></a></li><li><a href="namespaces.html"><span>Namespaces</span></a></li><li class="current"><a href="annotated.html"><span>Classes</span></a></li><li><a href="//github.com/bwapi/bwapi/issues"><span>Issues</span></a></li><li><a href="//github.com/bwapi/bwapi/wiki"><span>Wiki</span></a></li><li><div id="MSearchBox" class="MSearchBoxInactive"><span class="left"><img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""><input id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"></span><span class="right"><a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" src="search/close.png" alt=""></a></span></div></li></ul></div><div id="navrow2" class="tabs2"><ul class="tablist"><li><a href="annotated.html"><span>Class List</span></a></li><li><a href="classes.html"><span>Class Index</span></a></li><li><a href="inherits.html"><span>Class Hierarchy</span></a></li><li><a href="functions.html"><span>Class Members</span></a></li></ul></div><div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"></div><div id="MSearchResultsWindow"><iframe src="javascript:void(0)" name="MSearchResults" id="MSearchResults"></iframe></div><div id="nav-path" class="navpath"><ul><li class="navelem"><a class="el" href="namespace_b_w_a_p_i.html">BWAPI</a></li><li class="navelem"><a class="el" href="class_b_w_a_p_i_1_1_broodwar_output_device.html">BroodwarOutputDevice</a></li></ul></div></div><div class="header"><div class="summary"><a href="#pub-methods">Public Member Functions</a> | <a href="class_b_w_a_p_i_1_1_broodwar_output_device-members.html">List of all members</a></div><div class="headertitle"><div class="title">BWAPI::BroodwarOutputDevice Class Reference</div></div></div><div class="contents"><div class="dynheader"> Inheritance diagram for BWAPI::BroodwarOutputDevice:</div><div class="dyncontent"><div class="center"><img src="class_b_w_a_p_i_1_1_broodwar_output_device__inherit__graph.png" usemap="#_b_w_a_p_i_1_1_broodwar_output_device_inherit__map" alt="Inheritance graph"></div></div><table class="memberdecls"><tbody><tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods"></a> Public Member Functions</h2></td></tr><tr><td class="memItemLeft"> </td><td class="memItemRight"><a class="el" href="class_b_w_a_p_i_1_1_broodwar_output_device.html#a51cafe66ee9d51d998b8ec5b88712b2e">BroodwarOutputDevice</a> (<a class="el" href="namespace_b_w_a_p_i_1_1_text.html#a944232c0d5b699bd4e51e36b37394555">Text::Enum</a> defaultColor=<a class="el" href="namespace_b_w_a_p_i_1_1_text.html#a944232c0d5b699bd4e51e36b37394555a668a95e48106405b0e37cd6f8ea5ab07">Text::Yellow</a>)</td></tr><tr><td class="memItemLeft"> </td><td class="memItemRight"><a class="el" href="class_b_w_a_p_i_1_1_broodwar_output_device.html#aec798c3285de5a260f3cd38f5774f292">BroodwarOutputDevice</a> (const <a class="el" href="class_b_w_a_p_i_1_1_broodwar_output_device.html">BroodwarOutputDevice</a> &o)</td></tr><tr><td class="memItemLeft"><a class="elRef" href="//en.cppreference.com/w/cpp/io/streamsize.html">std::streamsize</a> </td><td class="memItemRight"><a class="el" href="class_b_w_a_p_i_1_1_broodwar_output_device.html#ab9fca78bc2ab96115477b16dc585d3d0">write</a> (const char *s, <a class="elRef" href="//en.cppreference.com/w/cpp/io/streamsize.html">std::streamsize</a> n)</td></tr></tbody></table><a id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p>Output device for writing text to the screen as a notification. </p><p>Normally when you write stuff in Starcraft, the text wraps at word boundaries when it would otherwise exceed the screen width. When this happens any <a class="el" href="namespace_b_w_a_p_i_1_1_text.html#a944232c0d5b699bd4e51e36b37394555" title="Enumeration of text formatting codes">Text::Enum</a> color in the message is lost and the next line will be some default color. To fix this color problem this device keeps track of the width of the text in the buffer and manually wraps when needed (not on word boundaries), and then colors the next line with the current color again before continuing to write. </p><dl class="section since"><dt>Since</dt><dd>4.2.0 </dd></dl></div><h2 class="groupheader">Constructor & Destructor Documentation</h2><a class="anchor" id="a51cafe66ee9d51d998b8ec5b88712b2e"></a><div class="memitem"><div class="memproto">BWAPI::BroodwarOutputDevice::BroodwarOutputDevice (<a class="el" href="namespace_b_w_a_p_i_1_1_text.html#a944232c0d5b699bd4e51e36b37394555">Text::Enum</a> <span class="paramname"><em>defaultColor</em> = <code><a class="el" href="namespace_b_w_a_p_i_1_1_text.html#a944232c0d5b699bd4e51e36b37394555a668a95e48106405b0e37cd6f8ea5ab07">Text::Yellow</a></code></span>) <span class="mlabels"><span class="mlabel">explicit</span></span></div><div class="memdoc"><p>References <a class="elRef" href="//en.cppreference.com/w/cpp/io/basic_streambuf/sputc.html">std::stringbuf::sputc()</a>.</p></div></div><a class="anchor" id="aec798c3285de5a260f3cd38f5774f292"></a><div class="memitem"><div class="memproto">BWAPI::BroodwarOutputDevice::BroodwarOutputDevice (const <a class="el" href="class_b_w_a_p_i_1_1_broodwar_output_device.html">BroodwarOutputDevice</a> & <span class="paramname"><em>o</em></span>)</div><div class="memdoc"></div></div><h2 class="groupheader">Member Function Documentation</h2><a class="anchor" id="ab9fca78bc2ab96115477b16dc585d3d0"></a><div class="memitem"><div class="memproto"><a class="elRef" href="//en.cppreference.com/w/cpp/io/streamsize.html">std::streamsize</a> BWAPI::BroodwarOutputDevice::write (const char * <span class="paramname"><em>s</em>, </span><a class="elRef" href="//en.cppreference.com/w/cpp/io/streamsize.html">std::streamsize</a> <span class="paramname"><em>n</em> </span>)</div><div class="memdoc"><p>References <a class="el" href="namespace_b_w_a_p_i.html#a83b1b4e50cdae7bd59c8dd744bc9926e">BWAPI::BroodwarPtr</a>, <a class="el" href="namespace_b_w_a_p_i_1_1_text.html#a1d169e56cb590b82f00a39c35cbdc3f7">BWAPI::Text::isColor()</a>, <a class="el" href="namespace_b_w_a_p_i_1_1_text.html#a944232c0d5b699bd4e51e36b37394555a8fd8b496ec23a4ba7a86b53e192bb934">BWAPI::Text::Previous</a>, <a class="el" href="class_b_w_a_p_i_1_1_game.html#a179153276873126ee522e108c7dc1af5">BWAPI::Game::printf()</a>, <a class="elRef" href="//en.cppreference.com/w/cpp/io/basic_streambuf/sputc.html">std::stringbuf::sputc()</a>, and <a class="elRef" href="//en.cppreference.com/w/cpp/io/basic_stringbuf/str.html">std::stringbuf::str()</a>.</p></div></div></div><hr class="footer"><address class="footer"><div style="float:left;" id="google_translate_element"></div><script>if(window.location.protocol!="file:"){function googleTranslateElementInit(){new google.translate.TranslateElement({pageLanguage:"en",layout:google.translate.TranslateElement.InlineLayout.HORIZONTAL},"google_translate_element")}var js=document.createElement("script");js.type="text/javascript";js.src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit";document.body.appendChild(js)};</script><small> Generated on Tue Sep 27 2016 23:28:25 for BWAPI by <a href="//www.doxygen.org/index.html"><img style="width:104px;height:31px;" class="footer" src="doxygen.png" alt="doxygen"></a> 1.8.11 </small></address><script src="jquery.js"></script><script src="dynsections.js"></script><script>$(document).ready(function(){searchBox.OnSelectItem(0);$(".memberdecls, .memname, .memproto, .paramname, .fieldname, .entry, .fragment").addClass("notranslate");$("#MSearchResultsWindow").addClass("notranslate");$(".qindex, .qindex + table").addClass("notranslate");$(".contents > ul").addClass("notranslate");$(".contents > h3").addClass("notranslate");$("#navrow4 > .tablist > li > a").addClass("notranslate");$("a.el, a.elRef").addClass("notranslate")});</script></body></html>