PlayCameraShake: Difference between revisions

From Onset Developer Wiki
28days (talk | contribs)
No edit summary
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 11: Line 11:
{{FuncParamOptional|Scale|The shake scale in floating point.}}
{{FuncParamOptional|Scale|The shake scale in floating point.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns nothing.}}


== Example ==
== Example ==
Example taken from https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/6ef0c5406e84a434ca2d497c470404802f05e0d6/horizon/client/world.lua
<syntaxhighlight lang="Lua>
<syntaxhighlight lang="Lua>
SetCameraShakeRotation(0.0, 0.0, 1.0, 10.0, 0.0, 0.0)
function ToggleDrunkEffect()
SetCameraShakeFOV(5.0, 5.0)
if (not DrunkOn) then
PlayCameraShake(100000.0, 2.0, 1.0, 1.1)
DrunkOn = true
SetPostEffect("ImageEffects", "VignetteIntensity", 1.0)
SetPostEffect("Chromatic", "Intensity", 5.0)
SetPostEffect("Chromatic", "StartOffset", 0.1)
SetPostEffect("MotionBlur", "Amount", 0.05)
SetPostEffect("MotionWhiteBalanceBlur", "Temp", 7000)
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)
else
DrunkOn = false
SetPostEffect("ImageEffects", "VignetteIntensity", 0.25)
SetPostEffect("Chromatic", "Intensity", 0.0)
SetPostEffect("Chromatic", "StartOffset", 0.0)
SetPostEffect("MotionBlur", "Amount", 0.0)
SetPostEffect("MotionWhiteBalanceBlur", "Temp", 6500)
StopCameraShake(false)
end
end
AddRemoteEvent("ToggleDrunkEffect", ToggleDrunkEffect)
</syntaxhighlight>
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
{{Template:CameraShake}}
{{Template:CameraShakeFunctions}}

Latest revision as of 14:52, 23 December 2020

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

  • This function returns nothing.

Example

Example taken from https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/6ef0c5406e84a434ca2d497c470404802f05e0d6/horizon/client/world.lua

function ToggleDrunkEffect()
	if (not DrunkOn) then
		DrunkOn = true
		SetPostEffect("ImageEffects", "VignetteIntensity", 1.0)
		SetPostEffect("Chromatic", "Intensity", 5.0)
		SetPostEffect("Chromatic", "StartOffset", 0.1)
		SetPostEffect("MotionBlur", "Amount", 0.05)
		SetPostEffect("MotionWhiteBalanceBlur", "Temp", 7000)
		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)
	else
		DrunkOn = false
		SetPostEffect("ImageEffects", "VignetteIntensity", 0.25)
		SetPostEffect("Chromatic", "Intensity", 0.0)
		SetPostEffect("Chromatic", "StartOffset", 0.0)
		SetPostEffect("MotionBlur", "Amount", 0.0)
		SetPostEffect("MotionWhiteBalanceBlur", "Temp", 6500)
		StopCameraShake(false)
	end
end
AddRemoteEvent("ToggleDrunkEffect", ToggleDrunkEffect)

See also