Trap system - Revision history

Sunjammer at 23:10, 8 March 2012

2012-03-08T23:10:39Z

Sunjammer: Adding intro, fixing links, fixing typos, adding links

2012-03-08T23:09:31Z

Adding intro, fixing links, fixing typos, adding links

Show changes

Axe Murderer: grammar

2009-10-24T06:25:32Z

grammar

Axe Murderer: spelling and grammar changes

2009-10-24T06:22:15Z

spelling and grammar changes

Axe Murderer: a couple of spelling and punctuation fixes

2009-10-24T05:43:37Z

a couple of spelling and punctuation fixes

Axe Murderer: re-did logic "diagram" to change its orientation from across the page to down the page so it would fit better.

2009-10-24T05:26:33Z

re-did logic "diagram" to change its orientation from across the page to down the page so it would fit better.

Axe Murderer: re-did "flow diagrams" so they are oriented down the page rather than across. They were running way off the right edge and were "misaligned".

2009-10-24T05:11:30Z

re-did "flow diagrams" so they are oriented down the page rather than across. They were running way off the right edge and were "misaligned".

Axe Murderer: reworded a fragmented sentence

2009-10-24T04:58:25Z

reworded a fragmented sentence

BryanDerksen: /* Setting up the traps */ remove a stray hard return

2009-09-04T16:34:27Z

‎Setting up the traps: remove a stray hard return

BryanDerksen: /* Setting up the traps */ more descriptions from var_placeable

2009-09-04T16:34:12Z

‎Setting up the traps: more descriptions from var_placeable

@@ Line 30: / Line 30: @@
 Once a trap placeable is armed, it will automatically spawn an [[EFFECT_TYPE_*|EFFECT_TYPE_AOE]] onto itself that provides the trigger mechanism for the trap. The type of the area of effect object spawned is defined for each trap type in [[traps.xls]], pointing to an entry in [[AOE.xls]] defining the dimensions of the trigger volume. Afterwards, if a Signal Target was defined on the placeable, the target object will receive [[EVENT_TYPE_TRAP_TRIGGER_ARMED]].
-Logic path:
+=== Logic Tree ===
 Pre-placed:
@@ Line 77: / Line 77: @@
 * If the trap does not have an owner set, it is considered an environmental trap and only hostile to the player's group. If the entering creature is not a member of the player's group, the function exists immediately without applying any effects.
-Logic Tree:
+=== Logic Tree ===
 <pre>

@@ Line 101: / Line 101: @@
 The presence of the trap skill on a member of the player's party will automatically spawn an EFFECT_TYPE_HEARTBEAT on that creature, which runs the function [[Trap_RunDetectionPulse]] from sys_traps_h at predefined intervals that shorten based on skill level.
-The detection pulse function scans the area around the party member, to a range based on the character's skill level, looking for active placeable objects and inspecting the Trap Type and Detected states on them. Each pulse, the 10 closest placeable objects to the player's current location are inspected.
+The detection pulse function scans the area around the party member, to a range based on the character's skill level, looking for active placeable objects and inspecting their Trap Type and Detected states. Each pulse, the 10 closest placeable objects to the player's current location are inspected.
 When an undetected trap is found, a skill check (defined in sys_traps_h.[[TrapTryDetect]]()) determines whether or not the player detects it. This check is based partially on the player's traps rank.

@@ Line 99: / Line 99: @@
 == Trap Detection ==
-The presence of the trap skill on member of the player's party will automatically spawn an EFFECT_TYPE_HEARTBEAT on that creature, which runs the function [[Trap_RunDetectionPulse]] from sys_traps_h at predefined intervals that shorten based on skill level.
+The presence of the trap skill on a member of the player's party will automatically spawn an EFFECT_TYPE_HEARTBEAT on that creature, which runs the function [[Trap_RunDetectionPulse]] from sys_traps_h at predefined intervals that shorten based on skill level.
-The detection pulse function scans the area around the party member to a range based on the character's skill level for active placeable objects and inspects the found objects for their Trap Type and Detected state. Each pulse, the 10 closes placeable objects to the players current location are inspected.
+The detection pulse function scans the area around the party member, to a range based on the character's skill level, looking for active placeable objects and inspecting the Trap Type and Detected states on them. Each pulse, the 10 closest placeable objects to the player's current location are inspected.
-For object to be found to be an undetected trap, a skill check (defined in sys_traps_h.[[TrapTryDetect]]()) determines whether or not the player detects the trap. This check is based partially on the players traps rank.
+When an undetected trap is found, a skill check (defined in sys_traps_h.[[TrapTryDetect]]()) determines whether or not the player detects it. This check is based partially on the player's traps rank.
-On successful detection, the object is flagged as detected and thereby made visible to the player and his party. An additional visual effect is spawned to provide a visual cue to the player about the detection. We are still considering whether the game will auto pause in the event of a detected trap.
+On successful detection, the object is flagged as detected and thereby made visible to the player and his party. Another visual effect is also spawned to provide an additional visual cue to the player about the detection. We are still considering whether the game will auto pause in the event of a detected trap.
 == Trap Disarming ==

@@ Line 59: / Line 59: @@
 Any creature object entering the area of effect object trigger around an armed trap object will cause an EVENT_ENTER to fire into placeable_core.nss, which will call the function [[Trap_HandleEventEnter]]() in [[sys_traps_h]].
-Here, a number of conditions are checked to validate if the entering object will to set the trap off:
+Here, a number of conditions are checked to validate if the entering object triggers the trap:
 If the trap object is currently set inactive, the function will exit immediately without applying any effects.
@@ Line 93: / Line 93: @@
 </pre>
-If all conditions are satisifed and the entering object has been found valid for triggering the trap, the function [[Trap_TriggerTrap]]() is called from [[sys_traps_h]], causing the effects defined in traps.xls to be applied to the entering object. In addition, if a Signal Target was defined on the trap placeable, [[EVENT_TYPE_TRAP_TRIGGER_ENTER]] will be fired to the closes object matching the 'PLC_SIGNAL_TAG' string variable on the placeable, allowing triggering of designer defined events (such as running environmental traps).
+If all conditions are satisifed and the entering object has been found valid for triggering the trap, the function [[Trap_TriggerTrap]]() is called from [[sys_traps_h]], causing the effects defined in traps.xls to be applied to the entering object. In addition, if a Signal Target was defined on the trap placeable, [[EVENT_TYPE_TRAP_TRIGGER_ENTER]] will be fired to the closest object matching the 'PLC_SIGNAL_TAG' string variable on the placeable. This allows for the triggering of designer defined events (such as running environmental traps).
-After running, the trap disables itself, preventing any further triggering from entering objects. Traps that have a 'Rearming Delay' specified will automatically reactivate after the specified amount of time - all other traps will self destruct after 1000ms.
+After running, the trap disables itself, preventing any further triggering from entering objects. Traps that have a 'Rearming Delay' specified will automatically reactivate after the specified amount of time - all other traps will self destruct after 1000ms (1 sec).
 == Trap Detection ==

@@ Line 70: / Line 70: @@
 <pre>
-object enters -- Trap Active? -- Yes --> Have Owner -- Yes --> object hostile to owner -- Yes --> Trigger Trap!
+object enters
-                              \-- No --> do nothing.     \
-                                                         \ --> IsPartyMember(object) -- Yes --> Trigger Trap!
-                                                                                        \-- No --> do nothing.
+   is Trap Active?  --No--> do nothing.
 </pre>
 If all conditions are satisifed and the entering object has been found valid for triggering the trap, the function [[Trap_TriggerTrap]]() is called from [[sys_traps_h]], causing the effects defined in traps.xls to be applied to the entering object. In addition, if a Signal Target was defined on the trap placeable, [[EVENT_TYPE_TRAP_TRIGGER_ENTER]] will be fired to the closes object matching the 'PLC_SIGNAL_TAG' string variable on the placeable, allowing triggering of designer defined events (such as running environmental traps).
 After running, the trap disables itself, preventing any further triggering from entering objects. Traps that have a 'Rearming Delay' specified will automatically reactivate after the specified amount of time - all other traps will self destruct after 1000ms.
 == Trap Detection ==

@@ Line 25: / Line 25: @@
 <pre>
-object spawns --> object has trap type set -- Yes --> object active? -- Yes --> object arms itself --> object spawns AoE trigger on itself
+object spawns
-                                               \ -- No --> do nothing    \
-                                                                          \ -- No --> do nothing.
 </pre>
@@ Line 33: / Line 45: @@
 <pre>
-Trap Item Ability Use --> Placeable object is created (inactive) --> object is armed/activated after delay --> object spawns AoE trigger on itself
+Trap Item Ability Use
 </pre>

@@ Line 16: / Line 16: @@
 When a pre placed object is initially loaded, it will receive an EVENT_SPAWN, during which the default placeable event script ([[placeable_core]].nss) will automatically 'arm' the trap if the object is 'active' at that time. If the object is not active, it needs to be activated and armed manually by the designer. This can be done by calling the function [[TrapArm]]() in [[sys_traps_h]].
-Dynamically spawned traps are created when a player controlled character uses one of the trap kit item abilities from their quickbar, causing the character to play a kneeling 'conjure' animation. The object will spawn in as initially inactive at the players location and will arm through a delayed itself after a short grace period to allow the player to exit the danger area around the trap. The player will also automatically be set as the traps owner:
+Dynamically spawned traps are created when a player controlled character uses one of the trap kit item abilities from their quickbar, causing the character to play a kneeling 'conjure' animation. The object will spawn in as initially inactive at the players location and will arm itself after a short grace period to allow the player to exit the danger area around the trap. The player will also automatically be set as the trap's owner.
-Once a trap placeable is armed, it will automatically spawn an EFFECT_AREA_OF_EFFECT onto itself that provides the trigger mechanism for the trap. The type of the area of effect object are defined for each trap type in [[traps.xls]], pointing to an entry in [[aoe.xls]] defining the dimensions of the trigger volume. Aftwards, if a Signal Target was defined on the placeable, the target object will receive [[EVENT_TYPE_TRAP_TRIGGER_ARMED]].
+Once a trap placeable is armed, it will automatically spawn an EFFECT_AREA_OF_EFFECT onto itself that provides the trigger mechanism for the trap. The type of the area of effect object spawned is defined for each trap type in [[traps.xls]], pointing to an entry in [[aoe.xls]] defining the dimensions of the trigger volume. Aftwards, if a Signal Target was defined on the placeable, the target object will receive [[EVENT_TYPE_TRAP_TRIGGER_ARMED]].
 Logic path:

@@ Line 96: / Line 96: @@
 {{variable table row|PLC_TRAP_OWNER| object | 0 | Set when a trap is spawned from scripting}}
 {{variable table row|PLC_TRAP_REARM_DELAY | float |0| If this is set to anything other than 0, the trap will rearm after triggering in so many seconds.}}
-{{variable table row|PLC_TRAP_SIGNAL_HEIGHT | float |1| height projectiles are fired from projectile traps.
+{{variable table row|PLC_TRAP_SIGNAL_HEIGHT | float |1| height projectiles are fired from projectile traps.}}
 }}
 {{variable table row|PLC_TRAP_SIGNAL_TAG | string || Tag of the object that will be notified of enter events. }}
 {{variable table row|PLC_TRAP_TEAM | int |0|the team which will approach the trap when triggered}}

@@ Line 90: / Line 90: @@
 {{variable table start}}
-{{variable table row|PLC_TRAP_AOE | int | |}}
+{{variable table row|PLC_TRAP_AOE | int | | index into [[AOE.xls]] identifying the AOE trigger the trap should use}}
-{{variable table row|PLC_TRAP_DEACTIVATE | int | |}}
+{{variable table row|PLC_TRAP_DEACTIVATE | int |0 |1/0 to indicate whether trap should be set inactive once triggered.}}
 {{variable table row|PLC_TRAP_DETECTED | int |0| Defines if the trap is visible or not when spawned.}}
 {{variable table row|PLC_TRAP_OWNER| object | 0 | Set when a trap is spawned from scripting}}
-{{variable table row|PLC_TRAP_REARM_DELAY | float || If this is set to anything other than 0, the trap will rearm after triggering in so many seconds.}}
+{{variable table row|PLC_TRAP_REARM_DELAY | float |0| If this is set to anything other than 0, the trap will rearm after triggering in so many seconds.}}
-{{variable table row|PLC_TRAP_SIGNAL_HEIGHT | float || }}
+{{variable table row|PLC_TRAP_SIGNAL_HEIGHT | float |1| height projectiles are fired from projectile traps.
 {{variable table row|PLC_TRAP_SIGNAL_TAG | string || Tag of the object that will be notified of enter events. }}
-{{variable table row|PLC_TRAP_TEAM | int ||}}
+{{variable table row|PLC_TRAP_TEAM | int |0|the team which will approach the trap when triggered}}
-{{variable table row|PLC_TRAP_TYPE | int || a row in [[traps.xls]] indicating what type of trap this is. An object automatically becomes a trap trigger if this is not 0.}}
+{{variable table row|PLC_TRAP_TYPE | int |0| a row in [[traps.xls]] indicating what type of trap this is. An object automatically becomes a trap trigger if this is not 0.}}
 {{variable table end}}