GetVehicleComponentScale: Difference between revisions

Revision as of 16:36, 27 June 2019

This function gets the component scale of a vehicle.

Syntax

float, float, float getVehicleComponentScale ( vehicle theVehicle, string theComponent [, string base = "root" ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:getComponentScale(...)

Counterpart: setVehicleComponentScale

Required Arguments

theVehicle: The vehicle you wish to get component scale of.
theComponent: A vehicle component (this is the frame name from the model file of the component you wish to modify)

Optional Arguments

base: A string representing what the returned scale is relative to. It can be one of the following values:
- parent: The scale is relative to the parent component.
- root: The scale is relative to the root component.
- world: The scale is a world scale.

Returns

Returns three floats indicating the scale of the component, x, y and z respectively.

Example

Click to collapse [-]

This example gets the name and the scale of the components and outputs it in the chat.

addCommandHandler("vcs", -- short for 'vehicle component scale'
    function()
        local theVeh = getPedOccupiedVehicle(localPlayer)
	local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
        if (theVeh) then
            for k in pairs (getComponent) do
		local x, y, z = getVehicleComponentScale(theVeh, k)
                outputChatBox("Scale of "..k.." is"..x.." "..y.." "..z)
            end
        end
    end
)

@@ Line 1: / Line 1: @@
-{{Needs Checking|Missing. r14489.}}
+__NOTOC__
+{{Client function}}
+This function gets the component scale of a [[vehicle]].
+==Syntax==
+<syntaxhighlight lang="lua">
+float, float, float getVehicleComponentScale ( vehicle theVehicle, string theComponent [, string base = "root" ] )
+</syntaxhighlight>
+{{OOP||[[vehicle]]:getComponentScale||setVehicleComponentScale}}
+===Required Arguments===
+*'''theVehicle:''' The [[vehicle]] you wish to get component scale of.
+*'''theComponent:''' A [[Vehicle_Components|vehicle component]] (this is the frame name from the model file of the component you wish to modify)
+===Optional Arguments===
+{{New feature/item|3.0141|1.6.6|14489|
+*'''base:''' A string representing what the returned scale is relative to. It can be one of the following values:
+**'''parent:''' The scale is relative to the parent component.
+**'''root:''' The scale  is relative to the root component.
+**'''world:''' The scale is a world scale.
+}}
+===Returns===
+Returns three ''floats'' indicating the scale of the component, ''x'', ''y'' and ''z'' respectively.
+==Example==
+<section class="client" show="true" name="This example gets the name and the scale of the components and outputs it in the chat.">
+<syntaxhighlight lang="lua">
+addCommandHandler("vcs", -- short for 'vehicle component scale'
+    function()
+        local theVeh = getPedOccupiedVehicle(localPlayer)
+	local getComponent = getVehicleComponents(theVeh) -- returns table with all the components of the vehicle
+        if (theVeh) then
+            for k in pairs (getComponent) do
+		local x, y, z = getVehicleComponentScale(theVeh, k)
+                outputChatBox("Scale of "..k.." is"..x.." "..y.." "..z)
+            end
+        end
+    end
+)
+</syntaxhighlight>
+</section>
+==See Also==
+{{Client_vehicle_functions}}