Dgs3DImageIsAttached: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 7: Line 7:
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isElementAttached ( dgsElement the3DImageElement )
bool dgs3DImageIsAttached( dgsElement element )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:isAttached|}}
{{OOP||[[element]]:isAttached|}}
Line 13: Line 13:
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''the3DImageElement :''' The element to check for attachment.
*'''element:''' The dgs 3d image element to check for attachment.


===Returns===
===Returns===
Line 23: Line 23:
This example is making export function to check weather the player is talking or not:
This example is making export function to check weather the player is talking or not:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
dgs = exports.dgs
function isPlayerTalking(player)
function isPlayerTalking(player)
local player = player or localPlayer;
local player = player or localPlayer;
return dgs:dgs3DImageIsAttached(icons[player]);
return dgs:dgs3DImageIsAttached(icons[player]); -- this table inside another client file .
end  
end  
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Element_functions}}
{{DGS 3D Image Functions}}

Latest revision as of 10:07, 17 January 2023

This functions checks whether or not 3DImage element is attached to another element.

Syntax

bool dgs3DImageIsAttached( dgsElement element )

OOP Syntax Help! I don't understand this!

Method: element:isAttached(...)


Required Arguments

  • element: The dgs 3d image element to check for attachment.

Returns

Returns true if the specified element is attached to another element, false if it is not attached or nil if an improper argument was passed.

Example

This example is making export function to check weather the player is talking or not: 

dgs = exports.dgs

function isPlayerTalking(player)
	local player = player or localPlayer;
	return dgs:dgs3DImageIsAttached(icons[player]); -- this table inside another client file .
end

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/Dgs3DImageIsAttached?oldid=76032"