DetachElementFromElement

From Multi Theft Auto: Wiki
Revision as of 11:56, 19 April 2007 by Black Dragon (talk | contribs)
Jump to navigation Jump to search

This function detaches attached elements from one another.

Syntax

bool detachElementFromElement ( element theElement, [ element theAttachToElement ] )

Required Arguments

  • theElement: The element to be detached (the "child")

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • theAttachToElement: The element you wish to detach from, will detach from the attached element if this isn't specified.

Returns

Returns true if the detaching was successful, false otherwise.

Example

This function will detach any elements that might have been attached to the passed element.

function freeElement( element )
      if ( isElementAttached( element ) ) then --If the specified element is attached to something
            detachElementFromElement( element ) --Detach it.
      else
            outputChatBox( "Element is not attached" ) --If not, say it wasn't attached in the first place.
      end
end

See Also