Skip to main content

WorldImage

Accessor to modify World Image from Lua scripts.

info

This module can only be used in Entity scripts.

Properties​

imageId​

Asset ID of the current image. This property is read-only.

imageColor​

Color of the current image. This property is read-only.

Functions​

setImageId(id)​

Load an image asset and apply it to the Entity.

info

This method can only be used in Entity scripts.

Parameters​

  • id — Id of the target asset.

setImageColor(color)​

Sets the color of the image.

info

This method can only be used in Entity scripts.

Parameters​

  • color — Target color.

setVisibility(id, visible)​

Changes image visibility for a target Player.

info

This method can only be used in Entity scripts.

Parameters​

  • id — Client ID of the target Player or Players.All.
  • visible — If the image should be visible to the target.