LuaLocalScript

Description

The script that is only executed on the client. Its execution logic and performance are also only shown on the local client. The script can be automatically executed under the following file directories. Client scripts under "Workspace" will not be automatically executed. They should be stored in the following objects:
1. ClientfirstLogic.
2. The avatar mesh in the WorkSpace. StarterCharacterScripts in StarterPlayers, which will automatically move under the avatar mesh after running.
3. The player in the Players. StarterPlayerScripts in StarterPlayers, which will automatically move under the player after running.
4. GameUI of the player. Scripts of StarterUI, which will automatically move under the GameUI after running.
5. Player's Backpack, for example, scripts in the Tool.

Properties

        string    Name
    The custom name of this object.

        string    ClassName
    The object-type name.

        RWObject    Parent
    The parent of this object.

        string    FilePath
    Open the script.

        Enum.List(LuaValueBaseData>    LuaValue
    Define variables in the script as property parameters.

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.