Difference between revisions of "Osiris/API/CharacterTeleportPartiesToTriggerWithMovieRequestCallback"
From Divinity Engine Wiki
(Documented CharacterTeleportPartiesToTriggerWithMovieRequestCallback) |
m |
||
| Line 2: | Line 2: | ||
* call '''CharacterTeleportPartiesToTriggerWithMovieRequestCallback'''(''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_Event''') | * call '''CharacterTeleportPartiesToTriggerWithMovieRequestCallback'''(''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_Event''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Prepares to teleport all player characters to '''_Trigger'''. This call will register the trigger internally, and subsequently generate a [[Osiris/API/TeleportRequestMovie|TeleportRequestMovie]] event for each [[Osiris/API/CharacterGetReservedUserID|user]] | + | Prepares to teleport all player characters to '''_Trigger'''. This call will register the trigger internally, and subsequently generate a [[Osiris/API/TeleportRequestMovie|TeleportRequestMovie]] event with name '''_Event''' for each [[Osiris/API/CharacterGetReservedUserID|user]]. Once [[Osiris/API/CharacterSetTeleportMovie|CharacterSetTeleportMovie]] has subsequently been called for every user, all player character will finally be teleported and the requested movies will be played (can be a different movie for each user). Whenever a player character arrives at its destination, a story event with the same '''_Event''' name will be thrown for them. |
This call can be used to move all players to a new level. | This call can be used to move all players to a new level. | ||
Revision as of 00:34, 26 November 2018
Full Definition(s)
- call CharacterTeleportPartiesToTriggerWithMovieRequestCallback((TRIGGERGUID)_Trigger, (STRING)_Event)
Description
Prepares to teleport all player characters to _Trigger. This call will register the trigger internally, and subsequently generate a TeleportRequestMovie event with name _Event for each user. Once CharacterSetTeleportMovie has subsequently been called for every user, all player character will finally be teleported and the requested movies will be played (can be a different movie for each user). Whenever a player character arrives at its destination, a story event with the same _Event name will be thrown for them.
This call can be used to move all players to a new level.
Notes
- _Trigger must be global if it is located in a different level.
- Use TeleportTo if you want to teleport individual characters.
- This call is not used in the DOS2 main campaign. It was added because at some point we planned to show a different movie for each origin character between the Tutorial level and Fort Joy.
