Difference between revisions of "Osiris/API/TemporaryCharacterCreateAtTrigger"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * call '''CharacterCreateAtTrigger'''(''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_TemplateId''', ''(INTEGER)'''''_PlaySpawn''') ===== Descr...") |
m (Added failure information) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
* call '''CharacterCreateAtTrigger'''(''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_TemplateId''', ''(INTEGER)'''''_PlaySpawn''') | * call '''CharacterCreateAtTrigger'''(''(TRIGGERGUID)'''''_Trigger''', ''(STRING)'''''_TemplateId''', ''(INTEGER)'''''_PlaySpawn''') | ||
===== Description ===== | ===== 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 | + | 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 ===== | ===== 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]] | ||
* [[Osiris/API/CharacterCreateAtTrigger|CharacterCreateAtTrigger]] | * [[Osiris/API/CharacterCreateAtTrigger|CharacterCreateAtTrigger]] | ||
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
- This does not return the character being created. If you need to reference that character, it is best to query the _Trigger's position and use TemporaryCharacterCreateAtPosition, which does return the character.
- See the information about the return value of CharacterCreateAtPosition for when this call will not do anything.
See Also
- CharacterAppearAt
- CharacterCreateAtTrigger
- CharacterCreateAtPosition
- TemporaryCharacterCreateAtPosition
- CharacterCreateAtPositionOutOfSightTo
- TemporaryCharacterCreateAtPositionOutOfSightTo
- CharacterAppearAtCustom
- CharacterAppearAtPosition
- CharacterAppearAtPositionCustom
- CharacterAppearAtPositionOutOfSightTo
- CharacterAppearAtPositionOutOfSightToCustom
- CharacterAppearAtPositionOutOfSightToObject
- CharacterAppearAtPositionOutOfSightToObjectCustom
- CharacterAppearCustom
- CharacterAppearOnTrailOutOfSightTo
- CharacterAppearOnTrailOutOfSightToCustom
- CharacterAppearOnTrailOutOfSightToObject
- CharacterAppearOnTrailOutOfSightToObjectCustom
- CharacterAppearOutOfSightTo
- CharacterAppearOutOfSightToCustom
- CharacterAppearOutOfSightToObject
- CharacterAppearOutOfSightToObjectCustom
- SetOnStage
