CreateRibbonEffect()

Syntax

Result = CreateRibbonEffect(#Effect, MaterialID, NbChains, NbElements, Length)

Create a new ribbon trail effect. Once created, the effect has to be attached with AttachRibbonEffect(). It is possible to hide the effect with HideEffect().

Parameters

#Effect	The number to identify the new effect. #PB_Any can be used to auto-generate this number.
MaterialID	The material to apply on the ribbon trail. To get a valid 'MaterialID', use MaterialID().
NbChains	Number of chains of the ribbon trail. The more chains, the more precise the ribbon will be.
NbElements	Number of elements per chains. The more elements, the more precise the ribbon will be.
Length	Maximum length, in world unit, of the ribbon. Once the length is reached the ribbon will be completely fade out.

Return value

Returns nonzero if the effect was created successfully and zero if there was an error. If #PB_Any was used as the #Effect parameter then the new generated number is returned on success.

See Also

FreeEffect(), HideEffect()

Supported OS

All