Difference between revisions of "Osiris/API/TemporaryCharacterCreateAtTrigger"

From Divinity Engine Wiki
Jump to: navigation, search
m
m (Added failure information)
 
Line 5: Line 5:
 
===== Notes =====
 
===== Notes =====
 
* This does not return the character being created. If you need to reference that character, it is best to [[Osiris/API/GetPosition|query the '''_Trigger''''s position]] and use [[Osiris/API/TemporaryCharacterCreateAtPosition|TemporaryCharacterCreateAtPosition]], which does return the character.
 
* This does not return the character being created. If you need to reference that character, it is best to [[Osiris/API/GetPosition|query the '''_Trigger''''s position]] and use [[Osiris/API/TemporaryCharacterCreateAtPosition|TemporaryCharacterCreateAtPosition]], which does return the character.
 +
* See the information about the return value of [[Osiris/API/CharacterCreateAtPosition|CharacterCreateAtPosition]] for when this call will not do anything.
 
===== See Also =====
 
===== See Also =====
 
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]]
 
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]]

Latest revision as of 11:07, 22 June 2018

Full Definition(s)
  • call CharacterCreateAtTrigger((TRIGGERGUID)_Trigger, (STRING)_TemplateId, (INTEGER)_PlaySpawn)
Description

Creates a temporary character of the root template defined by _TemplateId (in a <root template name>_<root template UUID> format) at the _Trigger. If _PlaySpawn is 1, the creature will play its spawn animation as it appears. A temporary character's corpse is not saved. This call is useful to avoid very large save file sizes if it is used to spawn very large numbers of characters.

Notes
See Also