-
Notifications
You must be signed in to change notification settings - Fork 4
Event Fields
(Attribute) Event to trigger the specified effects on.
Valid values:
Functional - tool becomes functional
Powered - tool becomes powered
Enabled - tool is enabled
Activated - tool function is activated via terminal or hotbar
LeftClick - tool function is activated by player left click
RightClick - tool function is activated by player right click
Click - tool function is activated by either player click
Firing - tool function is activated by any method
Hit - tool is working on something somewhere in its effect volume
RayHit - tool raycast hit something directly in front of the tool
(Optional) Specifies an animation to trigger on a subpart. Any number of these can be specified.
(Required) Name of the subpart to apply the animation to. (Do not include the subpart_)
(Required) Type of animation to apply.
Valid values: Rotate - Linear - Hide - Unhide
(Required for Rotate and Linear) A 3D vector defining the axis to move the subpart along or rotate it around.
(Optional) Speed in metres/s (to move) or degrees/s (to rotate) the subpart.
(Optional) Time in ticks to run the animation. If not preset or zero the animation will run indefinitely while the trigger is active.
(Optional) Time in ticks to accelerate into the movement at the start of the animation (and out of it at the end).
(Optional) Specifies a particle effect to generate at a specified location. Any number of these can be specified.
(Required) This can be either the name of a specific particle effect to generate, or the SubtypeId of a Physical Material prefixed with MaterialProperties/ (i.e. MaterialProperties/ShipDrill) to generate different particles depending on the material being affected, per the ContactProperties section of the PhysicalMaterialDefinition.
(Required) Location to generate the particle effect at.
Valid values:
Centre - Particle is spawned relative to the centre of the tool.
Emitter - Particle is spawned relative to the specified dummy.
Hit - Particle is spawned relative to the tool's forward raycast hit point.
(Required if Location is Emitter) Name of the model dummy to spawn the particle relative to (if this is a subpart include the subpart_).
(Optional) The vector by which to offset the particle effect from the location specified in Location.
(Optional) Specifies a beam effect to be drawn between two points. Any number of these can be specified.
(Required) Name of the dummy to start the beam at.
(Required) Location to end the beam at.
Valid values:
Emitter - End the beam at the specified End dummy.
Forward - Project the beam forward until it reaches the end of the tool's range.
Hit - Project the beam forward until it hits something or reaches the end of the tool's range.
(Optional) Name of the dummy to end the beam at if using Emitter EndLocation.
(Optional) Name of a transparent material to use for the beam.
Default value: WeaponLaser
(Optional) Width of the beam in metres.
Default value: 0.5
(Optional) Length of the beam in metres (only used if using Forward EndLocation.
Default value: 0
(Optional) RGBA colour value for the beam. RGB fields cap at 255, Alpha values above 255 increase brightness/bloom.
Default value: 255, 255, 255, 1000
(Optional) Specifies a sound to play. Only one of these can be specified per event.
(Required) Either the name of a specific audio definition to play, or the SubtypeId of a Physical Material prefixed with MaterialProperties/ (i.e. MaterialProperties/ShipDrill) to play different sounds depending on the material being affected, per the ContactProperties section of the PhysicalMaterialDefinition.