Dgs3DImageAttachToElement: Difference between revisions
No edit summary |
No edit summary |
||
Line 17: | Line 17: | ||
* [[createWeapon|Weapons]] | * [[createWeapon|Weapons]] | ||
* [[Camera]]s | * [[Camera]]s | ||
==Syntax== | ==Syntax== | ||
Line 26: | Line 22: | ||
bool dgs3DImageAttachToElement ( element theElement, element theAttachToElement, [ float xPosOffset = 0, float yPosOffset = 0, float zPosOffset = 0, float xRotOffset = 0, float yRotOffset = 0, float zRotOffset = 0 ] ) | bool dgs3DImageAttachToElement ( element theElement, element theAttachToElement, [ float xPosOffset = 0, float yPosOffset = 0, float zPosOffset = 0, float xRotOffset = 0, float yRotOffset = 0, float zRotOffset = 0 ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[element]]: | {{OOP||[[element]]:3DImageAttachToElement||3DImageDetachFromElement}} | ||
===Required Arguments=== | ===Required Arguments=== |
Revision as of 21:41, 11 August 2022
This function attaches 3D DGS Image element to another element, so that the first one follows the second whenever it moves.
If an attempt is made to attach two elements that are already attached the opposite way (eg the3DImage becomes theAttachToElement and vice versa), the 1st attachment order is automatically detached in favor of the 2nd attachment order. Also, the3DImage cannot be attached to two separate elements at one time. For example, two the3DImage can be attached to one single car, but you can attach car to the3DImage , If you attempt to do this it won't work .
This is not compatible with all elements. The following elements are compatible:
Syntax
bool dgs3DImageAttachToElement ( element theElement, element theAttachToElement, [ float xPosOffset = 0, float yPosOffset = 0, float zPosOffset = 0, float xRotOffset = 0, float yRotOffset = 0, float zRotOffset = 0 ] )
OOP Syntax Help! I don't understand this!
- Method: element:3DImageAttachToElement(...)
- Counterpart: 3DImageDetachFromElement
Required Arguments
- theElement: The element to be attached.
- theAttachToElement: The element to attach the first to.
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.
- xPosOffset: The x offset, if you want the elements to be a certain distance from one another (default 0).
- yPosOffset: The y offset (default 0).
- zPosOffset: The z offset (default 0).
- xRotOffset: The x rotation offset (default 0).
- yRotOffset: The y rotation offset (default 0).
- zRotOffset: The z rotation offset (default 0).
Returns
Returns true if the attaching process was successful, false otherwise.
Example
<section name="client" class="client" show="true"> Example 1: This example attaches a mic icon to the player who start voice chat:
if isVoiceEnabled() then local dgs = exports.dgs local micPNG = dxCreateTexture('assests/mic.png'); local icons = {}; addEventHandler('onClientPlayerVoiceStart',root, function() print('[Voice-System]: '..getPlayerName(source)..' started talking.') local x,y,z = getElementPosition(source); if ((source ~= localPlayer and isElementOnScreen(source)) or (localPlayer == source)) and not isElement(icons[source]) then local dgsMic = dgs:dgsCreate3DImage(x,y,z+1.5,micPNG,tocolor(255,255,255,255),4,4,20); print(dgs:dgs3DImageAttachToElement(dgsMic,localPlayer,0,0,1.5)) icons[source] = dgsMic; end end ) addEventHandler('onClientPlayerVoiceStop',root, function() print('[Voice-System]: '..getPlayerName(source)..' Stoped talking.') if isElement(icons[source]) then destroyElement(icons[source]); icons[source] = nil; end end ) end
See Also
- attachElements
- createElement
- destroyElement
- detachElements
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementByIndex
- getElementByID
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementCollisionsEnabled
- getElementColShape
- getElementData
- getAllElementData
- hasElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementsByType
- getElementsWithinColShape
- getElementsWithinRange
- getElementType
- getElementVelocity
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementWithinColShape
- isElementWithinMarker
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementVelocity
- setLowLODElement
- getPedContactElement
- getResourceDynamicElementRoot
- getResourceRootElement