Page tree
Skip to end of metadata
Go to start of metadata


Introduced in

Version:1.00

Description

Description:Displays a HUDs resource, which is defined in the RscTitles section of the mission description.ext (see Scripting with description.ext in the VBS3 Scripting Manual), or the addon config.cpp.

Syntax

Syntax:cutRsc [name, type, speed]
Parameters:
  • name: String - Class name of the resource ("Default" removes the current resource).
  • type: String - Can be either (see Title Effect Type for more information about these values):
    • "PLAIN"
    • "PLAIN DOWN"
    • "BLACK"
    • "BLACK FADED"
    • "BLACK OUT"
    • "BLACK IN"
    • "WHITE OUT"
    • "WHITE IN"
  • speed: Number - Fade in time (in seconds) (optional, default: 1).
Return Value:Nothing

Alternative Syntax

Syntax:layer cutRsc [name, type, speed]
Parameters:
  • layer: Number - Defines the layer in which the effect is shown, where 0 is the lowest one (negative values allow placement of resources behind the current UI).
  • name: String - Class name of the resource ("Default" removes the current resource).
  • type: String - Can be either (see Title Effect Type for more information about these values):
    • "PLAIN"
    • "PLAIN DOWN"
    • "BLACK"
    • "BLACK FADED"
    • "BLACK OUT"
    • "BLACK IN"
    • "WHITE OUT"
    • "WHITE IN"
  • speed: Number - Fade in time (in seconds) (optional, default: 1).
Return Value:Nothing

Examples

Examples:
cutRsc ["binocular","PLAIN"]
cutRsc ["binocular","PLAIN",0.001]
cutRsc ["binocular","PLAIN",2]
2 cutRsc ["binocular","PLAIN",2];

Additional Information

See also: titleRsc, cutText, cutObj
Multiplayer:
Problems:

Notes





The command will ignore a duration of 0 seconds, isntead you can use a duration of 0.001 to display the resource almost instantly