PlayCameraShake: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|PlayCameraShake(Duration [, BlendInTime, BlendOutTime, Scale])}} {{FuncParameters}} {{FuncParam|Du...")
 
No edit summary
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Make the player's camera shake using [[StopCameraShake]].}}


{{FuncSyntax|PlayCameraShake(Duration [, BlendInTime, BlendOutTime, Scale])}}
{{FuncSyntax|PlayCameraShake(Duration [, BlendInTime, BlendOutTime, Scale])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|Duration |__EDIT_ME__}}
{{FuncParam|Duration |The duration in milliseconds.}}
{{FuncParam|BlendInTime|__EDIT_ME__}}
{{FuncParam|BlendInTime|The blend-in time.}}
{{FuncParam|BlendOutTime|__EDIT_ME__}}
{{FuncParam|BlendOutTime|The blen-out time.}}
{{FuncParamOptional|Scale|__EDIT_ME__}}
{{FuncParamOptional|Scale|The shake scale in floating point.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|__EDIT_ME__}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
SetCameraShakeRotation(0.0, 0.0, 1.0, 10.0, 0.0, 0.0)
SetCameraShakeFOV(5.0, 5.0)
PlayCameraShake(100000.0, 2.0, 1.0, 1.1)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:CameraShake}}

Revision as of 13:22, 20 November 2019

PlayCameraShake

Type: Function
Context: Client
Introduced: v1.0

Description

Make the player's camera shake using StopCameraShake.

Syntax

PlayCameraShake(Duration [, BlendInTime, BlendOutTime, Scale])

Parameters

  • Duration
    The duration in milliseconds.
  • BlendInTime
    The blend-in time.
  • BlendOutTime
    The blen-out time.
  • Scale (optional)
    The shake scale in floating point.

Return Value

  • __EDIT_ME__

Example

SetCameraShakeRotation(0.0, 0.0, 1.0, 10.0, 0.0, 0.0)
SetCameraShakeFOV(5.0, 5.0)
PlayCameraShake(100000.0, 2.0, 1.0, 1.1)

See also

Template:CameraShake