Difference between revisions of "Osiris/Shared/ProcCharacterMoveTo"
From Divinity Engine Wiki
m |
m |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''',''(GUIDSTRING)'''''_Point''',''(INTEGER)'''''_Running''',''(STRING)'''''_Event''') | + | * PROC '''ProcCharacterMoveTo'''(''(CHARACTERGUID)'''''_Char''', ''(GUIDSTRING)'''''_Point''', ''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''') |
===== Description ===== | ===== Description ===== | ||
| − | This is a wrapper around the | + | This is a wrapper around the [[Osiris/API/CharacterMoveTo|CharacterMoveTo]] API call that takes care of interactions with various other behaviours. A.o., |
| − | |||
* It disables all dialogs while the character is moving. | * It disables all dialogs while the character is moving. | ||
* It disables all reactions to crimes while the character is moving. | * It disables all reactions to crimes while the character is moving. | ||
| Line 10: | Line 9: | ||
* / | * / | ||
===== Notes ===== | ===== Notes ===== | ||
| − | * If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ | + | * If you wish to abort a move initiated this way, in addition to calling [[Osiris/API/CharacterPurgeQueue|CharacterPurgeQueue]], you also have to call [[Osiris/Shared/ProcClearStoryMove|ProcClearStoryMove]]. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment. |
| − | * Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo|CharacterMoveTo]] | + | * Preferably always use this routine or [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]] instead of [[Osiris/API/CharacterMoveTo|CharacterMoveTo]]. |
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/CharacterMoveTo|CharacterMoveTo]] | * [[Osiris/API/CharacterMoveTo|CharacterMoveTo]] | ||
| + | * Helper [[Osiris/Shared/ProcClearStoryMove|ProcClearStoryMove]] | ||
* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]] | * Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]] | ||
| − | [[Category:Osiris Shared Mod Helpers]] | + | [[Category:Osiris Shared Mod Helpers|CharacterMoveTo]] |
Latest revision as of 14:42, 21 February 2018
Full Definition(s)
- PROC ProcCharacterMoveTo((CHARACTERGUID)_Char, (GUIDSTRING)_Point, (INTEGER)_Running, (STRING)_Event)
Description
This is a wrapper around the CharacterMoveTo API call that takes care of interactions with various other behaviours. A.o.,
- It disables all dialogs while the character is moving.
- It disables all reactions to crimes while the character is moving.
- If the move is interrupted in one way or another, the character will resume moving after the interruption
Return Values
- /
Notes
- If you wish to abort a move initiated this way, in addition to calling CharacterPurgeQueue, you also have to call ProcClearStoryMove. This will restore all of the suspended behaviours and prevent the resumption of the movement at a later moment.
- Preferably always use this routine or ProcStateManagerCharacterMoveTo instead of CharacterMoveTo.
See Also
- CharacterMoveTo
- Helper ProcClearStoryMove
- Helper ProcStateManagerCharacterMoveTo
