Inheritance diagram for BaseContainer:

[legend]

Public Member Functions
proto external string	GetClassName ()

proto external string	GetName ()

proto external void	SetName (string name)

proto external BaseContainer	GetAncestor ()

proto external void	SetAncestor (ResourceName ancestor)

proto external void	ClearVariable (string varName)

proto external void	ClearVariables ()

proto external bool	IsVariableSet (string varName)

proto external bool	IsVariableSetDirectly (string varName)

proto external bool	IsType (string varName, TypeName type)

proto external int	GetVarIndex (string varName)

proto external string	GetVarName (int varIndex)

proto external int	GetNumVars ()

proto external DataVarType	GetDataVarType (int varIndex)

proto external string	GetUIWidget (int varIndex)
	Return empty string or value from UIWidgets values.

proto external int	GetLimits (int varIndex, out float min, out float max, out float step)
	Return limits from property params, return value indicates how many values was read (0 - none, 1 - min, 2 - min,max, 3 - min,max,step)

proto external void	GetEnumValues (int varIndex, out array< string > names, out array< int > values)

proto external bool	Get (string varName, out void val)

proto external bool	GetDefaultAsString (string varName, out string val)

proto external BaseContainer	GetObject (string varName)

proto external bool	SetObject (string varName, BaseContainer val)

proto external ref BaseContainerList	GetObjectArray (string varName)
	Get wrapper for array of objects (the list is read only).

proto external ref BaseContainerList	SetObjectArray (string varName)
	Set array of objects.

proto external bool	Set (string varName, void val)

proto external int	GetSourceAddons (out notnull array< string > addonNames)
	Get list of addons where resource is defined or modified.

proto external BaseContainer	GetChild (int n)

proto external int	GetNumChildren ()

proto external BaseContainer	GetParent ()

Public Member Functions inherited from BaseResourceObject
proto external BaseContainer	ToBaseContainer ()

proto external IEntitySource	ToEntitySource ()

proto external MeshObject	ToMeshObject ()

proto external AnimationSource	ToAnimation ()

proto external VObject	ToVObject ()

proto external void	Release (bool flush=false)
	Release object.

proto external ResourceName	GetResourceName ()
	Returns name of visual object.

Public Member Functions inherited from pointer
proto string	ToString ()

Static Public Member Functions
static proto BaseContainer	Cast (BaseContainer from)

static proto bool	SafeCastType (out TypeName type, out BaseContainer to, BaseContainer from)
	This function is for internal script usage.

Member Function Documentation

◆ Cast()

static proto BaseContainer BaseContainer.Cast ( BaseContainer from )

static

◆ ClearVariable()

proto external void BaseContainer.ClearVariable ( string varName )

◆ ClearVariables()

proto external void BaseContainer.ClearVariables ( )

◆ Get()

proto external bool BaseContainer.Get	(	string	varName,
		out void	val
	)

◆ GetAncestor()

proto external BaseContainer BaseContainer.GetAncestor ( )

◆ GetChild()

proto external BaseContainer BaseContainer.GetChild ( int n )

◆ GetClassName()

proto external string BaseContainer.GetClassName ( )

◆ GetDataVarType()

proto external DataVarType BaseContainer.GetDataVarType ( int varIndex )

◆ GetDefaultAsString()

proto external bool BaseContainer.GetDefaultAsString	(	string	varName,
		out string	val
	)

◆ GetEnumValues()

proto external void BaseContainer.GetEnumValues	(	int	varIndex,
		out array< string >	names,
		out array< int >	values
	)

◆ GetLimits()

proto external int BaseContainer.GetLimits	(	int	varIndex,
		out float	min,
		out float	max,
		out float	step
	)

Return limits from property params, return value indicates how many values was read (0 - none, 1 - min, 2 - min,max, 3 - min,max,step)

◆ GetName()

proto external string BaseContainer.GetName ( )

◆ GetNumChildren()

proto external int BaseContainer.GetNumChildren ( )

◆ GetNumVars()

proto external int BaseContainer.GetNumVars ( )

◆ GetObject()

proto external BaseContainer BaseContainer.GetObject ( string varName )

◆ GetObjectArray()

proto external ref BaseContainerList BaseContainer.GetObjectArray ( string varName )

Get wrapper for array of objects (the list is read only).

BaseContainerList points = src.GetObjectArray("Points");
 
for (int i = 0; i < points.Count(); i++)
{
    ...
}

◆ GetParent()

proto external BaseContainer BaseContainer.GetParent ( )

◆ GetSourceAddons()

proto external int BaseContainer.GetSourceAddons ( out notnull array< string > addonNames )

Get list of addons where resource is defined or modified.

◆ GetUIWidget()

proto external string BaseContainer.GetUIWidget ( int varIndex )

Return empty string or value from UIWidgets values.

◆ GetVarIndex()

proto external int BaseContainer.GetVarIndex ( string varName )

◆ GetVarName()

proto external string BaseContainer.GetVarName ( int varIndex )

◆ IsType()

proto external bool BaseContainer.IsType	(	string	varName,
		TypeName	type
	)

◆ IsVariableSet()

proto external bool BaseContainer.IsVariableSet ( string varName )

◆ IsVariableSetDirectly()

proto external bool BaseContainer.IsVariableSetDirectly ( string varName )

◆ SafeCastType()

static proto bool BaseContainer.SafeCastType	(	out TypeName	type,
		out BaseContainer	to,
		BaseContainer	from
	)

static

This function is for internal script usage.

◆ Set()

proto external bool BaseContainer.Set	(	string	varName,
		void	val
	)

◆ SetAncestor()

proto external void BaseContainer.SetAncestor ( ResourceName ancestor )

◆ SetName()

proto external void BaseContainer.SetName ( string name )

◆ SetObject()

proto external bool BaseContainer.SetObject	(	string	varName,
		BaseContainer	val
	)

◆ SetObjectArray()

proto external ref BaseContainerList BaseContainer.SetObjectArray ( string varName )

Set array of objects.

Return wrapper for object array where objects can be added/removed.

BaseContainerList points = src.SetObjectArray("Points");
points.Insert(...);
points.Insert(...);
points.Insert(...);

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

Core/generated/Containers/BaseContainer.c

Public Member Functions

Static Public Member Functions