ReadMe Class

Summary

[Editor-Only] A welcome screen for an asset.
Assembly
Animancer.dll
Namespace
Animancer.Editor
Base Types
  • ScriptableObject
Derived Types
graph BT Type-->Base0["ScriptableObject"] Type["ReadMe"] class Type type-node Derived0["AnimancerReadMe"]-->Type click Derived0 "/animancer/api/Animancer.Editor/AnimancerReadMe"

Syntax

public abstract class ReadMe : ScriptableObject

Constructors

Name Summary
ReadMe(ReadMe.LinkSection[]) Creates a new Animancer.Editor.ReadMe and sets the Animancer.Editor.ReadMe.LinkSections.

Properties

Name Value Summary
BaseProductName string
The base name of this product (without any "Lite", "Pro", "Demo", etc.).
ChangeLogURL string
The URL for the change log of this version.
DocumentationURL string
The URL for the documentation.
ExtraSamples ReadMe.LinkSection[]
Extra sections to be displayed with the samples.
Introduction string
An introductory explanation of this asset.
LinkSections ReadMe.LinkSection[]
Sections to be displayed below the samples.
PrefKey string
The key used to save the release number.
ProductName string
The name of this product.
ReleaseNumber int
The release ID of the current version.
SamplesLabel string
The display name for the samples section.
SamplesURL string
The URL for the sample documentation.
UpdateURL string
The URL to check for the latest version.
VersionName string
The display name of this product version.

Methods

Name Value Summary
GetEmailURL(string, string) string
Returns a mailto link.
static
OnEnable() void
Called after this object is loaded.