AnimancerReadMe Class

Summary

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

Syntax

[AnimancerHelpUrl(typeof(AnimancerReadMe))]
public class AnimancerReadMe : ReadMe

Attributes

Type Description
AnimancerHelpUrlAttribute [Assert-Conditional] A UnityEngine.HelpURLAttribute which points to Animancer's documentation.

Constructors

Name Summary
AnimancerReadMe()

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.
Inherited from ReadMe
Introduction string
An introductory explanation of this asset.
Inherited from ReadMe
LinkSections ReadMe.LinkSection[]
Sections to be displayed below the samples.
Inherited from ReadMe
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.
Inherited from ReadMe
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.
Inherited from ReadMe
static
OnEnable() void
Called after this object is loaded.
Inherited from ReadMe