Class VSActionReference

    • Constructor Detail

      • VSActionReference

        public VSActionReference()
        Creates a VirtualSpace Action Reference property with no name and with a null value.
      • VSActionReference

        public VSActionReference​(Atom propertyAtom)
        Creates a VirtualSpace Action Reference property with the specified name with a null value.
        propertyAtom - the property atom.
      • VSActionReference

        public VSActionReference​(Atom propertyAtom,
                                 java.lang.String newValue)
        Creates a VirtualSpace Action Reference property with the specified name and value.
        propertyAtom - the property atom.
        newValue - the new string value for the property.
    • Method Detail

      • getCurrentListener

        protected IVSActionListener getCurrentListener()
        Gets the current listener, i.e. the parent property.
        The current listener, or null for none.
      • onRemoved

        protected void onRemoved​(VSAction oldTarget)
        Called when the property reference has been disposed of e.g. due to new reference or pure disposal of this property.
        Specified by:
        onRemoved in class VSRelativeReference<VSAction>
        oldTarget - The old target reference.
      • invokeAction

        public java.lang.String invokeAction​(IClientSessionGyro clientGyro,
                                             GProp<?> trigger,
                                             boolean isRemote,
                                             IVSActionProcessComplete completeCallback)
        Invokes the action. The action is posted to the appropriate worker thread for execution, or run in a separate thread depending on settings.

        If not enabled or read-only, the method will fail with an error message. The same message will then also be logged as a warning,

        If this method is called from a Run Mode not being any of the Server Run Modes, the method will just log an informational message and return null

        clientGyro - Client gyro to use, null to look-it up if needed from current thread.
        trigger - The trigger property, null for none.
        isRemote - Flag indicating that the reason for the action invocation is remote, i.e. from the Client.
        completeCallback - Called when complete (in the action execution thread), null for none.
        null for success, otherwise an error message. The return from this method may be done prior to completion of the TX process (use the completeCallback to monitor completion).