InvokeState¶
The function invocation state.
Description¶
This class is used by GoostEngine.invoke to manage pending invocations.
Signals¶
- completed ( )
Emitted when the method is successfully called without errors. This signal is not emitted if the invocation is configured as repeating, see is_repeating.
- post_call ( )
Emitted after the method is called.
- pre_call ( )
Emitted when the method is about to be called.
Property Descriptions¶
- String method
| Default | "" |
| Getter | get_target_method() |
The method name which is going to be invoked in the target object (read-only).
- Object target
| Getter | get_target() |
The target Object where the method is going to be invoked (read-only).
- float time_left
| Default | 0.0 |
| Getter | get_time_left() |
The total time left before the target method is called (read-only).
Method Descriptions¶
- void cancel ( )
Cancels the invocation, preventing the target method from being called.
- bool is_active ( )
Tells whether this state is currently processed. If the state is cancelled with cancel, then this will return false.
- bool is_repeating ( )
Tells whether the method invocation is repeated every repeat_rate seconds as requested by GoostEngine.invoke.