Libraries.Game.Graphics.TextureRegion

The TextureRegion class is made up of two features: a Texture, and a rectangular space on the screen. This class is primarily for internal use in the game engine. For a class with the same functionality, users are recommended to use the Drawable class. Any texture defined by this class will be located on the screen by a coordinate system. A coordinate of (0,0) is the very botom left corner of the screen. Increasing the first value will make the texture move to the right. Increasing the second value will make the texture move up the screen.

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

This action copies the information from the given TextureRegion into this TextureRegion.

This action copies the information from a given TextureRegion at the given coordinates to the given width and height onto this TextureRegion.

This action will dispose of the Texture stored in this TextureRegion.

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

This action flips the TextureRegion along the x-axis.

This action flips the TextureRegion along the y-axis.

This action returns where the TextureRegion begins the bottom edge of its region on the stored texture, where 0 is the far bottom of the texture and 1 is the far top side of the texture.

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

This action returns where the TextureRegion begins the left edge of its region on the stored texture, where 0 is the far left of the texture and 1 is the far right side of the texture.

This action returns the height of the region.

This action returns the width of the TextureRegion.

This action returns the x coordinate where the region begins on the Texture.

This action returns the y coordinate where the region begins on the Texture.

This action returns where the TextureRegion begins the right edge of its region on the stored texture, where 0 is the far left of the texture and 1 is the far right side of the texture.

This action returns the texture held by this TextureRegion.

This action returns where the TextureRegion begins the top edge of its region on the stored texture, where 0 is the far bottom of the texture and 1 is the far top side of the texture.

This action returns whether or not the TextureRegion has been flipped along the x-axis.

This action returns whether or not the TextureRegion has been flipped along the y-axis.

This action loads part of a texture into this TextureRegion, using the given percentage coordinates from 0 to 1 of the texture to load.

This action loads part of a texture into the TextureRegion, starting from the bottom left corner to the given width and height.

This action loads an entire texture into the TextureRegion.

This action loads part of a texture into this TextureRegion, starting from the given x,y coordinates of the Texture to the given width and height.

This action sets where the TextureRegion begins the bottom edge of its region on the stored texture, where 0 is the far bottom of the texture and 1 is the far top side of the texture.

This action sets where the TextureRegion begins the left edge of its region on the stored texture, where 0 is the far left of the texture and 1 is the far right side of the texture.

Sets the region of this TextureRegion to be the same as the region of a different TextureRegion.

Sets the region of this TextureRegion to start at the given x,y coordinates and go to the given width and height.

This action will set the region of this TextureRegion to begin at the bottom left of the Texture to the top right, where 0 represents the far left or bottom, and 1 represents the far right or top.

Sets the region of this TextureRegion to begin at the start of the given TextureRegion's plus an offset by the given x,y values, and stretching to the given width and height.

This action sets the height of the region.

This action sets the width of the TextureRegion.

This action sets the x coordinate where the region begins on the Texture.

This action sets the y coordinate where the region begins on the Texture.

This action sets where the TextureRegion begins the left edge of its region on the stored texture, where 0 is the far left of the texture and 1 is the far right side of the texture.

This action sets the texture used by this TextureRegion to the given texture.

This action sets where the TextureRegion begins the top edge of its region on the stored texture, where 0 is the far bottom of the texture and 1 is the far top side of the texture.