AdditionalVerbProps - Vanilla-Expanded/VanillaExpandedFramework GitHub Wiki
AdditionalVerbProps
is a class used to provide, as the name implies, additional properties for verbs in MVCF. It has the following fields:
label
: string
(required)
The most important field, this is used to figure out which verb this applies to. It must exactly match the label
field of the verb you want to apply it to.
canBeToggled
: bool
(default: false
)
Sets if the player can toggle the use of this verb.
visualLabel
: string
(default: label
)
If you want to provide a separate label than what you use to link the verb to these props, here is the place. This is useful to have the label
be an internal name. For more information, see Verb Label Strategy.
description
: string
(default: the description of the parent)
Describe the verb, shown when mousing over the verb's gizmo.
separateToggle
: bool
(default: false
)
Show a separate toggle gizmo, rather than having it be a checkbox on top of the verb's fire gizmo. If this is false
or not provided for any verb in your mod, you need to enable the feature IntegratedToggle
in your ModDef
.
toggleLabel
: string
(default: visualLabel
)
Label for the toggle gizmo, only used if separateToggle
is true
.
toggleDescription
: string
(default: description
)
Description for the toggle gizmo, used on mouseover. Only used if separateToggle
is true
.
toggleIconPath
: string
(optional)
Path to a icon to use for the toggle gizmo. Defaults to the same icon as the verb, which is explained in Verb Icon Strategy. Only used if separateToggle
is true
.
comps
: List<CompProperties>
Provide comps for new features. See Verb Comps.
managedClass
: Type
(default: VerbWithComps
if comps
exists, otherwise ManagedVerb
) [ADVANCED USAGE]
The class to use for this verb in the VerbManager
. Must be a subclass of the default value. I recommend looking through the source of MVCF to figure out how to use this, sorry.