modding:function:objaddoverlay
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 === | === objAddOverlay === | ||
- | ^ Syntax | (objAddOverlay obj overlayType pos rotation [lifetime]) | | + | ^ Syntax |
- | ^ Arguments | obj: The space object to add the overlay on | | + | ^ |
- | ^ | overlayType: | + | ^ 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]]| | ^ Category | [[spaceObject functions]]| | ||
^ Description | Adds an overlay to a spaceObject. | | ^ Description | Adds an overlay to a spaceObject. | |
modding/function/objaddoverlay.1486091079.txt.gz · Last modified: 2017/02/03 03:04 by xephyr