Difference between revisions of "Sandbox.ModAPI.Ingame.IMyAssembler"
(→CubeGrid) |
(→CustomName) |
||
| Line 111: | Line 111: | ||
===CustomName=== | ===CustomName=== | ||
| + | <syntaxhighlight lang="csharp"> | ||
| + | string CustomName {get;} | ||
| + | </syntaxhighlight> | ||
| + | The name of the block as shown in the terminal list. | ||
| + | |||
===CustomNameWithFaction=== | ===CustomNameWithFaction=== | ||
===DefinitionDisplayNameText=== | ===DefinitionDisplayNameText=== | ||
Revision as of 04:28, 12 January 2015
Contents
- 1 Sandbox.ModAPI.Ingame.IMyAssembler
- 1.1 Namespace
- 1.2 Assembly
- 1.3 Syntax
- 1.4 Methods
- 1.4.1 GetActions
- 1.4.2 GetActionWithName
- 1.4.3 GetOwnerFactionTag
- 1.4.4 GetPlayerRelationToOwner
- 1.4.5 GetUserRelationToOwner
- 1.4.6 HasLocalPlayerAccess
- 1.4.7 HasPlayerAccess
- 1.4.8 MoveQueueItemRequest
- 1.4.9 RemoveQueueItemRequest
- 1.4.10 RequestEnable
- 1.4.11 RequestShowOnHUD
- 1.4.12 SearchActionsOfName
- 1.4.13 SetCustomName
- 1.4.14 UpdateIsWorking
- 1.4.15 UpdateVisual
- 1.5 Properties
- 1.5.1 BlockDefinition
- 1.5.2 CheckConnectionAllowed
- 1.5.3 CubeGrid
- 1.5.4 CustomName
- 1.5.5 CustomNameWithFaction
- 1.5.6 DefinitionDisplayNameText
- 1.5.7 DetailedInfo
- 1.5.8 DisassembleRatio
- 1.5.9 DisplayNameText
- 1.5.10 Enabled
- 1.5.11 IsBeingHacked
- 1.5.12 IsFunctional
- 1.5.13 IsProducing
- 1.5.14 IsQueueEmpty
- 1.5.15 IsWorking
- 1.5.16 Max
- 1.5.17 Min
- 1.5.18 NextItemId
- 1.5.19 NumberInGrid
- 1.5.20 Orientation
- 1.5.21 OwnerId
- 1.5.22 Position
- 1.5.23 ShowOnHUD
- 1.5.24 UseConveyorSystem
Sandbox.ModAPI.Ingame.IMyAssembler
This interface is used to work with Assembler blocks.
Namespace
Assembly
Sandbox.Common (Sandbox.Common.dll)
Syntax
public interface IMyAssembler : IMyProductionBlock, IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntityMethods
GetActions
void GetActions(List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)This returns an ITerminalAction list containing a list of all valid actions for the block.
GetActionWithName
ITerminalAction GetActionWithName(string name)This searches the block for an associated action corresponding to the specified name.
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)HasLocalPlayerAccess
bool HasLocalPlayerAccess()HasPlayerAccess
bool HasPlayerAccess(long playerId)MoveQueueItemRequest
void MoveQueueItemRequest(uint queueItemId, int targetIdx)RemoveQueueItemRequest
void RemoveQueueItemRequest(int itemIdx)RequestEnable
void RequestEnable(bool enable)Turns the block off or on depending on if true or false. Same as action OnOff_On or OnOff_Off.
RequestShowOnHUD
void RequestShowOnHUD(bool enable)Enables or disables the ShowOnHUD option. If an antenna is present, the block will transmit its name and location to users in range of the antenna.
SearchActionsOfName
void SearchActionsOfName(string name, List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect = null)Search for all actions that start with the specified name. For instance, if you search for OnOff, you will get a list of actions returned including "OnOff_On" and "OnOff_Off"
SetCustomName
void SetCustomName(string text)
void SetCustomName(StringBuilder text)This sets the name of the block. This is the same as changing the block's name in the terminal.
UpdateIsWorking
void UpdateIsWorking()Updates the current value of the IsWorking property.
UpdateVisual
void UpdateVisual()Properties
BlockDefinition
SerializableDefinitionId BlockDefinition {get;}CheckConnectionAllowed
bool CheckConnectionAllowed {get;}CubeGrid
IMyCubeGrid CubeGrid {get;}CustomName
string CustomName {get;}The name of the block as shown in the terminal list.
