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: Class Members - Functions< / 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 22:33:13 +00:00
< link href = "doxygen-awesome-sidebar-only.css" rel = "stylesheet" type = "text/css" / >
2024-05-29 22:32:17 +00:00
< link href = "doxygen-awesome-sidebar-only-darkmode-toggle.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 class = "current" > < a href = "functions.html" > < span > Class  Members< / span > < / a > < / li >
< / ul >
< / div >
< div id = "navrow3" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "functions.html" > < span > All< / span > < / a > < / li >
< li class = "current" > < a href = "functions_func.html" > < span > Functions< / span > < / a > < / li >
< li > < a href = "functions_vars.html" > < span > Variables< / span > < / a > < / li >
< / ul >
< / div >
< div id = "navrow4" class = "tabs3" >
< ul class = "tablist" >
< li > < a href = "#index__5F" > < span > _< / span > < / a > < / li >
< li > < a href = "#index_c" > < span > c< / span > < / a > < / li >
< li > < a href = "#index_e" > < span > e< / span > < / a > < / li >
< li > < a href = "#index_f" > < span > f< / span > < / a > < / li >
< li > < a href = "#index_g" > < span > g< / span > < / a > < / li >
< li > < a href = "#index_h" > < span > h< / span > < / a > < / li >
< li > < a href = "#index_i" > < span > i< / span > < / a > < / li >
< li > < a href = "#index_l" > < span > l< / span > < / a > < / li >
< li > < a href = "#index_p" > < span > p< / span > < / a > < / li >
< li > < a href = "#index_r" > < span > r< / span > < / a > < / li >
< li > < a href = "#index_s" > < span > s< / span > < / a > < / li >
< li > < a href = "#index_t" > < span > t< / span > < / a > < / li >
< li class = "current" > < a href = "#index_u" > < span > u< / span > < / a > < / li >
< / ul >
< / div >
< / div > <!-- top -->
2024-05-29 22:09:05 +00:00
< 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('functions_func.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 = "contents" >
< div class = "textblock" > Here is a list of all documented functions with links to the class documentation for each member:< / div >
< h3 > < a id = "index__5F" name = "index__5F" > < / a > - _ -< / h3 > < ul >
< li > _begin()  :  < a class = "el" href = "classutils_1_1GameMode.html#aa1b190a57e4106951a559301665739ec" > utils::GameMode< / a > < / li >
< li > _end()  :  < a class = "el" href = "classutils_1_1GameMode.html#ae69ff36bf1c3f60fad279e9991ca2d82" > utils::GameMode< / a > < / li >
< / ul >
< h3 > < a id = "index_c" name = "index_c" > < / a > - c -< / h3 > < ul >
< li > clear_listeners()  :  < a class = "el" href = "classutils_1_1PlayerInput.html#a1b3a6b23e41e3a4b57d916e6ed0fab6b" > utils::PlayerInput< / a > < / li >
< / ul >
< h3 > < a id = "index_e" name = "index_e" > < / a > - e -< / h3 > < ul >
< li > evaluate()  :  < a class = "el" href = "structutils_1_1PlayerInput_1_1Listener.html#a5d187489ffaac84a884938d81d4a2fdb" > utils::PlayerInput::Listener< / a > < / li >
< / ul >
< h3 > < a id = "index_f" name = "index_f" > < / a > - f -< / h3 > < ul >
< li > find_empty_player_slot()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#ab3895b9b48c4646a876e188d226c5723" > utils::GameRoot3D< / a > < / li >
< / ul >
< h3 > < a id = "index_g" name = "index_g" > < / a > - g -< / h3 > < ul >
< li > get_game_mode()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a896b4e4d3b9465a83a10249dbd559662" > utils::GameRoot3D< / a > < / li >
< li > get_game_state()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a105011a591cf09368958d4be350ed352" > utils::GameRoot3D< / a > < / li >
< li > get_last_mouse_motion()  :  < a class = "el" href = "classutils_1_1PlayerInput.html#a689cc968b84d6a92c10c541b97e3477e" > utils::PlayerInput< / a > < / li >
< li > get_levels()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#aa9ed453a0b416641dfa5154a0b69c79e" > utils::GameRoot3D< / a > < / li >
< li > get_player()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a27492f37140fa8af6c6955f2147f5521" > utils::GameRoot3D< / a > < / li >
< li > get_player_id()  :  < a class = "el" href = "classutils_1_1IPlayer.html#ad697b5e89246178d99a4c281eaf313af" > utils::IPlayer< / a > < / li >
< li > get_players()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#af176a558f2a3b972c970087c2a1e3d7b" > utils::GameRoot3D< / a > < / li >
< li > get_singleton()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#ad1c9387dee7919a8ab5d60b19cba2140" > utils::GameRoot3D< / a > < / li >
< li > grab_singleton()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a0fc164bad77a192ff2209eee18e5104b" > utils::GameRoot3D< / a > < / li >
< / ul >
< h3 > < a id = "index_h" name = "index_h" > < / a > - h -< / h3 > < ul >
< li > has_changed()  :  < a class = "el" href = "structutils_1_1PlayerInput_1_1Listener.html#af989733fa828d5920c3cc26a440f60b1" > utils::PlayerInput::Listener< / a > < / li >
< li > has_singleton()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a13e110d60dffd924248af9c3f6943706" > utils::GameRoot3D< / a > < / li >
< / ul >
< h3 > < a id = "index_i" name = "index_i" > < / a > - i -< / h3 > < ul >
< li > initialize_player()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a865e6d9fe4f9422c0fb974bd6b1222ce" > utils::GameRoot3D< / a > < / li >
< li > is_valid_level()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a77e4726bb8fec522669cbb2c068e47d9" > utils::GameRoot3D< / a > < / li >
< / ul >
< h3 > < a id = "index_l" name = "index_l" > < / a > - l -< / h3 > < ul >
< li > level_unloaded()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#af34016620adcdc2654358b463769a85f" > utils::GameRoot3D< / a > < / li >
< li > listen_to()  :  < a class = "el" href = "classutils_1_1PlayerInput.html#a52f0f96cd4732ce06016459094d3a714" > utils::PlayerInput< / a > < / li >
< li > load_level()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#acbec3f7b39c8c991a725e611dd8b869e" > utils::GameRoot3D< / a > < / li >
< li > load_level_at()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#ad53d50b5b35e4c13bf84f2d9c0f45a0b" > utils::GameRoot3D< / a > < / li >
< / ul >
< h3 > < a id = "index_p" name = "index_p" > < / a > - p -< / h3 > < ul >
< li > player_input_connected()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a85eee9cb258971abe9fe8577314b2556" > utils::GameRoot3D< / a > < / li >
< / ul >
< h3 > < a id = "index_r" name = "index_r" > < / a > - r -< / h3 > < ul >
< li > register_spawn_point()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a1937044fe05a903610308f8d382de975" > utils::GameRoot3D< / a > < / li >
< li > release_singleton()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#adc4455c11d39f8a267091f29ead441ee" > utils::GameRoot3D< / a > < / li >
< li > remove_player()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a89953130655a618aefa8f3ea0db63a53" > utils::GameRoot3D< / a > < / li >
< li > replace_levels()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a453c8aa3920d7d0adaf2490c63a7d92c" > utils::GameRoot3D< / a > < / li >
< li > reset_game_mode()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#add087bf071383383e68e919173670c47" > utils::GameRoot3D< / a > < / li >
< / ul >
< h3 > < a id = "index_s" name = "index_s" > < / a > - s -< / h3 > < ul >
< li > set_device()  :  < a class = "el" href = "classutils_1_1PlayerInput.html#a63928906c8769151ef37adcad505de35" > utils::PlayerInput< / a > < / li >
< li > set_game_mode()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a6c2a1aa2c35808a1b003ae79eac348c2" > utils::GameRoot3D< / a > < / li >
< li > setup_player_input()  :  < a class = "el" href = "classutils_1_1IPlayer.html#a0cafb35522002c12a00da6cb408e462c" > utils::IPlayer< / a > < / li >
< li > spawn_at_position()  :  < a class = "el" href = "classutils_1_1IPlayer.html#aa5e2d0a33a4114e45b2bd1bea95fa1db" > utils::IPlayer< / a > < / li >
< li > spawn_player()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a3e74ac9841575d9a915cf7ac6735b42b" > utils::GameRoot3D< / a > < / li >
< li > stop_listening()  :  < a class = "el" href = "classutils_1_1PlayerInput.html#aedfe45a2286098d3e5c9bfc00fddd1e1" > utils::PlayerInput< / a > < / li >
< / ul >
< h3 > < a id = "index_t" name = "index_t" > < / a > - t -< / h3 > < ul >
< li > to_node()  :  < a class = "el" href = "classutils_1_1IPlayer.html#aee51a05e36995e6523c3284b5cef1f42" > utils::IPlayer< / a > < / li >
< / ul >
< h3 > < a id = "index_u" name = "index_u" > < / a > - u -< / h3 > < ul >
< li > unload_all_levels()  :  < a class = "el" href = "classutils_1_1GameRoot3D.html#a4053b12af23cef53eb294729f1cb3aa8" > utils::GameRoot3D< / a > < / 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 = "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 >
