Class RnObject

constructor

• new RnObject(): RnObject

• Creates a new RnObject instance with auto-generated unique name and UID

  Returns RnObject

_tags

Static ReadonlyInvalidObjectUID

StaticcurrentMaxObjectCount

objectUID

• get objectUID(): number

• Gets the unique object identifier

  Returns number

  The object's UID

uniqueName

• get uniqueName(): string

• Gets the unique name of this object

  Returns string

  The unique name string

_copyFrom

• _copyFrom(rnObject): void
• Internal

  Copies tag data from another RnObject instance to this object

  Parameters

  • rnObject: RnObject

    The source RnObject to copy tags from

  Returns void

getTag

• getTag(tagName): Tag

• Retrieves a complete tag object (name and value) for the specified tag name

  Parameters

  • tagName: string

    The name of the tag to retrieve

  Returns Tag

  A Tag object containing the name and value

getTagValue

• getTagValue(tagName): any

• Retrieves the value associated with a specific tag name

  Parameters

  • tagName: string

    The name of the tag whose value to retrieve

  Returns any

  The tag value, or undefined if the tag doesn't exist

hasTag

• hasTag(tagName): boolean

• Checks whether this object has a tag with the specified name

  Parameters

  • tagName: string

    The name of the tag to check for

  Returns boolean

  True if the tag exists (value is not null/undefined), false otherwise

matchTag

• matchTag(tagName, tagValue): boolean

• Checks if this object has a tag with the specified name and value

  Parameters

  • tagName: string

    The tag name to match
  • tagValue: string

    The tag value to match

  Returns boolean

  True if the object has a matching tag, false otherwise

matchTags

• matchTags(tags): boolean

• Checks if this object has all the specified tags with exactly matching values

  Parameters

  • tags: RnTags

    Object containing tag names as keys and expected values

  Returns boolean

  True if all specified tags exist with matching values, false otherwise

matchTagsAsFreeStrings

• matchTagsAsFreeStrings(stringArray): boolean

• Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.

  Parameters

  • stringArray: string[]

    Array of strings that must all be present in the combined tag string

  Returns boolean

  True if all strings are found in the combined tag string, false otherwise

removeTag

• removeTag(tagName): void

• Removes a tag from this object

  Parameters

  • tagName: string

    The name of the tag to remove

  Returns void

tryToSetTag

• tryToSetTag(tag): boolean

• Attempts to set a tag on this object. If the tag already exists, it will be replaced.

  Parameters

  • tag: Tag

    The tag object containing the name and value to set

  Returns boolean

  True if the tag was successfully set, false if the tag name contains invalid characters

tryToSetUniqueName

• tryToSetUniqueName(name, toAddNameIfConflict): boolean

• Attempts to set a unique name for this object

  Parameters

  • name: string

    The desired unique name
  • toAddNameIfConflict: boolean

    If true, appends UID to make name unique when conflicts occur; if false, fails on conflict

  Returns boolean

  True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false

unregister

• unregister(): void

• Unregisters this object from all tracking collections. Should be called when the object is being destroyed.

  Returns void

validateTagString

• validateTagString(val): boolean

• Validates that a tag string contains only allowed characters (alphanumeric and underscore)

  Parameters

  • val: string

    The string to validate

  Returns boolean

  True if the string contains only valid characters, false if it contains invalid characters

Static_reset

• _reset(): void
• Internal

  Resets all static object tracking data. Used primarily for testing.

  Returns void

StaticgetRnObject

• getRnObject(objectUid): undefined | RnObject

• Retrieves an RnObject instance by its unique identifier

  Parameters

  • objectUid: number

    The unique identifier of the object to retrieve

  Returns undefined | RnObject

  The RnObject instance or undefined if not found or garbage collected

StaticgetRnObjectByName

• getRnObjectByName(uniqueName): undefined | RnObject

• Retrieves an RnObject instance by its unique name

  Parameters

  • uniqueName: string

    The unique name of the object to retrieve

  Returns undefined | RnObject

  The RnObject instance or undefined if not found or garbage collected

StaticsearchByTag

• searchByTag(tag, value): undefined | WeakRef<RnObject>

• Searches for the first object that has a specific tag with the given value

  Parameters

  • tag: string

    The tag name to search for
  • value: string

    The tag value to match

  Returns undefined | WeakRef<RnObject>

  WeakRef to the first matching object, or undefined if not found