Version: Unity 6.7 Beta (6000.7)
LanguageEnglish
  • C#

ResourceTable.RemoveVariant

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool RemoveVariant(string key, string variantKey);

Parameters

Parameter Description
key The key text.
variantKey The selector key to remove the value for.

Returns

bool true when the entry held variants; otherwise false.

Description

Removes one variant value from a key's entry in this table.

Removes the value stored for variantKey in this locale's table only. The entry and its default value stay, and resolution for that variant key falls back to the default. The key stays registered on the shared VariantSelectorMetadata, because other locale tables may still hold values for it; unregister it with VariantSelectorMetadata.RemoveKey once every locale has dropped it. Does nothing when the key or variant does not exist.

Additional resources: ResourceTable.AddStringVariant, IVariantSelector

Make a key vary by storefront from script.

namespace Unity.Localization.Samples
{
    public static class AddVariantByScriptExample
    {
        public static void MakeWishlistVaryByStorefront(ResourceTable table)
        {
            // The default value, used wherever no variant matches.
            table.AddStringEntry("wishlist", "Add to wishlist");

// The selector lives on the shared key, so every locale resolves the same way. var key = table.SharedData.GetEntry("wishlist"); if (key.Metadata.GetMetadata<VariantSelectorMetadata>() == null) key.Metadata.AddMetadata(new VariantSelectorMetadata(new StorefrontVariantSelector()));

// The value this locale shows when the selector reports "GOG". table.AddStringVariant("wishlist", "GOG", "Add to GOG wishlist"); }

public static void RemoveTheVariant(ResourceTable table) { table.RemoveVariant("wishlist", "GOG"); } } }