Grimwar/Entities/env screenshake

Overview · Getting started · SDK setup · Maps · Custom content · Entities · VSig · VMod · Workshop · Addons · Servers · Help

All entities

Shake player cameras within a radius.

Placement: Point.

Set it up

Set amplitude in degrees, frequency, duration, and radius. Radius 0 affects every player equally. Use start and stop from server logic. The amplitude, duration, and frequency setters clamp to zero or greater; radius and falloff remain authored settings.

Settings

These are the initial authoring values. Script inputs and runtime state are listed separately below.

Setting	Default	Meaning and choices
amplitude Amplitude	1.5	Maximum view-angle displacement in degrees. Minimum: 0.
frequency Frequency	18	Shake oscillations per second. Minimum: 0.
duration Duration	0.6	Minimum: 0.
radius Radius	20	World radius. Zero shakes every player equally. Minimum: 0.
falloff_exponent Falloff Exponent	1	Exponent applied to distance attenuation. Minimum: 0.01.
ignore_nav_mesh Ignore Nav Mesh	false	Exclude this entity from navigation-mesh building. This does not disable its gameplay collision.

VSig contract

Use the names below with a ref bound to this entity. The value column describes the catalog value type, not a C# method signature. See Read the reference for arguments, authority, and common controls.

Kind	Member	Value	Authority / access
Input	kill	none	Server
Input	set_amplitude	float	Server
Input	set_duration	float	Server
Input	set_frequency	float	Server
Input	start	string	Server
Input	stop	string	Server
Output	killed	none	Server
Output	start	string	Server
Output	stop	string	Server
Property	amplitude	float	Server; read/write
Property	duration	float	Server; read/write
Property	frequency	float	Server; read/write