(CreativeDevice:creative_device).GetSimulationEntity extension | Unreal Editor for 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_device is operating within.

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


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

(CreativeDevice:creative_device).GetSimulationEntity<native><public><experimental>()<decides><diverges><reads><writes><allocates>:entity

Parameters

GetSimulationEntity takes the following parameters:

Name	Type	Description
`CreativeDevice`	`creative_device`

Attributes and Effects

The following attributes and effects determine how GetSimulationEntity 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`	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.
`public`	The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data.

Effect	Meaning
`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.
`diverges`	Indicates that calls to the function may not complete.
`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.
`writes`	This effect indicates that the function may change values in memory.
`allocates`	This effect indicates that the function may instantiate an object in memory. Allocating `<unique>` classes requires the `<allocates>` specifier.