Difference between revisions of "Osiris/API/Transform"
From Divinity Engine Wiki
(Osiris Core APIs) |
m |
||
Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
− | * call '''Transform'''(''((GUIDSTRING)'''''_Object''','' (STRING)'''''_ObjectTemplate''','' (INTEGER)'''''_ReplaceScripts''','' (INTEGER)'''''_ReplaceScale''') | + | * call '''Transform'''(''((GUIDSTRING)'''''_Object''',''(STRING)'''''_ObjectTemplate''',''(INTEGER)'''''_ReplaceScripts''',''(INTEGER)'''''_ReplaceScale''',''(INTEGER)'''''_ReplaceStats''') |
===== Description ===== | ===== Description ===== | ||
− | Transforms '''_Object''' into the root template '''_ObjectTemplate'''. In particular, a.o. the visual and physics resources will be replaced, as well as the VisualSetIndices. | + | Transforms '''_Object''' into the root template '''_ObjectTemplate'''. In particular, a.o. the visual and physics resources will be replaced, as well as the VisualSetIndices. |
+ | |||
+ | Other parameters allow you to customise whether certain properties of '''_Object''' should be replaced by the values of their corresponding on '''_ObjectTemplate''': | ||
+ | * '''_ReplaceScripts''': indicates whether the assigned behaviour scripts should be replaced. | ||
+ | * '''_ReplaceScale''': indicates whether the current scale of the object should be replaced. | ||
+ | * '''_ReplaceStats''': indicates whether the Stats should be replaced. | ||
===== Notes ===== | ===== Notes ===== | ||
* Transforming an object more than once is not supported. It may (seem to) work, but the result is undefined. | * Transforming an object more than once is not supported. It may (seem to) work, but the result is undefined. |
Revision as of 21:19, 25 August 2017
Full Definition(s)
- call Transform(((GUIDSTRING)_Object,(STRING)_ObjectTemplate,(INTEGER)_ReplaceScripts,(INTEGER)_ReplaceScale,(INTEGER)_ReplaceStats)
Description
Transforms _Object into the root template _ObjectTemplate. In particular, a.o. the visual and physics resources will be replaced, as well as the VisualSetIndices.
Other parameters allow you to customise whether certain properties of _Object should be replaced by the values of their corresponding on _ObjectTemplate:
- _ReplaceScripts: indicates whether the assigned behaviour scripts should be replaced.
- _ReplaceScale: indicates whether the current scale of the object should be replaced.
- _ReplaceStats: indicates whether the Stats should be replaced.
Notes
- Transforming an object more than once is not supported. It may (seem to) work, but the result is undefined.
See Also
- /