The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Scope visual

Used to manage some of the visual effects from scripts.

Visibility: Global.

List of functions

ShieldHitEffect
Arguments	Returns	Example
int: ship_id int: caster_id double: coord_x double: coord_y double: strength - intensity of visual effect	void	visual.ShieldHitEffect( 10, 15, 20,23, 0.2);
Description
Applies shield damaged visual effect on client. Strength affects brightness of effect, global coordinates - direction.

ShieldUpEffect
Arguments	Returns	Example
int: ship_id	void	visual.ShieldUpEffect(132);
Description
Invokes "shield up" visual effect.

ShieldDownEffect
Arguments	Returns	Example
int: ship_id	void	visual.ShieldDownEffect(132);
Description
Invokes "shield down" visual effect.

DeviceDeactivateEffect
Arguments	Returns	Example
int: ship_id int: device_gid string: effect_xml_id	void	visual.DeviceDeactivateEffect(132, 515, "SomeDeviceEffect");
Description
Deactivates specified visual effect, connected to specific device.

DeviceActivateEffect
Arguments	Returns	Example
int: ship_id int: device_gid string: effect_xml_id double: max_length	void	visual.DeviceActivateEffect(132, 515, "SomeDeviceEffect", 100);
Description
Activites visual effect of device with no target parameters. Effect will worn off in max_length, unless Deactivate is called earlier.

DeviceActivateEffectOnObject
Arguments	Returns	Example
int: ship_id int: device_gid string: effect_xml_id double: max_length int: object_id	void	visual.DeviceActivateEffectOnObject(132, 515, "SomeDeviceEffect", 100, 35355);
Description
Activites visual effect of device with target parameters. Effect will worn off in max_length, unless Deactivate is called earlier.

DeviceActivateEffectOnTarget
Arguments	Returns	Example
int: ship_id int: device_gid string: effect_xml_id double: max_length double: coord_x double: coord_y	void	visual.DeviceActivateEffectOnTarget(132, 515, "SomeDeviceEffect", 100, 100, 105);
Description
Activites visual effect of device with target parameters. Effect will worn off in max_length, unless Deactivate is called earlier.