GHI_ScreenShake

Pilus edited this page Aug 11, 2015 · 1 revision
Clone this wiki locally

Notes:

Screen Shake will not work in combat. In a future update a message telling the user the world is shaking will appear. You will also be able to define this message in the code.

Syntax:

GHI_ScreenShake(duration, intensity, message)

Arguments:

GHI_ has 2 required arguments and 1 optional argument as of GHI 2.0.12.

intensity
''Number''
The amount of shake. This number can not be higher than 64.
duration
''Number''
The total time of the action, including fade in and fade out time. Be mindful of using this as it can cause users to feel ill if shaking for too long.
message
''String''
A custom message displayed when screen shaking is activated in combat. If nil, then a default message is displayed.

Aliases:

None

Example:

GHI_ScreenShake(1, 8)

This script causes the screen to shake slightly for 1 second.