Called when the component begins simulating within the scene.
- Use this to add asynchronous/suspends update logic for a component.
OnBeginSimulation
is guaranteed to run beforeOnSimulate
.OnSimulate
will be cancelled beforeOnEndSimulation
Verse using statement |
using { /Verse.org/SceneGraph } |
OnSimulate<native_callable><protected><experimental>()<suspends>:void
Parameters
OnSimulate
does not take any parameters.
Attributes and Effects
The following attributes and effects determine how OnSimulate
behaves and how you can use it in your programs. For the complete list of attribute and effect specifiers, see the Specifiers Page.
Attribute | Meaning |
---|---|
native_callable |
Indicates that an instance method is both native (implemented in C++) and may be called by other C++ code. You can see this specifier used on an instance method. This specifier doesn’t propagate to subclasses and so you don’t need to add it to a definition when overriding a method that has this specifier. |
protected |
The identifier is only accessible in the current class and any subtypes. You can use this on classes, interfaces, structs, enums, non-module methods, and data. |
Effect | Meaning |
---|---|
suspends |
Indicates that the function is async. Creates an async context for the body of the function. |