Osiris/API/EnableSendToHomestead: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
(Document EnableSendToHomestead)
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
Depending on whether '''_Bool''' is 1 or 0, enables or disables sending items to the homestead chest for '''_Character''' by right-clicking on items in their inventory.
Depending on whether '''_Bool''' is 1 or 0, enables or disables sending items to the homestead chest for '''_Character''' by right-clicking on items in their inventory.
===== Notes =====
===== Notes =====
* When the waypoint shrine button is [[Osiris/API/CharacterEnableWaypointUsage|disabled]], this functionality will not work either regardless of whether it is enabled or not.
* When a player sends an item to the homestead, an [[Osiris/API/ItemSendToHomesteadEvent|ItemSendToHomesteadEvent]] is thrown.
* When a player sends an item to the homestead check, an [[Osiris/API/ItemSendToHomesteadEvent|ItemSendToHomesteadEvent]] is thrown.
* See the DivinityOrigins goal ''GLO_LVHub_PlayerChests'' for how this functionality is used in the main game.
* See the DivinityOrigins goal ''GLO_LVHub_PlayerChests'' for how this functionality is used in the main game.
===== See Also =====
===== See Also =====
Line 11: Line 10:
* [[Osiris/API/ItemSendToHomesteadEvent|ItemSendToHomesteadEvent]]
* [[Osiris/API/ItemSendToHomesteadEvent|ItemSendToHomesteadEvent]]


[[Category:Osiris Calls]]
[[Category:Osiris Calls|EnableSendToHomestead]]

Latest revision as of 15:20, 19 December 2017

Full Definition(s)
  • call EnableSendToHomestead((CHARACTERGUID)_Character, (INTEGER)_Bool)
Description

Depending on whether _Bool is 1 or 0, enables or disables sending items to the homestead chest for _Character by right-clicking on items in their inventory.

Notes
  • When a player sends an item to the homestead, an ItemSendToHomesteadEvent is thrown.
  • See the DivinityOrigins goal GLO_LVHub_PlayerChests for how this functionality is used in the main game.
See Also