Scrifen -- Hafen scripting API

[b0r3d0m]

Update!

A lot of new API functions and events were added:

- takeItem(itemName) function
- onUserInput(input) event
- waitForPf() function
- Equipory functions:
* getEquippedItems()
* equipItem(itemName)
* unequipItem(itemName)
- Chat functions and event:
* sendAreaChatMessage(msg)
* sendPartyChatMessage(msg)
* sendVillageChatMessage(msg)
* sendPrivateChatMessage(to, msg)
* onChatMessage(chat, from, msg)

[algorithm]

Update!

A lot of new API functions and events were added:

- takeItem(itemName) function
- onUserInput(input) event
- waitForPf() function
- Equipory functions:
* getEquippedItems()
* equipItem(itemName)
* unequipItem(itemName)
- Chat functions and event:
* sendAreaChatMessage(msg)
* sendPartyChatMessage(msg)
* sendVillageChatMessage(msg)
* sendPrivateChatMessage(to, msg)
* onChatMessage(chat, from, msg)

Great!! Thanks a lot for a good job!

[Thedrah]

is it possible to log out using this?

so to make a script that would log in to multiple characters to load curios. or to perform multiple functions such as a hunter and a butcher

edit: found out after reading through some hehe
how would a character pick up/lift an object using this?

[b0r3d0m]

is it possible to log out using this?

Yep, see the `logout` function.

how would a character pick up/lift an object using this?

You can pick items like dandelions and blueberries via the `pickItem` function.
It's not possible to lift objects at the moment, I will think about it.

[b0r3d0m]

lift an object using this?

Added. See `liftObject` and `mapRightClick` functions to lift and place it correspondingly.

[b0r3d0m]

Update is available.

The following API methods were added:

- getHP()
- getSpeed()
- setSpeed(speed)
- useMenuAction(hotkeys)
- craft(itemName)
- craftAll(itemName)

[b0r3d0m]

Update is available.

New API methods were added:
- chooseFlowerMenuOption
- dropItem
- dropItemFromHand
- useItemFromHandOnObject

Fixed invalid `takeItem` function's return value and added additional checks to it.

I also changed flower menu interaction to fix a crash (you should call the `chooseFlowerMenuOption` function instead of returning an option name from the `onFlowerMenuOpen` hook now).

[stya]

If I get a 'canPathTo' and 'getBarrel(contentType)' I will start using it

For the barrel thing you just have to check the Overlay, but I guess you guys know that already

Edit: also a 'isTileFree' or something in the same vein.

[b0r3d0m]

getBarrel(contentType)

Added. See the `getBarrelContent` function.

[b0r3d0m]

Update is available:

• New API functions added -- getMapObjectsByFullName, getBarrelLiters and getGrowthStage
• New fullName property added to the map objects returned from the getMapObjects, getMapObjectsByFullName and getAllMapObjects functions