modding:function:objsetoverlayproperty
Discuss this page on this pages TalkPage
objSetOverlayProperty
| Syntax | (objSetOverlayProperty obj overlayID property value) |
|---|---|
| Arguments | obj: the object the overlay is on (can be itself) |
| overlayID: The ID of the overlay. If the overlay itself is calling this function use aOverlayID. | |
| property: the property on the overlay to set (see table below) | |
| value: the new value of the property | |
| Returns | |
| Category | space_objects overlays |
| Description | Sets a property on an overlay. Useful mostly for counter overlays, but also useful for setting position and rotation. |
Properties
'counter 'counterLabel 'pos position 'rotation angle
Example
(objSetOverlayProperty gSource aOverlayID 'counter 25)
Sets the counter property to 25 ticks.
Return to Object functions list
Return to Functions list
modding/function/objsetoverlayproperty.txt · Last modified: 2017/01/24 05:33 by xephyr