Osiris/API/CharacterMoveTo: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
(Osiris Core APIs)
 
mNo edit summary
 
(7 intermediate revisions by 2 users not shown)
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.
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 be 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.
* See the notes of [[Osiris/API/CharacterMoveToPosition|CharacterMoveToPosition]] for usage details.
* '''_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 =====
===== See Also =====
* Helper [[Osiris/Shared/ProcCharacterMoveTo]]
* [[Osiris/API/CharacterFlushQueue|CharacterFlushQueue]]
* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo]]
* [[Osiris/API/CharacterLookFromTrigger|CharacterLookFromTrigger]]
* [[Osiris/API/CharacterMoveToPosition|CharacterMoveToPosition]]
[[Category:Osiris Calls]]
* [[Osiris/API/CharacterPurgeQueue|CharacterPurgeQueue]]
* [[Osiris/API/ItemMoveToTrigger|ItemMoveToTrigger]]
* [[Osiris/API/StoryEvent|StoryEvent]]
* [[Osiris/API/TeleportTo|TeleportTo]]
* Helper [[Osiris/Shared/ProcCharacterMoveTo|ProcCharacterMoveTo]]
* Helper [[Osiris/Shared/ProcStateManagerCharacterMoveTo|ProcStateManagerCharacterMoveTo]]
 
[[Category:Osiris Calls|CharacterMoveTo]]

Latest revision as of 13:46, 1 July 2018

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 be raised for _Character. If _IncreaseSpeed is 1, _Character will starting moving increasingly faster the longer it has been moving.

Notes
See Also
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/CharacterMoveTo&oldid=5962"