RED Event List: Difference between revisions
No edit summary |
No edit summary |
||
| Line 18: | Line 18: | ||
|eventname = Drop_Point_Marker | |eventname = Drop_Point_Marker | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This is a special type of Event which doesn’t respond to On or Off messages. This Event is used as a position where AI will drop off objects while in AI_COLLECTING_MODE. This is how Grabber robots can drop their rocks off at a specific location. | ||
|params = | |params = | ||
}} | }} | ||
| Line 36: | Line 36: | ||
|eventname = Follow_Waypoints | |eventname = Follow_Waypoints | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This event will force all linked objects to follow a specified waypoint list, with a specific following method. | ||
|params = | |on = Begin following the waypoints. An AI will use the closest waypoint as the location to begin the path following. | ||
|off = Stop following the current waypoint path. | |||
|params = '''Waypoint List:''' Name of the waypoint list that the AI should follow. <hr> '''Always Face Player:''' If true, the AI will always face the player while following their waypoints <hr> '''Max Speed Scale (0-100):''' Used to make the AI move slower while following waypoints <hr> '''Follow Method:''' This determines how the AI will behave when the last waypoint node is reached. The choices are: <br /> | |||
'''1.''' One way: follow the waypoints to the last node and stop. <br /> | |||
'''2.''' Loop: follow the waypoints to the last node, then return to the start and repeat <br /> | |||
'''3.''' Ping Pong: follow the waypoints to the last node, then follow the nodes back to the start (repeat). | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 45: | Line 50: | ||
|eventname = Goto | |eventname = Goto | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This Event will make all linked entities travel to the Event location. | ||
|params = | |on = Make linked entities start moving towards Event location. | ||
|params = '''Always Face Player:''' If true, the AI will always face the player while following their waypoints <hr> '''Max Speed Scale (0-100):''' Used to make the AI move slower while following waypoints | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 54: | Line 60: | ||
|eventname = Goto_Player | |eventname = Goto_Player | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This Event will make all linked entities travel to the Player position. The linked entities will continue to pathfind to the Player until they have line-of-sight. When the entities can see the Player, they will return to their default AI. | ||
|on = Make linked entities start moving towards the Player. | |||
|params = | |params = | ||
}} | }} | ||
| Line 90: | Line 97: | ||
|eventname = Look_At | |eventname = Look_At | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This Event will cause any linked AI to turn and face the Event location. | ||
|on = Make linked AI look at the Event. | |||
|params = | |params = | ||
}} | }} | ||
| Line 99: | Line 107: | ||
|eventname = Play_Animation | |eventname = Play_Animation | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This event will cause a linked AI to play a specific animation. If the animation is a state animation (i.e., a looping animation) then it will replace the current animation state for the AI. If the animation is an action animation (i.e., a one-time animation) then it is blended with the current state. | ||
|params = | |on = Play the animation. | ||
|params = '''Animation:''' Name of the animation. This is selectable from a list of possible animations for the object that is linked. <hr> '''Hold Last Frame:''' If true, the model will stay in the last frame of animation. This is only valid if the animation is defined as an action animation. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 117: | Line 126: | ||
|eventname = Set_Friendliness | |eventname = Set_Friendliness | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This Event will set the Friendliness of all linked objects. | ||
|params = | |on = Change the Friendliness of an entity. | ||
|params = '''Friendliness:''' The friendliness is selectable from a drop-down list, and consists of the following choices:<br /> | |||
'''1.''' Unfriendly: AI will attack the player on sight.<br /> | |||
'''2.''' Neutral: AI will only attack the player if provoked.<br /> | |||
'''3.''' Friendly: AI will not attack the player, and may attack entities that are attacking the player.<br /> | |||
'''4.''' Outcast: AI will attack anything it sees. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 126: | Line 141: | ||
|eventname = Shoot_At | |eventname = Shoot_At | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This Event will cause all linked AI to shoot at the Event location. The AI will continue to shoot at the Event until an Off message is received. | ||
|on = Make all linked AI attack the Event location. | |||
|off = Make all linked AI stop attacking the Event location. | |||
|params = | |params = | ||
}} | }} | ||
| Line 135: | Line 152: | ||
|eventname = Shoot_Once | |eventname = Shoot_Once | ||
|category = AI_Actions | |category = AI_Actions | ||
|description = | |description = This Event will make all linked AI shoot once in the direction they are currently facing. | ||
|params = | |on = Fire a single time. | ||
|params = '''Shoot Type:''' Primary, Secondary, Flare. What type of weapon to use. | |||
}} | }} | ||
==Catalysts== | ==Catalysts== | ||
| Line 165: | Line 183: | ||
|image = Icon_Event_L.png | |image = Icon_Event_L.png | ||
|category = Catalysts | |category = Catalysts | ||
|description = | |description = This Event will change On messages to Off messages (and Off to On) before forwarding them to any linked Events. | ||
|on = Change message to Off. | |||
|off = Change message to On. | |||
|params = | |params = | ||
}} | }} | ||
| Line 175: | Line 195: | ||
|image = Icon_Event_C.png | |image = Icon_Event_C.png | ||
|category = Catalysts | |category = Catalysts | ||
|description = | |description = This Event behaves like a switch that remembers it’s state (on or off). This Event can be used to turn lights on or off, and can be used to let the player activate special events. If the Event is linked to a VFX, this VFX is used as the model for the switch (the default state of the VFX should be off, with the animation taking the VFX to the on state). | ||
|params = | |on = Toggle the state of the switch. The behavior of the switch is controlled through the Event parameters. | ||
|params = '''Initial State:''' The initial state of the switch (either on or off) <hr> '''Behavior:''' This says what kind of signal the switch will send. (toggle between on and off, always send an on, always send an off) <hr> '''Sound:''' Disk filename (including the .wav extension) of the sound to play when the switch is thrown <hr> '''Max Throws:''' How many times the switch can be thrown <hr> '''Infinite Throws:''' If true, the Max Throws parameter is ignored, and the switch can be thrown an infinite number of times. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 220: | Line 241: | ||
|eventname = When_Dead | |eventname = When_Dead | ||
|category = Catalysts | |category = Catalysts | ||
|description = | |description = This Event will send an On message to all linked Events when all linked objects have died. This Event is used when you want to do something when a specific object has been destroyed. | ||
|params = | |params = | ||
}} | }} | ||
| Line 311: | Line 332: | ||
|eventname = Explode | |eventname = Explode | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will cause an explosion to occur at the Event location. The explosion can be made to cause a geomod, and you can control the amount of damage caused by the explosion. | ||
|params = | |on = Make the explosion happen. | ||
|params = '''Damage:''' The amount of damage caused by the explosion. This is the damage that is applied to any object within the explosion range. <hr> '''Type:''' Small, Medium, Large. This field isn’t properly supported yet. We need to list a selection of different explosions to choose from. <hr> '''Geomod:''' If true, the explosion will apply a geomod at the center of the explosion. The hardness of the rock where the explosion occurs is used to determine if a geomod is possible. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 320: | Line 342: | ||
|eventname = Goal_Check | |eventname = Goal_Check | ||
|category = Level | |category = Level | ||
|description = | |description = This Event can either block or forward On messages, depending on the state of an associated goal_set Event. | ||
|params = | |on = Foward On messages if min_count exceeds the current count value of the associated goal_set Event | ||
|params = '''Goal Name:''' Script name for the associated Goal_Set Event <hr> '''Minimum Count:''' The miniumum value that the associated Goal_Set Event must have before forwarding messages | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 338: | Line 361: | ||
|eventname = Goal_Set | |eventname = Goal_Set | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will increment a count variable every time it receives an On message (Off messages will cause the count value to decrement). | ||
|params = | |on = Increment count by one. | ||
|off = Decrement count by one. | |||
|params = '''Start Count:''' The inital value of the count variable (this will be zero in most cases). | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 356: | Line 381: | ||
|eventname = Load_Level | |eventname = Load_Level | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will cause the specified level to load. The Player will be taken to the new level seamlessly. | ||
|params = | |on = Load the specified level. | ||
|params = '''Filename:''' Disk filename (including the .d4l extension) of the level to load. <hr> '''Start Marker id:''' The unique id of the Drop_Point_Marker associated with the level transition. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 365: | Line 391: | ||
|eventname = Message | |eventname = Message | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will make a sound file play and display the associated text on the Player HUD. | ||
|params = | |on = Play the message. | ||
|params = '''Persona:''' Selectable from drop-down list of names which is generated from personas.tbl. Select "none" if you don’t want the message to be from a persona. <hr> '''Voice Filename:''' Disk filename (including .wav extension) of the sound file to play. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 401: | Line 428: | ||
|eventname = Play_Sound | |eventname = Play_Sound | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will cause a sound to play. The sound can be a 3D or 2D sound, and it can be made to loop. | ||
|params = | |on = Start playing the sound. | ||
|off = Stop the sound, if it is playing. | |||
|params = '''Sound Filename:''' Disk filename of the sound to play (including .wav extension). <hr> '''Min Distance:''' Distance (in meters) where the sound begins to drop off in volume. If you don’t want the sound to be 3D, set the Min Distance to zero. <hr> '''Looping:''' If true, the sound will play looping (until you stop it by sending an Off message to this Event). | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 419: | Line 448: | ||
|eventname = Remove_Object | |eventname = Remove_Object | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will destroy all objects linked to the event. Objects will disappear instantly (i.e., without their death sequence). | ||
|on = Kill all linked objects immediately. | |||
|params = | |params = | ||
}} | }} | ||
| Line 428: | Line 458: | ||
|eventname = Slay_Object | |eventname = Slay_Object | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will kill all linked objects, and allow their death sequence to play. | ||
|on = Kill all linked objects. | |||
|params = | |params = | ||
}} | }} | ||
| Line 437: | Line 468: | ||
|eventname = Spawn_Object | |eventname = Spawn_Object | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will cause a specific object type to be created. The object is created at the Event location, with an identity matrix orientation. | ||
|params = | |on = Spawn the object at the Event location. | ||
|params = '''Object Type:''' Entity, Clutter, Item. Selectable from a drop-down list. <hr> '''Object Class:''' The classname of the object. Selectable from a drop-down list. The choice here depends on the Object Type that has been selected. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 446: | Line 478: | ||
|eventname = Swap_Textures | |eventname = Swap_Textures | ||
|category = Level | |category = Level | ||
|description = | |description = This Event will cause the specified textures (up to 2 per Event) to be used on all linked objects. | ||
|params = | |on = Swap the textures. | ||
|params = '''Texture Num:''' Texture index to swap (starts from 0) <hr> '''Texture Filename:''' Disk filename (including extension) of the texture bitmap to use | |||
}} | }} | ||
==Modifiers== | ==Modifiers== | ||
| Line 529: | Line 562: | ||
|eventname = Give_Item_To_Player | |eventname = Give_Item_To_Player | ||
|category = Modifiers | |category = Modifiers | ||
|description = | |description = This Event will make the player pick up a specific item. Items are normally automatically picked up by the player when he gets close enough to them. All game items are specified in items.tbl. | ||
|params = | |on = Give the player the specified item. | ||
|params = '''Item:''' Item class name, which is selectable from a drop-down list of all items from items.tbl. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 547: | Line 581: | ||
|eventname = Heal | |eventname = Heal | ||
|category = Modifiers | |category = Modifiers | ||
|description = | |description = This Event will add life to all the linked objects. This Event can be used to damage events by using a negative Life Delta value. | ||
|params = | |on = Add the Event Life Delta value to the life of all linked objects. | ||
|params = '''Life Delta:''' How much life to add (negative amount will cause damage) | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 565: | Line 600: | ||
|eventname = Make_Fly | |eventname = Make_Fly | ||
|category = Modifiers | |category = Modifiers | ||
|description = | |description = This Event will make the linked AI enter fly mode. If the AI is already flying, this Event does nothing. This Event can only make AI fly if it normally has the ability (i.e., this Event can’t make a Cave Slug fly). | ||
|on = Make linked AI enter fly mode. | |||
|params = | |params = | ||
}} | }} | ||
| Line 583: | Line 619: | ||
|eventname = Make_Walk | |eventname = Make_Walk | ||
|category = Modifiers | |category = Modifiers | ||
|description = | |description = This Event will make the linked AI enter walk mode. If the AI is already walking, this Event does nothing. This Event can only make AI walk if it normally has the ability (i.e., this Event can’t make a Grabber walk). | ||
|on = Make linked AI enter walk mode. | |||
|params = | |params = | ||
}} | }} | ||
| Line 646: | Line 683: | ||
|eventname = Shake_Player | |eventname = Shake_Player | ||
|category = Modifiers | |category = Modifiers | ||
|description = | |description = This Event will shake the viewpoint of the Player. | ||
|params = | |on = Start shaking the Player camera. | ||
|params = '''Magnitude:''' How strong to make the shaking. This value is the max amplitude of the shake in meters. <hr> '''Time:''' How long to shake the camera in seconds. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 673: | Line 711: | ||
|eventname = Switch_Model | |eventname = Switch_Model | ||
|category = Modifiers | |category = Modifiers | ||
|description = | |description = This Event will change the model of all linked objects to the model filename that is contained in the Event. | ||
|params = | |on = Change the model. | ||
|params = '''Model filename:''' Disk filename (with extension) of the model to switch to. | |||
}} | }} | ||
<div style="font-size:0%"> | <div style="font-size:0%"> | ||
| Line 682: | Line 721: | ||
|eventname = Teleport | |eventname = Teleport | ||
|category = Modifiers | |category = Modifiers | ||
|description = | |description = This Event will teleport all linked objects to the Event location. There are no special effects associated with the teleportation. | ||
|on = Teleport all linked objects. | |||
|params = | |params = | ||
}} | }} | ||
Revision as of 19:48, 3 November 2020
 |
This page is under construction. The information on this page may not yet be complete. |
This page lists all event scripting objects available in RED. To read more about how the scripting system itself works, see Events.
AI_Actions
Attack
|
AttackOn Response None
Off Response None
Parameters
|
Drop_Point_Marker
|
Drop_Point_MarkerThis is a special type of Event which doesn’t respond to On or Off messages. This Event is used as a position where AI will drop off objects while in AI_COLLECTING_MODE. This is how Grabber robots can drop their rocks off at a specific location.On Response None
Off Response None
Parameters
|
Drop_Weapon
|
Drop_WeaponOn Response None
Off Response None
Parameters
|
Follow_Waypoints
|
Follow_WaypointsThis event will force all linked objects to follow a specified waypoint list, with a specific following method.On Response Begin following the waypoints. An AI will use the closest waypoint as the location to begin the path following.
Off Response Stop following the current waypoint path.
Parameters
Waypoint List: Name of the waypoint list that the AI should follow. Always Face Player: If true, the AI will always face the player while following their waypoints Max Speed Scale (0-100): Used to make the AI move slower while following waypoints Follow Method: This determines how the AI will behave when the last waypoint node is reached. The choices are: 1. One way: follow the waypoints to the last node and stop. |
Goto
|
GotoThis Event will make all linked entities travel to the Event location.On Response Make linked entities start moving towards Event location.
Off Response None
Parameters
Always Face Player: If true, the AI will always face the player while following their waypoints Max Speed Scale (0-100): Used to make the AI move slower while following waypoints |
Goto_Player
|
Goto_PlayerThis Event will make all linked entities travel to the Player position. The linked entities will continue to pathfind to the Player until they have line-of-sight. When the entities can see the Player, they will return to their default AI.On Response Make linked entities start moving towards the Player.
Off Response None
Parameters
|
Headlamp_State
|
Headlamp_StateOn Response None
Off Response None
Parameters
|
Holster_Player_Weapon
|
Holster_Player_WeaponOn Response None
Off Response None
Parameters
|
Holster_Weapon
|
Holster_WeaponOn Response None
Off Response None
Parameters
|
Look_At
|
Look_AtThis Event will cause any linked AI to turn and face the Event location.On Response Make linked AI look at the Event.
Off Response None
Parameters
|
Play_Animation
|
Play_AnimationThis event will cause a linked AI to play a specific animation. If the animation is a state animation (i.e., a looping animation) then it will replace the current animation state for the AI. If the animation is an action animation (i.e., a one-time animation) then it is blended with the current state.On Response Play the animation.
Off Response None
Parameters
Animation: Name of the animation. This is selectable from a list of possible animations for the object that is linked. Hold Last Frame: If true, the model will stay in the last frame of animation. This is only valid if the animation is defined as an action animation. |
Set_AI_Mode
|
Set_AI_ModeOn Response None
Off Response None
Parameters
|
Set_Friendliness
|
Set_FriendlinessThis Event will set the Friendliness of all linked objects.On Response Change the Friendliness of an entity.
Off Response None
Parameters
Friendliness: The friendliness is selectable from a drop-down list, and consists of the following choices: 1. Unfriendly: AI will attack the player on sight. |
Shoot_At
|
Shoot_AtThis Event will cause all linked AI to shoot at the Event location. The AI will continue to shoot at the Event until an Off message is received.On Response Make all linked AI attack the Event location.
Off Response Make all linked AI stop attacking the Event location.
Parameters
|
Shoot_Once
|
Shoot_OnceThis Event will make all linked AI shoot once in the direction they are currently facing.On Response Fire a single time.
Off Response None
Parameters
Shoot Type: Primary, Secondary, Flare. What type of weapon to use. |
Catalysts
Cyclic_Timer
|
Cyclic_TimerThis Event will send an On message to all linked Events at a specified interval. This Event has to receive an On Message before it will begin sending out messages.On Response Begin sending On messages at the specified interval.
Off Response None
Parameters
Time: The interval in seconds between sending On messages to all linked Events Max Sends: The number of times the Event will send out On messages Send Forever: If true, the Max Sends field is ignored, and the Cyclic Timer sends On messages forever |
Delay
|
DelayOn Response None
Off Response None
Parameters
|
Invert
|
InvertThis Event will change On messages to Off messages (and Off to On) before forwarding them to any linked Events.On Response Change message to Off.
Off Response Change message to On.
Parameters
|
Switch
|
SwitchThis Event behaves like a switch that remembers it’s state (on or off). This Event can be used to turn lights on or off, and can be used to let the player activate special events. If the Event is linked to a VFX, this VFX is used as the model for the switch (the default state of the VFX should be off, with the animation taking the VFX to the on state).On Response Toggle the state of the switch. The behavior of the switch is controlled through the Event parameters.
Off Response None
Parameters
Initial State: The initial state of the switch (either on or off) Behavior: This says what kind of signal the switch will send. (toggle between on and off, always send an on, always send an off) Sound: Disk filename (including the .wav extension) of the sound to play when the switch is thrown Max Throws: How many times the switch can be thrown Infinite Throws: If true, the Max Throws parameter is ignored, and the switch can be thrown an infinite number of times. |
When_Armor_Reaches
|
When_Armor_ReachesOn Response None
Off Response None
Parameters
|
When_Countdown_Over
|
When_Countdown_OverOn Response None
Off Response None
Parameters
|
When_Countdown_Reaches
|
When_Countdown_ReachesOn Response None
Off Response None
Parameters
|
When_Cutscene_Over
|
When_Cutscene_OverOn Response None
Off Response None
Parameters
|
When_Dead
|
When_DeadThis Event will send an On message to all linked Events when all linked objects have died. This Event is used when you want to do something when a specific object has been destroyed.On Response None
Off Response None
Parameters
|
When_Enter_Vehicle
|
When_Enter_VehicleOn Response None
Off Response None
Parameters
|
When_Hit
|
When_HitOn Response None
Off Response None
Parameters
|
When_Life_Reaches
|
When_Life_ReachesOn Response None
Off Response None
Parameters
|
When_Try_Exit_Vehicle
|
When_Try_Exit_VehicleOn Response None
Off Response None
Parameters
|
Level
Alarm
|
AlarmOn Response None
Off Response None
Parameters
|
Alarm_Siren
|
Alarm_SirenOn Response None
Off Response None
Parameters
|
Cutscene
|
CutsceneOn Response None
Off Response None
Parameters
|
|
On Response None
Off Response None
Parameters
|
Endgame
|
EndgameOn Response None
Off Response None
Parameters
|
Explode
|
ExplodeThis Event will cause an explosion to occur at the Event location. The explosion can be made to cause a geomod, and you can control the amount of damage caused by the explosion.On Response Make the explosion happen.
Off Response None
Parameters
Damage: The amount of damage caused by the explosion. This is the damage that is applied to any object within the explosion range. Type: Small, Medium, Large. This field isn’t properly supported yet. We need to list a selection of different explosions to choose from. Geomod: If true, the explosion will apply a geomod at the center of the explosion. The hardness of the rock where the explosion occurs is used to determine if a geomod is possible. |
Goal_Check
|
Goal_CheckThis Event can either block or forward On messages, depending on the state of an associated goal_set Event.On Response Foward On messages if min_count exceeds the current count value of the associated goal_set Event
Off Response None
Parameters
Goal Name: Script name for the associated Goal_Set Event Minimum Count: The miniumum value that the associated Goal_Set Event must have before forwarding messages |
Goal_Create
|
Goal_CreateOn Response None
Off Response None
Parameters
|
Goal_Set
|
Goal_SetThis Event will increment a count variable every time it receives an On message (Off messages will cause the count value to decrement).On Response Increment count by one.
Off Response Decrement count by one.
Parameters
Start Count: The inital value of the count variable (this will be zero in most cases). |
Item_Pickup_State
|
Item_Pickup_StateOn Response None
Off Response None
Parameters
|
Load_Level
|
Load_LevelThis Event will cause the specified level to load. The Player will be taken to the new level seamlessly.On Response Load the specified level.
Off Response None
Parameters
Filename: Disk filename (including the .d4l extension) of the level to load. Start Marker id: The unique id of the Drop_Point_Marker associated with the level transition. |
Message
|
MessageThis Event will make a sound file play and display the associated text on the Player HUD.On Response Play the message.
Off Response None
Parameters
Persona: Selectable from drop-down list of names which is generated from personas.tbl. Select "none" if you don’t want the message to be from a persona. Voice Filename: Disk filename (including .wav extension) of the sound file to play. |
Monitor_State
|
Monitor_StateOn Response None
Off Response None
Parameters
|
Music_Start
|
Music_StartOn Response None
Off Response None
Parameters
|
Music_Stop
|
Music_StopOn Response None
Off Response None
Parameters
|
Play_Sound
|
Play_SoundThis Event will cause a sound to play. The sound can be a 3D or 2D sound, and it can be made to loop.On Response Start playing the sound.
Off Response Stop the sound, if it is playing.
Parameters
Sound Filename: Disk filename of the sound to play (including .wav extension). Min Distance: Distance (in meters) where the sound begins to drop off in volume. If you don’t want the sound to be 3D, set the Min Distance to zero. Looping: If true, the sound will play looping (until you stop it by sending an Off message to this Event). |
Play_Vclip
|
Play_VclipOn Response None
Off Response None
Parameters
|
Remove_Object
|
Remove_ObjectThis Event will destroy all objects linked to the event. Objects will disappear instantly (i.e., without their death sequence).On Response Kill all linked objects immediately.
Off Response None
Parameters
|
Slay_Object
|
Slay_ObjectThis Event will kill all linked objects, and allow their death sequence to play.On Response Kill all linked objects.
Off Response None
Parameters
|
Spawn_Object
|
Spawn_ObjectThis Event will cause a specific object type to be created. The object is created at the Event location, with an identity matrix orientation.On Response Spawn the object at the Event location.
Off Response None
Parameters
Object Type: Entity, Clutter, Item. Selectable from a drop-down list. Object Class: The classname of the object. Selectable from a drop-down list. The choice here depends on the Object Type that has been selected. |
Swap_Textures
|
Swap_TexturesThis Event will cause the specified textures (up to 2 per Event) to be used on all linked objects.On Response Swap the textures.
Off Response None
Parameters
Texture Num: Texture index to swap (starts from 0) Texture Filename: Disk filename (including extension) of the texture bitmap to use |
Modifiers
Armor
|
ArmorOn Response None
Off Response None
Parameters
|
Black_Out_Player
|
Black_Out_PlayerOn Response None
Off Response None
Parameters
|
Bolt_State
|
Bolt_StateOn Response None
Off Response None
Parameters
|
Clear_Endgame_If_Killed
|
Clear_Endgame_If_KilledOn Response None
Off Response None
Parameters
|
Continuous_Damage
|
Continuous_DamageCause the AI or Player which triggered the event to receive damage (use a trigger reset time of 0 to make the damage continuous).On Response Apply damage to the entity who triggered the event. Any linked objects will also receive damage.
Off Response None
Parameters
Damage Per Sec: Damage per second applied. (0 is instant death) Damage Type: melee, bullet, armor piercing bullet, explosive, fire, energy, electrical, acid, scalding. |
Detach
|
DetachOn Response None
Off Response None
Parameters
|
Fog_State
|
Fog_StateOn Response None
Off Response None
Parameters
|
Force_Monitor_Update
|
Force_Monitor_UpdateOn Response None
Off Response None
Parameters
|
Give_Item_To_Player
|
Give_Item_To_PlayerThis Event will make the player pick up a specific item. Items are normally automatically picked up by the player when he gets close enough to them. All game items are specified in items.tbl.On Response Give the player the specified item.
Off Response None
Parameters
Item: Item class name, which is selectable from a drop-down list of all items from items.tbl. |
Go_Undercover
|
Go_UndercoverOn Response None
Off Response None
Parameters
|
Heal
|
HealThis Event will add life to all the linked objects. This Event can be used to damage events by using a negative Life Delta value.On Response Add the Event Life Delta value to the life of all linked objects.
Off Response None
Parameters
Life Delta: How much life to add (negative amount will cause damage) |
Ignite_Entity
|
Ignite_EntityOn Response None
Off Response None
Parameters
|
Make_Fly
|
Make_FlyThis Event will make the linked AI enter fly mode. If the AI is already flying, this Event does nothing. This Event can only make AI fly if it normally has the ability (i.e., this Event can’t make a Cave Slug fly).On Response Make linked AI enter fly mode.
Off Response None
Parameters
|
Make_Invulnerable
|
Make_InvulnerableOn Response None
Off Response None
Parameters
|
Make_Walk
|
Make_WalkThis Event will make the linked AI enter walk mode. If the AI is already walking, this Event does nothing. This Event can only make AI walk if it normally has the ability (i.e., this Event can’t make a Grabber walk).On Response Make linked AI enter walk mode.
Off Response None
Parameters
|
Modify_Rotating_Mover
|
Modify_Rotating_MoverOn Response None
Off Response None
Parameters
|
Mover_Pause
|
Mover_PauseOn Response None
Off Response None
Parameters
|
Particle_State
|
Particle_StateOn Response None
Off Response None
Parameters
|
Push_Region_State
|
Push_Region_StateOn Response None
Off Response None
Parameters
|
Reverse_Mover
|
Reverse_MoverOn Response None
Off Response None
Parameters
|
Set_Gravity
|
Set_GravityOn Response None
Off Response None
Parameters
|
Shake_Player
|
Shake_PlayerThis Event will shake the viewpoint of the Player.On Response Start shaking the Player camera.
Off Response None
Parameters
Magnitude: How strong to make the shaking. This value is the max amplitude of the shake in meters. Time: How long to shake the camera in seconds. |
Skybox_State
|
Skybox_StateOn Response None
Off Response None
Parameters
|
Strip_Player_Weapons
|
Strip_Player_WeaponsOn Response None
Off Response None
Parameters
|
Switch_Model
|
Switch_ModelThis Event will change the model of all linked objects to the model filename that is contained in the Event.On Response Change the model.
Off Response None
Parameters
Model filename: Disk filename (with extension) of the model to switch to. |
Teleport
|
TeleportThis Event will teleport all linked objects to the Event location. There are no special effects associated with the teleportation.On Response Teleport all linked objects.
Off Response None
Parameters
|
Teleport_Player
|
Teleport_PlayerOn Response None
Off Response None
Parameters
|
Turn_Off_Physics
|
Turn_Off_PhysicsOn Response None
Off Response None
Parameters
|
Unhide
|
UnhideOn Response None
Off Response None
Parameters
|
Special
Activate_Capek_Shield
|
Activate_Capek_ShieldOn Response None
Off Response None
Parameters
|
Countdown_Begin
|
Countdown_BeginOn Response None
Off Response None
Parameters
|
Countdown_End
|
Countdown_EndOn Response None
Off Response None
Parameters
|
Defuse_Nuke
|
Defuse_NukeOn Response None
Off Response None
Parameters
|
Display_Fullscreen_Image
|
Display_Fullscreen_ImageOn Response None
Off Response None
Parameters
|
Fire_Weapon_No_Anim
|
Fire_Weapon_No_AnimOn Response None
Off Response None
Parameters
|
Never_Leave_Vehicle
|
Never_Leave_VehicleOn Response None
Off Response None
Parameters
|
Win_PS2_Demo
|
Win_PS2_DemoOn Response None
Off Response None
Parameters
|
Continuous Damage Description Cause the AI or Player which triggered the event to receive damage (use a trigger reset time of 0 to make the damage continuous).
On Response Apply damage to the entity who triggered the event. Any linked objects will also receive damage.
Off Response None.
Parameters Damage_per_second: Damage per second applied.
Damage_type: Generic, Brushing, Burning. Currently the only supported damage_type is Generic.
Cyclic Timer Description This Event will send an On message to all linked Events at a specified interval. This Event has to receive an On Message before it will begin sending out messages.
On Response Begin sending On messages at the specified interval.
Off Response None.
Parameters Time: The interval in seconds between sending On messages to all linked Events
Max Sends: The number of times the Event will send out On messages
Send Forever: If true, the Max Sends field is ignored, and the Cyclic Timer sends On messages forever
Drop Point Marker Description This is a special type of Event which doesn’t respond to On or Off messages. This Event is used as a position where AI will drop off objects while in AI_COLLECTING_MODE. This is how Grabber robots can drop their rocks off at a specific location.
On Response None.
Off Response None.
Parameters None.
Explode Description This Event will cause an explosion to occur at the Event location. The explosion can be made to cause a geomod, and you can control the amount of damage caused by the explosion.
On Response Make the explosion happen.
Off Response None.
Parameters Damage: The amount of damage caused by the explosion. This is the damage that is applied to any object within the explosion range.
Type: Small, Medium, Large. This field isn’t properly supported yet. We need to list a selection of different explosions to choose from.
Geomod: If true, the explosion will apply a geomod at the center of the explosion. The hardness of the rock where the explosion occurs is used to determine if a geomod is possible.
Follow_Waypoints
Description
This event will force all linked objects to follow a specified waypoint list, with a specific following method.
On Response Begin following the waypoints. An AI will use the closest waypoint as the location to begin the path following.
Off Response Stop following the current waypoint path.
Parameters Waypoint List: Name of the waypoint list that the AI should follow.
Always Face Player: If true, the AI will always face the player while following their waypoints
Max Speed Scale (0-100): Used to make the AI move slower while following waypoints
Follow Method: This determines how the AI will behave when the last waypoint node is reached. The choices are: 1. One way: follow the waypoints to the last node and stop. 2. Loop: follow the waypoints to the last node, then return to the start and repeat 3. Ping Pong: follow the waypoints to the last node, then follow the nodes back to the start (repeat).
Follow_Player Description This Event will force all linked objects to follow and protect the Player. This should only be used to make Hendrix follow (or stop following) the Player.
On Response Make linked entities follow the Player.
Off Response Make linked entities stop following the Player.
Parameters None.
Give_Item_To_Player Description This Event will make the player pick up a specific item. Items are normally automatically picked up by the player when he gets close enough to them. All game items are specified in items.tbl.
On Response Give the player the specified item.
Off Response None.
Parameters Item: Item class name, which is selectable from a drop-down list of all items from items.tbl.
Goal_Check Description This Event can either block or forward On messages, depending on the state of an associated goal_set Event.
On Response Foward On messages if min_count exceeds the current count value of the associated goal_set Event
Off Response None.
Parameters Goal Name: Script name for the associated Goal_Set Event Minimum Count: The miniumum value that the associated Goal_Set Event must have before forwarding messages
Goal_Set Description This Event will increment a count variable every time it receives an On message (Off messages will cause the count value to decrement).
On Response Increment count by one.
Off Response Decrement count by one.
Parameters Start Count: The inital value of the count variable (this will be zero in most cases).
Goto Description This Event will make all linked entities travel to the Event location.
On Response Make linked entities start moving towards Event location.
Off Response None.
Parameters Always Face Player: If true, the AI will always face the player while following their waypoints Max Speed Scale (0-100): Used to make the AI move slower while following waypoints
Goto_Player Description This Event will make all linked entities travel to the Player position. The linked entities will continue to pathfind to the Player until they have line-of-sight. When the entities can see the Player, they will return to their default AI.
On Response Make linked entities start moving towards the Player.
Off Response None.
Parameters None.
Heal Description This Event will add life to all the linked objects. This Event can be used to damage events by using a negative Life Delta value.
On Response Add the Event Life Delta value to the life of all linked objects.
Off Response None.
Parameters Life Delta: How much life to add (negative amount will cause damage)
Invert Description This Event will change On messages to Off messages (and Off to On) before forwarding them to any linked Events.
On Response Change message to Off.
Off Response Change message to On.
Parameters None.
Level_Transition_Marker Description This is a special type of Event which doesn’t respond to On or Off messages. This Event is used to maintain the correct positions and orientations off all objects in the transition areas between levels. This Event needs to be placed in the location of the trigger which causes level loading in the other level involved in the transition.
On Response None.
Off Response None.
Parameters None.
Load_Level Description This Event will cause the specified level to load. The Player will be taken to the new level seamlessly.
On Response Load the specified level.
Off Response None.
Parameters Filename: Disk filename (including the .d4l extension) of the level to load. Start Marker id: The unique id of the Drop_Point_Marker associated with the level transition.
Look_At Description This Event will cause any linked AI to turn and face the Event location.
On Response Make linked AI look at the Event.
Off Response None.
Parameters None.
Play_Sound Description This Event will cause a sound to play. The sound can be a 3D or 2D sound, and it can be made to loop.
On Response Start playing the sound.
Off Response Stop the sound, if it is playing.
Parameters Sound Filename: Disk filename of the sound to play (including .wav extension).
Min Distance: Distance (in meters) where the sound begins to drop off in volume. If you don’t want the sound to be 3D, set the Min Distance to zero.
Looping: If true, the sound will play looping (until you stop it by sending an Off message to this Event).
Make_Fly Description This Event will make the linked AI enter fly mode. If the AI is already flying, this Event does nothing. This Event can only make AI fly if it normally has the ability (i.e., this Event can’t make a Cave Slug fly).
On Response Make linked AI enter fly mode.
Off Response None.
Parameters None.
Make_Walk Description This Event will make the linked AI enter walk mode. If the AI is already walking, this Event does nothing. This Event can only make AI walk if it normally has the ability (i.e., this Event can’t make a Grabber walk).
On Response Make linked AI enter walk mode.
Off Response None.
Parameters None.
Message Description This Event will make a sound file play and display the associated text on the Player HUD.
On Response Play the message.
Off Response None.
Parameters Persona: Selectable from drop-down list of names which is generated from personas.tbl. Select "none" if you don’t want the message to be from a persona.
Voice Filename: Disk filename (including .wav extension) of the sound file to play.
Play_Animation Description This event will cause a linked AI to play a specific animation. If the animation is a state animation (i.e., a looping animation) then it will replace the current animation state for the AI. If the animation is an action animation (i.e., a one-time animation) then it is blended with the current state.
On Response Play the animation.
Off Response None.
Parameters Animation: Name of the animation. This is selectable from a list of possible animations for the object that is linked.
Hold Last Frame: If true, the model will stay in the last frame of animation. This is only valid if the animation is defined as an action animation.
Remove_Object Description This Event will destroy all objects linked to the event. Objects will disappear instantly (i.e., without their death sequence).
On Response Kill all linked objects immediately.
Off Response None.
Parameters None.
Set_Friendliness Description This Event will set the Friendliness of all linked objects.
On Response Change the Friendliness of an entity.
Off Response None.
Parameters Friendliness: The friendliness is selectable from a drop-down list, and consists of the following choices:
1. Unfriendly: AI will attack the player on sight. 2. Neutral: AI will only attack the player if provoked. 3. Friendly: AI will not attack the player, and may attack entities that are attacking the player. 4. Outcast: AI will attack anything it sees.
Set_Light_State Description This Event will set the state of any linked lights. Currently this event can set a light on or off, but any light related changes (like making a light flash, change color, etc.) can be data within this event.
On Response Change the state of all linked lights.
Off Response None.
Parameters State: On or Off
Slay_Object Description This Event will kill all linked objects, and allow their death sequence to play.
On Response Kill all linked objects.
Off Response None.
Parameters None.
Shake_Player Description This Event will shake the viewpoint of the Player.
On Response Start shaking the Player camera.
Off Response None.
Parameters Magnitude: How strong to make the shaking. This value is the max amplitude of the shake in meters.
Time: How long to shake the camera in seconds.
Shield Description This Event will add the Shield Delta value to the shield of all linked objects.
On Response Add Shield Delta to all linked objects shields.
Off Response None.
Parameters Shield Delta: The amount of shield to add (you can decrease shield by using a negative number here).
Shoot_At Description This Event will cause all linked AI to shoot at the Event location. The AI will continue to shoot at the Event until an Off message is received.
On Response Make all linked AI attack the Event location.
Off Response Make all linked AI stop attacking the Event location.
Parameters None.
Shoot_Once Description This Event will make all linked AI shoot once in the direction they are currently facing.
On Response Fire a single time.
Off Response None.
Parameters Shoot Type: Primary, Secondary, Flare. What type of weapon to use.
Spawn_Object Description This Event will cause a specific object type to be created. The object is created at the Event location, with an identity matrix orientation. [FIXME: we may want to give events an orientation]
On Response Spawn the object at the Event location.
Off Response None.
Parameters Object Type: Entity, Clutter, Item. Selectable from a drop-down list.
Object Class: The classname of the object. Selectable from a drop-down list. The choice here depends on the Object Type that has been selected.
Swap_Textures Description This Event will cause the specified textures (up to 2 per Event) to be used on all linked objects.
On Response Swap the textures.
Off Response None.
Parameters Texture Num: Texture index to swap (starts from 0)
Texture Filename: Disk filename (including extension) of the texture bitmap to use
Switch Description This Event behaves like a switch that remembers it’s state (on or off). This Event can be used to turn lights on or off, and can be used to let the player activate special events. If the Event is linked to a VFX, this VFX is used as the model for the switch (the default state of the VFX should be off, with the animation taking the VFX to the on state).
On Response Toggle the state of the switch. The behavior of the switch is controlled through the Event parameters.
Off Response None.
Parameters Initial State: The initial state of the switch (either on or off)
Behavior: This says what kind of signal the switch will send. (toggle between on and off, always send an on, always send an off)
Sound: Disk filename (including the .wav extension) of the sound to play when the switch is thrown
Max Throws: How many times the switch can be thrown
Infinite Throws: If true, the Max Throws parameter is ignored, and the switch can be thrown an infinite number of times.
Switch_Model Description This Event will change the model of all linked objects to the model filename that is contained in the Event.
On Response Change the model.
Off Response None.
Parameters Model filename: Disk filename (with extension) of the model to switch to.
Teleport Description This Event will teleport all linked objects to the Event location. There are no special effects associated with the teleportation.
On Response Teleport all linked objects.
Off Response None.
Parameters None.
When Dead Description This Event will send an On message to all linked Events when all linked objects have died. This Event is used when you want to do something when a specific object has been destroyed.
On Response None.
Off Response None.
Parameters None.