Difference between revisions of "API:Sandbox.ModAPI.Ingame.IMyButtonPanel"

From Space Engineers Wiki
Jump to: navigation, search
(Created page with "{{subst:Template:APINamespaceHeaders|Sandbox.ModAPI.Ingame|Sandbox.Common|Sandbox.Common.dll}}")
 
(IMyButtonPanel object. Generated using all template files with light customization to fill in a few bits.)
 
Line 3: Line 3:
 
-->
 
-->
  
−
=NAMESPACE PATH GOES HERE=
+
=Sandbox.ModAPI.Ingame.IMyButtonPanel=
−
DESCRIPTION GOES HERE.
+
Interface for button panel blocks.
−
==Namespace==<!-- 1=Namespace. Example: Sandbox.ModAPI.Ingame-->
+
==Namespace==
 
[[Sandbox.ModAPI.Ingame]]
 
[[Sandbox.ModAPI.Ingame]]
 
==Assembly==
 
==Assembly==
−
[[Sandbox.Common]] (Sandbox.Common.dll)<!-- 2=Assembly Name. Example: Sandbox.Common | 3=DLL file name. Example: Sandbox.Common.dll-->
+
[[Sandbox.Common]] (Sandbox.Common.dll)
 
==Syntax==
 
==Syntax==
 
<syntaxhighlight lang="csharp">
 
<syntaxhighlight lang="csharp">
−
INSERT SYNTAX HERE.
+
public interface IMyButtonPanel : IMyTerminalBlock, IMyCubeBlock, IMyEntity
 
</syntaxhighlight>
 
</syntaxhighlight>
 
==Methods==
 
==Methods==
 +
===GetOwnerFactionTag===
 +
<syntaxhighlight lang="csharp">
 +
string GetOwnerFactionTag()
 +
</syntaxhighlight>
 +
This returns a string with the faction tag of the associated owner.
 +
 +
===GetPlayerRelationToOwner===
 +
<syntaxhighlight lang="csharp">
 +
MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId)
 +
</syntaxhighlight>
 +
 +
===GetUserRelationToOwner===
 +
<syntaxhighlight lang="csharp">
 +
MyRelationsBetweenPlayerAndBlock GetUserRelationToOWner(long playerId)
 +
</syntaxhighlight>
 +
 +
===UpdateIsWorking===
 +
<syntaxhighlight lang="csharp">
 +
void UpdateIsWorking()
 +
</syntaxhighlight>
 +
Updates the current value of the IsWorking property.
 +
 +
===UpdateVisual===
 +
<syntaxhighlight lang="csharp">
 +
void UpdateVisual()
 +
</syntaxhighlight>
 +
{{subst:Tempalte:IMyTerminalBlockMethods}}
  
 
==Properties==
 
==Properties==
 +
===BlockDefinition===
 +
<syntaxhighlight lang="csharp">
 +
SerializableDefinitionId BlockDefinition {get;}
 +
</syntaxhighlight>
 +
 +
===CheckConnectionAllowed===
 +
<syntaxhighlight lang="csharp">
 +
bool CheckConnectionAllowed {get;}
 +
</syntaxhighlight>
 +
 +
===CubeGrid===
 +
<syntaxhighlight lang="csharp">
 +
IMyCubeGrid CubeGrid {get;}
 +
</syntaxhighlight>
 +
 +
===DefinitionDisplayNameText===
 +
<syntaxhighlight lang="csharp">
 +
string DefinitionDisplayNameText {get;}
 +
</syntaxhighlight>
 +
 +
===DisassembleRatio===
 +
<syntaxhighlight lang="csharp">
 +
float DisassembleRatio {get;}
 +
</syntaxhighlight>
 +
 +
===DisplayNameText===
 +
<syntaxhighlight lang="csharp">
 +
string DisplayNameText {get;}
 +
</syntaxhighlight>
 +
 +
===IsBeingHacked===
 +
<syntaxhighlight lang="csharp">
 +
bool IsBeingHacked {get;}
 +
</syntaxhighlight>
 +
If the block is being ground down, returns true.
 +
 +
===IsFunctional===
 +
<syntaxhighlight lang="csharp">
 +
bool IsFunctional {get;}
 +
</syntaxhighlight>
 +
Determines whether or not the block is built enough to perform its function.
 +
 +
===IsWorking===
 +
<syntaxhighlight lang="csharp">
 +
bool IsWorking {get;}
 +
</syntaxhighlight>
 +
 +
===Max===
 +
<syntaxhighlight lang="csharp">
 +
Vector3I Max {get;}
 +
</syntaxhighlight>
 +
 +
===Min===
 +
<syntaxhighlight lang="csharp">
 +
Vector3I Min {get;}
 +
</syntaxhighlight>
 +
 +
===NumberInGrid===
 +
<syntaxhighlight lang="csharp">
 +
int NumberInGrid {get;}
 +
</syntaxhighlight>
 +
Returns the number of this block's type in the grid (not quantity of blocks of that type on the grid). For instance, if you have a thruster, and add a second thruster, this will return 2. If you remove the second thruster and build another one to replace it, it will return 3.
 +
 +
===Orientation===
 +
<syntaxhighlight lang="csharp">
 +
MyBlockOrientation Orientation {get;}
 +
</syntaxhighlight>
  
−
[[Category: API]]
+
===OwnerId===
 +
<syntaxhighlight lang="csharp">
 +
long OwnerId {get;}
 +
</syntaxhighlight>
 +
 
 +
===Position===
 +
<syntaxhighlight lang="csharp">
 +
Vector3I Position {get;}
 +
</syntaxhighlight>
 +
===CustomName===
 +
<syntaxhighlight lang="csharp">
 +
string CustomName {get;}
 +
</syntaxhighlight>
 +
The name of the block as shown in the terminal list.
 +
 
 +
===CustomNameWithFaction===
 +
<syntaxhighlight lang="csharp">
 +
string CustomNameWithFaction {get;}
 +
</syntaxhighlight>
 +
 
 +
===DetailedInfo===
 +
<syntaxhighlight lang="csharp">
 +
string DetailedInfo {get;}
 +
</syntaxhighlight>
 +
 
 +
===ShowOnHUD===
 +
<syntaxhighlight lang="csharp">
 +
Bool ShowOnHUD {get;}
 +
</syntaxhighlight>
 +
Returns whether or not ShowOnHUD is active.
 +
[[Category: API]][[Category:Programmable Block]][[Category:Sandbox.ModAPI.Ingame]]

Latest revision as of 07:12, 13 January 2015


Sandbox.ModAPI.Ingame.IMyButtonPanel

Interface for button panel blocks.

Namespace

Sandbox.ModAPI.Ingame

Assembly

Sandbox.Common (Sandbox.Common.dll)

Syntax

public interface IMyButtonPanel : IMyTerminalBlock, IMyCubeBlock, IMyEntity

Methods

GetOwnerFactionTag

string GetOwnerFactionTag()

This returns a string with the faction tag of the associated owner.

GetPlayerRelationToOwner

MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId)

GetUserRelationToOwner

MyRelationsBetweenPlayerAndBlock GetUserRelationToOWner(long playerId)

UpdateIsWorking

void UpdateIsWorking()

Updates the current value of the IsWorking property.

UpdateVisual

void UpdateVisual()

{{subst:Tempalte:IMyTerminalBlockMethods}}

Properties

BlockDefinition

SerializableDefinitionId BlockDefinition {get;}

CheckConnectionAllowed

bool CheckConnectionAllowed {get;}

CubeGrid

IMyCubeGrid CubeGrid {get;}

DefinitionDisplayNameText

string DefinitionDisplayNameText {get;}

DisassembleRatio

float DisassembleRatio {get;}

DisplayNameText

string DisplayNameText {get;}

IsBeingHacked

bool IsBeingHacked {get;}

If the block is being ground down, returns true.

IsFunctional

bool IsFunctional {get;}

Determines whether or not the block is built enough to perform its function.

IsWorking

bool IsWorking {get;}

Max

Vector3I Max {get;}

Min

Vector3I Min {get;}

NumberInGrid

int NumberInGrid {get;}

Returns the number of this block's type in the grid (not quantity of blocks of that type on the grid). For instance, if you have a thruster, and add a second thruster, this will return 2. If you remove the second thruster and build another one to replace it, it will return 3.

Orientation

MyBlockOrientation Orientation {get;}

OwnerId

long OwnerId {get;}

Position

Vector3I Position {get;}

CustomName

string CustomName {get;}

The name of the block as shown in the terminal list.

CustomNameWithFaction

string CustomNameWithFaction {get;}

DetailedInfo

string DetailedInfo {get;}

ShowOnHUD

Bool ShowOnHUD {get;}

Returns whether or not ShowOnHUD is active.

Retrieved from "http://spaceengineerswiki.com/index.php?title=API:Sandbox.ModAPI.Ingame.IMyButtonPanel&oldid=11874"