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: utils::IPlayer 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 >
2024-05-29 22:09:05 +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:40:11 +00:00
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
2024-05-29 22:10:08 +00:00
< link href = "doxygen-awesome.css" rel = "stylesheet" type = "text/css" / >
2024-05-29 17:40:11 +00:00
< / 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 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" >
< 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 = "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 >
2024-05-29 22:09:05 +00:00
< / 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" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classutils_1_1IPlayer.html',''); initResizable(); });
/* @license-end */
< / script >
< 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 = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pri-attribs" > Private Attributes< / a > |
< a href = "#friends" > Friends< / a > |
< a href = "classutils_1_1IPlayer-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > utils::IPlayer Class Reference< span class = "mlabels" > < span class = "mlabel" > abstract< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Interface required for player nodes.
< a href = "classutils_1_1IPlayer.html#details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "player_8hpp_source.html" > player.hpp< / a > > < / code > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pub-methods" name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a0cafb35522002c12a00da6cb408e462c" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classutils_1_1IPlayer.html#a0cafb35522002c12a00da6cb408e462c" > setup_player_input< / a > (< a class = "el" href = "classutils_1_1PlayerInput.html" > PlayerInput< / a > *input)=0< / td > < / tr >
< tr class = "memdesc:a0cafb35522002c12a00da6cb408e462c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Called by < a class = "el" href = "classutils_1_1GameRoot3D.html" title = "The root of a game." > GameRoot3D< / a > when this player is instantiated or assigned a new < a class = "el" href = "classutils_1_1PlayerInput.html" title = "An event-driven input observer." > PlayerInput< / a > . < br / > < / td > < / tr >
< tr class = "separator:a0cafb35522002c12a00da6cb408e462c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aee51a05e36995e6523c3284b5cef1f42" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "aee51a05e36995e6523c3284b5cef1f42" name = "aee51a05e36995e6523c3284b5cef1f42" > < / a >
virtual gd::Node *  < / td > < td class = "memItemRight" valign = "bottom" > < b > to_node< / b > ()=0< / td > < / tr >
< tr class = "memdesc:aee51a05e36995e6523c3284b5cef1f42" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Convert < a class = "el" href = "classutils_1_1IPlayer.html" title = "Interface required for player nodes." > IPlayer< / a > instance to node. < br / > < / td > < / tr >
< tr class = "separator:aee51a05e36995e6523c3284b5cef1f42" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa5e2d0a33a4114e45b2bd1bea95fa1db" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "aa5e2d0a33a4114e45b2bd1bea95fa1db" name = "aa5e2d0a33a4114e45b2bd1bea95fa1db" > < / a >
virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < b > spawn_at_position< / b > (gd::Transform3D const & at)=0< / td > < / tr >
< tr class = "memdesc:aa5e2d0a33a4114e45b2bd1bea95fa1db" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Spawn the player at a given transform, usually the global transform of a < a class = "el" href = "classutils_1_1SpawnPoint3D.html" title = "A location in the game world that the player can spawn at." > SpawnPoint3D< / a > . < br / > < / td > < / tr >
< tr class = "separator:aa5e2d0a33a4114e45b2bd1bea95fa1db" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ad697b5e89246178d99a4c281eaf313af" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "ad697b5e89246178d99a4c281eaf313af" name = "ad697b5e89246178d99a4c281eaf313af" > < / a >
uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < b > get_player_id< / b > ()< / td > < / tr >
< tr class = "memdesc:ad697b5e89246178d99a4c281eaf313af" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns the player id assigned to this instance. < br / > < / td > < / tr >
< tr class = "separator:ad697b5e89246178d99a4c281eaf313af" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pri-attribs" name = "pri-attribs" > < / a >
Private Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a886564aee16d6d3b3bc703771bd73819" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a886564aee16d6d3b3bc703771bd73819" name = "a886564aee16d6d3b3bc703771bd73819" > < / a >
std::optional< uint32_t >   < / td > < td class = "memItemRight" valign = "bottom" > < b > player_id< / b > {std::nullopt}< / td > < / tr >
< tr class = "separator:a886564aee16d6d3b3bc703771bd73819" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "friends" name = "friends" > < / a >
Friends< / h2 > < / td > < / tr >
< tr class = "memitem:af0421a654f3306c48e35f75da5eb8590" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "af0421a654f3306c48e35f75da5eb8590" name = "af0421a654f3306c48e35f75da5eb8590" > < / a >
class  < / td > < td class = "memItemRight" valign = "bottom" > < b > GameRoot3D< / b > < / td > < / tr >
< tr class = "separator:af0421a654f3306c48e35f75da5eb8590" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > Interface required for player nodes. < / p >
< p > Use multiple inheritance and implement < a class = "el" href = "classutils_1_1IPlayer.html" title = "Interface required for player nodes." > IPlayer< / a > to make a regular node usable as a player with < a class = "el" href = "classutils_1_1GameRoot3D.html" title = "The root of a game." > GameRoot3D< / a > . < / p >
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a id = "a0cafb35522002c12a00da6cb408e462c" name = "a0cafb35522002c12a00da6cb408e462c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a0cafb35522002c12a00da6cb408e462c" > ◆   < / a > < / span > setup_player_input()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual void utils::IPlayer::setup_player_input < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "classutils_1_1PlayerInput.html" > PlayerInput< / a > *  < / td >
< td class = "paramname" > < em > input< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Called by < a class = "el" href = "classutils_1_1GameRoot3D.html" title = "The root of a game." > GameRoot3D< / a > when this player is instantiated or assigned a new < a class = "el" href = "classutils_1_1PlayerInput.html" title = "An event-driven input observer." > PlayerInput< / a > . < / p >
< p > Use < a class = "el" href = "classutils_1_1PlayerInput.html#a52f0f96cd4732ce06016459094d3a714" title = "Start listening for action." > PlayerInput::listen_to< / a > to register input callbacks. There's no need to keep the input pointer around. As the instance is managed by the < a class = "el" href = "classutils_1_1GameRoot3D.html" title = "The root of a game." > GameRoot3D< / a > . < / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
< li > < a class = "el" href = "player_8hpp_source.html" > player.hpp< / a > < / li >
< li > player.cpp< / li >
< / ul >
< / div > <!-- contents -->
2024-05-29 22:09:05 +00:00
< / div > <!-- doc - content -->
2024-05-29 17:40:11 +00:00
<!-- start footer part -->
2024-05-29 22:09:05 +00:00
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < b > utils< / b > < / li > < li class = "navelem" > < a class = "el" href = "classutils_1_1IPlayer.html" > IPlayer< / a > < / 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 >
