Libraries.Interface.Events.ScreenshotEvent Documentation

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

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.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

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

Equals(Libraries.Language.Object object)

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

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

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

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetHeight()

This action returns the height of the screenshot in pixels.

Return

integer:

GetScreenshot()

This action returns the PixelMap storing the screenshot.

Return

Libraries.Game.Graphics.PixelMap:

GetWidth()

This action returns the width of the screenshot in pixels.

Return

integer:

GetX()

This action returns the x-coordinate of the bottom-left corner of the screenshot, as measured in window coordinates.

Return

integer:

GetY()

This action returns the y-coordinate of the bottom-left corner of the screenshot, as measured in window coordinates.

Return

integer:

SetDimensions(integer x, integer y, integer width, integer height)

This action sets the x and y coordinates of the bottom-left corner of the region captured by the screenshot, along with the width and height of the screenshot. This is set by the engine when a screenshot is performed, so most users will never need to call this action directly.

Parameters

  • integer x
  • integer y
  • integer width
  • integer height

SetScreenshot(Libraries.Game.Graphics.PixelMap screenshot)

This action sets the PixelMap that stores the screenshot. This is called automatically by the engine after taking the screenshot, so most users will never need to call this directly.

Parameters