Verse API reference page for the (CreativeObject:creative_object).GetSimulationEntity extension | Fortnite Documentation

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.

Returns the simulation entity at the root of the experience this creative_object is operating within.

The simulation entity is the rootmost entity in an experience.
Fails if this creative_object is not operating in a context with a valid SimulationEntity.


Verse `using` statement	`using { /Fortnite.com/Devices }`

(CreativeObject:creative_object).GetSimulationEntity<public><native>()<transacts><decides>:entity

Parameters

GetSimulationEntity takes the following parameters:

Name	Type	Description
`CreativeObject`	`creative_object`

Attributes, Specifiers, and Effects

The following attributes, specifiers, and effects determine how you can interact with GetSimulationEntity in your programs, as well as how it behaves in your programs and UEFN. For the complete list of attributes, specifiers, and effects; see the Specifiers Page.

Specifiers

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.

Effects

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.
`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.