InstancePlaceholder

Placeholder for the root Entity of a PackedEntity.

1.0.0

class InstancePlaceholderReckfellSharpInherits Entity

Placeholder for the root Entity of a PackedEntity.

Turning on the option Load As Placeholder for an instantiated scene in the editor causes it to be replaced by an InstancePlaceholder when running the game, this will not replace the node in the editor. This makes it possible to delay actually loading the scene until calling InstancePlaceholder.CreateInstance. This is useful to avoid loading large scenes all at once by loading parts of it selectively. Note: Like Entity, InstancePlaceholder does not have a transform. This causes any child nodes to be positioned relatively to the Viewport origin, rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Methods3

CreateInstanceEntity

# CreateInstance

C#
public Entity CreateInstance(bool replace = false, PackedEntity customScene = null);

Call this method to actually load in the node. The created node will be placed as a sibling above the InstancePlaceholder in the scene tree. The Entity's reference is also returned for convenience. Note: InstancePlaceholder.CreateInstance is not thread-safe. Use ReckfellObject.CallDeferred if calling from a thread.

Parameters
Name	Type	Default
`replace`	`bool`	`false`
`customScene`	`PackedEntity`	`null`

Returns Entity

GetInstancePathstring

# GetInstancePath

C#
public string GetInstancePath();

Gets the path to the PackedEntity resource file that is loaded by default when calling InstancePlaceholder.CreateInstance. Not thread-safe. Use ReckfellObject.CallDeferred if calling from a thread.

Returns string

GetStoredValuesReckfell.Collections.Dictionary

# GetStoredValues

C#
public Reckfell.Collections.Dictionary GetStoredValues(bool withOrder = false);

Returns the list of properties that will be applied to the node when InstancePlaceholder.CreateInstance is called. If with_order is true, a key named .order (note the leading period) is added to the dictionary. This .order key is an Reckfell.Collections.Array of string property names specifying the order in which properties will be applied (with index 0 being the first).

Parameters
Name	Type	Default
`withOrder`	`bool`	`false`

Returns Reckfell.Collections.Dictionary

Reckfell Engine documentationBack to top ↑