diff options
| author | JellyBrick <shlee1503@naver.com> | 2018-06-22 22:15:42 +0900 |
|---|---|---|
| committer | JellyBrick <shlee1503@naver.com> | 2018-06-22 22:15:42 +0900 |
| commit | 3e5a28fa0a1ba2d461271f22399476c241bcffe3 (patch) | |
| tree | 91786e1a0b268678153fca0ef03c1e26549a077f /docs/class_tg_bot_1_1_game.html | |
| parent | e2871c54a71a8015923b8215816c2a81e1b0c209 (diff) | |
Regenerate docs
Diffstat (limited to 'docs/class_tg_bot_1_1_game.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_game.html | 282 |
1 files changed, 282 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_game.html b/docs/class_tg_bot_1_1_game.html new file mode 100644 index 0000000..9fceb42 --- /dev/null +++ b/docs/class_tg_bot_1_1_game.html @@ -0,0 +1,282 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.11"/> +<title>tgbot-cpp: TgBot::Game Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">tgbot-cpp + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.11 --> +<script type="text/javascript"> +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="files.html"><span>Files</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 type="text" 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" border="0" 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="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_tg_bot_1_1_game.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="class_tg_bot_1_1_game-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::Game Class Reference<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>This object represents a game. + <a href="class_tg_bot_1_1_game.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_game_8h_source.html">Game.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a6a83e8940305ff4fad66dfe67dbb348b"><td class="memItemLeft" align="right" valign="top">typedef std::shared_ptr< <a class="el" href="class_tg_bot_1_1_game.html">Game</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_game.html#a6a83e8940305ff4fad66dfe67dbb348b">Ptr</a></td></tr> +<tr class="separator:a6a83e8940305ff4fad66dfe67dbb348b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:ac0edbacabf558513040e47b81910cdec"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_game.html#ac0edbacabf558513040e47b81910cdec">title</a></td></tr> +<tr class="memdesc:ac0edbacabf558513040e47b81910cdec"><td class="mdescLeft"> </td><td class="mdescRight">Title of the game. <a href="#ac0edbacabf558513040e47b81910cdec">More...</a><br /></td></tr> +<tr class="separator:ac0edbacabf558513040e47b81910cdec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acfd798616a7d6e8d1a0c7f6962e38893"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_game.html#acfd798616a7d6e8d1a0c7f6962e38893">description</a></td></tr> +<tr class="memdesc:acfd798616a7d6e8d1a0c7f6962e38893"><td class="mdescLeft"> </td><td class="mdescRight">Description of the game. <a href="#acfd798616a7d6e8d1a0c7f6962e38893">More...</a><br /></td></tr> +<tr class="separator:acfd798616a7d6e8d1a0c7f6962e38893"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a38fe8bac265c3718117881a4d989f271"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="class_tg_bot_1_1_photo_size.html#a05f58e05528a02e6bc98b67a81e8ae83">PhotoSize::Ptr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_game.html#a38fe8bac265c3718117881a4d989f271">photo</a></td></tr> +<tr class="memdesc:a38fe8bac265c3718117881a4d989f271"><td class="mdescLeft"> </td><td class="mdescRight">Photo that will be displayed in the game message in chats. <a href="#a38fe8bac265c3718117881a4d989f271">More...</a><br /></td></tr> +<tr class="separator:a38fe8bac265c3718117881a4d989f271"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa1f513d7c8058839d766f22b4090a3cb"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_game.html#aa1f513d7c8058839d766f22b4090a3cb">text</a></td></tr> +<tr class="memdesc:aa1f513d7c8058839d766f22b4090a3cb"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Brief description of the game or high scores included in the game message. <a href="#aa1f513d7c8058839d766f22b4090a3cb">More...</a><br /></td></tr> +<tr class="separator:aa1f513d7c8058839d766f22b4090a3cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0ed54ba6406a8cc8623ba1748c166e7f"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="class_tg_bot_1_1_message_entity.html#a6710ffdbafba909633df7bcd8c488da0">MessageEntity::Ptr</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_game.html#a0ed54ba6406a8cc8623ba1748c166e7f">textEntities</a></td></tr> +<tr class="memdesc:a0ed54ba6406a8cc8623ba1748c166e7f"><td class="mdescLeft"> </td><td class="mdescRight">Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. <a href="#a0ed54ba6406a8cc8623ba1748c166e7f">More...</a><br /></td></tr> +<tr class="separator:a0ed54ba6406a8cc8623ba1748c166e7f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2578e62f28ad5191e1754983a14cad4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_tg_bot_1_1_animation.html#afc55b2a385eeb3209e91bbbd1214c06a">Animation::Ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_game.html#a2578e62f28ad5191e1754983a14cad4c">animation</a></td></tr> +<tr class="memdesc:a2578e62f28ad5191e1754983a14cad4c"><td class="mdescLeft"> </td><td class="mdescRight">Optional. <a class="el" href="class_tg_bot_1_1_animation.html" title="You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack fo...">Animation</a> that will be displayed in the game message in chats. Upload via BotFather. <a href="#a2578e62f28ad5191e1754983a14cad4c">More...</a><br /></td></tr> +<tr class="separator:a2578e62f28ad5191e1754983a14cad4c"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>This object represents a game. </p> +<p>Use BotFather to create and edit games, their short names will act as unique identifiers. </p> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00044">44</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a class="anchor" id="a6a83e8940305ff4fad66dfe67dbb348b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef std::shared_ptr<<a class="el" href="class_tg_bot_1_1_game.html">Game</a>> <a class="el" href="class_tg_bot_1_1_game.html#a6a83e8940305ff4fad66dfe67dbb348b">TgBot::Game::Ptr</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00046">46</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a2578e62f28ad5191e1754983a14cad4c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_animation.html#afc55b2a385eeb3209e91bbbd1214c06a">Animation::Ptr</a> TgBot::Game::animation</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. <a class="el" href="class_tg_bot_1_1_animation.html" title="You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack fo...">Animation</a> that will be displayed in the game message in chats. Upload via BotFather. </p> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00078">78</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> + +</div> +</div> +<a class="anchor" id="acfd798616a7d6e8d1a0c7f6962e38893"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Game::description</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Description of the game. </p> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00056">56</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a38fe8bac265c3718117881a4d989f271"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="class_tg_bot_1_1_photo_size.html#a05f58e05528a02e6bc98b67a81e8ae83">PhotoSize::Ptr</a>> TgBot::Game::photo</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Photo that will be displayed in the game message in chats. </p> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00061">61</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> + +</div> +</div> +<a class="anchor" id="aa1f513d7c8058839d766f22b4090a3cb"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Game::text</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. Brief description of the game or high scores included in the game message. </p> +<p>Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. </p> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00068">68</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a0ed54ba6406a8cc8623ba1748c166e7f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="class_tg_bot_1_1_message_entity.html#a6710ffdbafba909633df7bcd8c488da0">MessageEntity::Ptr</a>> TgBot::Game::textEntities</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. </p> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00073">73</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ac0edbacabf558513040e47b81910cdec"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TgBot::Game::title</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Title of the game. </p> + +<p>Definition at line <a class="el" href="_game_8h_source.html#l00051">51</a> of file <a class="el" href="_game_8h_source.html">Game.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/types/<a class="el" href="_game_8h_source.html">Game.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_game.html">Game</a></li> + <li class="footer">Generated on Fri Jun 22 2018 22:14:16 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li> + </ul> +</div> +</body> +</html> |