Class OccurrenceSync.Handle

A handle is used to represent an Occurrence from Pixyz, it may or may not be instantiated in unity

Inheritance

object

OccurrenceSync.Handle

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Pixyz.UnitySDK

Assembly: Unity.Pixyz.UnitySDK.Runtime.dll

Syntax

public class OccurrenceSync.Handle

Constructors

Handle(uint)

Declaration

public Handle(uint occurrenceId)

Parameters

Type	Name	Description
uint	occurrenceId

Handle(OccurrenceWrapper)

Declaration

public Handle(OccurrenceWrapper wrapper)

Parameters

Type	Name	Description
OccurrenceWrapper	wrapper

Fields

Name

Declaration

public string Name

Field Value

Type	Description
string

OccurrenceID

Declaration

public uint OccurrenceID

Field Value

Type	Description
uint

Properties

IsInstantiated

Is the target occurrence instantiated in unity ?

Declaration

public bool IsInstantiated { get; }

Property Value

Type	Description
bool

Reference

Return a new reference to the instantiated occurrence if it was instantiated, null otherwise

Declaration

public OccurrenceRef Reference { get; }

Property Value

Type	Description
OccurrenceRef

Methods

Equals(object)

Used so 2 instance of handle representing the same occurrence can be equal with == operator

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Instantiate(TreeModel, bool)

Instantiate the occurrence in unity or return a new ref to the already instantiated occurrence

Declaration

public OccurrenceRef Instantiate(TreeModel model, bool temporary = true)

Parameters

Type	Name	Description
TreeModel	model
bool	temporary

Returns

Type	Description
OccurrenceRef