7cc5c4f330d47060/geode
1
0
Fork 0
mirror of https://github.com/geode-sdk/geode.git synced 2025-02-17 00:30:26 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs changes

Browse source
This commit is contained in:
HJfod 2023-02-01 23:43:53 +02:00
parent 6d3847d9e1
commit 0849323ea1
2 changed files with 108 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

156
loader/include/Geode/cocos/base_nodes/CCNode.h vendored
View file

@ -844,64 +844,122 @@ public:
/// @} end of Tag & User Data
GEODE_ADD(
private:
friend class geode::modifier::FieldContainer;
private:
friend class geode::modifier::FieldContainer;
geode::modifier::FieldContainer* getFieldContainer();
std::optional<std::any> getAttributeInternal(std::string const& attribute);
public:
/**
* Get the string ID of this node
* @returns The ID, or an empty string if the node has no ID.
*/
std::string getID();
/**
* Set the string ID of this node. String IDs are a Geode addition
* that are much safer to use to get nodes than absolute indexes
* @param id The ID of the node, recommended to be in kebab case
* without any spaces or uppercase letters. If the node is added
* by a mod, use the _spr literal to append the mod ID to it
*/
void setID(std::string const& id);
geode::modifier::FieldContainer* getFieldContainer();
std::optional<std::any> getAttributeInternal(std::string const& attribute);
/**
* Get a child by its string ID
* @param id ID of the child
* @returns The child, or nullptr if none was found
*/
CCNode* getChildByID(std::string const& id);
public:
/**
* Get the string ID of this node
* @returns The ID, or an empty string if the node has no ID.
* @note Geode addition
*/
std::string getID();
/**
* Set the string ID of this node. String IDs are a Geode addition
* that are much safer to use to get nodes than absolute indexes
* @param id The ID of the node, recommended to be in kebab case
* without any spaces or uppercase letters. If the node is added
* by a mod, use the _spr literal to append the mod ID to it
* @note Geode addition
*/
void setID(std::string const& id);
/**
* Get a child by its string ID. Recursively searches all the children
* @param id ID of the child
* @returns The child, or nullptr if none was found
*/
CCNode* getChildByIDRecursive(std::string const& id);
/**
* Get a child by its string ID
* @param id ID of the child
* @returns The child, or nullptr if none was found
* @note Geode addition
*/
CCNode* getChildByID(std::string const& id);
void setAttribute(std::string const& attribute, std::any value);
template<class T>
std::optional<T> getAttribute(std::string const& attribute) {
if (auto value = this->getAttributeInternal(attribute)) {
try {
return std::any_cast<T>(value.value());
} catch(...) {
return std::nullopt;
}
/**
* Get a child by its string ID. Recursively searches all the children
* @param id ID of the child
* @returns The child, or nullptr if none was found
* @note Geode addition
*/
CCNode* getChildByIDRecursive(std::string const& id);
/**
* Set an attribute on a node. Attributes are a system added by Geode,
* where a node may have any sort of extra data associated with it. Used
* for mod intercommunication. For example, a mod that adds scrollbars to
* layers might check if the layer has an attribute set for whether the
* scrollbar should be disabled. The key of the attribute should be
* prefixed with the mod ID, like hjfod.cool-scrollbars/enable.
* @param attribute The attribute key. Should be prefixed with the mod ID,
* like hjfod.cool-scrollbars/enable
* @param value The value of the attribute
* @note Geode addition
*/
void setAttribute(std::string const& attribute, std::any value);
/**
* Get an attribute from the node. Attributes may be anything
* @param attribute The attribute key
* @returns The value, or nullopt if the attribute doesn't exist or if the
* type didn't match
* @note Geode addition
*/
template<class T>
std::optional<T> getAttribute(std::string const& attribute) {
if (auto value = this->getAttributeInternal(attribute)) {
try {
return std::any_cast<T>(value.value());
} catch(...) {
return std::nullopt;
}
return std::nullopt;
}
return std::nullopt;
}
void setLayout(Layout* layout, bool apply = true);
Layout* getLayout();
void updateLayout();
/**
* Set the Layout for this node. Used to automatically position children,
* based on the selected layout. In order to apply the layout after a child
* has been added, call updateLayout
* @param layout Layout to set to this node
* @param apply Whether to call updateLayout now or not
* @note Geode addition
*/
void setLayout(Layout* layout, bool apply = true);
/**
* Get the Layout for this node
* @returns The current layout, or nullptr if no layout is set
* @note Geode addition
*/
Layout* getLayout();
/**
* Update the layout of this node using the current Layout. If no layout is
* set, nothing happens
* @note Geode addition
*/
void updateLayout();
void setPositionHint(PositionHint hint);
PositionHint getPositionHint();
/**
* Give a hint to the current Layout about where this node should be
* positioned in it. Allows detaching the node from the current
* layout by setting position to absolute
* @param hint The hint to set
* @note The layout definitely should, but might not respect the hint
* given
* @note Geode addition
*/
void setPositionHint(PositionHint hint);
/**
* Get the current position hint for this node
* @note Geode addition
*/
PositionHint getPositionHint();
void swapChildIndices(CCNode* first, CCNode* second);
);
/**
* Swap two children
* @param first One of the nodes to swap
* @param second One of the nodes to swap
* @note Geode addition
*/
void swapChildIndices(CCNode* first, CCNode* second);
/// @{
/// @name Shader Program

2
loader/include/Geode/loader/ModInfo.hpp
View file

@ -45,7 +45,7 @@ namespace geode {
/**
* Human-readable ID of the Mod.
* Recommended to be in the format
* "com.developer.mod". Not
* "developer.mod". Not
* guaranteed to be either case-
* nor space-sensitive. Should
* be restricted to the ASCII