Glossary
The terms the Selvage documentation uses.
Terms
| Term | Definition |
|---|---|
| Candidate | An object that could be injected into a member. For more information, refer to Choose between several candidates. |
| Change, revoke | What a provider announces about a dependency it gave: a change when a newer one exists and the old one is still usable, a revoke when it must not be used any more. For more information, refer to Reactive. |
| Channel | A value on a member, set with [Channel], that picks the candidate whose preference has the same value. |
| Context | An object whose members Selvage injects: a MonoBehaviour, a ScriptableObject, an instance of a plain C# class, or a class, for its static members. |
| Decline | What a provider does when it has no dependency for a request: Selvage tries the next provider. For more information, refer to Supplies. |
| Default | What a member holds when nothing is injected: its initializer, or null. |
| Dependency | The object a member holds. |
| Fail | What a required member does when its dependency is missing: it keeps its default, and the Console window displays an error. |
| Inject by Default | The setting that injects every class of the project. For more information, refer to Inject every class of the project. |
| Inject, reinject, release | Give a member its dependency, give it a new one, and take it back. |
| Lifetime | Whether members share one provided object (Shared, or Permanent to keep it until play stops or scripts reload), each receive their own (Separate), or borrow one from a pool (Pooled). For more information, refer to Lifetimes. |
| Local block | A using (Injector.Local(...)) block that gives objects to what you create inside it. |
| Member | A field or property marked [Inject], or covered by a scope. |
| Missing | No provider had a dependency for the member. |
| Option | A property of [Inject] that changes how a member is injected, such as Optional. For more information, refer to Options. |
| Preference | Settings on a candidate that say which members it's for. |
| Promise | An [assembly: Promise] attribute saying a provider has a dependency of a type whenever a member of that type is injected in Play mode, so the Editor counts those members as guaranteed. For more information, refer to Require every member to be guaranteed. |
| Provide Definition | An asset that makes Selvage provide the assets of its folder, or a list of assets. |
| Provide Tuning | A component that changes how the Scene Provider provides the GameObject it's on. A Scene Provider with Require Provide Tuning enabled gives only GameObjects that have one. |
| Provider | A class that gives dependencies from one source, such as the Scene Provider, which gives components from the loaded scenes. |
| Provider list | The ordered providers on the Selvage page of the Project Settings window. Selvage tries them from top to bottom. |
| Ready | A context is ready once all its members are injected, including its Async members. |
| Registry | A provider that gives the objects your code adds to it. |
| Scope | A class, an assembly or the project in which Selvage injects every field and property that can hold a dependency, without [Inject] on each. |
| Setup | Everything on the Selvage page of the Project Settings window, saved to reuse in other projects. |
| Shipped provider | A provider that ships with Selvage: the Registry Provider, the Scene Provider, the Attribute Provider and the Asset Provider. |
| Watched | A scene object whose Provide Tuning component announces when it appears and when it leaves, so members follow it. For more information, refer to Follow a scene object. |