HU/isSoundPanningEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function hu}} {{New feature/item|3.0130|1.3.0|4162| This function checks whether panning is enabled in a sound element or not. }} {{Tip|Althrough t...")
 
No edit summary
Line 2: Line 2:
{{Client function hu}}
{{Client function hu}}
{{New feature/item|3.0130|1.3.0|4162|
{{New feature/item|3.0130|1.3.0|4162|
This function checks whether panning is enabled in a [[sound]] [[element]] or not.
Ez a funkció ellenőrzi, hogy a panning engedélyezve van-e egy hangelemben, vagy sem.
}}
}}
{{Tip|Althrough this function works in no-3D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}
{{Tip|Althrough this function works in no-3D sounds (those created by [[playSound]]), it only makes sense to use it with 3D sounds (created by [[playSound3D]]). Please refer to [[setSoundPanningEnabled]] for a explanation of what this property does.}}

Revision as of 15:33, 19 July 2018

Ez a funkció ellenőrzi, hogy a panning engedélyezve van-e egy hangelemben, vagy sem.

[[{{{image}}}|link=|]] Tip: Althrough this function works in no-3D sounds (those created by playSound), it only makes sense to use it with 3D sounds (created by playSound3D). Please refer to setSoundPanningEnabled for a explanation of what this property does.

Syntax

bool isSoundPanningEnabled ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:isPanningEnabled(...)
Variable: .panningEnabled
Counterpart: setSoundPanningEnabled

Required Arguments

Returns

Returns true if the sound is valid and it has panning enabled, false if it does not or is not valid.

Example

This example plays a xy.mp3 file in the root folder of the resource which contains it at the center of the map, and proves that by default a sound enables panning by outputting the result of this function to the chatbox right after creating it. Then it disables the panning of the sound.

local function testPanning()
    -- Create the sound and output the panning property state
    local sound = playSound3D("xy.mp3", 0, 0, 0)
    outputChatBox("By default, the sound has its panning " .. (isSoundPanningEnabled(sound) and "enabled" or "disabled"))
    -- Disable the panning and ouput a fact
    setSoundPanningEnabled(sound, false)
    outputChatBox("The sound panning was disabled, so it won't annoy you when the camera it's in a side anymore!", 0, 255, 0)
end
addEventHandler("onClientResourceStart", resourceRoot, testPanning)

Requirements

This template will be deleted.

See Also