Show / Hide Table of Contents

Class BaseNodeGroup

Inheritance
System.Object
BaseNodeGroup
AmeNodeGroup
PipeNet
TegNodeGroup
BaseNetConnectorNodeGroup<TNetType>
Implements
INodeGroup
Namespace: Content.Server.NodeContainer.NodeGroups
Assembly: Content.Server.dll
Syntax
public class BaseNodeGroup : object, INodeGroup

Fields

| Improve this Doc View Source

NetId

Network ID of this group for client-side debug visualization of nodes.

Declaration
public int NetId
Field Value
Type Description
System.Int32
| Improve this Doc View Source

Nodes

The list of nodes in this group.

Declaration
public readonly List<Node> Nodes
Field Value
Type Description
List<Node>

Properties

| Improve this Doc View Source

GroupId

Declaration
public NodeGroupID GroupId { get; }
Property Value
Type Description
NodeGroupID
| Improve this Doc View Source

NodeCount

Declaration
public int NodeCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Remaking

Declaration
public bool Remaking { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Removed

Debug variable to indicate that this NodeGroup should not be being used by anything.

Declaration
public bool Removed { get; set; }
Property Value
Type Description
System.Boolean

Methods

| Improve this Doc View Source

AfterRemake(IEnumerable<IGrouping<INodeGroup, Node>>)

Called after the nodes in this group have been made into one or more new groups.

Declaration
public virtual void AfterRemake(IEnumerable<IGrouping<INodeGroup, Node>> newGroups)
Parameters
Type Name Description
IEnumerable<IGrouping<INodeGroup, Node>> newGroups

A list of new groups for this group's former nodes.

Remarks

Use this to split in-group data such as pipe gas mixtures into newly split nodes.

| Improve this Doc View Source

Create(NodeGroupID)

Declaration
public void Create(NodeGroupID groupId)
Parameters
Type Name Description
NodeGroupID groupId
| Improve this Doc View Source

GetDebugData()

Declaration
public virtual string? GetDebugData()
Returns
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Initialize(Node, IEntityManager)

Declaration
public virtual void Initialize(Node sourceNode, IEntityManager entMan)
Parameters
Type Name Description
Node sourceNode
IEntityManager entMan
| Improve this Doc View Source

LoadNodes(List<Node>)

Called to load this newly created group up with new nodes.

Declaration
public virtual void LoadNodes(List<Node> groupNodes)
Parameters
Type Name Description
List<Node> groupNodes

The new nodes for this group.

| Improve this Doc View Source

RemoveNode(Node)

Called when a node has been removed from this group via deletion of the node.

Declaration
public virtual void RemoveNode(Node node)
Parameters
Type Name Description
Node node

The node that was deleted.

Remarks

Note that this always still results in a complete remake of the group later, but hooking this method is good for book keeping.

Explicit Interface Implementations

| Improve this Doc View Source

INodeGroup.Nodes

Declaration
IReadOnlyList<Node> INodeGroup.Nodes { get; }
Returns
Type Description
IReadOnlyList<Node>

Implements

INodeGroup
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾