Show / Hide Table of Contents

Class TTFlags

Inheritance
System.Object
TTFlags
Namespace: Eco.Gameplay.Systems.NewTooltip
Assembly: Eco.Gameplay.dll
Syntax
public sealed class TTFlags : Enum

Fields

AllowInstanceForSubTypeCache

Use this flag to allow operating with instance data for SubType cache mode (can be used for instance members or extension methods).
Even though tooltips cached as SubType should never depend on instance data (since it may differ for each instance), sometimes we can be sure that all instances of one type have the same data (e.g. static property).

Declaration
public const TTFlags AllowInstanceForSubTypeCache
Field Value
Type Description
TTFlags

AllowNonControllerTypeForChildren

Allow NewTooltipChildrenAttribute to be used with types that doesn't inherit from IController, if you're not sure about what you're doing don't use this. For example this is used in IPersistentData where the type is object but we still want to use this because we are making sure manually that non IController types aren't assigned this attribute.

Declaration
public const TTFlags AllowNonControllerTypeForChildren
Field Value
Type Description
TTFlags

AllowSubTypeCacheForGenericTypes

Setting this type will allow the use of the SubType cache mode with generic classes. When SubType cache mode is used, all instances of a generic type with a generic argument before runtime will be treated as a single subType meaning : -> tooltip with "OverrideType: typeof(GenericType'')" and SubType cache mode will have the same cache for all the types (GenericType'int', GenericType'float', etc.) meaning only the derived types of GenericType'' will have their own caches.

Declaration
public const TTFlags AllowSubTypeCacheForGenericTypes
Field Value
Type Description
TTFlags

ClearCacheForAllInstances

Use this flag for tooltip parts that need to be cached per instance, but need to be marked as dirty for all instances at once in some cases. If a specific instance gets passed when marking a tooltip as dirty then this flag will be ignored.

Declaration
public const TTFlags ClearCacheForAllInstances
Field Value
Type Description
TTFlags

ClearCacheForAllUsers

Use this flag for tooltip parts that need to be cached per user, but need to be marked as dirty for all users at once in some cases. If a specific user gets passed when marking a tooltip as dirty then this flag will be ignored.

Declaration
public const TTFlags ClearCacheForAllUsers
Field Value
Type Description
TTFlags

ForceInstantUpdate

Setting this flag for a tooltip part will cause server to notify clients and server's cache that it was marked as dirty instantly. Normally this happens in intervals defined by CacheRefreshRate.

Declaration
public const TTFlags ForceInstantUpdate
Field Value
Type Description
TTFlags

None

Declaration
public const TTFlags None
Field Value
Type Description
TTFlags

value__

Declaration
public int value__
Field Value
Type Description
System.Int32

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾