2024-05-29 21:07:31 +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: godot_macros.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 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 21:07:31 +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 21:07:31 +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 21:07:31 +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 > < 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 -->
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('godot__macros_8hpp_source.html',''); initResizable(); });
/* @license-end */
< / script >
< div id = "doc-content" >
2024-05-29 21:07:31 +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" > godot_macros.hpp< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2024-05-29 21:15:31 +00:00
< a href = "godot__macros_8hpp.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "preprocessor" > #ifndef UTILS_GODOT_MACROS_HPP< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < span class = "preprocessor" > #define UTILS_GODOT_MACROS_HPP< / span > < / div >
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < span class = "preprocessor" > #include " godot_cpp/classes/engine.hpp" < / span > < / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < span class = "preprocessor" > #include " godot_cpp/core/class_db.hpp" < / span > < / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < span class = "preprocessor" > #include " godot_cpp/variant/string.hpp" < / span > < / 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 > < / div >
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < span class = "preprocessor" > #define MACRO_STRING_INNER(_Arg) #_Arg< / span > < / div >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > < span class = "preprocessor" > #define MACRO_STRING(_Arg) MACRO_STRING_INNER(_Arg)< / span > < / div >
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#a3dab0009fb317e0fce558e09edd4964c" > 22< / a > < / span > < span class = "preprocessor" > #define GDPROPERTY(PropName_, PropType_) \< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < span class = "preprocessor" > godot::ClassDB::bind_method(godot::D_METHOD(" get_" < / span > #PropName_), & CLASSNAME::get_##PropName_); \< / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > godot::ClassDB::bind_method(godot::D_METHOD(" set_" #PropName_, " value" ), & CLASSNAME::set_##PropName_); \< / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > 25< / span > godot::ClassDB::add_property(MACRO_STRING(CLASSNAME), godot::PropertyInfo(PropType_, #PropName_), " set_" #PropName_, " get_" #PropName_)< / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#a9e70408fe612616931e2c251eb149114" > 33< / a > < / span > < span class = "preprocessor" > #define GDPROPERTY_HINTED(PropName_, PropType_, ...) \< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "preprocessor" > godot::ClassDB::bind_method(godot::D_METHOD(" get_" < / span > #PropName_), & CLASSNAME::get_##PropName_); \< / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > godot::ClassDB::bind_method(godot::D_METHOD(" set_" #PropName_, " value" ), & CLASSNAME::set_##PropName_); \< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > godot::ClassDB::add_property(MACRO_STRING(CLASSNAME), godot::PropertyInfo(PropType_, #PropName_, __VA_ARGS__), " set_" #PropName_, " get_" #PropName_)< / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#aec4c8284cb9ea77c97a7037176081801" > 43< / a > < / span > < span class = "preprocessor" > #define GDFUNCTION(FnName_) godot::ClassDB::bind_method(godot::D_METHOD(#FnName_), & CLASSNAME::FnName_)< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00050" name = "l00050" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#abb5f0f48b26566dab84ff075fdc9fb4e" > 50< / a > < / span > < span class = "preprocessor" > #define GDFUNCTION_ARGS(FnName_, ...) godot::ClassDB::bind_method(godot::D_METHOD(#FnName_, __VA_ARGS__), & CLASSNAME::FnName_)< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > 51< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00057" name = "l00057" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#ab1d89a5d5f8e83ed25d64195e8e432b6" > 57< / a > < / span > < span class = "preprocessor" > #define GDFUNCTION_STATIC(FnName_) godot::ClassDB::bind_static_method(MACRO_STRING(CLASSNAME), godot::D_METHOD(#FnName_), & CLASSNAME::_FnName)< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00058" name = "l00058" > < / a > < span class = "lineno" > 58< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00064" name = "l00064" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#a26ae27fbaa531f900a2e3a2c339975df" > 64< / a > < / span > < span class = "preprocessor" > #define GDFUNCTION_STATIC_ARGS(FnName_, ...) godot::ClassDB::bind_static_method(MACRO_STRING(CLASSNAME), godot::D_METHOD(#FnName_, __VA_ARGS__), & CLASSNAME::FnName_)< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00065" name = "l00065" > < / a > < span class = "lineno" > 65< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00069" name = "l00069" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#abed0b44fb9b7da904a745cd09219ddea" > 69< / a > < / span > < span class = "preprocessor" > #define GDSIGNAL(...) godot::ClassDB::add_signal(MACRO_STRING(CLASSNAME), godot::MethodInfo(__VA_ARGS__))< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00070" name = "l00070" > < / a > < span class = "lineno" > 70< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00076" name = "l00076" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#ae0818ebba543d3c6e8a61f460509451f" > 76< / a > < / span > < span class = "preprocessor" > #define GDRESOURCETYPE(Class_) godot::vformat(" %s/%s:%s" < / span > , godot::Variant::OBJECT, godot::PROPERTY_HINT_RESOURCE_TYPE, #Class_)< / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00077" name = "l00077" > < / a > < span class = "lineno" > 77< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00083" name = "l00083" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#a36c0da7ac54da4b5a5a9fe754e68eaa1" > 83< / a > < / span > < span class = "preprocessor" > #define GDEDITORONLY() if(!godot::Engine::get_singleton()-> is_editor_hint()) return;< / span > < / div >
< div class = "line" > < a id = "l00089" name = "l00089" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#a33ac9c3bfce05f857cfdd472cb00ca89" > 89< / a > < / span > < span class = "preprocessor" > #define GDGAMEONLY() if(godot::Engine::get_singleton()-> is_editor_hint()) return;< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00090" name = "l00090" > < / a > < span class = "lineno" > 90< / span > < / div >
2024-05-29 21:15:31 +00:00
< div class = "line" > < a id = "l00096" name = "l00096" > < / a > < span class = "lineno" > < a class = "line" href = "godot__macros_8hpp.html#a069154a04e2e9e1df6cbbec0a0fc8829" > 96< / a > < / span > < span class = "preprocessor" > #define GDENUM(Name_, ...)\< / span > < / div >
2024-05-29 21:07:31 +00:00
< div class = "line" > < a id = "l00097" name = "l00097" > < / a > < span class = "lineno" > 97< / span > < span class = "preprocessor" > struct Name_ {\< / span > < / div >
< div class = "line" > < a id = "l00098" name = "l00098" > < / a > < span class = "lineno" > 98< / span > < span class = "preprocessor" > enum Value {__VA_ARGS__};\< / span > < / div >
< div class = "line" > < a id = "l00099" name = "l00099" > < / a > < span class = "lineno" > 99< / span > < span class = "preprocessor" > private:\< / span > < / div >
< div class = "line" > < a id = "l00100" name = "l00100" > < / a > < span class = "lineno" > 100< / span > < span class = "preprocessor" > Value value{};\< / span > < / div >
< div class = "line" > < a id = "l00101" name = "l00101" > < / a > < span class = "lineno" > 101< / span > < span class = "preprocessor" > public:\< / span > < / div >
< div class = "line" > < a id = "l00102" name = "l00102" > < / a > < span class = "lineno" > 102< / span > < span class = "preprocessor" > static inline godot::String get_property_hint() { return godot::String(#__VA_ARGS__); }\< / span > < / div >
< div class = "line" > < a id = "l00103" name = "l00103" > < / a > < span class = "lineno" > 103< / span > < span class = "preprocessor" > inline Name_(Value value): value{value} {}\< / span > < / div >
< div class = "line" > < a id = "l00104" name = "l00104" > < / a > < span class = "lineno" > 104< / span > < span class = "preprocessor" > inline Name_(Name_ const & value): value{value.value} {}\< / span > < / div >
< div class = "line" > < a id = "l00105" name = "l00105" > < / a > < span class = "lineno" > 105< / span > < span class = "preprocessor" > }< / span > < / div >
< div class = "line" > < a id = "l00106" name = "l00106" > < / a > < span class = "lineno" > 106< / span > < / div >
< div class = "line" > < a id = "l00107" name = "l00107" > < / a > < span class = "lineno" > 107< / span > < span class = "preprocessor" > #endif < / span > < span class = "comment" > // !UTILS_GODOT_MACROS_HPP< / span > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
2024-05-29 22:09:05 +00:00
< / div > <!-- doc - content -->
2024-05-29 21:07:31 +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" > < a class = "el" href = "godot__macros_8hpp.html" > godot_macros.hpp< / 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 21:07:31 +00:00
< / body >
< / html >
