Difference between revisions of "Osiris/API/TemporaryCharacterCreateAtPosition"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * query '''TemporaryCharacterCreateAtPosition'''('''''[in]'''(REAL)'''''_X''', '''''[in]'''(REAL)'''''_Y''', '''''[in]'''(REAL)'''''_Z''', '''''...") |
m (Expanded failure information) |
||
| (2 intermediate revisions by one other user not shown) | |||
| 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 | + | * '''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 ===== | ||
*/ | */ | ||
===== See Also ===== | ===== See Also ===== | ||
| − | |||
* [[Osiris/API/CharacterAppearAt|CharacterAppearAt]] | * [[Osiris/API/CharacterAppearAt|CharacterAppearAt]] | ||
* [[Osiris/API/CharacterCreateAtTrigger|CharacterCreateAtTrigger]] | * [[Osiris/API/CharacterCreateAtTrigger|CharacterCreateAtTrigger]] | ||
Latest revision as of 11:08, 22 June 2018
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 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
- CharacterAppearAt
- CharacterCreateAtTrigger
- TemporaryCharacterCreateAtTrigger
- CharacterCreateAtPosition
- CharacterCreateAtPositionOutOfSightTo
- TemporaryCharacterCreateAtPositionOutOfSightTo
- CharacterAppearAtCustom
- CharacterAppearAtPosition
- CharacterAppearAtPositionCustom
- CharacterAppearAtPositionOutOfSightTo
- CharacterAppearAtPositionOutOfSightToCustom
- CharacterAppearAtPositionOutOfSightToObject
- CharacterAppearAtPositionOutOfSightToObjectCustom
- CharacterAppearCustom
- CharacterAppearOnTrailOutOfSightTo
- CharacterAppearOnTrailOutOfSightToCustom
- CharacterAppearOnTrailOutOfSightToObject
- CharacterAppearOnTrailOutOfSightToObjectCustom
- CharacterAppearOutOfSightTo
- CharacterAppearOutOfSightToCustom
- CharacterAppearOutOfSightToObject
- CharacterAppearOutOfSightToObjectCustom
- SetOnStage
