deleteStatus: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
[[Category:Scripting Commands|DELETESTATUS]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|DELETESTATUS]]
____________________________________________________________________________________________
[[Category:Scripting Commands ArmA|DELETESTATUS]]


| ofpr |= Game name


<h2 style="color:#000066">'''deleteStatus ''statusName'''''</h2>
|1.75|= Game version


|eff= global |= Effects in MP
____________________________________________________________________________________________


'''Operand types:'''
| Delete a status (created with [[saveStatus]]) from the campaign's progress file. |= Description
____________________________________________________________________________________________


'''statusName:''' [[String]]
| '''deleteStatus''' status |= Syntax


'''Type of returned value:'''
|p1= status: [[String]] - name of the saved status |= Parameter 1


[[Boolean]]
| [[Boolean]]
true if the status was deleted successfully, false if not |= Return value
____________________________________________________________________________________________
 
|x1= <pre>deleteStatus "playerStatus"</pre> |= Example 1
____________________________________________________________________________________________


'''Compatibility:'''
| [[saveStatus]] |= See also


Added in version '''1.75'''
}}


'''Description:'''
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


Delete status created by [[saveStatus]] from campaign progress file.
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>


'''Example:'''
[[Category:Scripting Commands|DELETESTATUS]]
 
[[Category:Scripting Commands OFP 1.96|DELETESTATUS]]
'''deleteStatus''' "playerState"
[[Category:Scripting Commands ArmA|DELETESTATUS]]

Revision as of 23:45, 1 August 2006

Hover & click on the images for description

Description

Description:
Delete a status (created with saveStatus) from the campaign's progress file.
Groups:
Uncategorised

Syntax

Syntax:
deleteStatus status
Parameters:
status: String - name of the saved status
Return Value:
Boolean - true if the status was deleted successfully, false if not

Examples

Example 1:
deleteStatus "playerStatus"

Additional Information

See also:
saveStatus

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

Notes

Bottom Section