User Tools

Site Tools


en:orx:config:settings_structure:orxfx

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
en:orx:config:settings_structure:orxfx [2017/05/30 00:50 (4 years ago)]
127.0.0.1 external edit
en:orx:config:settings_structure:orxfx [2021/08/09 05:50 (3 months ago)] (current)
sausage Stagger and DoNotCache properties
Line 5: Line 5:
 === FX === === FX ===
  
-<code ini>​[FXTemplate]+<code ini> 
 +[FXTemplate]
 SlotList ​   = FXSlotTemplate1#​FXSlotTemplate2#​... SlotList ​   = FXSlotTemplate1#​FXSlotTemplate2#​...
 +Stagger ​    = <​bool>​ # <​float>​
 KeepInCache = <​bool>​ KeepInCache = <​bool>​
-Loop        = <​bool></​code>​+DoNotCache ​ = <​bool>​ 
 +Loop        = <​bool>​ 
 +</​code>​
  
 === FXSlot === === FXSlot ===
  
-<code ini>​[FXSlotTemplate]+<code ini> 
 +[FXSlotTemplate]
 Type          = alpha | color | rgb | hsl | hsv | scale | rotation | position | speed | volume | pitch Type          = alpha | color | rgb | hsl | hsv | scale | rotation | position | speed | volume | pitch
 Curve         = linear | smooth | smoother | triangle | square | sine Curve         = linear | smooth | smoother | triangle | square | sine
Line 22: Line 27:
 Period ​       = <​float>​ Period ​       = <​float>​
 Absolute ​     = <​bool>​ Absolute ​     = <​bool>​
-Acceleration = <​float>​+Stagger ​      = <​bool>​ 
 +Acceleration ​ = <​float>​
 Amplification = <​float>​ Amplification = <​float>​
 Pow           = <​float>​ Pow           = <​float>​
 UseRotation ​  = <​bool>​ UseRotation ​  = <​bool>​
-UseScale ​     = <​bool></​code>​+UseScale ​     = <​bool>​ 
 +</​code>​
  
  
Line 35: Line 42:
 Here's a list of the available properties for an ''​orxFX''​ structure: Here's a list of the available properties for an ''​orxFX''​ structure:
   * ''​SlotList'':​ List of all the slots that will be used by that FX. Each slot will affect one attribute of the object one which the FX is applied. Up to 8 slots can be defined for a single FX. This property //needs// to be defined.   * ''​SlotList'':​ List of all the slots that will be used by that FX. Each slot will affect one attribute of the object one which the FX is applied. Up to 8 slots can be defined for a single FX. This property //needs// to be defined.
 +  * ''​Stagger'':​ If the first value is true, this FX will be added after all already existing FXs. Defaults to false. The second value, optional, is an additional time offset, in seconds, when the FX will start, staggered or not. Defaults to 0.0f.
   * ''​KeepInCache'':​ Specifies if the FX data should be kept in memory even when no FX of this type is used. This gives better performances but costs memory. Its default value is ''​false''​.   * ''​KeepInCache'':​ Specifies if the FX data should be kept in memory even when no FX of this type is used. This gives better performances but costs memory. Its default value is ''​false''​.
 +  * ''​DoNotCache'':​ If true, the FX won't get cached and will be recreated from config every time, which allows random values & variations but is more expensive. Defaults to false.
   * ''​Loop'':​ Specifies if the FX should be applied in loop. Its default value is ''​false''​.   * ''​Loop'':​ Specifies if the FX should be applied in loop. Its default value is ''​false''​.
  
Line 48: Line 57:
   * ''​Period'':​ Defines the ''​length''​ (period) of the cyclic curve (ie. 1/​frequency),​ in seconds. By default the period will be ''​EndTime''​ - ''​StartTime''​ so as to span on the whole slot duration.   * ''​Period'':​ Defines the ''​length''​ (period) of the cyclic curve (ie. 1/​frequency),​ in seconds. By default the period will be ''​EndTime''​ - ''​StartTime''​ so as to span on the whole slot duration.
   * ''​Absolute'':​ Should the slot apply absolute value to the object'​s attribute instead of relative ones? If an absolute slot is defined for a orxFX, it will override any other relative slot of the same orxFX of the same ''​Type''​. By default, its value is ''​false''​.   * ''​Absolute'':​ Should the slot apply absolute value to the object'​s attribute instead of relative ones? If an absolute slot is defined for a orxFX, it will override any other relative slot of the same orxFX of the same ''​Type''​. By default, its value is ''​false''​.
 +  * ''​Stagger'':​ If true, this slot will be added after all already existing slots. Defaults to false.
   * ''​Acceleration'':​ Defines the '​acceleration'​ of the curve over time (ie. the evolution of its frequency). A value < 1.0 means the frequency will decrease whereas a value > 1.0 means the frequency will increase. By default its value is 1.0, which means its frequency won't change.   * ''​Acceleration'':​ Defines the '​acceleration'​ of the curve over time (ie. the evolution of its frequency). A value < 1.0 means the frequency will decrease whereas a value > 1.0 means the frequency will increase. By default its value is 1.0, which means its frequency won't change.
   * ''​Amplification'':​ Defines the evolution of the amplitude of the curve over time. A value < 1.0 means the amplitude will decrease whereas a value > 1.0 means the amplitude will increase. By default its value is 1.0, which means its amplitude won't change.   * ''​Amplification'':​ Defines the evolution of the amplitude of the curve over time. A value < 1.0 means the amplitude will decrease whereas a value > 1.0 means the amplitude will increase. By default its value is 1.0, which means its amplitude won't change.
en/orx/config/settings_structure/orxfx.txt · Last modified: 2021/08/09 05:50 (3 months ago) by sausage