Differences

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

--- modding:function:objaddoverlay [2017/02/03 03:04] – created xephyr
+++ modding:function:objaddoverlay [2017/02/03 04:01] (current) – Add alternate syntax 0xabcdef
@@ Line 3: / Line 3: @@
 === objAddOverlay ===
-^ Syntax | (objAddOverlay obj overlayType pos rotation [lifetime]) |
+^ Syntax | (objAddOverlay obj overlayType [lifetime]) -> overlayID |
-^ Arguments | obj: The space object to add the overlay on |
+^        | (objAddOverlay obj overlayType pos rotation [lifetime]) -> overlayID |
-^ | overlayType: the overlay type to add to the space object |
+^ Arguments | **obj**: The space object to add the overlay on |
-^ | pos: Optional field. Position of the overlay |
+^ | **overlayType**: the overlay type to add to the space object |
-^ | rotation: Optional field. Rotation of the overlay. |
+^ | **pos**: Optional field. Position of the overlay |
-^ | [lifetime]: Optional field. Lifetime, in ticks, the overlay is on the ship for. |
+^ | **rotation**: Optional field. Rotation of the overlay. |
-^ Returns | Overlay ID |
+^ | **[lifetime]**: Optional field. Lifetime, in ticks, the overlay is on the ship for. |
+^ Returns | A pointer to the created overlay |
 ^ Category | [[spaceObject functions]]|
 ^ Description | Adds an overlay to a spaceObject. |