Difference between revisions of "Osiris/API/TemporaryCharacterCreateAtPositionOutOfSightTo"

From Divinity Engine Wiki
Jump to: navigation, search
(Created page with "===== Full Definition(s) ===== * query '''TemporaryCharacterCreateAtPositionOutOfSightTo'''('''''[in]'''(REAL)'''''_X''', '''''[in]'''(REAL)'''''_Y''', '''''[in]'''(REAL)'''''...")
 
m (Expanded failure information)
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
 
* query '''TemporaryCharacterCreateAtPositionOutOfSightTo'''('''''[in]'''(REAL)'''''_X''', '''''[in]'''(REAL)'''''_Y''', '''''[in]'''(REAL)'''''_Z''', '''''[in]'''(STRING)'''''_TemplateId''', '''''[in]'''(INTEGER)'''''_PlaySpawn''', '''''[in]'''(STRING)'''''_Event''', '''''[out]'''(CHARACTERGUID)'''''_Created''')
 
* query '''TemporaryCharacterCreateAtPositionOutOfSightTo'''('''''[in]'''(REAL)'''''_X''', '''''[in]'''(REAL)'''''_Y''', '''''[in]'''(REAL)'''''_Z''', '''''[in]'''(STRING)'''''_TemplateId''', '''''[in]'''(INTEGER)'''''_PlaySpawn''', '''''[in]'''(STRING)'''''_Event''', '''''[out]'''(CHARACTERGUID)'''''_Created''')
 
===== Description =====
 
===== Description =====
−
Creates a temporary character of the root template defined by '''_TemplateId''' (in a <root template name>_<root template UUID> format) at the nearest position to the coordinates given by '''_X''', '''_Y''', '''_Z''' which is out of sight for all players. The character is returned as '''_Created''', and '''_Event''' is thrown when it appears. 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 amounts of characters.
+
Creates a temporary character of the root template defined by '''_TemplateId''' (in a <root template name>_<root template UUID> format) at the nearest position to the coordinates given by '''_X''', '''_Y''', '''_Z''' which is out of sight for all players. The character is returned as '''_Created''', and '''_Event''' is thrown when it appears. 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.
 
===== Return Values =====
 
===== Return Values =====
−
* '''Success/Failure''': Fails if '''_TemplateID''' is not a character or does not exist.
+
* '''Success/Failure''': Fails if '''_TemplateID''' is not a character template, does not exist, or if the template is not a ghost template and no valid AI-grid position can be found within 5 metres of the specified position.
 
* '''_Created''': The character created.
 
* '''_Created''': The character created.
 
===== Notes =====
 
===== Notes =====

Latest revision as of 12:08, 22 June 2018

Full Definition(s)
  • query TemporaryCharacterCreateAtPositionOutOfSightTo([in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [in](STRING)_TemplateId, [in](INTEGER)_PlaySpawn, [in](STRING)_Event, [out](CHARACTERGUID)_Created)
Description

Creates a temporary character of the root template defined by _TemplateId (in a <root template name>_<root template UUID> format) at the nearest position to the coordinates given by _X, _Y, _Z which is out of sight for all players. The character is returned as _Created, and _Event is thrown when it appears. 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.

Return Values
  • Success/Failure: Fails if _TemplateID is not a character template, does not exist, or if the template is not a ghost template and no valid AI-grid position can be found within 5 metres of the specified position.
  • _Created: The character created.
Notes
  • /
See Also
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/TemporaryCharacterCreateAtPositionOutOfSightTo&oldid=5937"