API ReferenceSandbox.Bind

BindSystemclass

Data bind system, bind properties to each other.

object→BindSystem
Namespace
Sandbox.Bind
Assembly
Sandbox.Bind
Declaration
public class Sandbox.Bind.BindSystem

Methods3

Showing 3 methods

public System.Attribute[] FindAttributes(T obj, string property)PUBLIC

For this object, with this property, find the property that supplies it and return any attributes set on it. This is useful for editors to allow them to supply the correct editor, without having access to the property.

ParameterTypeDescription
objT—
propertystring—
Returns:Attribute[]—

public void Flush()PUBLIC

Call a tick with no timer limits, forcing all pending actions to be actioned

Returns:void—

public void Tick()PUBLIC

Should be called every frame. Will run through the links and check for changes, then action those changes. Will also remove dead links.

Returns:void—

Properties5

Showing 5 properties

public Sandbox.Bind.Builder Sandbox.Bind.BindSystem.Build { get; set; }PUBLICGETSET

A helper to create binds between two properties (or whatever you want)

Returns:Builder—

public bool Sandbox.Bind.BindSystem.CatchExceptions { get; set; }PUBLICGETSET

If true we'll catch and remove exceptions when testing links instead of propagating them to the Tick call.

Returns:bool—

public int Sandbox.Bind.BindSystem.LinkCount { get; set; }PUBLICGETSET

The current amount of active links

Returns:int—

public string Sandbox.Bind.BindSystem.Name { get; set; }PUBLICGETSET

The debug name given to this system (ie Tools, Client, Server)

Returns:string—

public bool Sandbox.Bind.BindSystem.ThrottleUpdates { get; set; }PUBLICGETSETPER-FRAME

If true we'll throttle time between link change checks. This should always be enabled in game, for performance reasons.

Returns:bool—

On this page