DeprecatedRNA Struct Reference

#include <RNA_types.hh>

Public Attributes
const char *	note
short	version
short	removal_version

Detailed Description

Information about deprecated properties.

Used by the API documentation and Python API to print warnings when accessing a deprecated property.

Definition at line 1034 of file RNA_types.hh.

Member Data Documentation

note

const char* DeprecatedRNA::note

Single line deprecation message, suggest alternatives where possible.

Definition at line 1036 of file RNA_types.hh.

Referenced by pyrna_prop_warn_deprecated(), RNA_def_property_deprecated(), and rna_generate_property().

removal_version

short DeprecatedRNA::removal_version

The version this will be removed. The value represents major, minor versions (sub-version isn't supported). Compatible with Main::versionfile (e.g. 502 for v5.2).

Definition at line 1044 of file RNA_types.hh.

Referenced by pyrna_prop_warn_deprecated(), RNA_def_property_deprecated(), and rna_generate_property().

version

short DeprecatedRNA::version

The released version this was deprecated.

Definition at line 1038 of file RNA_types.hh.

Referenced by RNA_def_property_deprecated(), and rna_generate_property().

---

The documentation for this struct was generated from the following file:

• RNA_types.hh