Difference between revisions of "Osiris/Shared/PROC LoopEffect"
From Divinity Engine Wiki
(Created page with "===== Full Definition(s) ===== * PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_FXHandle''', ''(STRING)'''''_Region''', '...") |
|||
| Line 1: | Line 1: | ||
===== Full Definition(s) ===== | ===== Full Definition(s) ===== | ||
| − | * PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)''''' | + | * PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_ID''', ''(STRING)'''''_Region''', ''(STRING)'''''_BoneName''') |
===== Description ===== | ===== Description ===== | ||
| Line 7: | Line 7: | ||
The effect will only be played if the player is in the level '''_Region'''. If the effect should be played in any region (e.g. cause the loop effect is attached to the player itself), the region must be set to '''"__ANY__"'''. | The effect will only be played if the player is in the level '''_Region'''. If the effect should be played in any region (e.g. cause the loop effect is attached to the player itself), the region must be set to '''"__ANY__"'''. | ||
| − | The ''' | + | The '''_ID''' is used to stop the loop effect through [[Osiris/Shared/PROC_StopLoopEffect|PROC_StopLoopEffect]]. |
===== Notes ===== | ===== Notes ===== | ||
| Line 14: | Line 14: | ||
===== See Also ===== | ===== See Also ===== | ||
* [[Osiris/API/PlayLoopEffect|PlayLoopEffect]] | * [[Osiris/API/PlayLoopEffect|PlayLoopEffect]] | ||
| − | * [[Osiris/Shared/ | + | * [[Osiris/Shared/PROC_StopLoopEffect|PROC_StopLoopEffect]] |
| − | [[Category:Osiris Shared Mod Helpers| | + | [[Category:Osiris Shared Mod Helpers|PROC_LoopEffect]] |
Revision as of 23:19, 9 July 2018
Full Definition(s)
- PROC PROC_LoopEffect((STRING)_Effect, (GUIDSTRING)_Source, (STRING)_ID, (STRING)_Region, (STRING)_BoneName)
Description
Plays the looping effect _Effect on the bone _BoneName of _Source. If _BoneName is set to an empty string, the loop effect will be attached to the root of _Source.
The effect will only be played if the player is in the level _Region. If the effect should be played in any region (e.g. cause the loop effect is attached to the player itself), the region must be set to "__ANY__".
The _ID is used to stop the loop effect through PROC_StopLoopEffect.
Notes
- This is a wrapper around the Osiris call PlayLoopEffect. It takes care of starting/stopping loop effects when entering or leaving regions.
