Comments (4)
we all know that's the hardest part of being a dev.
I think it competes with naming things =P
I think it'd make for a cleaner style.
I think so too, will probably implement it in a near future.
Thanks for the feedback!
from godot-lua-pluginscript.
Hi there! I'm sorry for the current lack of documentation =/
There is a way to mark properties to not show in editor, based on the PropertyUsage enum taken from GDNative's godot_property_usage_flags:
MyClass.some_property = property {
"This String property is not exported to editor!",
usage = PropertyUsage.NOEDITOR,
}
This will register some_property
in ClassDB and it will be available from GDScript or other languages via instance.some_property
or instance.get("some_property")
or the like, it will just not show in the inspector.
Now, depending on your use case, if you only need a "private" (hidden from ClassDB or other languages) instance variable, you can also just set it on _init
, which is called whenever an instance is created, right after initializing other registered properties from class:
MyClass.some_public_property = 42
function MyClass:_init()
assert(self.some_public_property == 42)
self.some_private_property = Array()
end
Also, if you want a class-wide (called static
in C/C++/C#/...) private constant/variable, using Lua's locals should be enough:
local class_wide_variable = Dictionary()
function MyClass:get_from_class_cache(key)
return class_wide_variable[key]
end
from godot-lua-pluginscript.
As a side note, properties are exported by default just because GODOT_PROPERTY_USAGE_DEFAULT
exports properties to the editor.
In a first moment, I thought of making properties not exported by default, and have an alias of the property
function called export
that exports properties by default. I don't recall now why exactly I didn't go with this idea, but it can surely be revisited!
Something like:
-- by default, `property` has `usage = PropertyUsage.NOEDITOR`
-- although setting it explicitly would override this default
MyClass.noeditor_property = property { "not shown in inspector" }
MyClass.another_noeditor_property = "also not shown in inspector"
-- export would be an alias to `property { usage = PropertyUsage.DEFAULT }`
MyClass.exported_property = export { "shown in inspector" }
from godot-lua-pluginscript.
Thank you for the detailed explanation! And no worries on the documentation, we all know that's the hardest part of being a dev.
Personally, I'd prefer the property vs export syntax. I think it'd make for a cleaner style. Just my two cents though.
from godot-lua-pluginscript.
Related Issues (20)
- Passing data between GD.yield() and resume() HOT 1
- Array:sort_custom Usage HOT 4
- Scripts Inherited By Scenes All Share Variables HOT 2
- Does this work with Godot 4 alpha / nightly? HOT 9
- key press or simulating keyboard HOT 5
- Scripts not reloading in editor HOT 3
- WebAssembly / HTML5 target HOT 3
- Reasoning behind not supporting multithreading in lua? HOT 3
- Runtime scripting HOT 4
- Do you know what the problem could be loading a multithreading library called effil? HOT 3
- cannot load this plugin due to "attempt to call a nil value" HOT 8
- load plugin first time has some errors. HOT 2
- "undefined symbol: lua_gettop" when attempting to load luasocket HOT 9
- `remote` keyword? HOT 1
- Get Lua script instances while unboxing Object Variants
- Plugin not working in Godot 4.0 HOT 2
- Unable to execute text from textEdit's text property with loadstring() HOT 1
- Mono: Core API Hash Mismatch Error. HOT 4
- Can't use the extension HOT 3
- cant use the plugin HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from godot-lua-pluginscript.