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:
|
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
|
.. rst-class:: classref-item-separator
|
||||||
|
|
||||||
|
|
|
@ -45,7 +45,7 @@
|
||||||
[codeblock]
|
[codeblock]
|
||||||
func my_event_handler(cargo=null) -> bool:
|
func my_event_handler(cargo=null) -> bool:
|
||||||
[/codeblock]
|
[/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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="call_on_enter">
|
<method name="call_on_enter">
|
||||||
|
|
Loading…
Reference in New Issue