Buttonclass
Constructors1
Showing 1 constructors
public Button()
No results match this filter.
Methods3
Showing 3 methods
public void Toggle(Sandbox.GameObject presser)
Toggles the button between on and off states.
| Parameter | Type | Description |
|---|---|---|
| presser | GameObject | — |
void—public void TurnOff()
Turns the button off. Does nothing if already off or animating.
void—public void TurnOn(Sandbox.GameObject presser = null)
Turns the button on. Does nothing if already on or animating.
| Parameter | Type | Description |
|---|---|---|
| presser = null | GameObject | — |
void—No results match this filter.
Properties22
Showing 22 properties
public Sandbox.Curve Sandbox.Mapping.Button.AnimationCurve { get; set; }
Animation curve to use, X is the time between 0-1 and Y is how much the button is pressed from 0-1.
public float Sandbox.Mapping.Button.AnimationTime { get; set; }
How long in seconds should it take to animate this button.
float—public bool Sandbox.Mapping.Button.AutoReset { get; set; }
bool—public bool Sandbox.Mapping.Button.IsAnimating { get; set; }
True if the button is currently animating
bool—public bool Sandbox.Mapping.Button.IsOn { get; set; }
True if the button is currently on
bool—public Sandbox.Mapping.Button.ButtonMode Sandbox.Mapping.Button.Mode { get; set; }
public bool Sandbox.Mapping.Button.Move { get; set; }
bool—public Sandbox.GameObject Sandbox.Mapping.Button.MoveTarget { get; set; }
public Sandbox.SoundEvent Sandbox.Mapping.Button.OffSound { get; set; }
Sound to play when the button is released.
public Sandbox.Doo Sandbox.Mapping.Button.OnPressed { get; set; }
Called when the button is pressed. Receives the GameObject that pressed it.
public Sandbox.Doo Sandbox.Mapping.Button.OnReleased { get; set; }
Called when the button is released. Receives the GameObject that released it.
public Sandbox.SoundEvent Sandbox.Mapping.Button.OnSound { get; set; }
Sound to play when the button is pressed.
public Sandbox.Doo Sandbox.Mapping.Button.OnTurnedOff { get; set; }
Called when the button turns off.
public Sandbox.Doo Sandbox.Mapping.Button.OnTurnedOn { get; set; }
Called when the button turns on. Receives the GameObject that activated it.
public float Sandbox.Mapping.Button.ResetTime { get; set; }
float—public string Sandbox.Mapping.Button.TooltipDescription { get; set; }
string—public string Sandbox.Mapping.Button.TooltipDescriptionOff { get; set; }
string—public string Sandbox.Mapping.Button.TooltipIcon { get; set; }
string—public string Sandbox.Mapping.Button.TooltipIconOff { get; set; }
string—public string Sandbox.Mapping.Button.TooltipTitle { get; set; }
string—public string Sandbox.Mapping.Button.TooltipTitleOff { get; set; }
string—No results match this filter.