ClientUIImageControl

supers: ClientUIBaseControl

The type that represents an instance of an Image Control component. Contains functions for manipulating the image source and fill type.

Methods8

function ClientUIImageControl:SetImage(imageSource: EnumItem.ImageSource, imageId: integer)

Sets the image source and ID.

Parameters

imageSourceEnumItem.ImageSource: The source to get the image asset from.
imageIdinteger: The ID of the image asset.

function ClientUIImageControl:SetSoftEdgeWidth(widthX: number, widthY: number)

Sets the horizontal and vertical soft edge width.

Changes are applied even if masking and soft edge are disabled.

Parameters

widthXnumber: The horizontal soft edge width.
widthYnumber: The vertical soft edge width.

function ClientUIImageControl:SetFillUnused()

Sets the fill type to Unused.

See:

Enum.ImageFillType for all image fill types.

function ClientUIImageControl:SetFillHorizontal(fillHorizontalType: EnumItem.ImageFillHorizontalType, fillAmount: NormalizedPercentage)

Sets the fill type to Horizontal and sets the horizontal fill type and fill amount to the specified values.

See:

Enum.ImageFillHorizontalType for all horizontal image fill types.

Parameters

fillHorizontalTypeEnumItem.ImageFillHorizontalType: The horizontal fill type.
fillAmountNormalizedPercentage: The normalized percentage of the image that should be revealed.

function ClientUIImageControl:SetFillVertical(fillVerticalType: EnumItem.ImageFillVerticalType, fillAmount: NormalizedPercentage)

Sets the fill type to Vertical and sets the vertical fill type and fill amount to the specified values.

Changes are applied even if masking is disabled; masking will not be enabled if disabled when the function is called.

See:

Enum.ImageFillVerticalType for all vertical image fill types.

Parameters

fillVerticalTypeEnumItem.ImageFillVerticalType: The vertical fill type.
fillAmountNormalizedPercentage: The normalized percentage of the image that should be revealed.

function ClientUIImageControl:SetFillRadial90(fillRadial90Type: EnumItem.ImageFillRadial90Type, fillAmount: NormalizedPercentage)

Sets the fill type to Radial90 and sets the radial 90 fill type and fill amount to the specified values.

Changes are applied even if masking is disabled; masking will not be enabled if disabled when the function is called.

See:

Enum.ImageFillRadial90Type for all radial 90-degree image fill types.

Parameters

fillRadial90TypeEnumItem.ImageFillRadial90Type: The radial 90-degree origin point.
fillAmountNormalizedPercentage: The normalized percentage of the image that should be revealed.

function ClientUIImageControl:SetFillRadial180(fillRadialType: EnumItem.ImageFillRadialType, fillAmount: NormalizedPercentage)

Sets the fill type to Radial180 and sets the radial fill type and fill amount to the specified values.

Changes are applied even if masking is disabled; masking will not be enabled if disabled when the function is called.

See:

Enum.ImageFillRadialType for all radial image fill types.

Parameters

fillRadialTypeEnumItem.ImageFillRadialType: The radial fill origin direction.
fillAmountNormalizedPercentage: The normalized percentage of the image that should be revealed.

function ClientUIImageControl:SetFillRadial360(fillRadialType: EnumItem.ImageFillRadialType, fillAmount: NormalizedPercentage)

Sets the fill type to Radial360 and sets the radial fill type and fill amount to the specified values.

Changes are applied even if masking is disabled; masking will not be enabled if disabled when the function is called.

See:

Enum.ImageFillRadialType for all radial image fill types.

Parameters

fillRadialTypeEnumItem.ImageFillRadialType: The radial fill starting position.
fillAmountNormalizedPercentage: The normalized percentage of the image that should be revealed.

Fields18

ClientUIImageControl.imageSource : EnumItem.ImageSource

[Read] The image source type.

ClientUIImageControl.imageId : integer

[Read] The image asset ID.

ClientUIImageControl.imageColor : ColorValue

[Read/Write/Tweenable] The color of the image.

ClientUIImageControl.imageType : EnumItem.ImageType

[Read/Write] The image type.

ClientUIImageControl.enableMask : boolean

[Read/Write] Whether masking is enabled.

ClientUIImageControl.enableSoftEdge : boolean

[Read/Write] Whether soft edge is enabled.

ClientUIImageControl.softEdgeMode : EnumItem.ImageMaskSoftEdgeMode

[Read/Write] The soft edge mode.

ClientUIImageControl.softEdgeWidthX : number

[Read/Write/Tweenable] The horizontal soft edge width.

ClientUIImageControl.softEdgeWidthY : number

[Read/Write/Tweenable] The vertical soft edge width.

ClientUIImageControl.horizontalSoftRange : number

[Read/Write/Tweenable] The horizontal soft edge range.

ClientUIImageControl.verticalSoftRange : number

[Read/Write/Tweenable] The vertical soft edge range.

ClientUIImageControl.reverseMaskArea : boolean

[Read/Write] Whether to invert the mask area.

ClientUIImageControl.fillType : EnumItem.ImageFillType

[Read/Write] The fill type of the image.

ClientUIImageControl.fillHorizontalType : EnumItem.ImageFillHorizontalType

[Read/Write] The fill direction when the fill type is Horizontal.

ClientUIImageControl.fillVerticalType : EnumItem.ImageFillVerticalType

[Read/Write] The fill direction when the fill type is Vertical.

ClientUIImageControl.fillRadial90Type : EnumItem.ImageFillRadial90Type

[Read/Write] The fill origin used when the fill type is Radial90.

ClientUIImageControl.fillRadialType : EnumItem.ImageFillRadialType

[Read/Write] The fill origin used when the fill type is Radial180 or Radial360.

ClientUIImageControl.fillAmount : NormalizedPercentage

[Read/Write/Tweenable] The normalized percentage of the image that should be revealed.