BaseContainerProps Interface Reference

An Attribute for BaseContainer. More...

Inheritance diagram for BaseContainerProps:

Public Member Functions
proto void	BaseContainerProps (string category="", string description="", string color="255 0 0 255", bool visible=true, bool insertable=true, bool configRoot=false, string icon="", NamingConvention namingConvention=NamingConvention.NC_MUST_HAVE_GUID)
Public Member Functions inherited from CommonEditorProps
proto void	CommonEditorProps (string category="", string description="", string color="255 0 0 255", bool visible=true, bool insertable=true, bool configRoot=false, string icon="",)

Detailed Description

An Attribute for BaseContainer.

[BaseContainerProps()]
class MyObject
{
    [Attribute("true", UIWidgets.CheckBox)]
    bool Prop1;
 
    [Attribute("7", UIWidgets.EditBox)]
    int Prop2;
 
    [Attribute("hello", UIWidgets.EditBox)]
    string Prop3;
}
 
[BaseContainerProps()]
class MyObjectSpecial: MyObject
{
    [Attribute("1.2", UIWidgets.EditBox)]
    float Prop4;
 
    [Attribute("", UIWidgets.Object)]
    ref MyObject Prop5;
}
 
// ...
class TestCube : GenericEntity
{
    [Attribute("", UIWidgets.Object)]
    ref MyObject m_singleObject;
 
    [Attribute("", UIWidgets.Object)]
    ref array<ref MyObject> m_arrayOfObjects;
};

Constructor & Destructor Documentation

BaseContainerProps()

proto void BaseContainerProps.BaseContainerProps	(	string	category = "",
		string	description = "",
		string	color = "255 0 0 255",
		bool	visible = true,
		bool	insertable = true,
		bool	configRoot = false,
		string	icon = "",
		NamingConvention	namingConvention = NamingConvention.NC_MUST_HAVE_GUID )

Parameters

category	Typically a "folder/item" path for placing the type into a tree view, e.g., "StaticEntities/Walls".
description	A description of the type's usage.
color	Color of an entity visualizer shape outline
visible	Indicates whether the entity visualizer is visible when not selected.
insertable	Indicates whether the type is available for insertion from the tree view.
configRoot	Indicates whether the type can be used as the root object of a config file (.conf).
icon	A path to an icon file for better visualization in a tree view.

---

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

• Core/generated/Attributes/BaseContainerProps.c