Verse API reference page for the CanMergeInto function
Succeeds if this entity can be merged into the target entity. Merging an entity with itself will always fail.
Verse using statement |
using { /Verse.org/SceneGraph } |
CanMergeInto<override>(TargetEntity:entity)<reads><computes><decides>:void
Parameters
CanMergeInto takes the following parameters:
| Name | Type | Description |
|---|---|---|
TargetEntity |
entity |
Attributes, Specifiers, and Effects
Specifiers
The following specifiers determine how you can interact with CanMergeInto in your programs. For the complete list of specifiers, see the Specifiers Page.
| Specifier | Meaning |
|---|---|
override |
Indicates that this child class provides a different method implementation than the parent class. |
Effects
The following effects determine how CanMergeInto behaves in your programs. For the complete list of effects, see the Effect Specifers section of the Specifiers Page.
| Effect | Meaning |
|---|---|
reads |
This effect indicates that the same inputs to the function may not always produce the same output. The behavior depends on factors external to the specified inputs, such as memory or the containing package version. |
computes |
This effect requires that the function has no side effects, and is not guaranteed to complete. There’s an unchecked requirement that the function, when provided with the same arguments, produces the same result. Any function that doesn’t have the native specifier that would otherwise have the converges effect is a good example of using the computes effect. |
decides |
Indicates that the function can fail, and that calling this function is a failable expression. Function definitions with the decides effect must also have the transacts effect, which means the actions performed by this function can be rolled back (as if the actions were never performed), if there’s a failure anywhere in the function. |