Osiris/Shared/DB WaypointInfo - Revision history

Tinkerer at 14:57, 19 December 2017

2017-12-19T14:57:10Z

← Older revision		Revision as of 14:57, 19 December 2017
Line 14:		Line 14:
	* [[Osiris/API/SetHomesteadKeyState\|SetHomesteadKeyState]]		* [[Osiris/API/SetHomesteadKeyState\|SetHomesteadKeyState]]

	[[Category:Osiris Shared Mod Helpers]]		[[Category:Osiris Shared Mod Helpers\|WaypointInfo]]

Tinkerer at 20:40, 29 October 2017

2017-10-29T20:40:43Z

← Older revision		Revision as of 20:40, 29 October 2017
Line 7:		Line 7:
	* If you assign the '''''WaypointShrine''''' item script to '''_Item''', then when a player get near it the associated waypoint will automatically be [[Osiris/API/UnlockWaypoint\|unlocked]] for that player and every one else in their party.		* If you assign the '''''WaypointShrine''''' item script to '''_Item''', then when a player get near it the associated waypoint will automatically be [[Osiris/API/UnlockWaypoint\|unlocked]] for that player and every one else in their party.
	* If you add "Send a use event to Osiris" to the "Use Actions" in the [[Sidebar\|sidebar]] of '''_Item''', then when a player clicks on '''_Item''', the waypoint menu will open.		* If you add "Send a use event to Osiris" to the "Use Actions" in the [[Sidebar\|sidebar]] of '''_Item''', then when a player clicks on '''_Item''', the waypoint menu will open.
	* Unlocking a waypoint this way does not automatically enable the anchor/waypoint travel button near the minimap, unless your mod depends on the main campaign. To enable it manually, see [[Osiris/API/SetHomesteadKeyState\|SetHomesteadKeyState]]		* Unlocking a waypoint this way does not automatically enable the anchor/waypoint travel button near the minimap, unless your mod depends on the main campaign. To enable it manually, see [[Osiris/API/SetHomesteadKeyState\|SetHomesteadKeyState]].
	===== See Also =====		===== See Also =====
	* [[Osiris/API/LockWaypoint\|LockWaypoint]]		* [[Osiris/API/LockWaypoint\|LockWaypoint]]

Tinkerer at 20:40, 29 October 2017

2017-10-29T20:40:12Z

← Older revision		Revision as of 20:40, 29 October 2017
Line 5:		Line 5:
	===== Notes =====		===== Notes =====
	* '''_Item''' and '''_Trigger''' must be global, because players can teleport to a waypoint from a different level in which the waypoint is located.		* '''_Item''' and '''_Trigger''' must be global, because players can teleport to a waypoint from a different level in which the waypoint is located.
	* If you assign the '''''WaypointShrine''' item script to '''_Item''', then when a player get near it the associated waypoint will automatically be [[Osiris/API/UnlockWaypoint\|unlocked]] for that player and every one else in their party.		* If you assign the '''''WaypointShrine''''' item script to '''_Item''', then when a player get near it the associated waypoint will automatically be [[Osiris/API/UnlockWaypoint\|unlocked]] for that player and every one else in their party.
	* If you add "Send a use event to Osiris" to the "Use Actions" in the [[Sidebar\|sidebar]] of '''_Item''', then when a player clicks on '''_Item''', the waypoint menu will open.		* If you add "Send a use event to Osiris" to the "Use Actions" in the [[Sidebar\|sidebar]] of '''_Item''', then when a player clicks on '''_Item''', the waypoint menu will open.
	* Unlocking a waypoint this way does not automatically enable the anchor/waypoint travel button near the minimap, unless your mod depends on the main campaign. To enable it manually, see [[Osiris/API/SetHomesteadKeyState\|SetHomesteadKeyState]]		* Unlocking a waypoint this way does not automatically enable the anchor/waypoint travel button near the minimap, unless your mod depends on the main campaign. To enable it manually, see [[Osiris/API/SetHomesteadKeyState\|SetHomesteadKeyState]]

Tinkerer: Documented DB_WaypointInfo

2017-10-28T21:09:12Z

Documented DB_WaypointInfo

New page

===== Full Definition(s) =====
* '''DB_WaypointInfo'''(''(ITEMGUID)'''''_Item''', ''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_WaypointName''')
===== Description =====
Defines that '''_Item''' must be [[Osiris/API/RegisterWaypoint|registered as a waypoint]]. Its name, as it appears in the waypoint list, is the value of the [[Translated_string_key_editor|translated string]] with '''_WaypointName''' as key. When a player chooses to go to this waypoint via the waypoint menu, they will be teleported to '''_Trigger'''.
===== Notes =====
* '''_Item''' and '''_Trigger''' must be global, because players can teleport to a waypoint from a different level in which the waypoint is located.
* If you assign the '''''WaypointShrine''' item script to '''_Item''', then when a player get near it the associated waypoint will automatically be [[Osiris/API/UnlockWaypoint|unlocked]] for that player and every one else in their party.
* If you add "Send a use event to Osiris" to the "Use Actions" in the [[Sidebar|sidebar]] of '''_Item''', then when a player clicks on '''_Item''', the waypoint menu will open.
* Unlocking a waypoint this way does not automatically enable the anchor/waypoint travel button near the minimap, unless your mod depends on the main campaign. To enable it manually, see [[Osiris/API/SetHomesteadKeyState|SetHomesteadKeyState]]
===== See Also =====
* [[Osiris/API/LockWaypoint|LockWaypoint]]
* [[Osiris/API/UnlockWaypoint|UnlockWaypoint]]
* [[Osiris/API/RegisterWaypoint|RegisterWaypoint]]
* [[Osiris/API/SetHomesteadKeyState|SetHomesteadKeyState]]

[[Category:Osiris Shared Mod Helpers]]