StartCameraFade: Difference between revisions
From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|StartCameraFade(FromAlpha, ToAlpha, Duration [, HexColor])}} {{FuncParameters}} {{FuncParam|FromAl...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Smoothly fade in or out, Setting CameraFade will overwrite any other started camera fades which were called before}} | ||
{{FuncSyntax|StartCameraFade(FromAlpha, ToAlpha, Duration [, HexColor])}} | {{FuncSyntax|StartCameraFade(FromAlpha, ToAlpha, Duration [, HexColor])}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|FromAlpha| | {{FuncParam|FromAlpha|Starting alpha (0-1)}} | ||
{{FuncParam|ToAlpha| | {{FuncParam|ToAlpha|Alpha you want to fade to (0-1)}} | ||
{{FuncParam|Duration | | {{FuncParam|Duration |Duration of the fade in seconds}} | ||
{{FuncParamOptional|HexColor| | {{FuncParamOptional|HexColor|Hex color of the fade}} | ||
{{FuncReturnValue|__EDIT_ME__}} | {{FuncReturnValue|__EDIT_ME__}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua"> | |||
StartCameraFade(1.0, 0.0, 4.0, "#000") | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
__EDIT_ME__ | __EDIT_ME__ | ||
Revision as of 11:52, 29 September 2019
Description
Smoothly fade in or out, Setting CameraFade will overwrite any other started camera fades which were called before
Syntax
StartCameraFade(FromAlpha, ToAlpha, Duration [, HexColor])
Parameters
- FromAlpha
Starting alpha (0-1) - ToAlpha
Alpha you want to fade to (0-1) - Duration
Duration of the fade in seconds - HexColor (optional)
Hex color of the fade
Return Value
- __EDIT_ME__
Example
StartCameraFade(1.0, 0.0, 4.0, "#000")
See also
__EDIT_ME__
