Description

The Ptr Lua function returns the handle to a child object.

Arguments

• Handle:
  The function takes a handle of the type "light_userdata" as an argument.
  It can be omitted when using the colon notation on an object.

  The Colon Notation is a way to omit the handle as the first argument when using the Object functions.

  This is the general syntax with the colon notation: object:function()

  This is the general syntax with standard handle notation: object.function(object)

  Learn more in the Lua Functions - Object API topic.
  

• Integer:
  This is the index number for the desired child object. This index is 1-based.
  

Return

• Handle | nil:
  The function returns a handle to the child object. If the child object does not exist, then it returns nil.

Example

This example prints the data connected to the first child of the selected sequence. It uses the Dump() function.

return function()
    -- SelectedSequence() creates a handle to the selected sequence.
    local selectedSequence = SelectedSequence()
    -- Check that a handle was returned - if not then exit function.
    if selectedSequence == nil then
        ErrPrintf("There is no selected sequence.")
        return
    end
    -- Get a handle to the first child object.
    local firstChild = selectedSequence:Ptr(1)
    -- Print some feedback.
    if firstChild ~= nil then
        Printf("=============== START OF DUMP ===============")
        firstChild:Dump()
        Printf("================ END OF DUMP ================")
    else
        ErrPrintf("The object do not have a child object.")
    end
end