Componentclass
A GameObject can have many components, which are the building blocks of the game.
Constructors1
Showing 1 constructors
protected Component()
No results match this filter.
Methods45
Showing 45 methods
protected T __sync_GetValue(Sandbox.WrappedPropertyGet`1<T> p)
| Parameter | Type | Description |
|---|---|---|
| p | WrappedPropertyGet<T> | — |
T—protected void __sync_SetValue(Sandbox.WrappedPropertySet`1<T> p)
| Parameter | Type | Description |
|---|---|---|
| p | WrappedPropertySet<T> | — |
void—public T AddComponent(bool startEnabled = True)
Add a component to this GameObject
| Parameter | Type | Description |
|---|---|---|
| startEnabled = True | bool | — |
T—public void Deserialize(System.Text.Json.Nodes.JsonObject node)
| Parameter | Type | Description |
|---|---|---|
| node | JsonObject | — |
void—public void DeserializeImmediately(System.Text.Json.Nodes.JsonObject node)
Deserialize this component as per `Sandbox.Component.Deserialize(System.Text.Json.Nodes.JsonObject)` but update `Sandbox.Component.GameObject` and `Sandbox.Component` property references immediately instead of having them deferred.
| Parameter | Type | Description |
|---|---|---|
| node | JsonObject | — |
void—public void Destroy()
Destroy this component, if it isn't already destroyed. The component will be removed from its GameObject and will stop existing. You should avoid interating with the component after calling this.
void—public void DestroyGameObject()
Destroy the parent GameObject. This really only exists so when you're typing Destroy you realise that calling Destroy only destroys the Component - not the whole GameObject.
void—protected virtual void DrawGizmos()
Called in the editor to draw things like bounding boxes etc
void—public void EditLog(string name, object source)
Called when something on the component has been edited
Obsolete: EditLog is obsolete use Scene.Editor.UndoScope or Scene.Editor.AddUndo instead.
| Parameter | Type | Description |
|---|---|---|
| name | string | — |
| source | object | — |
void—public T GetComponent(bool includeDisabled = False)
Get a component on this GameObject
| Parameter | Type | Description |
|---|---|---|
| includeDisabled = False | bool | — |
T—public T GetComponentInChildren(bool includeDisabled = False, bool includeSelf = True)
Get component on this GameObject or on descendant GameObjects
| Parameter | Type | Description |
|---|---|---|
| includeDisabled = False | bool | — |
| includeSelf = True | bool | — |
T—public T GetComponentInParent(bool includeDisabled = False, bool includeSelf = True)
Get component on this GameObject and on ancestor GameObjects
| Parameter | Type | Description |
|---|---|---|
| includeDisabled = False | bool | — |
| includeSelf = True | bool | — |
T—public System.Collections.Generic.IEnumerable`1<T> GetComponents(bool includeDisabled = False)
Get components on this GameObject
| Parameter | Type | Description |
|---|---|---|
| includeDisabled = False | bool | — |
IEnumerable<T>—public System.Collections.Generic.IEnumerable`1<T> GetComponentsInChildren(bool includeDisabled = False, bool includeSelf = True)
Get components on this GameObject and on descendant GameObjects
| Parameter | Type | Description |
|---|---|---|
| includeDisabled = False | bool | — |
| includeSelf = True | bool | — |
IEnumerable<T>—public System.Collections.Generic.IEnumerable`1<T> GetComponentsInParent(bool includeDisabled = False, bool includeSelf = True)
Get components on this GameObject and on ancestor GameObjects
| Parameter | Type | Description |
|---|---|---|
| includeDisabled = False | bool | — |
| includeSelf = True | bool | — |
IEnumerable<T>—public T GetOrAddComponent(bool startEnabled = True)
Add a component to this GameObject
| Parameter | Type | Description |
|---|---|---|
| startEnabled = True | bool | — |
T—public void Invoke(float secondsDelay, System.Action action, System.Threading.CancellationToken ct = null)
Invoke a method in x seconds. Won't be invoked if the component is no longer active.
| Parameter | Type | Description |
|---|---|---|
| secondsDelay | float | — |
| action | Action | — |
| ct = null | CancellationToken | — |
void—public bool IsRunningDoo(Sandbox.Doo doo)
Returns true if the given Doo is currently running on this component.
| Parameter | Type | Description |
|---|---|---|
| doo | Doo | — |
bool—public static override object JsonRead(System.Text.Json.Utf8JsonReader reader, System.Type targetType)
| Parameter | Type | Description |
|---|---|---|
| reader | Utf8JsonReader | — |
| targetType | Type | — |
object—public static override void JsonWrite(object value, System.Text.Json.Utf8JsonWriter writer)
| Parameter | Type | Description |
|---|---|---|
| value | object | — |
| writer | Utf8JsonWriter | — |
void—protected virtual void OnAwake()
Called once per component
void—protected virtual void OnDestroy()
Called once, when the component or gameobject is destroyed
void—protected virtual void OnDirty()
Called when the component has become dirty
Obsolete: This API member is obsolete.
void—protected virtual void OnDisabled()
void—protected virtual void OnEnabled()
Called after Awake or whenever the component switches to being enabled (because a gameobject hierarchy active change, or the component changed)
void—protected virtual void OnFixedUpdate()
When enabled, called on a fixed interval that is determined by the Scene. This is also the fixed interval in which the physics are ticked. Time.Delta is that fixed interval.
void—protected virtual void OnParentChanged(Sandbox.GameObject oldParent, Sandbox.GameObject newParent)
The parent has changed from one parent to another
| Parameter | Type | Description |
|---|---|---|
| oldParent | GameObject | — |
| newParent | GameObject | — |
void—public virtual void OnParentDestroy()
The parent object is being destroyed. This is a nice place to switch to a healthier parent.
void—protected virtual void OnPreRender()
When enabled, called every frame, does not get called on a dedicated server
void—protected virtual void OnRefresh()
Called immediately after being refreshed from a network snapshot.
void—protected virtual void OnStart()
Called once before the first Update - when enabled.
void—protected virtual void OnTagsChanged()
When tags have been updated
void—protected virtual void OnUpdate()
When enabled, called every frame
void—protected virtual void OnValidate()
Called immediately after deserializing, and when a property is changed in the editor.
void—public virtual void Reset()
void—public void RunDoo(Sandbox.Doo doo, System.Action`1<Sandbox.Doo.Configure> c = null)
| Parameter | Type | Description |
|---|---|---|
| doo | Doo | — |
| c = null | Action<Configure> | — |
void—public System.Text.Json.Nodes.JsonNode Serialize(Sandbox.GameObject.SerializeOptions options = null)
| Parameter | Type | Description |
|---|---|---|
| options = null | SerializeOptions | — |
JsonNode—public void StopAllDoo()
Stop all running Doos
void—No results match this filter.
Properties29
Showing 29 properties
public bool Sandbox.Component.Active { get; set; }
True if this Component is enabled, and all of its ancestor GameObjects are enabled
bool—public virtual sealed Sandbox.ComponentList Sandbox.Component.Components { get; set; }
Access components on this component's GameObject
public virtual int Sandbox.Component.ComponentVersion { get; set; }
The version of the component. Used by `Sandbox.JsonUpgrader`.
int—public Sandbox.DebugOverlaySystem Sandbox.Component.DebugOverlay { get; set; }
Allows drawing of temporary debug shapes and text in the scene
public bool Sandbox.Component.Enabled { get; set; }
The enable state of this `Sandbox.Component`. This doesn't tell you whether the component is actually active because its parent `Sandbox.GameObject` might be disabled. This merely tells you what the component wants to be. You should use `Sandbox.Component.Active` to determine whether the object is truly active in the scene.
bool—public Sandbox.ComponentFlags Sandbox.Component.Flags { get; set; }
public Sandbox.GameObject Sandbox.Component.GameObject { get; set; }
The GameObject this component belongs to.
public System.Guid Sandbox.Component.Id { get; set; }
Guid—public bool Sandbox.Component.IsProxy { get; set; }
True if this is a networked object and is owned by another client. This means that we're not controlling this object, so shouldn't try to move it or anything.
bool—public virtual sealed bool Sandbox.Component.IsValid { get; set; }
bool—public Transform Sandbox.Component.LocalTransform { get; set; }
The local transform of the game object.
public Sandbox.GameObject.NetworkAccessor Sandbox.Component.Network { get; set; }
public System.Action Sandbox.Component.OnComponentDestroy { get; set; }
Action—public System.Action Sandbox.Component.OnComponentDisabled { get; set; }
Action—public System.Action Sandbox.Component.OnComponentEnabled { get; set; }
Action—public System.Action Sandbox.Component.OnComponentFixedUpdate { get; set; }
Action—public System.Action Sandbox.Component.OnComponentStart { get; set; }
Action—public System.Action Sandbox.Component.OnComponentUpdate { get; set; }
Action—public Sandbox.Scene Sandbox.Component.Scene { get; set; }
The scene this Component is in. This is a shortcut for `GameObject.Scene`.
protected Sandbox.TaskSource Sandbox.Component.Task { get; set; }
Allow creating tasks that are automatically cancelled when the GameObject is destroyed.
public Sandbox.GameTransform Sandbox.Component.Transform { get; set; }
The transform of the GameObject this component belongs to. Components don't have their own transforms but they can access the transform of the GameObject they belong to. This is a shortcut for `GameObject.Transform`.
public virtual sealed Rotation Sandbox.Component.WorldRotation { get; set; }
The world rotation of the game object.
No results match this filter.