Component Methods |
The Component type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddComponent | Adds a component as a child. |
| BeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String) | |
| BeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String) | |
| BeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String) | |
| BeginNetworkMessage(ServerNetworkService_UsersUserInfo, String) | |
| BeginNetworkMessageToEveryone | |
| BeginNetworkMessageToServer | |
| Clone | Creates a copy of the object. |
| CreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum) | Creates a child component. |
| CreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum) | Creates a child component. |
| CreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum) | Creates a child component. |
| Dispose | Detaches the object from the hierarchy and deletes the object data. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindParent(Type) | Finds the parent of the specified type. |
| FindParent(MetadataTypeInfo) | Finds the parent of the specified type. |
| FindParentT | Finds the parent of the specified type. |
| FindThisOrParent(Type) | Finds the parent or self of the specified type. |
| FindThisOrParent(MetadataTypeInfo) | Finds the parent or self of the specified type. |
| FindThisOrParentT | Finds the parent or self of the specified type. |
| GetAllParents | Gets all parents of the component. |
| GetComponent(String, Boolean) | Finds a child component by name. |
| GetComponent(Type, Boolean, Boolean) | Finds a child component of the specified type. |
| GetComponent(MetadataTypeInfo, Boolean, Boolean) | Finds a child component of the specified type. |
| GetComponentT(Boolean, Boolean) | Finds a child component of the specified type. |
| GetComponentT(String, Boolean) | Finds a child component by name with the specified type. |
| GetComponentByNameWithIndex | Finds a child component by name and number in the case when there are several components with the specified name. |
| GetComponentByPath | Finds a child component by path. |
| GetComponents(Boolean, Boolean, Boolean, Boolean) | Finds child components. |
| GetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent) | Finds child components. |
| GetComponents(Type, Boolean, Boolean, Boolean, Boolean) | Finds child components of the specified type. |
| GetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean) | Finds child components of the specified type. |
| GetComponentsT(Boolean, Boolean, Boolean, Boolean) | Finds child components of the specified type. |
| GetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT) | Finds child components of the specified type. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetPathFromParent | Returns the path to the object from the parent. |
| GetPathFromRoot | Returns the object's access path from the root object. |
| GetProvidedType | Returns a type when the object is used as a type. |
| GetScreenLabelInfo | |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsMethodInvoking | Checks if a method is running over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MetadataGetMemberBySignature | Returns the object metadata member by name. |
| MetadataGetMembers | Returns the object metadata members. |
| MethodInvoke | Calls a method by name. |
| MethodInvokeCancel | Cancels the execution of selected method that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method. |
| MethodInvokeCancelAll | Cancels the execution of all methods that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method. |
| NetworkDisablePropertySynchronization | |
| NetworkIsDisabledPropertySynchronization | |
| NetworkModeAddUser | |
| NetworkModeIsEnabledForUser | |
| NetworkModeRemoveUser | |
| NetworkRestoreDisabledPropertySynchronization | |
| NewObjectSetDefaultConfiguration | Called when the object is created in the editor. Designed to configure the initial state. |
| NewObjectSetDefaultConfigurationUpdate | Called during object creation in the editor. Designed to configure the initial state. |
| OnAddedToParent | Called when a component is added to the parent. |
| OnClientConnectedAfterRootComponentEnabled | |
| OnClientConnectedBeforeRootComponentEnabled | |
| OnClientDisconnected | |
| OnClone | Called when the object is cloned. |
| OnComponentAdded | Called when a child component is added. |
| OnComponentRemoved | Called when a child component is removed. |
| OnDisabled | Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property. |
| OnDisabledInSimulation | Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property. |
| OnDispose | Called when the object is disposed. |
| OnEditorGetTextInfoCenterBottomCorner | |
| OnEnabled | Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property. |
| OnEnabledChanged | Called when value of Enabled property is changed. |
| OnEnabledInHierarchyChanged | Called when value of EnabledInHierarchy property is changed. |
| OnEnabledInSimulation | Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property. |
| OnLoad | Called during object loading. |
| OnMetadataGetMemberBySignature | Called when the object metadata member is received by name. |
| OnMetadataGetMembers | Called upon receipt of the object's metadata members. |
| OnMetadataGetMembersFilter | Called when filtering receive members of the object metadata. |
| OnPreloadResources | Called when preloading the resources used by the object. |
| OnReceiveNetworkMessageFromClient | |
| OnReceiveNetworkMessageFromServer | |
| OnRemovedFromParent | Called when a component is removed from the parent. |
| OnSave | Called during object saving. |
| OnSimulationStep | Called during the simulation step. |
| OnSimulationStepClient | Called during the simulation step. |
| OnUpdate | Called during the update process of all objects. |
| PreloadResources | Preload resources used by the object. |
 | Calls Info(Object). | |
| PropertyGet(String, Object, Boolean) | Gets the value of a property by name. |
| PropertyGetT(String, Object, Boolean) | Gets the value of a property by name. |
| PropertySet | Sets the value of a property by name. |
| RemoveAllComponents | Removes all child components. |
| RemoveComponent | Removes a child component. |
| RemoveFromParent | Detaches the object from its parent. |
| ToString |
Returns the name and type of the object as a string.
(Overrides ObjectToString) |
| TypeSettingsIsPublic | Checks whether the object provided as a type is public. |
| TypeSettingsIsPublicMember | Checks whether the member is set up as public. |
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx) |
| PropertyGet |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertyGetT |
Gets the value of the object property by name.
(Defined by ObjectEx) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx) |
See Also