Osiris/Shared/PROC LoopEffect - Revision history

Tinkerer at 20:49, 20 February 2019

2019-02-20T20:49:07Z

← Older revision		Revision as of 20:49, 20 February 2019
Line 10:		Line 10:

	===== Notes =====		===== Notes =====
	* This is a wrapper around the Osiris call [[Osiris/API/PlayLoopEffect\|PlayLoopEffect]]. It takes care of starting/stopping loop effects when entering or leaving regions.		* This is a wrapper around the Osiris call [[Osiris/API/PlayLoopEffect\|PlayLoopEffect]]. It takes care of starting/stopping loop effects when entering or leaving regions, and when saving/loading games (ongoing looping effects are not saved/restored by the game engine).

	===== See Also =====		===== See Also =====

DerCapac at 22:23, 9 July 2018

2018-07-09T22:23:31Z

← Older revision		Revision as of 22:23, 9 July 2018
Line 16:		Line 16:
	* [[Osiris/Shared/PROC_StopLoopEffect\|PROC_StopLoopEffect]]		* [[Osiris/Shared/PROC_StopLoopEffect\|PROC_StopLoopEffect]]

	[[Category:Osiris Shared Mod Helpers\|~~PROC_LoopEffect~~]]		[[Category:Osiris Shared Mod Helpers\|LoopEffect]]

DerCapac at 22:19, 9 July 2018

2018-07-09T22:19:38Z

← Older revision		Revision as of 22:19, 9 July 2018
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''~~_FXHandle~~''', ''(STRING)'''''_Region''', ''(STRING)'''''_BoneName''')		* 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 '''~~_FXHandle~~''' is used to stop the loop effect through [[Osiris/Shared/~~ProcStopLoopEffect~~\|~~ProcStopLoopEffect~~]].		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/~~ProcStopLoopEffect~~\|~~ProcStopLoopEffect~~]]		* [[Osiris/Shared/PROC_StopLoopEffect\|PROC_StopLoopEffect]]

	[[Category:Osiris Shared Mod Helpers\|~~ProcCharacterMoveToAndTalk~~]]		[[Category:Osiris Shared Mod Helpers\|PROC_LoopEffect]]

DerCapac: Created page with "===== Full Definition(s) ===== * PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_FXHandle''', ''(STRING)'''''_Region''', '..."

2018-07-09T22:16:34Z

Created page with "===== Full Definition(s) ===== * PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_FXHandle''', ''(STRING)'''''_Region''', '..."

New page

===== Full Definition(s) =====
* PROC '''PROC_LoopEffect'''(''(STRING)'''''_Effect''', ''(GUIDSTRING)'''''_Source''', ''(STRING)'''''_FXHandle''', ''(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 '''_FXHandle''' is used to stop the loop effect through [[Osiris/Shared/ProcStopLoopEffect|ProcStopLoopEffect]].

===== Notes =====
* This is a wrapper around the Osiris call [[Osiris/API/PlayLoopEffect|PlayLoopEffect]]. It takes care of starting/stopping loop effects when entering or leaving regions.

===== See Also =====
* [[Osiris/API/PlayLoopEffect|PlayLoopEffect]]
* [[Osiris/Shared/ProcStopLoopEffect|ProcStopLoopEffect]]

[[Category:Osiris Shared Mod Helpers|ProcCharacterMoveToAndTalk]]