from lnx.logicnode.lnx_nodes import *


class GetPropertyNode(LnxLogicTreeNode):
    """Return the value of the given object property. If the object is `null`
    or the property does not exist on the object, the node returns `null`.

    @input Object: The object to which the property belongs.
    @input Property: The name of the property from which to get the value.

    @output Value: The value of the property.
    @output Property: The name of the property as stated in the `Property` input.

    @see `Object Properties Panel > Leenkx Props > Properties` (do not confuse Leenkx object properties with Blender custom properties!)
    @see [`iron.object.Object.properties`](https://api.leenkx.com/iron/object/Object.html#properties)

    @seeNode Set Object Property
    """
    bl_idname = 'LNGetPropertyNode'
    bl_label = 'Get Object Property'
    lnx_version = 1
    lnx_section = 'props'

    def lnx_init(self, context):
        self.add_input('LnxNodeSocketObject', 'Object')
        self.add_input('LnxStringSocket', 'Property')

        self.add_output('LnxDynamicSocket', 'Value')
        self.add_output('LnxStringSocket', 'Property')