Verse API reference page for the IsInScene function | Fortnite Documentation

Succeeds if the component is currently in the scene.

After OnAddedToScene is called this call succeeds.
After OnRemovingFromScene is called this call fails.


Verse `using` statement	`using { /Verse.org/SceneGraph }`

IsInScene<public><native><final>()<reads><computes><decides>:void

Parameters

IsInScene does not take any parameters.

Attributes, Specifiers, and Effects

Specifiers

The following specifiers determine how you can interact with IsInScene in your programs. For the complete list of specifiers, see the Specifiers Page.

Specifier	Meaning
`public`	The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, 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.
`final`	You can only use the final specifier on classes and members of classes. When a class has the final specifier, you cannot create a subclass of the class. When a field has the final specifier, you cannot override the field in a subclass. When a method has the final specifier, you cannot override the method in a subclass.

Effects

The following effects determine how IsInScene 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.