| Properties |
|
|
|
|
| Property Name |
|
Return Data Type |
Description |
Example Syntax |
| Index |
|
Number |
Returns the numerical index of this Viewport |
HippoNet.LocalHost.Engine:FindViewport(1).Index |
| Path |
|
String |
Returns the full path of the Root Pin of this viewport from the Engine Root Pin |
HippoNet.LocalHost.Engine:FindViewport(1).Path |
| Level |
|
Number |
Value between 0.0 and 1.0 that represents the level of the viewport master on this viewport this value can be read or set |
HippoNet.LocalHost.Engine:FindViewport(1).Level |
| Functions |
|
|
|
|
| Function Name |
Parameters |
Return Data Type |
Description |
Example Syntax |
| FadeLevel |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades the level of this viewport in the background from a value (either given or current) to the value given, over FadeTime Seconds, does not halt script execution |
HippoNet.LocalHost.Engine:FindViewport(1):FadeLevel(0, 1, 10) |
| FadeLevelWait |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades the level of this viewport from a value (either given or current) to the value given, over FadeTime Seconds, does halt script execution while in progress |
HippoNet.LocalHost.Engine:FindViewport(1):FadeLevelWait(1, 0, 15) |
| SnapEndLevel |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Snaps the level from a value (either given or current) to the value give after the FadeTime Seconds has passed. This does not halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):SnapEndLevel(0, 1, 10) |
| SnapEndLevelWait |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Snaps the level from a value (either given or current) to the value give after the FadeTime Seconds has passed. This does halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):SnapEndLevelWait(1, 0, 15) |
| EasingCubicLevel |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades level from a value (either given or current) to the value give after the FadeTime Seconds has passed using a Easing Cubic curve. This does not halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):EasingCubicLevel(0, 1, 10) |
| EasingCubicLevelWait |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades level from a value (either given or current) to the value give after the FadeTime Seconds has passed using a Easing Cubic curve. This does halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):EasingCubicLevelWait(1, 0, 15) |
| EasingSineLevel |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Sine curve. This does not halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):EasingSineLevel(0, 1, 10) |
| EasingSineLevelWait |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Sine curve. This does halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):EasingSineLevelWait(1, 0, 15) |
| EasingQuadraticLevel |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Quadratic curve. This does not halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):EasingQuadraticLevel(0, 1, 10) |
| EasingQuadraticLevelWait |
(Number From(Optional),Number To,Number FadeTime) |
Nothing |
Fades level from a value (either given or current) to the value given after the FadeTime Seconds has passed using a Easing Quadratic curve. This does halt the script |
HippoNet.LocalHost.Engine:FindViewport(1):EasingQuadraticLevelWait(1, 0, 15) |
| SetPreset |
(Number PresetIndex) |
Nothing |
Attempts to load a Mix Preset with index PresetIndex onto this Viewport Object if the preset exists |
HippoNet.LocalHost.Engine:FindViewport(1):SetPreset(10) |
| Reset |
() |
Nothing |
Resets the Viewport and all it’s Layers back to their default state |
HippoNet.LocalHost.Engine:FindViewport(1):Reset() |
Post your comment on this topic.