Difference between revisions of "Osiris/API/EnableSendToHomestead"

From Divinity Engine Wiki
Jump to: navigation, search
(Document EnableSendToHomestead)
 
m (fixes)
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 =====

Revision as of 19:46, 20 September 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