JeiDrawable
Link to jeidrawable
Represents anything that can be drawn in a JEI recipe or category.
A drawable can be anything from an ingredient, to a blank image, to something with animations. Refer to all the available factory methods for more information.
All JeiIngredients can automatically convert into a JeiDrawable, avoiding some boilerplate. Refer to invalid#asJeiDrawable(RawJeiIngredient) and its specialized versions invalid#asJeiDrawable(IItemStack) and invalid#asJeiDrawable(IFluidStack) for more information.
Importing the class
Link to importing-the-class
It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
ZenScript Copyimport mods.jei.component.JeiDrawable;
Static Methods
Link to static-methods
Name: blank
Creates a blank drawable of the given width and height.
A blank drawable draws nothing.
Returns: A blank JeiDrawable.
Return Type: JeiDrawable
ZenScript CopyJeiDrawable.blank(width as int, height as int) as JeiDrawable
Parameter | Type | Description |
---|---|---|
Parameter width | Type int | Description The width of the drawable. |
Parameter height | Type int | Description The height of the drawable. |
Name: of
Creates a drawable that draws the given JeiIngredient.
Returns: An ingredient JeiDrawable.
Return Type: JeiDrawable
ZenScript CopyJeiDrawable.of(ingredient as JeiIngredient) as JeiDrawable
Parameter | Type | Description |
---|---|---|
Parameter ingredient | Type JeiIngredient | Description The ingredient to draw. |
Name: of
Creates a drawable that draws the given texture, as specified in the parameters.
Returns: A texture JeiDrawable.
Return Type: JeiDrawable
ZenScript CopyJeiDrawable.of(texture as ResourceLocation, u as int, v as int, width as int, height as int) as JeiDrawable
Parameter | Type | Description |
---|---|---|
Parameter texture | Type ResourceLocation | Description A ResourceLocation identifying the path of the texture to draw. |
Parameter u | Type int | Description The u coordinate of the texture (i.e. the top-left x coordinate of the rectangle to draw). |
Parameter v | Type int | Description The v coordinate of the texture (i.e. the top-left y coordinate of the rectangle to draw). |
Parameter width | Type int | Description The width of the texture to draw. |
Parameter height | Type int | Description The height of the texture to draw. |
Name: ofAnimated
Creates an animated version of the given drawable that animates over the course of a set of ticks.
The original drawable is left untouched, meaning that the returned instance is a fully separate drawable.
Returns: An animated JeiDrawable.
Return Type: JeiDrawable
ZenScript CopyJeiDrawable.ofAnimated(delegate as JeiDrawable, ticks as int, animation as JeiDrawableAnimation) as JeiDrawable
Parameter | Type | Description |
---|---|---|
Parameter delegate | Type JeiDrawable | Description The drawable that should be animated. |
Parameter ticks | Type int | Description The amount of ticks over which the animation unfolds. 20 ticks is 1 second. |
Parameter animation | Type JeiDrawableAnimation | Description The type of animation that should be rendered. |
Name: ofAnimated
Creates an animated version of a texture drawable.
Using this method is effectively equivalent to
ofAnimated(of(texture, u, v, width, height), ticks, animation)
. It is thus merely provided as a
convenience to avoid having to create two drawables.
Returns: An animated texture JeiDrawable.
Return Type: JeiDrawable
ZenScript CopyJeiDrawable.ofAnimated(texture as ResourceLocation, u as int, v as int, width as int, height as int, ticks as int, animation as JeiDrawableAnimation) as JeiDrawable
Parameter | Type | Description |
---|---|---|
Parameter texture | Type ResourceLocation | Description A ResourceLocation identifying the path of the texture to draw. |
Parameter u | Type int | Description The u coordinate of the texture (i.e. the top-left x coordinate of the rectangle to draw). |
Parameter v | Type int | Description The v coordinate of the texture (i.e. the top-left y coordinate of the rectangle to draw). |
Parameter width | Type int | Description The width of the texture to draw. |
Parameter height | Type int | Description The height of the texture to draw. |
Parameter ticks | Type int | Description The amount of ticks over which the animation unfolds. 20 ticks is 1 second. |
Parameter animation | Type JeiDrawableAnimation | Description The type of animation that should be rendered. |
Name: ofNinePatch
Creates a new texture drawable which is based on a nine-patch texture.
Returns: A nine-patch texture JeiDrawable.
Return Type: JeiDrawable
ZenScript CopyJeiDrawable.ofNinePatch(texture as ResourceLocation, u as int, v as int, width as int, height as int, expectedWidth as int, expectedHeight as int) as JeiDrawable
Parameter | Type | Description |
---|---|---|
Parameter texture | Type ResourceLocation | Description A ResourceLocation identifying the path of the texture to draw. |
Parameter u | Type int | Description The u coordinate of the texture (i.e. the top-left x coordinate of the rectangle to draw). |
Parameter v | Type int | Description The v coordinate of the texture (i.e. the top-left y coordinate of the rectangle to draw). |
Parameter width | Type int | Description The width of the texture to draw. |
Parameter height | Type int | Description The height of the texture to draw. |
Parameter expectedWidth | Type int | Description The width of the drawable. |
Parameter expectedHeight | Type int | Description The height of the drawable. |