Clarify add_event_handler in docs
This commit is contained in:
parent
b4eec2c364
commit
85d5af180b
|
@ -276,7 +276,7 @@ Registers a ``handler`` to be called when ``event`` is dispatched. The handler f
|
|||
|
||||
func my_event_handler(cargo=null) -> bool:
|
||||
|
||||
Cargo is an optional parameter that can be passed to the handler. See also :ref:`dispatch<class_LimboState_method_dispatch>`.
|
||||
If the handler returns ``true``, the event will be consumed. Cargo is an optional parameter that can be passed to the handler. See also :ref:`dispatch<class_LimboState_method_dispatch>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
[codeblock]
|
||||
func my_event_handler(cargo=null) -> bool:
|
||||
[/codeblock]
|
||||
Cargo is an optional parameter that can be passed to the handler. See also [method dispatch].
|
||||
If the handler returns [code]true[/code], the event will be consumed. Cargo is an optional parameter that can be passed to the handler. See also [method dispatch].
|
||||
</description>
|
||||
</method>
|
||||
<method name="call_on_enter">
|
||||
|
|
Loading…
Reference in New Issue