Difference between revisions of "Osiris/API/CharacterAppear"

From Divinity Engine Wiki
Jump to: navigation, search
(Osiris Core APIs)
 
m
 
(7 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
* call '''CharacterAppear'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_PlaySpawn''', ''(STRING)'''''_Event''')
 
* call '''CharacterAppear'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_PlaySpawn''', ''(STRING)'''''_Event''')
 
===== Description =====
 
===== Description =====
  '''_Character''', which can currently be off-stage, appears at its current position. If '''_PlaySpawn''' is 1, the character-specific spawn animation is played. Once the character has appeared on stage (and finished playing its spawning animation if requested), '''_Event''' is raised for '''_Character'''.
+
'''_Character''', which can currently be off-stage, appears at its current position. If '''_PlaySpawn''' is 1, the character-specific spawn animation is played. Once the character has appeared on stage (and finished playing its spawning animation if requested), '''_Event''' is raised for '''_Character'''.
 
===== Notes =====
 
===== Notes =====
* This routine does '''not''' work if '''_Character''' is dead. Use '''SetOnStage''' instead for such characters.
+
* This routine does '''not''' work if '''_Character''' is dead. Use [[Osiris/API/SetOnStage|SetOnStage]] instead for such characters.
* Tip: set a character off-stage and teleport it to its desired position before calling this routine.
+
* Tip: set a character off-stage and teleport it to its desired position before calling this routine, or use [[Osiris/API/CharacterAppearAt|CharacterAppearAt]] instead.
 
===== See Also =====
 
===== See Also =====
* [[Osiris/API/CharacterAppearOnTrailOutOfSightTo]]
+
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]]
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObject]]
+
* [[Osiris/API/CharacterAppearAtCustom|CharacterAppearAtCustom]]
* [[Osiris/API/CharacterAppearOutOfSightTo]]
+
* [[Osiris/API/CharacterAppearAtPosition|CharacterAppearAtPosition]]
* [[Osiris/API/CharacterAppearOutOfSightToObject]]
+
* [[Osiris/API/CharacterAppearAtPositionCustom|CharacterAppearAtPositionCustom]]
+
* [[Osiris/API/CharacterAppearAtPositionOutOfSightTo|CharacterAppearAtPositionOutOfSightTo]]
[[Category:Osiris Calls]]
+
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToCustom|CharacterAppearAtPositionOutOfSightToCustom]]
 +
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObject|CharacterAppearAtPositionOutOfSightToObject]]
 +
* [[Osiris/API/CharacterAppearAtPositionOutOfSightToObjectCustom|CharacterAppearAtPositionOutOfSightToObjectCustom]]
 +
* [[Osiris/API/CharacterAppearCustom|CharacterAppearCustom]]
 +
* [[Osiris/API/CharacterAppearOnTrailOutOfSightTo|CharacterAppearOnTrailOutOfSightTo]]
 +
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToCustom|CharacterAppearOnTrailOutOfSightToCustom]]
 +
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObject|CharacterAppearOnTrailOutOfSightToObject]]
 +
* [[Osiris/API/CharacterAppearOnTrailOutOfSightToObjectCustom|CharacterAppearOnTrailOutOfSightToObjectCustom]]
 +
* [[Osiris/API/CharacterAppearOutOfSightTo|CharacterAppearOutOfSightTo]]
 +
* [[Osiris/API/CharacterAppearOutOfSightToCustom|CharacterAppearOutOfSightToCustom]]
 +
* [[Osiris/API/CharacterAppearOutOfSightToObject|CharacterAppearOutOfSightToObject]]
 +
* [[Osiris/API/CharacterAppearOutOfSightToObjectCustom|CharacterAppearOutOfSightToObjectCustom]]
 +
* [[Osiris/API/SetOnStage|SetOnStage]]
 +
* [[Osiris/API/StoryEvent|StoryEvent]]
 +
 
 +
[[Category:Osiris Calls|CharacterAppear]]

Latest revision as of 16:05, 19 December 2017

Full Definition(s)
  • call CharacterAppear((CHARACTERGUID)_Character, (INTEGER)_PlaySpawn, (STRING)_Event)
Description

_Character, which can currently be off-stage, appears at its current position. If _PlaySpawn is 1, the character-specific spawn animation is played. Once the character has appeared on stage (and finished playing its spawning animation if requested), _Event is raised for _Character.

Notes
  • This routine does not work if _Character is dead. Use SetOnStage instead for such characters.
  • Tip: set a character off-stage and teleport it to its desired position before calling this routine, or use CharacterAppearAt instead.
See Also