OnBegin function
This function is called when the NPC is added to the simulation.
Verse using statement |
using { /Fortnite.com/AI } |
OnBegin<native_callable><public>()<suspends><reads><writes><allocates><no_rollback>:void
Parameters
OnBegin does not take any parameters.
Attributes and Effects
The following attributes and effects determine how OnBegin 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. |
public |
The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data. |
| Effect | Meaning |
|---|---|
suspends |
Indicates that the function is async. Creates an async context for the body of the function. |
reads |
This effect indicates that the same inputs may not always produce the same output. The behavior depends on factors external to the specified inputs, such as memory or the containing module version. |
writes |
This effect indicates that it may change values in memory. |
allocates |
This effect indicates that it may instantiate an object in memory. Allocating unique classes requires the allocates specifier. |
no_rollback |
This is the default effect when no exclusive effect is specified. The no_rollback effect indicates that any actions performed by the function cannot be undone and so the function cannot be used in a failure context. This effect cannot be manually specified. |