Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


NewStaticSafetyId

Allocates a new static safety ID to store information for the provided type.
Read time 2 minutesLast updated 22 days ago

Definition

NewStaticSafetyId(byte*, int)

Allocates a new static safety ID to store information for the provided type.
public static int NewStaticSafetyId(byte* ownerTypeNameBytes, int byteCount)

Parameters

ownerTypeNameBytes

The name of the scripting type that owns the AtomicSafetyHandle, to be embedded in error messages involving the handle. This must be a UTF8-encoded byte array, and doesn't have to be null-terminated.

byteCount

The number of bytes in the
ownerTypeNameBytes
array, excluding the optional null terminator.

Returns

Type

Description

intThe newly allocated safety ID.

Remarks

After creating a new static safety ID, use AtomicSafetyHandle.SetStaticSafetyId to assign it to the applicable AtomicSafetyHandle instances.
The job debugger uses this static safety ID to look up the provided type's name, and any custom error messages created with AtomicSafetyHandle.SetCustomErrorMessage. Without this information, the job debugger can only give general error messages that might not clearly identify the source of the error.

NewStaticSafetyId<T>()

Allocates a new static safety ID, to store information for the provided type T.
public static int NewStaticSafetyId<T>()

Returns

Type

Description

intThe newly allocated safety ID.

Remarks

After creating a new static safety ID, use AtomicSafetyHandle.SetStaticSafetyId to assign it to the applicable AtomicSafetyHandle instances.
The job debugger uses this static safety ID to look up the provided type's name, and any custom error messages created with AtomicSafetyHandle.SetCustomErrorMessage. Without this information, the job debugger can only give general error messages that might not clearly identify the source of the error.
This variant uses the name of the provided type
T
as the handle's owner type name.