|
TweenGMS Script ReferenceVersion 0.9.70
|
|
|
| target | Instance to associate with tween and its property |
| prop | Property setter script (e.g. x__) |
| ease | Ease algorithm script (e.g. EaseInOutQuad) |
| mode | Play mode constant (0-4) (TWEEN_MODE_****) |
| delta | Whether to set timing in seconds(true) or steps (false) |
| delay | Amount of time to delay start of tween in seconds or steps |
| dur | Duration of time to ease property from start to destination |
| start | Starting value of eased property |
| dest | Destination value of eased property |
| ... | (optional) Extra parameters for extended property setters |
Returns: tween id
Example
|
|
|
| target | Instance to associate with tween |
| prop | Property setter script (e.g. x__) |
| ease | Ease algorithm script (e.g. EaseInOutQuad) |
| mode | Play mode constant (TWEEN_MODE_****) |
| delta | Whether to set timing in seconds(true) or steps (false) |
| delay | Amount of time to delay start of tween in seconds or steps |
| dur | Duration of time to ease property from start to destination |
| start | Starting value of eased property |
| dest | Destination value of eased property |
| ... | (optional) Extra parameters for extended property setters |
|
Returns: tween id Example
|
|
|
| tween | Tween id |
| prop | Property setter script (e.g. x__) |
| ease | Ease algorithm script (e.g. EaseInOutQuad) |
| mode | Play mode constant (TWEEN_MODE_****) |
| delta | Whether to set timing in seconds(true) or steps (false) |
| delay | Amount of time to delay start of tween in seconds or steps |
| dur | Duration of time to ease property from start to destination |
| start | Starting value of eased property |
| dest | Destination value of eased property |
| ... | (optional) Extra parameters for extended property setters |
|
Returns: na Example
|
|
|
| tween | Tween id |
| delay | Amount of time to delay start of tween in seconds or steps |
|
Returns: na Example
|
|
|
| tween | Tween id |
|
Returns: null tween id Example
|
|
|
| tween | Tween id |
|
Returns: null tween id Example
|
|
|
| tween | Tween id |
| destroy | Destroy tween when finished? |
| kill_target | Destroy target instance as well? |
|
Returns: na Example
|
|
|
| tween | Tween id |
|
Returns: bool Example
|
|
|
| tween | Tween id |
|
Returns: bool Example
|
|
|
| tween | Tween id |
|
Returns: bool Example
|
|
|
| tween | Tween id |
|
Returns: bool Example
|
|
|
| tween | Tween id |
|
Returns: bool Example
|
|
|
| ... | Original script parameters |
| deactivated | Affect tweens associated with deactivated targets? |
|
Returns: na Example
|
|
|
| group | Tween control group |
| ... | Original script parameters |
| deactivated | Affect tweens associated with deactivated targets? |
|
Returns: na Example
|
|
|
| target | Instance id, object index, or parent |
| ... | Original script parameters |
| deactivated | Affect tweens associated with deactivated targets? |
|
Returns: na Example
|
|
|
| tween | Tween id |
|
Returns: na Example
|
|
|
| tween | Tween id |
|
Returns: na Example
|
|
|
| tween | Tween id |
|
Returns: na Example
|
|
|
| tween | Tween id |
| call_event | Execute FINISH event callback? |
|
Returns: na Example
|
|
|
| tween | Tween id |
|
Returns: na Example
|
|
|
| tween | Tween id |
| amount | Relative direction/amount to step (1.0 = Next | -1.0 = Previous) |
|
Returns: na Example
|
|
|
| tween | Tween id |
| call_event | Execute callbacks for FINISH DELAY event? |
|
Returns: na Example
|
|
|
| value1 | Starting value |
| value2 | Destination value |
| amount | Amount to ease between start and destination (0.0 - 1.0) |
| ease | Easing algorithm script |
|
Returns: real Example
|
|
|
|
Returns: null tween id Example
|
|
|
| tween | Tween id |
| target | Instance to associate with tween |
|
Returns: tween id Example
|
|
|
| tween | Tween id |
| target | Instance to associate with tween |
| prop | Property setter script (e.g. x__) |
| ease | Ease algorithm script (e.g. EaseInOutQuad) |
| mode | Play mode constant (TWEEN_MODE_****) |
| delta | Whether to set timing in seconds(true) or steps (false) |
| delay | Amount of time to delay start of tween in seconds or steps |
| dur | Duration of time to ease property from start to destination |
| start | Starting value of eased property |
| dest | Destination value of eased property |
| ... | (optional) Extra parameters for extended property setters |
|
Returns: na Example
|
|
|
Returns: default tween id
Example
|
|
|
| tweens | Tweens selection constant -- TWEENS_**** |
| data | Relevant group or target for tween selection |
| script | Script to have each tween execute |
| ... | Optional arguments to pass to script |
|
Returns: na Example
|
|
|
| arg0... | Values to pass to extended property script |
|
Returns: array Example
|
|
|
| tween | Tween id |
|
Returns: real Example
|
|
|
| tween | Tween id |
| amount | Relative amount between 0.0 - 1.0 |
|
Returns: real Example
|
|
|
| tween | Tween id |
| time | A specific time in seconds or steps |
|
Returns: real Example
|
|
|
| tween | Tween id |
| event | Tween event constant (TWEEN_EV_****) |
| target | Instance environment to call script |
| script | Name of custom script to call |
| arg0... | Optional arguments to pass to script |
|
Returns: callback id Example
|
|
|
| tween | Tween id |
| event | Tween event constant (TWEEN_EV_****) |
| target | Instance environment to call script |
| user_event | User defined event to call for target |
|
Returns: callback id Example
|
|
|
| callback | Callback id |
|
Returns: na Example
|
|
|
| callback | Callback id |
|
Returns: bool Example
|
|
|
|
Returns: null callback id Example
|
|
|
| callback | Callback id |
| enable | Enable callback? |
|
Returns: na Example
|
|
|
| callback | Callback id |
Returns: bool
Example
|
|
|
| tween | Tween id |
| event | Tween event constant -- TWEEN_EV_**** |
|
Returns: na Example
|
|
|
| tween | Tween id |
| event | Tween event constant -- TWEEN_EV_**** |
| enable | Enable event? |
|
Returns: na Example
|
|
|
| tween | Tween id |
| event | Tween event constant -- TWEEN_EV_**** |
|
Returns: bool Example
|
|
|
| delta | Use delta(seconds) timing? |
|
Returns: na Example
|
|
|
| x1 | x start |
| y1 | y start |
| x2 | x destination |
| y2 | y destination |
| dur | Duration of tween in steps or seconds |
| ease | Easing algorithm script |
| delay | (optional) Duration delay start of tween |
|
Returns: tween id Example
|
|
|
| xscale1 | Image scale x start |
| yscale1 | Image scale y start |
| xscale2 | Image scale x destination |
| yscale2 | Image scale y destination |
| dur | Duration fo tween in steps or seconds |
| ease | Easing algorithm script |
| delay | (optional) Duration to delay start of tween |
|
Returns: tween id Example
|
|
|
| angle1 | Image angle start |
| angle2 | Image angle destination |
| dur | Duration of tween in steps or seconds |
| ease | Easing algorithm script |
| dur | (optional) Duration to delay start of tween |
|
Returns: tween id Example
|
|
|
| x1 | x start |
| y1 | y start |
| x2 | x destination |
| y2 | y destination |
| dur | Duration of tween in steps or seconds |
| ease | Easing algorithm script |
| delay | (optional) Duration of time to delay start of tween |
|
Returns: tween id Example
|
|
|
| alpha1 | Alpha start |
| alpha2 | Alpha destination |
| dur | Duration of tween in steps or seconds |
| ease | Easing alorithm script |
| delay | (optional) Duration to delay start of tween |
|
Returns: tween id Example
|
|
|
| index1 | Image index start |
| index2 | Image index destination |
| dur | Duration of tween in steps or seconds |
| ease | Easing alorithm script |
| delay | (optional) Duration to delay start of tween |
|
Returns: tween id Example
|
|
|
| col1 | Starting image blend colour |
| col2 | Destination image blend colour |
| dur | Duration of tween in steps or seconds |
| ease | Easing alorithm script |
| delay | (optional) Duration to delay start of tween |
|
Returns: tween id Example
|
|
|
| speed1 | Starting speed |
| speed2 | Destination speed |
| dur | Duration of tween in steps or seconds |
| ease | Easing alorithm script |
| delay | (optional) Duration to delay start of tween |
|
Returns: tween id Example
|
|
|
| hspeed1 | Starting horizontal speed |
| vspeed1 | Starting vertical speed |
| hspeed2 | Destination horizontal speed |
| vspeed2 | Destination vertical speed |
| dur | Duration of tween in steps or seconds |
| ease | Easing alorithm script |
| delay | (optional) Duration to delay start of tween |
|
Returns: tween id Example
|
|
|
| tween | Tween id |
| group | Group number |
|
Returns: na Example
|
|
|
| tween | Tween id |
| scale | Timing scale factor (Default = 1.0) |
|
Returns: na Example
|
|
|
| tween | Tween id |
| time | New time value |
|
Returns: na Example
|
|
|
| tween | Tween id |
| target | Instance id |
|
Returns: na Example
|
|
|
| tween | Tween id |
| prop | Property setter |
|
Returns: na Example
|
|
|
| tween | Tween id |
| delta | Use seconds(delta) timing? |
Returns: na
Example
|
|
|
| tween | Tween id |
| start | New start value |
Returns: na
ExampleTweenSetStart(tween, 0); |
|
|
| tween | Tween id |
| dest | New destination value |
Returns: na
Example
|
|
|
| tween | Tween id |
| dur | Duration of time in steps or seconds |
Returns: na
Example
|
|
|
| tween | Tween id |
| delay | Active delay value in steps or seconds |
Returns: na
Example
|
|
|
| tween | Tween id |
| delay | Starting delay value in steps or seconds |
Returns: na
Example
|
|
|
| tween | Tween id |
| mode | Tween play mode constant -- TWEEN_MODE_* |
Returns: na
Example
|
|
|
| tween | Tween id |
| ease | Easing algorithm script |
Returns: na
Example
|
|
|
| tween | Tween id |
| arg0... | Variable number of arguments to pass as extended data |
Returns: na
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: instance id
Example
|
|
|
| tween | Tween id |
Returns: tween property
Example
|
|
|
| tween | Tween id |
Returns: bool
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: extended data
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
| tween | Tween id |
Returns: real
Example
|
|
|
Returns: bool
Example
|
|
|
Returns: real
Example
|
|
|
Returns: real
Example
|
|
|
| enable | Enable the tweening system? |
Returns: na
Example
|
|
|
| scale | Relative speed to process tweens |
Returns: na
Example
|
|
|
| interval | Number of steps before system updates (default=1) |
Returns: na
Example
|
|
|
| fps | Frame rate (Default=10) |
Returns: na
Example
|
|
|
| interations | Number of tweens to check each step |
Returns: na
Example
|
|
|
| scaled | Whether or not to return time affected by system's time scale |
Returns: real
Example
|
|
|
| room | Room id |
Returns: na
Example
|
|
|
Returns: na
Example
|
|
|
Returns: na
Example
|
|
|
Returns: real
Example
|
|
|
Returns: real
Example
|
|
|
Returns: real
Example
|
|
|
Returns: real
Example
|
|
|
Returns: na
Example
|
|
|
Returns: na
Example
|