BIS fnc dbClassRemove: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= Database
____________________________________________________________________________________________


| <pre>/*
|descr= Remove class from Scripted Database. The function does not return the modified database but modifies the passed array directly.


Description:
|s1= [database, path] call [[BIS_fnc_dbClassRemove]]
Remove class from Scripted Database.


Parameter(s):
|p1= database - [[Array]]: Database array
_this select 0: ARRAY - Database array
|p2= path - [[Array]]: Path to class to be deleted
_this select 1: ARRAY - Path


Returns:
|r1= [[Boolean]]: True if class was removed
BOOLEAN - True if class was removed
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
|x1= <sqf>private _db = ["#MILLER", ["&KILLS", 1000], "#TERRA", ["&WEAPON", "MX 6.5mm"]];
____________________________________________________________________________________________
[_db, ["terra"]] call BIS_fnc_dbClassRemove; // true
 
_db // ["#MILLER",["&KILLS",1000]]</sqf>
| <!-- [] call [[BIS_fnc_dbClassRemove]]; --> |SYNTAX=
 
|p1= |PARAMETER1=
 
| |RETURNVALUE=
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |SEEALSO=


|seealso= [[:Category:Function Group: Database|Database functions]] [[BIS_fnc_dbClassCheck]] [[BIS_fnc_dbClassId]] [[BIS_fnc_dbClassIndex]] [[BIS_fnc_dbClassList]] [[BIS_fnc_dbClassReturn]] [[BIS_fnc_dbClassSet]] [[BIS_fnc_dbConfigPath]] [[BIS_fnc_dbImportConfig]] [[BIS_fnc_dbImportXML]] [[BIS_fnc_dbisClass]] [[BIS_fnc_dbisValue]] [[BIS_fnc_dbPrint]][[BIS_fnc_dbSymbolClass]] [[BIS_fnc_dbSymbolValue]] [[BIS_fnc_dbValueCheck]] [[BIS_fnc_dbValueId]] [[BIS_fnc_dbValueIndex]] [[BIS_fnc_dbValueList]] [[BIS_fnc_dbValueRemove]] [[BIS_fnc_dbValueReturn]] [[BIS_fnc_dbValueSet]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Database|{{uc:dbClassRemove}}]]
[[Category:Functions|{{uc:dbClassRemove}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:dbClassRemove}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:dbClassRemove}}]]

Latest revision as of 17:00, 13 July 2022

tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Remove class from Scripted Database. The function does not return the modified database but modifies the passed array directly.
Execution:
call
Groups:
Database

Syntax

Syntax:
[database, path] call BIS_fnc_dbClassRemove
Parameters:
database - Array: Database array
path - Array: Path to class to be deleted
Return Value:
Boolean: True if class was removed

Examples

Example 1:
private _db = ["#MILLER", ["&KILLS", 1000], "#TERRA", ["&WEAPON", "MX 6.5mm"]]; [_db, ["terra"]] call BIS_fnc_dbClassRemove; // true _db // ["#MILLER",["&KILLS",1000]]

Additional Information

See also:
Database functions BIS_fnc_dbClassCheck BIS_fnc_dbClassId BIS_fnc_dbClassIndex BIS_fnc_dbClassList BIS_fnc_dbClassReturn BIS_fnc_dbClassSet BIS_fnc_dbConfigPath BIS_fnc_dbImportConfig BIS_fnc_dbImportXML BIS_fnc_dbisClass BIS_fnc_dbisValue BIS_fnc_dbPrintBIS_fnc_dbSymbolClass BIS_fnc_dbSymbolValue BIS_fnc_dbValueCheck BIS_fnc_dbValueId BIS_fnc_dbValueIndex BIS_fnc_dbValueList BIS_fnc_dbValueRemove BIS_fnc_dbValueReturn BIS_fnc_dbValueSet

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_dbClassRemove&oldid=328348"