Differences

This shows you the differences between two versions of the page.

--- modding:function:objdamage [2017/02/03 21:32] – created xephyr
+++ modding:function:objdamage [2017/06/26 03:40] (current) – 0xabcdef
@@ Line 3: / Line 3: @@
 === objDamage ===
-^ Syntax | (objDamage obj weaponType objSource [pos] [options]) |
+^ Syntax | (objDamage obj weaponType objSource [pos] [options]) -> result |
-^ Arguments | obj: The space object to damage |
+^ Arguments | obj: The SpaceObject to damage |
 ^ | weaponType: unid of weapon to use to damage the object |
-^ | objSource: the source of the damgage |
+^ | objSource: the source of the damage |
-^ | [pos]: (optional) position of the damage on the receiving object|
+^ | [pos]: Position vector of the damage on the receiving object|
-^ | [options]: (optional) options accepted are 'fullResult and 'noHitEffect. |
+^ | [options]: ? |
-^ Returns | Result |
+^ Returns | result: String code representing the result of the damage |
 ^ Category | [[spaceObject functions]]|
 ^ Description | Use to damage an object directly through a function. Used on Pteravores. |
-=== Option ===
+=== objSource ===
-  'fullResult
+  * Nil
-  'noHitEffect
+  * SpaceObject
+  * (name flags)
-=== Result ===
+    * name: The string name of the cause
+    * flags:
+  * (obj [cause] [secondaryObj] [noun] [nounFlags])
+    * obj: The source of the damage
+    * cause: A destroyReason
+    * secondaryObj: Unused
+    * noun:
+    * nounFlags:
-  'noDamage
+=== options ===
-  'absorbedByShields
-  'armorHit
-  'structuralHit
-  'destroyed
+  * 'fullResult
+  * 'noHitEffect
+=== result ===
+  * 'noDamage
+  * 'absorbedByShields
+  * 'armorHit
+  * 'structuralHit (same as armorHit, but for stations)
+  * 'destroyed
+  * 'passthrough
+  * 'passthroughDestroyed (obj was destroyed AND the shot passed through)
+  * 'destroyedAbandoned (station was destroyed)
+  * "noDamageNoPassthrough",
 === Example ===
@@ Line 37: / Line 54: @@
 Return to [[modding:functions:]] list
+=== References ===
+http://forums.kronosaur.com/viewtopic.php?p=40207#p40207