AttachElementToBone - Revision history

Srslyyyy: Fix example indent.

2022-07-05T13:02:08Z

Fix example indent.

← Older revision		Revision as of 13:02, 5 July 2022
Line 108:		Line 108:

	local function onPedsProcessed()		local function onPedsProcessed()
	attachElementToBone(theGun, localPlayer, 24, 0, 0, 0, 0, 0, 0)-- Attach the sniper model to bone #24 of the local player, no offset is needed because the default GTA weapon models fit perfectly fine into bone #24		attachElementToBone(theGun, localPlayer, 24, 0, 0, 0, 0, 0, 0) -- Attach the sniper model to bone #24 of the local player, no offset is needed because the default GTA weapon models fit perfectly fine into bone #24
	attachElementToBone(thePara, localPlayer, 3, 0.1, -0.14, 0, math.rad(90), 0, 0)-- Attach parachute to bone #3 of the local player with a small position and rotation offset, so it looks nice		attachElementToBone(thePara, localPlayer, 3, 0.1, -0.14, 0, math.rad(90), 0, 0) -- Attach parachute to bone #3 of the local player with a small position and rotation offset, so it looks nice
	end		end
	addEventHandler("onClientPedsProcessed", root, onPedsProcessed)		addEventHandler("onClientPedsProcessed", root, onPedsProcessed)

DREFTHUN: Fixed code indentation

2021-02-15T10:03:17Z

Fixed code indentation

Zangomangu: Undo revision 67874 by DREFTHUN (talk) This is bad practice, it's unnecessary to set dimension/interior every frame you attach. I know it's convenient but you want this as performant as possible

2020-12-01T15:10:32Z

Undo revision 67874 by DREFTHUN (talk) This is bad practice, it's unnecessary to set dimension/interior every frame you attach. I know it's convenient but you want this as performant as possible

← Older revision		Revision as of 15:10, 1 December 2020
Line 61:		Line 61:
	if isElementOnScreen(ped) then		if isElementOnScreen(ped) then
	local boneMat = getElementBoneMatrix(ped, bone)		local boneMat = getElementBoneMatrix(ped, bone)
	~~local interior, dimension = getElementInterior(ped), getElementDimension(ped)~~
	local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)		local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)
	local rotMat = {		local rotMat = {
Line 92:		Line 91:
	1}		1}
	}		}
	~~setElementInterior(element, interior)~~
	~~setElementDimension(element, dimension)~~
	setElementMatrix(element, finalMatrix)		setElementMatrix(element, finalMatrix)
	return true		return true

DREFTHUN: Added interior and dimension sync as well.

2020-12-01T10:50:20Z

Added interior and dimension sync as well.

← Older revision		Revision as of 10:50, 1 December 2020
Line 61:		Line 61:
	if isElementOnScreen(ped) then		if isElementOnScreen(ped) then
	local boneMat = getElementBoneMatrix(ped, bone)		local boneMat = getElementBoneMatrix(ped, bone)
			local interior, dimension = getElementInterior(ped), getElementDimension(ped)
	local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)		local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)
	local rotMat = {		local rotMat = {
Line 91:		Line 92:
	1}		1}
	}		}
			setElementInterior(element, interior)
			setElementDimension(element, dimension)
	setElementMatrix(element, finalMatrix)		setElementMatrix(element, finalMatrix)
	return true		return true

Saml1er: Make onPedsProcessed function local in code example

2020-11-28T02:09:52Z

Make onPedsProcessed function local in code example

← Older revision		Revision as of 02:09, 28 November 2020
Line 107:		Line 107:
	local thePara = createObject(371, 0, 0, 0)		local thePara = createObject(371, 0, 0, 0)

	function onPedsProcessed()		local function onPedsProcessed()
	attachElementToBone(theGun, localPlayer, 24, 0, 0, 0, 0, 0, 0)-- Attach the sniper model to bone #24 of the local player, no offset is needed because the default GTA weapon models fit perfectly fine into bone #24		attachElementToBone(theGun, localPlayer, 24, 0, 0, 0, 0, 0, 0)-- Attach the sniper model to bone #24 of the local player, no offset is needed because the default GTA weapon models fit perfectly fine into bone #24
	attachElementToBone(thePara, localPlayer, 3, 0.1, -0.14, 0, math.rad(90), 0, 0)-- Attach parachute to bone #3 of the local player with a small position and rotation offset, so it looks nice		attachElementToBone(thePara, localPlayer, 3, 0.1, -0.14, 0, math.rad(90), 0, 0)-- Attach parachute to bone #3 of the local player with a small position and rotation offset, so it looks nice

Einheit-101: Added example, fixed some stuff

2020-11-23T23:31:28Z

Added example, fixed some stuff

← Older revision		Revision as of 23:31, 23 November 2020
Line 16:		Line 16:
	* '''offsetY''': The Y position offset from the bone.		* '''offsetY''': The Y position offset from the bone.
	* '''offsetZ''': The Z position offset from the bone.		* '''offsetZ''': The Z position offset from the bone.
	* '''rotationOffsetX''': The rotation X-axis offset from the bone.		* '''rotationOffsetX''': The rotation X-axis offset from the bone, in '''radians'''.
	* '''rotationOffsetY''': The rotation Y-axis offset from the bone.		* '''rotationOffsetY''': The rotation Y-axis offset from the bone, in '''radians'''.
	* '''rotationOffsetZ''': The rotation Z-axis offset from the bone.		* '''rotationOffsetZ''': The rotation Z-axis offset from the bone, in '''radians'''.

	[[Image:Bones.jpg\|thumb\|Bone numbers]]		[[Image:Bones.jpg\|thumb\|Bone numbers]]
Line 102:		Line 102:
	==Example==		==Example==
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	This example attaches a sniper rifle ~~(model 358)~~ to the ~~players hand~~.		This example attaches a sniper rifle and a backpack to the local player.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~todo~~		local theGun = createObject(358, 0, 0, 0)
			local thePara = createObject(371, 0, 0, 0)

			function onPedsProcessed()
			attachElementToBone(theGun, localPlayer, 24, 0, 0, 0, 0, 0, 0)-- Attach the sniper model to bone #24 of the local player, no offset is needed because the default GTA weapon models fit perfectly fine into bone #24
			attachElementToBone(thePara, localPlayer, 3, 0.1, -0.14, 0, math.rad(90), 0, 0)-- Attach parachute to bone #3 of the local player with a small position and rotation offset, so it looks nice
			end
			addEventHandler("onClientPedsProcessed", root, onPedsProcessed)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Einheit-101: First release

2020-11-23T23:23:31Z

First release

New page

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you to attach an object, ped, player or vehicle to a ped or player bone for '''ONE FRAME'''. In order to attach an element continuously to a bone, this function should be used in conjunction with [[onClientPedsProcessed]].
The function checks if a player is actually on screen and if he is not, the object gets moved out of the stream distance in order to preserve some performance.
Unlike bone_attach, this function provides perfect accuracy for the attached elements and performs better.

==Syntax==
<syntaxhighlight lang="lua">bool attachElementToBone(element theElement, ped thePed, int boneID, float offsetX, float offsetY, float offsetZ, float rotationOffsetX, float rotationOffsetZ, float rotationOffsetZ)</syntaxhighlight>

===Required arguments===
* '''theElement''': The element which should be attached to the ped/player bone. Should work with any element that is supported by matrix functions.
* '''thePed''': The ped or player which the element should be attached to.
* '''boneID''': The target bone where the element should be attached to.
* '''offsetX''': The X position offset from the bone.
* '''offsetY''': The Y position offset from the bone.
* '''offsetZ''': The Z position offset from the bone.
* '''rotationOffsetX''': The rotation X-axis offset from the bone.
* '''rotationOffsetY''': The rotation Y-axis offset from the bone.
* '''rotationOffsetZ''': The rotation Z-axis offset from the bone.

[[Image:Bones.jpg|thumb|Bone numbers]]

<div style="border: 3px red solid; margin-bottom:3px; padding-left:5px;">
*'''1:''' BONE_PELVIS1
*'''2:''' BONE_PELVIS
*'''3:''' BONE_SPINE1
*'''4:''' BONE_UPPERTORSO
*'''5:''' BONE_NECK
*'''6:''' BONE_HEAD2
*'''7:''' BONE_HEAD1
*'''8:''' BONE_HEAD
*'''21:''' BONE_RIGHTUPPERTORSO
*'''22:''' BONE_RIGHTSHOULDER
*'''23:''' BONE_RIGHTELBOW
*'''24:''' BONE_RIGHTWRIST
*'''25:''' BONE_RIGHTHAND
*'''26:''' BONE_RIGHTTHUMB
*'''31:''' BONE_LEFTUPPERTORSO
*'''32:''' BONE_LEFTSHOULDER
*'''33:''' BONE_LEFTELBOW
*'''34:''' BONE_LEFTWRIST
*'''35:''' BONE_LEFTHAND
*'''36:''' BONE_LEFTTHUMB
*'''41:''' BONE_LEFTHIP
*'''42:''' BONE_LEFTKNEE
*'''43:''' BONE_LEFTANKLE
*'''44:''' BONE_LEFTFOOT
*'''51:''' BONE_RIGHTHIP
*'''52:''' BONE_RIGHTKNEE
*'''53:''' BONE_RIGHTANKLE
*'''54:''' BONE_RIGHTFOOT
</div>

===Return===
Returns true if the object has successfully been attached to the ped/player, returns false if the specified ped/player is not on screen and the object has been moved out of the streaming distance.

==Code==
<syntaxhighlight lang="lua">
function attachElementToBone(element, ped, bone, offX, offY, offZ, offrx, offry, offrz)
if isElementOnScreen(ped) then
local boneMat = getElementBoneMatrix(ped, bone)
local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)
local rotMat = {
{sroll * spitch * syaw + croll * cyaw,
sroll * cpitch,
sroll * spitch * cyaw - croll * syaw},
{croll * spitch * syaw - sroll * cyaw,
croll * cpitch,
croll * spitch * cyaw + sroll * syaw},
{cpitch * syaw,
-spitch,
cpitch * cyaw}
}
local finalMatrix = {
{boneMat[2][1] * rotMat[1][2] + boneMat[1][1] * rotMat[1][1] + rotMat[1][3] * boneMat[3][1],
boneMat[3][2] * rotMat[1][3] + boneMat[1][2] * rotMat[1][1] + boneMat[2][2] * rotMat[1][2],-- right
boneMat[2][3] * rotMat[1][2] + boneMat[3][3] * rotMat[1][3] + rotMat[1][1] * boneMat[1][3],
0},
{rotMat[2][3] * boneMat[3][1] + boneMat[2][1] * rotMat[2][2] + rotMat[2][1] * boneMat[1][1],
boneMat[3][2] * rotMat[2][3] + boneMat[2][2] * rotMat[2][2] + boneMat[1][2] * rotMat[2][1],-- front
rotMat[2][1] * boneMat[1][3] + boneMat[3][3] * rotMat[2][3] + boneMat[2][3] * rotMat[2][2],
0},
{boneMat[2][1] * rotMat[3][2] + rotMat[3][3] * boneMat[3][1] + rotMat[3][1] * boneMat[1][1],
boneMat[3][2] * rotMat[3][3] + boneMat[2][2] * rotMat[3][2] + rotMat[3][1] * boneMat[1][2],-- up
rotMat[3][1] * boneMat[1][3] + boneMat[3][3] * rotMat[3][3] + boneMat[2][3] * rotMat[3][2],
0},
{offX * boneMat[1][1] + offY * boneMat[2][1] + offZ * boneMat[3][1] + boneMat[4][1],
offX * boneMat[1][2] + offY * boneMat[2][2] + offZ * boneMat[3][2] + boneMat[4][2],-- pos
offX * boneMat[1][3] + offY * boneMat[2][3] + offZ * boneMat[3][3] + boneMat[4][3],
1}
}
setElementMatrix(element, finalMatrix)
return true
else
setElementPosition(element, 0, 0, -1000)
return false
end
end
</syntaxhighlight>

==Example==
<section name="Client" class="client" show="true">
This example attaches a sniper rifle (model 358) to the players hand.
<syntaxhighlight lang="lua">
--todo
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

← Older revision		Revision as of 10:03, 15 February 2021
Line 59:		Line 59:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function attachElementToBone(element, ped, bone, offX, offY, offZ, offrx, offry, offrz)		function attachElementToBone(element, ped, bone, offX, offY, offZ, offrx, offry, offrz)
	if isElementOnScreen(ped) then		if isElementOnScreen(ped) then
	local boneMat = getElementBoneMatrix(ped, bone)		local boneMat = getElementBoneMatrix(ped, bone)
	local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)		local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)
	local rotMat = {		local rotMat = {
	{sroll * spitch * syaw + croll * cyaw,		{sroll * spitch * syaw + croll * cyaw,
	sroll * cpitch,		sroll * cpitch,
	sroll * spitch * cyaw - croll * syaw},		sroll * spitch * cyaw - croll * syaw},
	{croll * spitch * syaw - sroll * cyaw,		{croll * spitch * syaw - sroll * cyaw,
	croll * cpitch,		croll * cpitch,
	croll * spitch * cyaw + sroll * syaw},		croll * spitch * cyaw + sroll * syaw},
	{cpitch * syaw,		{cpitch * syaw,
	-spitch,		-spitch,
	cpitch * cyaw}		cpitch * cyaw}
	}		}
	local finalMatrix = {		local finalMatrix = {
	{boneMat[2][1] * rotMat[1][2] + boneMat[1][1] * rotMat[1][1] + rotMat[1][3] * boneMat[3][1],		{boneMat[2][1] * rotMat[1][2] + boneMat[1][1] * rotMat[1][1] + rotMat[1][3] * boneMat[3][1],
	boneMat[3][2] * rotMat[1][3] + boneMat[1][2] * rotMat[1][1] + boneMat[2][2] * rotMat[1][2],-- right		boneMat[3][2] * rotMat[1][3] + boneMat[1][2] * rotMat[1][1] + boneMat[2][2] * rotMat[1][2],-- right
	boneMat[2][3] * rotMat[1][2] + boneMat[3][3] * rotMat[1][3] + rotMat[1][1] * boneMat[1][3],		boneMat[2][3] * rotMat[1][2] + boneMat[3][3] * rotMat[1][3] + rotMat[1][1] * boneMat[1][3],
	0},		0},
	{rotMat[2][3] * boneMat[3][1] + boneMat[2][1] * rotMat[2][2] + rotMat[2][1] * boneMat[1][1],		{rotMat[2][3] * boneMat[3][1] + boneMat[2][1] * rotMat[2][2] + rotMat[2][1] * boneMat[1][1],
	boneMat[3][2] * rotMat[2][3] + boneMat[2][2] * rotMat[2][2] + boneMat[1][2] * rotMat[2][1],-- front		boneMat[3][2] * rotMat[2][3] + boneMat[2][2] * rotMat[2][2] + boneMat[1][2] * rotMat[2][1],-- front
	rotMat[2][1] * boneMat[1][3] + boneMat[3][3] * rotMat[2][3] + boneMat[2][3] * rotMat[2][2],		rotMat[2][1] * boneMat[1][3] + boneMat[3][3] * rotMat[2][3] + boneMat[2][3] * rotMat[2][2],
	0},		0},
	{boneMat[2][1] * rotMat[3][2] + rotMat[3][3] * boneMat[3][1] + rotMat[3][1] * boneMat[1][1],		{boneMat[2][1] * rotMat[3][2] + rotMat[3][3] * boneMat[3][1] + rotMat[3][1] * boneMat[1][1],
	boneMat[3][2] * rotMat[3][3] + boneMat[2][2] * rotMat[3][2] + rotMat[3][1] * boneMat[1][2],-- up		boneMat[3][2] * rotMat[3][3] + boneMat[2][2] * rotMat[3][2] + rotMat[3][1] * boneMat[1][2],-- up
	rotMat[3][1] * boneMat[1][3] + boneMat[3][3] * rotMat[3][3] + boneMat[2][3] * rotMat[3][2],		rotMat[3][1] * boneMat[1][3] + boneMat[3][3] * rotMat[3][3] + boneMat[2][3] * rotMat[3][2],
	0},		0},
	{offX * boneMat[1][1] + offY * boneMat[2][1] + offZ * boneMat[3][1] + boneMat[4][1],		{offX * boneMat[1][1] + offY * boneMat[2][1] + offZ * boneMat[3][1] + boneMat[4][1],
	offX * boneMat[1][2] + offY * boneMat[2][2] + offZ * boneMat[3][2] + boneMat[4][2],-- pos		offX * boneMat[1][2] + offY * boneMat[2][2] + offZ * boneMat[3][2] + boneMat[4][2],-- pos
	offX * boneMat[1][3] + offY * boneMat[2][3] + offZ * boneMat[3][3] + boneMat[4][3],		offX * boneMat[1][3] + offY * boneMat[2][3] + offZ * boneMat[3][3] + boneMat[4][3],
	1}		1}
	}		}
	setElementMatrix(element, finalMatrix)		setElementMatrix(element, finalMatrix)
	return true		return true
	else		else
	setElementPosition(element, 0, 0, -1000)		setElementPosition(element, 0, 0, -1000)
	return false		return false
	end		end
	end		end
	</syntaxhighlight>		</syntaxhighlight>