FlexiMotionReadMe Class

Summary

[Editor-Only] A welcome screen for FlexiMotion.FlexiMotionComponent.
Assembly
FlexiMotion.dll
Namespace
FlexiMotion.Editor
Base Types
graph BT Type-->Base0["ReadMe"] click Base0 "/flexi-motion/api/FlexiMotion.Editor/ReadMe" Base0-->Base1["ScriptableObject"] Type["FlexiMotionReadMe"] class Type type-node

Syntax

[HelpURL(FMStrings.DocsURLs.APIDocumentation + "." + nameof(FlexiMotion.Editor) + "/" + nameof(FlexiMotionReadMe))]
public class FlexiMotionReadMe : ReadMe

Attributes

Type Description
HelpURLAttribute

Constructors

Name Summary
FlexiMotionReadMe()

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.
ExamplesLabel string
The display name for the examples section.
ExampleURL string
The URL for the example documentation.
ExtraExamples ReadMe.LinkSection[]
Extra sections to be displayed with the examples.
Inherited from ReadMe
Introduction string
An introductory explanation of this asset.
LinkSections ReadMe.LinkSection[]
Sections to be displayed below the examples.
Inherited from ReadMe
PrefKey string
The key used to save the release number.
ProductName string
The name of this product.
Inherited from ReadMe
ReleaseNumber int
The release ID of the current version.
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
Inherited from ReadMe

Extension Methods

Name Value Summary
LogTemp<FlexiMotionReadMe>(Object) T
Debug.Log(message, context) with an [System.ObsoleteAttribute] warning so you remember to remove any calls.
SafeGetHashCode<FlexiMotionReadMe>() int
Uses System.Collections.Generic.EqualityComparer`1.Default to get a hash code.