Difference between revisions of "Osiris/API/TemporaryCharacterCreateAtPosition"
From Divinity Engine Wiki
| Line 2: | Line 2: | ||
* query '''TemporaryCharacterCreateAtPosition'''('''''[in]'''(REAL)'''''_X''', '''''[in]'''(REAL)'''''_Y''', '''''[in]'''(REAL)'''''_Z''', '''''[in]'''(STRING)'''''_TemplateId''', '''''[in]'''(INTEGER)'''''_PlaySpawn''', '''''[out]'''(CHARACTERGUID)'''''_Created''') | * query '''TemporaryCharacterCreateAtPosition'''('''''[in]'''(REAL)'''''_X''', '''''[in]'''(REAL)'''''_Y''', '''''[in]'''(REAL)'''''_Z''', '''''[in]'''(STRING)'''''_TemplateId''', '''''[in]'''(INTEGER)'''''_PlaySpawn''', '''''[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 coordinates given by '''_X''', '''_Y''', '''_Z''', and returns it as '''_Created'''. 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 | + | Creates a temporary character of the root template defined by '''_TemplateId''' (in a <root template name>_<root template UUID> format) at the coordinates given by '''_X''', '''_Y''', '''_Z''', and returns it as '''_Created'''. 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 or does not exist. | ||
Revision as of 11:57, 20 December 2017
Full Definition(s)
- query TemporaryCharacterCreateAtPosition([in](REAL)_X, [in](REAL)_Y, [in](REAL)_Z, [in](STRING)_TemplateId, [in](INTEGER)_PlaySpawn, [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 coordinates given by _X, _Y, _Z, and returns it as _Created. 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 or does not exist.
- _Created: The character created.
Notes
- /
See Also
- CharacterAppearAt
- CharacterCreateAtTrigger
- TemporaryCharacterCreateAtTrigger
- CharacterCreateAtPosition
- CharacterCreateAtPositionOutOfSightTo
- TemporaryCharacterCreateAtPositionOutOfSightTo
- CharacterAppearAtCustom
- CharacterAppearAtPosition
- CharacterAppearAtPositionCustom
- CharacterAppearAtPositionOutOfSightTo
- CharacterAppearAtPositionOutOfSightToCustom
- CharacterAppearAtPositionOutOfSightToObject
- CharacterAppearAtPositionOutOfSightToObjectCustom
- CharacterAppearCustom
- CharacterAppearOnTrailOutOfSightTo
- CharacterAppearOnTrailOutOfSightToCustom
- CharacterAppearOnTrailOutOfSightToObject
- CharacterAppearOnTrailOutOfSightToObjectCustom
- CharacterAppearOutOfSightTo
- CharacterAppearOutOfSightToCustom
- CharacterAppearOutOfSightToObject
- CharacterAppearOutOfSightToObjectCustom
- SetOnStage
