2024-05-29 17:40:11 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.9.7" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > godot-cpp-utils: player.hpp Source File< / 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 >
2024-05-29 21:29:38 +00:00
< 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 >
2024-05-29 17:40:11 +00:00
< 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 >
2024-05-29 21:29:38 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
< / script >
2024-05-29 17:50:33 +00:00
< script type = "text/javascript" src = "darkmode_toggle.js" > < / script >
2024-05-29 17:40:11 +00:00
< 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 id = "projectrow" >
< td id = "projectalign" >
< div id = "projectname" > godot-cpp-utils
< / div >
< div id = "projectbrief" > A collection of utility classes, functions and macros for use with Godot and GDExtension.< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
2024-05-29 21:29:38 +00:00
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related  Pages< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< span id = "MSearchSelect" onmouseover = "return searchBox.OnSearchSelectShow()" onmouseout = "return searchBox.OnSearchSelectHide()" >   < / span >
< input type = "text" id = "MSearchField" value = "" placeholder = "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.svg" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "files.html" > < span > File  List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > File  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 >
2024-05-29 17:40:11 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2024-05-29 21:29:38 +00:00
$(document).ready(function(){initNavTree('player_8hpp_source.html',''); initResizable(); });
2024-05-29 17:40:11 +00:00
/* @license-end */
< / script >
2024-05-29 21:29:38 +00:00
< div id = "doc-content" >
2024-05-29 17:40:11 +00:00
<!-- 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" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "header" >
< div class = "headertitle" > < div class = "title" > player.hpp< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "preprocessor" > #ifndef UTILS_PLAYER_HPP< / span > < / div >
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < span class = "preprocessor" > #define UTILS_PLAYER_HPP< / span > < / div >
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < / div >
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < span class = "preprocessor" > #include < cstdint> < / span > < / div >
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > 5< / span > < span class = "preprocessor" > #include < optional> < / span > < / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < span class = "preprocessor" > #include < godot_cpp/variant/transform3d.hpp> < / span > < / div >
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < span class = "keyword" > namespace < / span > gd = godot;< / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < span class = "keyword" > namespace < / span > godot { < span class = "keyword" > class < / span > Node; }< / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > 12< / span > < span class = "keyword" > namespace < / span > utils {< / div >
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < span class = "keyword" > class < / span > PlayerInput;< / div >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > < / div >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > < a class = "line" href = "classutils_1_1IPlayer.html" > 19< / a > < / span > < span class = "keyword" > class < / span > < a class = "code hl_class" href = "classutils_1_1IPlayer.html" > IPlayer< / a > {< / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < span class = "keyword" > friend< / span > < span class = "keyword" > class < / span > < a class = "code hl_class" href = "classutils_1_1GameRoot3D.html" > GameRoot3D< / a > ;< / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > < a class = "line" href = "classutils_1_1IPlayer.html#a0cafb35522002c12a00da6cb408e462c" > 26< / a > < / span > < span class = "keyword" > virtual< / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "classutils_1_1IPlayer.html#a0cafb35522002c12a00da6cb408e462c" > setup_player_input< / a > (< a class = "code hl_class" href = "classutils_1_1PlayerInput.html" > PlayerInput< / a > *input) = 0;< / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > < a class = "line" href = "classutils_1_1IPlayer.html#aee51a05e36995e6523c3284b5cef1f42" > 28< / a > < / span > < span class = "keyword" > virtual< / span > gd::Node *< a class = "code hl_function" href = "classutils_1_1IPlayer.html#aee51a05e36995e6523c3284b5cef1f42" > to_node< / a > () = 0;< / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > < a class = "line" href = "classutils_1_1IPlayer.html#aa5e2d0a33a4114e45b2bd1bea95fa1db" > 30< / a > < / span > < span class = "keyword" > virtual< / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "classutils_1_1IPlayer.html#aa5e2d0a33a4114e45b2bd1bea95fa1db" > spawn_at_position< / a > (gd::Transform3D < span class = "keyword" > const< / span > & at) = 0;< / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > uint32_t < a class = "code hl_function" href = "classutils_1_1IPlayer.html#ad697b5e89246178d99a4c281eaf313af" > get_player_id< / a > (); < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > std::optional< uint32_t> player_id{std::nullopt};< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > };< / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > }< / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < span class = "preprocessor" > #endif < / span > < span class = "comment" > // !UTILS_PLAYER_HPP< / span > < / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > < / div >
< div class = "ttc" id = "aclassutils_1_1GameRoot3D_html" > < div class = "ttname" > < a href = "classutils_1_1GameRoot3D.html" > utils::GameRoot3D< / a > < / div > < div class = "ttdoc" > The root of a game.< / div > < div class = "ttdef" > < b > Definition< / b > game_root.hpp:28< / div > < / div >
< div class = "ttc" id = "aclassutils_1_1IPlayer_html" > < div class = "ttname" > < a href = "classutils_1_1IPlayer.html" > utils::IPlayer< / a > < / div > < div class = "ttdoc" > Interface required for player nodes.< / div > < div class = "ttdef" > < b > Definition< / b > player.hpp:19< / div > < / div >
< div class = "ttc" id = "aclassutils_1_1IPlayer_html_a0cafb35522002c12a00da6cb408e462c" > < div class = "ttname" > < a href = "classutils_1_1IPlayer.html#a0cafb35522002c12a00da6cb408e462c" > utils::IPlayer::setup_player_input< / a > < / div > < div class = "ttdeci" > virtual void setup_player_input(PlayerInput *input)=0< / div > < div class = "ttdoc" > Called by GameRoot3D when this player is instantiated or assigned a new PlayerInput.< / div > < / div >
< div class = "ttc" id = "aclassutils_1_1IPlayer_html_aa5e2d0a33a4114e45b2bd1bea95fa1db" > < div class = "ttname" > < a href = "classutils_1_1IPlayer.html#aa5e2d0a33a4114e45b2bd1bea95fa1db" > utils::IPlayer::spawn_at_position< / a > < / div > < div class = "ttdeci" > virtual void spawn_at_position(gd::Transform3D const & at)=0< / div > < div class = "ttdoc" > Spawn the player at a given transform, usually the global transform of a SpawnPoint3D.< / div > < / div >
< div class = "ttc" id = "aclassutils_1_1IPlayer_html_ad697b5e89246178d99a4c281eaf313af" > < div class = "ttname" > < a href = "classutils_1_1IPlayer.html#ad697b5e89246178d99a4c281eaf313af" > utils::IPlayer::get_player_id< / a > < / div > < div class = "ttdeci" > uint32_t get_player_id()< / div > < div class = "ttdoc" > Returns the player id assigned to this instance.< / div > < div class = "ttdef" > < b > Definition< / b > player.cpp:4< / div > < / div >
< div class = "ttc" id = "aclassutils_1_1IPlayer_html_aee51a05e36995e6523c3284b5cef1f42" > < div class = "ttname" > < a href = "classutils_1_1IPlayer.html#aee51a05e36995e6523c3284b5cef1f42" > utils::IPlayer::to_node< / a > < / div > < div class = "ttdeci" > virtual gd::Node * to_node()=0< / div > < div class = "ttdoc" > Convert IPlayer instance to node.< / div > < / div >
< div class = "ttc" id = "aclassutils_1_1PlayerInput_html" > < div class = "ttname" > < a href = "classutils_1_1PlayerInput.html" > utils::PlayerInput< / a > < / div > < div class = "ttdoc" > An event-driven input observer.< / div > < div class = "ttdef" > < b > Definition< / b > player_input.hpp:18< / div > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
2024-05-29 21:29:38 +00:00
< / div > <!-- doc - content -->
2024-05-29 17:40:11 +00:00
<!-- start footer part -->
2024-05-29 21:29:38 +00:00
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < b > player.hpp< / b > < / li >
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.9.7 < / li >
< / ul >
< / div >
2024-05-29 17:40:11 +00:00
< / body >
< / html >
