The class contains functions for Generated Various Prefs using the fieldName and, for the tool-tip the XMLDocumentataion for the specified field.
- Template Parameters
-
| ValueType | The Value type stored by the Preference option to be generated. |
|
| static EditorPrefOption< ValueType > | GenNewEditorPrefOptionUsingXMLForTooltip (ValueType defaultValue, string fieldName, System.Type containingClass, bool alwaysLoadSaveOnAccess=true) |
| | This static function is used to create an instance of an EditorPrefOption. By passing in the field-name of a member, and the Type that it is contained in, the system will attempt to find this field's documentation in the embedded xml file. If found in the XML file, it will initialize the GUIConent tool-tip member in the returned EditorPrefOption, putting the XML documentation into it's tool-tip. If the member field cannot be found in the xml file, or if the xml file itself cannot be found, the returned EditorPrefOption will have an empty string for the tool-tip. Notes: - In order for the system to know which xml file contains the documentation, when running in a standalone project, the user must register the containingClass type, and xml file name and path, using EmbededXMLTooltip.RegisterClassWithXMLTooltipFile before calling this function. -In order for this function to work, when invoked from a DLL, the DLL must have embedded the xml documentation file, as a resource.
|
| |
