This page is not available in the language you have chosen. It will be displayed in English by default. If you would like to view it in a different language, you can try selecting another language.
Fires the CanceledEvent event.
Verse using statement |
using { /Verse.org/SceneGraph } |
SignalCancelEvent<protected><native>(Agent:agent)<transacts>:void
Parameters
SignalCancelEvent takes the following parameters:
| Name | Type | Description |
|---|---|---|
Agent |
agent |
Attributes, Specifiers, and Effects
Specifiers
The following specifiers determine how you can interact with SignalCancelEvent in your programs. For the complete list of specifiers, see the Specifiers Page.
| Specifier | Meaning |
|---|---|
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. |
native |
Indicates that the definition details of the element are implemented in C++. Verse definitions with the native specifier auto-generate C++ definitions that a developer can then fill out its implementation. You can use this specifier on classes, interfaces, enums, methods, and data. |
Effects
The following effects determine how SignalCancelEvent behaves in your programs. For the complete list of effects, see the Effect Specifers section of the Specifiers Page.
| Effect | Meaning |
|---|---|
transacts |
This effect indicates that any actions performed by the function can be rolled back. The transacts effect is required any time a mutable variable (var) is written. You'll be notified when you compile your code if the transacts effect was added to a function that can't be rolled back. Note that this check is not done for functions with the native specifier. |