Good Grid

Good Grid

The ultimate DrawGridLayer rewrite and API!

• Better Performance!
• Rotation Support!
• Extensive API
• Bug Fixes
• Exactly Like Vanilla (by default)

Editor Extension in MegaHack cannot be detected, thus the grid size will too small unless you enable extension override in this mod's settings.

Here's what you can do with the API as a Developer:

LineColor

This is a class that contains up to 2 colors for solid or gradient lines. When passing one into the constructor, both color A and B equal the same value. If you pass two colors, the line will be a gradient between the two.

LineColor(GLubyte r, GLubyte g, GLubyte b, GLubyte a);

Constructor with rgba bytes.

LineColor(const cocos2d::ccColor4B& colorA);

Constructor with one color, will make the line solid.

LineColor(const cocos2d::ccColor4B& colorA, const cocos2d::ccColor4B& colorB);

Constructor with two colors, will make the line a gradient between the two colors.

cocos2d::ccColor4B getColorA() const

Returns the first color.

cocos2d::ccColor4B getColorB() const

Returns the second color if it is set, else returns the first color.

DrawGridAPI.hpp

void markDirty()

Marks the grid as dirty, forcing it to update it's culling bounds.

bool isDirty()

Returns true if the grid is marked as dirty.

void setVanillaDraw(bool enabled)

Sets the grid rendering to Vanilla's implementation (used mostly for debugging, should not be used in a mod).

bool isVanillaDraw()

Returns true if vanilla draw is enabled.

void setLineSmoothing(bool enabled)

Line smoothing is only supported on Windows and MacOS! Sets all lines to smooth (useful for editor camera rotation)

bool hasLineSmoothing()

Line smoothing is only supported on Windows and MacOS! Returns true of line smoothing is enabled

void setLineSmoothingLimit(float limit)

Line smoothing is only supported on Windows and MacOS! Sets the editor zoom limit (if >= than this limit, the lines will not be made smooth) for line smoothing as having too many smoothed lines on screen at once is laggy. I recommend keeping it at default.

float getLineSmoothingLimit()

Returns the line smoothing limit

void overrideGridBoundsSize(cocos2d::CCSize size)

Sets the grid's max width and height bounds (useful for editor extenders and limiters).

cocos2d::CCSize getGridBoundsSize()

Returns the max width and height bounds of the grid.

void overrideGridBoundsOrigin(cocos2d::CCPoint origin)

Sets the grid's origin (bottom left) coordinates.

cocos2d::CCPoint getGridBoundsOrigin()

Returns the coordinates of the grid's origin.

cocos2d::CCSize getWorldViewSize()

Returns the World View size. This size is the window size scaled by the editor zoom multiplied by the overdraw factor to account for rotation.

float getOverdrawFactor()

Returns the overdraw factor for the rotated editor view.

void drawLine(const cocos2d::ccVertex2F& start, const cocos2d::ccVertex2F& end, const LineColor& color, float width, bool blend = false)

Draws a line to the screen with two coordinates where it starts and ends. Takes in a LineColor param which allows for a solid or gradient color. The width is the line width, for the purpose of optimization, this also determines Z ordering for that specific width. Blending is an optional param that will make the line blend with additive blending.

void drawRect(const cocos2d::CCRect& rect, const cocos2d::ccColor4B& color, bool blend = false)

Draws a rectangle to the screen with a CCRect param dictating the bounds and a color param to set its color. Blending is an optional param that will make the rectangle blend with additive blending.

void drawRectOutline(const cocos2d::CCRect& rect, const cocos2d::ccColor4B& color, float width, bool blend = false)

Draws a rectangle outline to the screen with a CCRect param dictating the bounds, a color param to set its color, and the width of the outline. Blending is an optional param that will make the rectangle outline blend with additive blending.

bool isObjectVisible(GameObject* object)

Util to check if an object is visible (accounting for selecting, group and hide options).

geode::Result getNodeByID(const std::string& id)

Returns a result of a DrawNode if one by the passed in ID exists.

template 
requires std::is_base_of_v
geode::Result getNode(const std::string& id)

Returns a result of a DrawNode if one passed by the type and ID exists.

template 
requires std::is_base_of_v
geode::Result getNode()

Returns a result of a DrawNode if one passed by the type. Will always be first of a type if multiple exist.

template 
requires std::is_base_of_v
T& addDraw(const std::string& id, Args&&... args)

Returns a reference of and adds a custom DrawNode to the DrawGridLayer with an ID.

DrawNode.hpp

This class is what makes up every part of the new DrawGridLayer. Every layer on it inherits this class. It provides a few methods as well as some virtuals you can override that will be called when added via the DrawGridAPI. You usually do not need to manually construct this yourself, as DrawGridAPI::addDraw will construct one for you and return it.

void setID(const std::string& id)

Sets the ID of the DrawNode.

std::string getID() const

Returns the ID of the DrawNode.

void setEnabled(bool enabled)

Sets if the DrawNode is enabled (should draw to the DrawGridLayer).

bool is