List Function - Rann-Studio/PowerKuy_Lib GitHub Wiki
Below is a list of functions included in PowerKuy_Lib, along with a brief description of each function and an example of how to use it:
add_magplant
This function is used to press the add item button on magplant
--@function: add_magplant
--@param: {position: string, offset: int}
--@return: no return
--@note:
--position: top, bottom, left, right [required]
--offset: int [optional] (default 0)
--@example:
add_magplant{
position = "top",
offset = 1
}
retrieve_magplant
This function is used to press the retrieve button on magplant
--@function: retrieve_magplant
--@param: {position: string, offset: int}
--@return: no return
--@note:
--position: top, bottom, left, right [required]
--offset: int [optional]
--@example:
retrieve_magplant{
position = "top",
offset = 1
}
break_item
This function is used to break item (block or background)
--@function: break_item
--@param: {x: int, y: int}
--@return: no return
break_item{
x = 23,
y = 24
}
place_item
This function is used to place item (block or background)
--@function: place_item
--@param: {x: int, y: int, item_id: int}
--@return: no return
place_item{
x = 23,
y = 24,
item_id = 123
}
clear_island
This function is used to clear world island automatically
--@function: clear_island
--@param: no param needed
--@return: no return
clear_island()
find_item
This function is used to find for items and get them
--@function: find_item
--@param: {item_id: int}
--@return: no return
--@note:
--item_id: id of the item you want to find [required]
--@example:
find_item{
item_id = 123
}
recycle_item
This function is used to recycle items in backpack
:warning: Warning: Please don't abuse this function
--@function: recycle_item
--@param: {item_id: int, amount: int}
--@return: no return
--@note:
--item_id: id of the item you want to recycle [required]
--amount: amount of the item you want to recycle [required]
--@example:
recycle_item{
item_id = 123,
amount = 200
}
recycle_all_item
This function is used to recycle all items in backpack
:warning: Warning: Please don't forget to drop all important items and don't abuse this function
--@function: recycle_all_item
--@param: no param needed
--@return: no return
--@example:
recycle_all_item()
drop_item
This function is used to drop items in backpack
--@function: drop_item
--@param: {item_id: int, amount: int}
--@return: no return
--@note:
--item_id: id of the item you want to drop [required]
--amount: amount of the item you want to drop[required]
--@example:
drop_item{
item_id = 123,
amount = 200
}
drop_all_item
This function is used to drop all items in backpack
--@function: drop_all_item
--@param: no param needed
--@return: no return
--@example:
drop_all_item()
grind_food
This function is used to grind item using grinder
--@function: grind_food
--@param: {position: string, offset: int, item_id: int, amount: int}
--@return: no return
--@note:
--position: top, bottom, left, right [required]
--offset: int [optional] (default 0)
--@example:
grind_food{
position = "left",
offset = 1,
item_id = 880,
amount = 5
}
auto_suck_bgems
This function is used to auto suck black gems based on the set time
--@function: auto_suck_bgems
--@param: {second: int, minute: int, hour: int}
--@return: no return
--@example:
auto_suck_bgems{
second = 30
}
show_notification
This function is used to display adventure notification and you can edit the icon and sound
--@function: show_notification
--@param: {icon: path, message: str, sound: path}
--@return: no return
--@note:
--icon: Icon to show in notification [optional] (default: interface/large/adventure.rttex)
--message: Message to show in notification [required]
--sound: Sound to play when a notification is shown [optional] (default: audio/gong.wav)
--@example:
show_notification{
icon = "interface/large/adventure.rttex",
message = "Hello Growtopians"
sound = "audio/achievement.wav"
}
:information_source: Info: For windows device, icon and sound path can be found at: %LOCALAPPDATA%/Growtopia (I don't know where files are stored in android 😂 )