Class SceneObject

Base class for objects that are parts of the scene (actors and scripts).

Inheritance

System.Object

Object

SceneObject

Actor

Script

Inherited Members

Object.__unmanagedPtr

Object.__internalId

Object.As<T>()

Object.NewValue(Type)

Object.New(String)

Object.New<T>()

Object.New(Type)

Object.Find<T>(Guid)

Object.Find(Guid, Type)

Object.TryFind<T>(Guid)

Object.Destroy(Object, Single)

Object.Destroy<T>(T, Single)

Object.GetUnmanagedPtr(Object)

Object.GetHashCode()

Object.ID

Object.TypeName

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: FlaxEngine

Assembly: FlaxEngine.CSharp.dll

Syntax

[Unmanaged]
[Tooltip("Base class for objects that are parts of the scene (actors and scripts).")]
public abstract class SceneObject : Object

Constructors

SceneObject()

Initializes a new instance of the SceneObject.

Declaration

protected SceneObject()

Properties

HasParent

Returns true if object has a parent assigned.

Declaration

[Unmanaged]
[Tooltip("Returns true if object has a parent assigned.")]
public bool HasParent { get; }

Property Value

System.Boolean

HasPrefabLink

Gets a value indicating whether this object has a valid linkage to the prefab asset.

Declaration

[Unmanaged]
[Tooltip("Gets a value indicating whether this object has a valid linkage to the prefab asset.")]
public bool HasPrefabLink { get; }

Property Value

System.Boolean

OrderInParent

Gets or sets zero-based index in parent actor children list (scripts or child actors).

Declaration

[HideInEditor]
[Unmanaged]
public int OrderInParent { get; set; }

Property Value

System.Int32

Parent

Gets or sets the parent actor (or null if object has no parent).

Declaration

[HideInEditor]
[Unmanaged]
public Actor Parent { get; set; }

Property Value

Actor

PrefabID

Gets the prefab asset ID. Empty if no prefab link exists.

Declaration

[Unmanaged]
[Tooltip("The prefab asset ID. Empty if no prefab link exists.")]
public Guid PrefabID { get; }

Property Value

System.Guid

PrefabObjectID

Gets the ID of the object within a prefab that is used for synchronization with this object. Empty if no prefab link exists.

Declaration

[Unmanaged]
[Tooltip("The ID of the object within a prefab that is used for synchronization with this object. Empty if no prefab link exists.")]
public Guid PrefabObjectID { get; }

Property Value

System.Guid

Methods

BreakPrefabLink()

Breaks the prefab linkage for this object, all its scripts, and all child actors.

Declaration

[NoAnimate]
[Unmanaged]
[Tooltip("Breaks the prefab linkage for this object, all its scripts, and all child actors.")]
public virtual void BreakPrefabLink()

GetNamePath(Char)

Gets the path containing name of this object and all parent objects in tree hierarchy separated with custom separator character (/ by default). Can be used to identify this object in logs.

Declaration

[Unmanaged]
[Tooltip("The path containing name of this object and all parent objects in tree hierarchy separated with custom separator character (/ by default). Can be used to identify this object in logs.")]
public string GetNamePath(char separatorChar = '/')

Parameters

System.Char separatorChar The character to separate the names.

Returns

System.String The full name path.

LinkPrefab(Guid, Guid)

Links scene object instance to the prefab asset and prefab object. Warning! This applies to the only this object (not scripts or child actors).

Declaration

[Unmanaged]
[Tooltip("Links scene object instance to the prefab asset and prefab object. Warning! This applies to the only this object (not scripts or child actors).")]
public virtual void LinkPrefab(Guid prefabId, Guid prefabObjectId)

Parameters

System.Guid prefabId The prefab asset identifier.

System.Guid prefabObjectId The prefab object identifier.

SetParent(Actor, Boolean)

Sets the parent actor.

Declaration

[Unmanaged]
[Tooltip("Sets the parent actor.")]
public virtual void SetParent(Actor value, bool canBreakPrefabLink)

Parameters

Actor value The new parent.

System.Boolean canBreakPrefabLink True if can break prefab link on changing the parent.

Extension Methods

Extensions.ReflectiveCompare<T>(T, T)

Extensions.RawClone<T>(T)