ChangeVesselOwnership Behaviour - jrossignol/ContractConfigurator GitHub Wiki

Behaviour for changing the ownership of a vessel after certain conditions are met.

BEHAVIOUR
{
    name = ChangeVesselOwnership
    type = ChangeVesselOwnership

    // Indicates the state where the vessel ownership should be changed.
    //
    // Type:      TriggeredBehaviour.State
    // Required:  Yes
    // Values:
    //     CONTRACT_ACCEPTED
    //     CONTRACT_FAILED
    //     CONTRACT_SUCCESS
    //     CONTRACT_COMPLETED
    //     PARAMETER_COMPLETED
    //
    onState = CONTRACT_SUCCESS

    // When the onState attribute is set to PARAMETER_COMPLETED, a value
    // must also be supplied for the parameter attribute.  This is the name
    // of the parameter that we are checking for completion.  This can be
    // specified multiple times.
    //
    // Type:      string
    // Required:  Sometimes (multiples allowed)
    //
    parameter = TheParameterName

    // The vessel for which we will be changing the ownership of.  This
    // should either be derived via an expression, or match the define
    // name of a previous VesselParameterGroup parameter.
    //
    // Type:      VesselIdentifier
    // Required:  Yes (multiples allowed)
    //
    vessel = TheVesselName

    // Whether to make the vessel owned or unowned.
    //
    // Type:      bool
    // Required:  No (defaulted)
    // Default:   true
    //
    owned = false
}