Skip to content

Enumerations

Enumeration List

Dialog Data

Result data parameter[3] of onPlayerDialogCallback

Key DataResult
data['dialog_name']dialogID
data['buttonClicked']buttonID

CommandData

DataTable for registerLuaCommand

propertyresult
commandCommandName
roleRequireRoleID
descriptionCommandDescription

EventData

DataTable for registerLuaEvent

propertyresult
idEventID
titleEventTitle
descriptionEventDescription
messageEventMessage

DailyEventData

DataTable for registerLuaDailyEvent

propertyresult
idEventID
titleEventTitle
descriptionEventDescription

TileDataProperties

TileDataProperties for Tile:getTileData() and Tile:setTileData()

propertyvalue
TILE_DATA_TYPE_SEED_FRUITS_COUNT0
TILE_DATA_TYPE_SEED_PLANTED_TIME1
TILE_DATA_TYPE_MAGPLANT_ITEM_COUNT2
TILE_DATA_TYPE_VENDING_ITEM_COUNT3
TILE_DATA_TYPE_SIGN_TEXT4
TILE_DATA_TYPE_DOOR_TEXT5
TILE_DATA_TYPE_DOOR_IS_OPEN6
TILE_DATA_TYPE_DOOR_DESTINATION7
TILE_DATA_TYPE_DOOR_ID8
TILE_DATA_TYPE_VENDING_ITEM_ID9
TILE_DATA_TYPE_VENDING_PRICE10
TILE_DATA_TYPE_VENDING_EARNED11
TILE_DATA_TYPE_DISPLAY_BLOCK_ITEM_ID12
TILE_DATA_TYPE_MAGPLANT_ITEM_ID13
TILE_DATA_TYPE_MAGPLANT_IS_ACTIVE14
TILE_DATA_TYPE_MAGPLANT_IS_MAGNET15
TILE_DATA_TYPE_MAGPLANT_SPACE16
TILE_DATA_TYPE_MAGPLANT_GEMS17
TILE_DATA_TYPE_MAGPLANT_SECOND_ITEM_ID18
TILE_DATA_TYPE_MAGPLANT_IS_ENABLED19
TILE_DATA_TYPE_MAGPLANT_HARVEST_TREES20
TILE_DATA_TYPE_MAGPLANT_COLLECT_SEEDS21

RoleProperties

RoleProperties for getRoles(), Player:getRole(), getHighestPriorityRole()

propertydescription
roleIDID of the Role
roleDescriptionRole Description
rolePriceprice of the Role
rolePrioritypriority of the Role
roleNamename of the Role
roleItemIDItemID of the Role
textureNameTexture Name
textureXYTexture Vector2
discordRoleIDDiscord RoleID
namePrefixName Prefix
chatPrefixChat Prefix
dailyRewardDiamondLocksCountDiamond Locks Rewards
computedFlagsComputed Flags

RoleFlags

Bitwise flags returned by RoleProperties.computedFlags

FlagBit Value
ACCESS_ALL_WORLDSbit.lshift(1, 0)
ALLOW_DROPPING_UNTRADEABLE_ITEMSbit.lshift(1, 1)
ALLOW_FULL_ACCESS_BLAST_DESIGNERbit.lshift(1, 2)
BYPASS_ANTICHEATbit.lshift(1, 3)
ALLOW_ENTER_NUKED_WORLDSbit.lshift(1, 4)
ALLOW_ENTER_ANY_WORLDSbit.lshift(1, 5)
INCREASE_BUILD_PUNCH_RANGE_SMALLbit.lshift(1, 6)
INCREASE_BUILD_PUNCH_RANGE_MEDIUMbit.lshift(1, 7)
INCREASE_BUILD_PUNCH_RANGE_UNLIMITEDbit.lshift(1, 8)
BYPASS_ANTICHEAT_RANGE_CHECKSbit.lshift(1, 9)
DISABLE_ALL_COOLDOWN_EFFECTSbit.lshift(1, 10)
ALLOW_USE_SPK_COMMANDSbit.lshift(1, 11)
ALLOW_FIND_ALL_ITEMSbit.lshift(1, 12)
ALLOW_FIND_ALL_BLOCKS_AND_CLOTHESbit.lshift(1, 13)
BYPASS_BAD_WORDS_FILTERbit.lshift(1, 14)
BYPASS_BLOCKED_ITEMS_FILTERbit.lshift(1, 15)
BYPASS_ECONOMY_SCANbit.lshift(1, 16)
ADVANCED_ECONOMY_ACCESSbit.lshift(1, 17)
ADVANCED_RENDER_ACCESSbit.lshift(1, 18)
DISABLE_SOME_COOLDOWN_EFFECTSbit.lshift(1, 19)
ALLOW_UNLIMITED_ZOOMbit.lshift(1, 20)
ALLOW_BREAKING_BEDROCK_AND_MAIN_DOORbit.lshift(1, 21)
ALLOW_PULL_FROM_OTHER_WORLDSbit.lshift(1, 22)
SHOW_IN_MODS_LISTbit.lshift(1, 23)
BYPASS_BROADCAST_LEVEL_CHECKbit.lshift(1, 24)
GET_BONUS_XPbit.lshift(1, 25)
EXTRA_FISHING_ITEMSbit.lshift(1, 26)
REDUCE_TREE_GROWTIMEbit.lshift(1, 27)

ItemCategoryFlags

Bitwise flags returned by Item:getCategoryType()

FlagBit Value
BETAbit.lshift(1, 0)
AUTO_PICKUPbit.lshift(1, 1)
MODbit.lshift(1, 2)
RANDOM_GROWbit.lshift(1, 3)
PUBLICbit.lshift(1, 4)
FOREGROUNDbit.lshift(1, 5)
HOLIDAYbit.lshift(1, 6)
UNTRADABLEbit.lshift(1, 7)

ItemEditableFlags

Bitwise flags returned by Item:getEditableType()

FlagBit Value
FLIPPEDbit.lshift(1, 0)
EDITABLEbit.lshift(1, 1)
SEEDLESSbit.lshift(1, 2)
PERMANENTbit.lshift(1, 3)
DROPLESSbit.lshift(1, 4)
NOSELFbit.lshift(1, 5)
NOSHADOWbit.lshift(1, 6)
WORLDLOCKbit.lshift(1, 7)

TileFlags

Bitwise flags returned by Tile:getFlags()

NameValue
TILE_FLAG_HAS_EXTRA_DATAbit.lshift(1, 0)
TILE_FLAG_HAS_PARENTbit.lshift(1, 1)
TILE_FLAG_WAS_SPLICEDbit.lshift(1, 2)
TILE_FLAG_WILL_SPAWN_SEEDS_TOObit.lshift(1, 3)
TILE_FLAG_IS_SEEDLINGbit.lshift(1, 4)
TILE_FLAG_FLIPPED_Xbit.lshift(1, 5)
TILE_FLAG_IS_ONbit.lshift(1, 6)
TILE_FLAG_IS_OPEN_TO_PUBLICbit.lshift(1, 7)
TILE_FLAG_BG_IS_ONbit.lshift(1, 8)
TILE_FLAG_FG_ALT_MODEbit.lshift(1, 9)
TILE_FLAG_IS_WETbit.lshift(1, 10)
TILE_FLAG_GLUEDbit.lshift(1, 11)
TILE_FLAG_ON_FIREbit.lshift(1, 12)
TILE_FLAG_PAINTED_REDbit.lshift(1, 13)
TILE_FLAG_PAINTED_GREENbit.lshift(1, 14)
TILE_FLAG_PAINTED_BLUEbit.lshift(1, 15)

PlayerClothes

PlayerClothes Properties

propertyvalue
Hat0
Shirt1
Pants2
Feet3
Face4
Hand5
Back6
Hair7

Released under the MIT License.