Tool

Description

A composite object with certain functions, used to create weapons, firearms, etc.

Properties

        string   ClassName
    The object-type name. Read only.

        string    Name
    The custom name of this object.

        RWObject   Parent
    The parent of this object.

        string   ToolIconID
    The icon ID of this tool displayed in the shortcut bar and the pack. When it is given a value by a script, a prefix rwid:// should be added, for example: " rwid://T23tdTB4bT1RCvBVdK".

        RWObject   Subject
    Used for a compound object, such as a tool, an accessory or a model, to confirm its reference position when the methods MoveTo, RotationTo and ScaleTo are executed in a script.

Functions

    RWObject.Create(classname)
    A special function, creating an instance of the specified class.

    DelAllChild()
    Deletes all child objects.

    Clone()
    Clones an object to create a copy.

    Destroy()
    Delete objects.

    GetAncestorByName(Name)
    Returns the object's first parent node with the same name.

    GetAncestorByClassName(className)
    Returns the object's first parent node of the same class.

    GetChildByName(Name,recursive)
    Returns the object's first child object with the same name. If the second parameter is true, it will search through descendants of all hierarchies.

    GetChildByClassName(className,recursive)
    Returns the object's first child object of the same type. If the second parameter is true, it will search through descendants of all hierarchies.

    GetAllChild()
    Seeks all its child objects and returns as a list.

    GetAllDescendant()
    Recursively seeks all its descendants and returns as a list.

    IsClass(ClassName)
    Judges whether it is the class the same as the given object class or not.

    IsAncestor(TarObj)
    Judges whether itself is the ancestor of the target object or not.

    IsDescendant(TarObj)
    Judges whether itself is the descendant of the target object or not.

    WaitForChild(childName,timeout)
    Seeks its own child object.

    Child(childName)
    Seeks its own child object by a given name.

    Equals(TarObj)
    Judges whether the target object is the same as itself or not.

Events

    ChildAdded(childobject)
    Triggered when a direct child object is added.

    ChildRemoved(childobject)
    Deletes all child objects.

    DescendantAdded(descendantobject)
    Triggered when a descendant is added.

    DescendantRemoved(descendantobject)
    Triggered when a descendant is removed.

    AncestryChanged(AncestryChanged)
    Triggered when the ancestry is changed.

    UnEquip()
    Triggered when the tool object itself is removed from avatar.

    Equip()
    Triggered when avatar is equipped with the tool object itself.

    Drop()
    Triggered when the tool object itself is removed from the backpack.