Interface: M2Image
An image that has been loaded into the game.
Remarks
An M2Image is a wrapper around a CanvasKit Image, with some additional properties.
Properties
canvaskitImage
canvaskitImage:
undefined
|Image
The image in CanvasKit format.
Source
fallbackLocalizationUrls?
optional
fallbackLocalizationUrls:string
[]
For a localized image that will be fetched, additional URLs to try if the URL in url
fails.
Source
height
height:
number
Source
imageName
imageName:
string
Name of the image, as it will be referred to when creating a sprite.
Source
isFallback
isFallback:
boolean
Is this image a fallback localized image?
Source
localize
localize:
boolean
Try to localize the image by fetching a locale-specific image? Default is false.
Source
originalUrl?
optional
originalUrl:string
For an image that will be fetched, the original URL before any localization.
Source
status
status:
M2ImageStatus
Status of the image: Deferred, Loading, Ready, or Error.
Source
svgString?
optional
svgString:string
An image defined by an SVG string.
Source
url?
optional
url:string
For an image that will be fetched, this is the URL that will be attempted. This may have localization applied.
Source
width
width:
number