SetElementCallPropagationEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server function}} Someone who knows what http://code.google.com/p/mtasa-blue/source/detail?r=6117 means needs to document this page. ==Syntax== <syntaxhighlight lang="lua"> ...")
 
m (fix oop syntax)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server_client function}}
Someone who knows what http://code.google.com/p/mtasa-blue/source/detail?r=6117 means needs to document this page.
This function enables/disables call propagation on a certain element. Look at the example for a practical application.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">bool setElementCallPropagationEnabled ( element theElement, bool enabled )</syntaxhighlight>
     
{{OOP||[[element]]:setCallPropagationEnabled||}}
</syntaxhighlight>
 
===Required Arguments===
 
 
===Optional Arguments===


===Required Arguments===
*'''theElement:''' The element whose propagation behaviour you'd like to change
*'''enabled:''' Whether propagation should be enabled or not


===Returns===
===Returns===
Returns ''true'', if the propagation behaviour has been changed successfully, ''false'' otherwise.


==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local parentImage = guiCreateStaticImage(0, 0, 64, 64, "img1.png", false)
local childImage = guiCreateStaticImage(0, 0, 16, 16, "img2.png", false, parentImage)


==Example==
-- Disable call propagation
setElementCallPropagationEnabled(parentImage, false)


<syntaxhighlight lang="lua">
-- Load another image
guiStaticImageLoadImage(parentImage, "img3.png")
--[[
    Normally (enabled call propagation) both parentImage and childImage would contain "img3.png" now.
    Due to disabled call propagation only parentImage will contain "img3.png" now (the call was not propagated down the tree)
]]


</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Utility functions}}
{{Element functions}}

Latest revision as of 14:34, 1 January 2015

This function enables/disables call propagation on a certain element. Look at the example for a practical application.

Syntax

bool setElementCallPropagationEnabled ( element theElement, bool enabled )

OOP Syntax Help! I don't understand this!

Method: element:setCallPropagationEnabled(...)


Required Arguments

  • theElement: The element whose propagation behaviour you'd like to change
  • enabled: Whether propagation should be enabled or not

Returns

Returns true, if the propagation behaviour has been changed successfully, false otherwise.

Example

Click to collapse [-]
Client
local parentImage = guiCreateStaticImage(0, 0, 64, 64, "img1.png", false)
local childImage = guiCreateStaticImage(0, 0, 16, 16, "img2.png", false, parentImage)

-- Disable call propagation
setElementCallPropagationEnabled(parentImage, false)

-- Load another image
guiStaticImageLoadImage(parentImage, "img3.png")
--[[
    Normally (enabled call propagation) both parentImage and childImage would contain "img3.png" now. 
    Due to disabled call propagation only parentImage will contain "img3.png" now (the call was not propagated down the tree)
]]

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementCallPropagationEnabled?oldid=43650"