Difference between revisions of "Osiris/Shared/DB WaypointInfo"
From Divinity Engine Wiki
(Documented DB_WaypointInfo) |
m |
||
| (2 intermediate revisions by the same user not shown) | |||
| 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]]. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/LockWaypoint|LockWaypoint]] | * [[Osiris/API/LockWaypoint|LockWaypoint]] | ||
| Line 14: | Line 14: | ||
* [[Osiris/API/SetHomesteadKeyState|SetHomesteadKeyState]] | * [[Osiris/API/SetHomesteadKeyState|SetHomesteadKeyState]] | ||
| − | [[Category:Osiris Shared Mod Helpers]] | + | [[Category:Osiris Shared Mod Helpers|WaypointInfo]] |
Latest revision as of 16:57, 19 December 2017
Full Definition(s)
- DB_WaypointInfo((ITEMGUID)_Item, (TRIGGERGUID)_Trigger, (STRING)_WaypointName)
Description
Defines that _Item must be registered as a waypoint. Its name, as it appears in the waypoint list, is the value of the 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 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 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 SetHomesteadKeyState.
