Difference between revisions of "Osiris/API/CharacterMoveTo"
From Divinity Engine Wiki
(Refer to StoryEvent) |
m |
||
| Line 2: | Line 2: | ||
* call '''CharacterMoveTo'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''', ''(INTEGER)'''''_IncreaseSpeed''') | * call '''CharacterMoveTo'''(''(CHARACTERGUID)'''''_Character''', ''(GUIDSTRING)'''''_Target''', ''(INTEGER)'''''_Running''', ''(STRING)'''''_Event''', ''(INTEGER)'''''_IncreaseSpeed''') | ||
===== Description ===== | ===== Description ===== | ||
| − | + | Causes '''_Character''' to start moving to '''_Target''', either walking or running depending on whether '''_Running''' is '''0''' or '''1'''. Once '''_Character''' has arrived at its destination, the event '''_Event''' will raised for '''_Character'''. If '''_IncreaseSpeed''' is '''1''', '''_Character''' will starting moving increasingly faster the longer it has been moving. | |
===== Notes ===== | ===== Notes ===== | ||
* If '''_Target''' is unreachable, '''_Character''' may teleport there. | * If '''_Target''' is unreachable, '''_Character''' may teleport there. | ||
| Line 14: | Line 14: | ||
* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]] | * Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|CharacterMoveTo]] |
Revision as of 16:16, 19 December 2017
Full Definition(s)
- call CharacterMoveTo((CHARACTERGUID)_Character, (GUIDSTRING)_Target, (INTEGER)_Running, (STRING)_Event, (INTEGER)_IncreaseSpeed)
Description
Causes _Character to start moving to _Target, either walking or running depending on whether _Running is 0 or 1. Once _Character has arrived at its destination, the event _Event will raised for _Character. If _IncreaseSpeed is 1, _Character will starting moving increasingly faster the longer it has been moving.
Notes
- If _Target is unreachable, _Character may teleport there.
- _Character will not participate in combats while it is moving.
- If a player starts a conversation with _Character, _Character will not stop and just keep moving.
- Use ProcCharacterMoveTo to avoid the problems mentioned above and several others, except for not participating in combat.
- Use ProcStateManagerCharacterMoveTo if you also want the character to join combats it encounters on its way.
See Also
- StoryEvent
- Helper ProcCharacterMoveTo
- Helper ProcStateManagerCharacterMoveTo
